From 29913a70fb672ed4f7f568d48bf4724a88447b61 Mon Sep 17 00:00:00 2001
From: Omar Salah <omar.salah1597@gmail.com>
Date: Tue, 30 Sep 2025 12:29:17 +0300
Subject: [PATCH] chore: add obv3 achievment interface

---
 src/OBv3.ts  | 178 +++++++++++++++++++++++++++++++++++++++++++++++++++
 src/index.ts |   1 +
 2 files changed, 179 insertions(+)
 create mode 100644 src/OBv3.ts

diff --git a/src/OBv3.ts b/src/OBv3.ts
new file mode 100644
index 0000000..58f72f7
--- /dev/null
+++ b/src/OBv3.ts
@@ -0,0 +1,178 @@
+/*!
+ * Open Badges v3.0 interfaces
+ * @see https://www.imsglobal.org/spec/ob/v3p0/
+ */
+
+import { IVerifiableCredential } from './VCDM.js'
+import { ILdType, ILinkedDataObject } from './LD.js'
+
+/**
+ * OBv3 Credential (Assertion)
+ * Extends W3C VC with an OBv3-specific credentialSubject
+ */
+export interface IOpenBadgeCredentialV3 extends IVerifiableCredential {
+  credentialSubject: IOpenBadgeSubject | IOpenBadgeSubject[]
+}
+
+/**
+ * OBv3 CredentialSubject
+ * https://www.imsglobal.org/spec/ob/v3p0/#credentialsubject
+ */
+export interface IOpenBadgeSubject extends ILinkedDataObject {
+  achievement: IAchievement | string
+  evidence?: IOBv3Evidence | IOBv3Evidence[]
+  [x: string]: any
+}
+
+/**
+ * OBv3 Achievement
+ * https://www.imsglobal.org/spec/ob/v3p0/#achievement
+ */
+export interface IAchievement extends ILinkedDataObject {
+  id: string
+
+  type: ILdType
+
+  name: string
+
+  description: string
+
+  criteria: ICriteria
+
+  alignment?: IAlignment[]
+
+  achievementType?: string
+
+  creator?: IProfile | string
+
+  creditsAvailable?: number
+
+  endorsement?: IEndorsementCredential[]
+
+  endorsementJwt?: string[]
+
+  fieldOfStudy?: string
+
+  humanCode?: string
+
+  image?: IImage
+
+  inLanguage?: string
+
+  otherIdentifier?: IIdentifierEntry[]
+
+  related?: IRelated[]
+
+  resultDescription?: IResultDescription[]
+
+  specialization?: string
+
+  tag?: string[]
+
+  version?: string
+
+  [x: string]: any
+}
+
+/** Evidence supporting the achievement */
+export interface IOBv3Evidence extends ILinkedDataObject {
+  id?: string
+  type: ILdType
+  name?: string
+  description?: string
+  url?: string
+  [x: string]: any
+}
+
+/** Criteria for the achievement */
+export interface ICriteria {
+  id?: string
+  narrative?: string
+  [x: string]: any
+}
+
+/** Alignment between achievement and framework */
+export interface IAlignment {
+  type: ILdType
+  targetName: string
+  targetUrl: string
+  targetCode?: string
+  targetDescription?: string
+  targetFramework?: string
+  targetType?: string
+  [x: string]: any
+}
+
+/** Simple image metadata */
+export interface IImage {
+  id: string
+  type: 'Image'
+  caption?: string
+}
+
+/** Profile (issuer/creator) */
+export interface IProfile {
+  id: string
+  type: ILdType
+  name?: string
+  url?: string
+  description?: string
+  [x: string]: any
+}
+
+/** EndorsementCredential */
+export interface IEndorsementCredential extends IVerifiableCredential {
+  type: ILdType
+  name?: string
+  description?: string
+  credentialSubject: IEndorsementSubject
+}
+
+/** EndorsementSubject */
+export interface IEndorsementSubject {
+  id: string
+  type: ILdType
+  endorsementComment?: string
+  [x: string]: any
+}
+
+/** Identifier entry */
+export interface IIdentifierEntry {
+  type: 'IdentifierEntry'
+  identifier: string
+  identifierType: string
+}
+
+/** Related achievement */
+export interface IRelated {
+  id: string
+  type: ILdType
+  inLanguage?: string
+  version?: string
+}
+
+/** ResultDescription */
+export interface IResultDescription {
+  id: string
+  type: ILdType
+  name: string
+  resultType: string
+  alignment?: IAlignment[]
+  allowedValue?: string[]
+  requiredLevel?: string
+  requiredValue?: string
+  rubricCriterionLevel?: IRubricCriterionLevel[]
+  valueMax?: string
+  valueMin?: string
+}
+
+/** RubricCriterionLevel */
+export interface IRubricCriterionLevel {
+  id: string
+  type: ILdType
+  name: string
+  description?: string
+  level?: string
+  points?: string
+  alignment?: IAlignment[]
+}
diff --git a/src/index.ts b/src/index.ts
index 566cde8..e0d77f6 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -5,3 +5,4 @@ export * from './LD.js'
 export * from './DID.js'
 export * from './KeyPair.js'
 export * from './VCDM.js'
+export * from './OBv3.js'