@sphereon/ssi-types 0.8.0 → 0.8.1-next.12

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./object"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}

package/dist/utils/object.d.ts

@@ -0,0 +1,7 @@
+export declare class ObjectUtils {
+    static asArray(value: unknown): any[];
+    static isObject(value: unknown): boolean;
+    static isUrlAbsolute(url: string): void;
+    static isString(value: unknown): boolean;
+}
+//# sourceMappingURL=object.d.ts.map

package/dist/utils/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAW;WACR,OAAO,CAAC,KAAK,EAAE,OAAO;WAItB,QAAQ,CAAC,KAAK,EAAE,OAAO;WAIvB,aAAa,CAAC,GAAG,EAAE,MAAM;WAMzB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;CAGhD"}

package/dist/utils/object.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectUtils = void 0;
+class ObjectUtils {
+    static asArray(value) {
+        return Array.isArray(value) ? value : [value];
+    }
+    static isObject(value) {
+        return Object.prototype.toString.call(value) === '[object Object]';
+    }
+    static isUrlAbsolute(url) {
+        // regex to check for absolute IRI (starting scheme and ':') or blank node IRI
+        const isAbsoluteRegex = /^([A-Za-z][A-Za-z0-9+-.]*|_):[^\s]*$/;
+        ObjectUtils.isString(url) && isAbsoluteRegex.test(url);
+    }
+    static isString(value) {
+        return typeof value === 'string' || Object.prototype.toString.call(value) === '[object String]';
+    }
+}
+exports.ObjectUtils = ObjectUtils;
+//# sourceMappingURL=object.js.map

package/dist/utils/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":";;;AAAA,MAAa,WAAW;IACf,MAAM,CAAC,OAAO,CAAC,KAAc;QAClC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAc;QACnC,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAA;IACpE,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,GAAW;QACrC,8EAA8E;QAC9E,MAAM,eAAe,GAAG,sCAAsC,CAAA;QAC9D,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACxD,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAc;QACnC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAA;IACjG,CAAC;CACF;AAlBD,kCAkBC"}

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@sphereon/ssi-types",
   "description": "SSI Common Types",
-  "version": "0.8.0",
+  "version": "0.8.1-next.12+84fb570",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc --build"
   },
+  "dependencies": {
+    "jwt-decode": "^3.1.2"
+  },
   "devDependencies": {
+    "@types/jest": "^27.0.2",
+    "jest": "^27.3.1",
+    "prettier": "^2.4.1",
+    "ts-jest": "^27.0.7",
     "typescript": "4.6.4"
   },
   "files": [
@@ -23,6 +30,12 @@
   "repository": "git@github.com:Sphereon-OpenSource/ssi-sdk.git",
   "author": "Sphereon <dev@sphereon.com>",
   "license": "Apache-2.0",
-  "keywords": [],
-  "gitHead": "1032feb5588568edfbca0110f3ff9e6c38894135"
+  "keywords": [
+    "SSI",
+    "Common Credential Types",
+    "Credential Mapping",
+    "Verifiable Credentials",
+    "DIDs"
+  ],
+  "gitHead": "84fb570f29ecd7a4fbd6477fd22284f47e814ab8"
 }

package/src/index.ts

@@ -1 +1,3 @@
 export * from './types'
+export * from './utils'
+export * from './mapper'

package/src/mapper/credential-mapper.ts

@@ -0,0 +1,245 @@
+import {
+  ClaimFormat,
+  ICredential,
+  IPresentation,
+  IVerifiableCredential,
+  IVerifiablePresentation,
+  JwtDecodedVerifiableCredential,
+  JwtDecodedVerifiablePresentation,
+  OriginalType,
+  OriginalVerifiableCredential,
+  OriginalVerifiablePresentation,
+  WrappedVerifiableCredential,
+  WrappedVerifiablePresentation,
+} from '../types'
+import jwt_decode from 'jwt-decode'
+import { ObjectUtils } from '../utils'
+
+export class CredentialMapper {
+  static decodeVerifiablePresentation(presentation: OriginalVerifiablePresentation): JwtDecodedVerifiablePresentation | IVerifiablePresentation {
+    if (CredentialMapper.isJwtEncoded(presentation)) {
+      return jwt_decode(presentation as string) as JwtDecodedVerifiablePresentation
+    } else if (CredentialMapper.isJwtDecodedPresentation(presentation)) {
+      return presentation as JwtDecodedVerifiablePresentation
+    } else if (CredentialMapper.isJsonLdString(presentation)) {
+      return JSON.parse(presentation as string) as IVerifiablePresentation
+    } else {
+      return presentation as IVerifiablePresentation
+    }
+  }
+
+  static decodeVerifiableCredential(credential: OriginalVerifiableCredential): JwtDecodedVerifiableCredential | IVerifiableCredential {
+    if (CredentialMapper.isJwtEncoded(credential)) {
+      return jwt_decode(credential as string) as JwtDecodedVerifiableCredential
+    } else if (CredentialMapper.isJwtDecodedCredential(credential)) {
+      return credential as JwtDecodedVerifiableCredential
+    } else if (CredentialMapper.isJsonLdString(credential)) {
+      return JSON.parse(credential as string) as IVerifiableCredential
+    } else {
+      return credential as IVerifiableCredential
+    }
+  }
+
+  static toWrappedVerifiablePresentation(presentation: OriginalVerifiablePresentation): WrappedVerifiablePresentation {
+    const original = presentation
+    const isJwtEncoded: boolean = CredentialMapper.isJwtEncoded(original)
+    const isJwtDecoded: boolean = CredentialMapper.isJwtDecodedPresentation(original)
+
+    const type = isJwtEncoded ? OriginalType.JWT_ENCODED : isJwtDecoded ? OriginalType.JWT_DECODED : OriginalType.JSONLD
+    const format: ClaimFormat = isJwtDecoded || isJwtEncoded ? 'jwt_vp' : 'ldp_vp'
+    const decoded = CredentialMapper.decodeVerifiablePresentation(original)
+    const vp: IPresentation =
+      isJwtEncoded || isJwtDecoded
+        ? CredentialMapper.jwtDecodedPresentationToUniformPresentation(decoded as JwtDecodedVerifiablePresentation, false)
+        : (decoded as IPresentation)
+    const vcs: WrappedVerifiableCredential[] = CredentialMapper.toWrappedVerifiableCredentials(vp.verifiableCredential)
+
+    // todo: We probably want to add proofs as well
+    return {
+      type,
+      format,
+      original,
+      decoded,
+      presentation: {
+        ...vp,
+        verifiableCredential: vcs, // We overwrite the credentials with wrapped versions, making it an InternalVerifiablePresentation. Note: we keep the singular key name of the vc data model
+      },
+      vcs,
+    }
+  }
+
+  static toWrappedVerifiableCredentials(verifiableCredentials: OriginalVerifiableCredential[]): WrappedVerifiableCredential[] {
+    return verifiableCredentials.map(CredentialMapper.toWrappedVerifiableCredential)
+  }
+
+  static toWrappedVerifiableCredential(verifiableCredential: OriginalVerifiableCredential): WrappedVerifiableCredential {
+    const original = verifiableCredential
+
+    const decoded = CredentialMapper.decodeVerifiableCredential(verifiableCredential)
+
+    const isJwtEncoded = CredentialMapper.isJwtEncoded(original)
+    const isJwtDecoded = CredentialMapper.isJwtDecodedCredential(original)
+    const type = isJwtEncoded ? OriginalType.JWT_ENCODED : isJwtDecoded ? OriginalType.JWT_DECODED : OriginalType.JSONLD
+
+    const credential =
+      isJwtDecoded || isJwtDecoded
+        ? CredentialMapper.jwtDecodedCredentialToUniformCredential(decoded as JwtDecodedVerifiableCredential)
+        : (decoded as ICredential)
+    const format = isJwtDecoded || isJwtDecoded ? 'jwt_vc' : 'ldp_vc'
+    //todo: We probably want to add proofs as well
+    return {
+      original,
+      decoded,
+      format,
+      type,
+      credential,
+    }
+  }
+
+  public static isJwtEncoded(original: OriginalVerifiableCredential | OriginalVerifiablePresentation) {
+    return ObjectUtils.isString(original) && (original as string).startsWith('ey')
+  }
+
+  private static isJsonLdString(original: OriginalVerifiableCredential | OriginalVerifiablePresentation) {
+    return ObjectUtils.isString(original) && (original as string).includes('@context')
+  }
+
+  public static isJwtDecodedCredential(original: OriginalVerifiableCredential): boolean {
+    return (<JwtDecodedVerifiableCredential>original)['vc'] !== undefined && (<JwtDecodedVerifiableCredential>original)['iss'] !== undefined
+  }
+
+  public static isJwtDecodedPresentation(original: OriginalVerifiablePresentation): boolean {
+    return (<JwtDecodedVerifiablePresentation>original)['vp'] !== undefined && (<JwtDecodedVerifiablePresentation>original)['iss'] !== undefined
+  }
+
+  static jwtEncodedPresentationToUniformPresentation(jwt: string, makeCredentialsUniform: boolean = true): IPresentation {
+    return CredentialMapper.jwtDecodedPresentationToUniformPresentation(jwt_decode(jwt), makeCredentialsUniform)
+  }
+
+  static jwtDecodedPresentationToUniformPresentation(
+    decoded: JwtDecodedVerifiablePresentation,
+    makeCredentialsUniform: boolean = true
+  ): IPresentation {
+    const presentation: IPresentation = {
+      ...(decoded.vp as IPresentation),
+    }
+    if (makeCredentialsUniform) {
+      presentation.verifiableCredential = decoded.vp.verifiableCredential.map(CredentialMapper.toUniformCredential) as IVerifiableCredential[] // We cast it because we IPresentation needs a VC. The internal Credential doesn't have the required Proof anymore (that is intended)
+    }
+    // Since this is a presentation, we delete any proof just to be sure (should not occur on JWT, but better safe than sorry)
+    delete presentation.proof
+
+    if (decoded.iss) {
+      const holder = presentation.holder
+      if (holder) {
+        if (holder !== decoded.iss) {
+          throw new Error(`Inconsistent holders between JWT claim (${decoded.iss}) and VC value (${holder})`)
+        }
+      }
+      presentation.holder = decoded.iss
+    }
+    if (decoded.jti) {
+      const id = presentation.id
+      if (id && id !== decoded.jti) {
+        throw new Error(`Inconsistent VP ids between JWT claim (${decoded.jti}) and VP value (${id})`)
+      }
+      presentation.id = decoded.jti
+    }
+    return presentation
+  }
+
+  static toUniformCredential(verifiableCredential: OriginalVerifiableCredential): ICredential {
+    const original = verifiableCredential
+    const decoded = CredentialMapper.decodeVerifiableCredential(verifiableCredential)
+
+    const isJwtEncoded: boolean = CredentialMapper.isJwtEncoded(original)
+    const isJwtDecoded: boolean = CredentialMapper.isJwtDecodedCredential(original)
+
+    if (isJwtDecoded || isJwtEncoded) {
+      return CredentialMapper.jwtDecodedCredentialToUniformCredential(decoded as JwtDecodedVerifiableCredential)
+    } else {
+      return decoded as ICredential
+    }
+  }
+
+  static toUniformPresentation(presentation: OriginalVerifiablePresentation): IPresentation {
+    const original = presentation
+    const decoded = CredentialMapper.decodeVerifiablePresentation(original)
+    const isJwtEncoded: boolean = CredentialMapper.isJwtEncoded(original)
+    const isJwtDecoded: boolean = CredentialMapper.isJwtDecodedPresentation(original)
+    const uniformPresentation =
+      isJwtEncoded || isJwtDecoded
+        ? CredentialMapper.jwtDecodedPresentationToUniformPresentation(decoded as JwtDecodedVerifiablePresentation, false)
+        : (decoded as IPresentation)
+    uniformPresentation.verifiableCredential = uniformPresentation.verifiableCredential?.map(
+      CredentialMapper.toUniformCredential
+    ) as IVerifiableCredential[] // We cast it because we IPresentation needs a VC. The internal Credential doesn't have the required Proof anymore (that is intended)
+    return uniformPresentation
+  }
+
+  static jwtEncodedCredentialToUniformCredential(jwt: string): ICredential {
+    return CredentialMapper.jwtDecodedCredentialToUniformCredential(jwt_decode(jwt))
+  }
+
+  static jwtDecodedCredentialToUniformCredential(decoded: JwtDecodedVerifiableCredential): ICredential {
+    const credential: ICredential = {
+      ...(decoded.vc as ICredential),
+    }
+    // Since this is a credential, we delete any proof just to be sure (should not occur on JWT, but better safe than sorry)
+    delete credential.proof
+
+    if (decoded.exp) {
+      const expDate = credential.credentialSubject?.expirationDate
+      const jwtExp = parseInt(decoded.exp.toString())
+      // fix seconds to millisecs for the date
+      const expDateAsStr = jwtExp < 9999999999 ? new Date(jwtExp * 1000).toISOString().replace(/\.000Z/, 'Z') : new Date(jwtExp).toISOString()
+      if (expDate && expDate !== expDateAsStr) {
+        throw new Error(`Inconsistent expiration dates between JWT claim (${expDateAsStr}) and VC value (${expDate})`)
+      }
+      credential.credentialSubject.expirationDate = expDateAsStr
+    }
+
+    if (decoded.nbf) {
+      const issuanceDate = credential.issuanceDate
+      const jwtNbf = parseInt(decoded.nbf.toString())
+      // fix seconds to millisecs for the date
+      const nbfDateAsStr = jwtNbf < 9999999999 ? new Date(jwtNbf * 1000).toISOString().replace(/\.000Z/, 'Z') : new Date(jwtNbf).toISOString()
+      if (issuanceDate && issuanceDate !== nbfDateAsStr) {
+        throw new Error(`Inconsistent issuance dates between JWT claim (${nbfDateAsStr}) and VC value (${issuanceDate})`)
+      }
+      credential.issuanceDate = nbfDateAsStr
+    }
+
+    if (decoded.iss) {
+      const issuer = credential.issuer
+      if (issuer) {
+        if (typeof issuer === 'string') {
+          if (issuer !== decoded.iss) {
+            throw new Error(`Inconsistent issuers between JWT claim (${decoded.iss}) and VC value (${issuer})`)
+          }
+        } else {
+          if (issuer.id !== decoded.iss) {
+            throw new Error(`Inconsistent issuers between JWT claim (${decoded.iss}) and VC value (${issuer.id})`)
+          }
+        }
+      }
+      credential.issuer = decoded.iss
+    }
+
+    if (decoded.sub) {
+      const csId = credential.credentialSubject?.id
+      if (csId && csId !== decoded.sub) {
+        throw new Error(`Inconsistent credential subject ids between JWT claim (${decoded.sub}) and VC value (${csId})`)
+      }
+      credential.credentialSubject.id = decoded.sub
+    }
+    if (decoded.jti) {
+      const id = credential.id
+      if (id && id !== decoded.jti) {
+        throw new Error(`Inconsistent credential ids between JWT claim (${decoded.jti}) and VC value (${id})`)
+      }
+      credential.id = decoded.jti
+    }
+    return credential
+  }
+}

package/src/mapper/index.ts

@@ -0,0 +1 @@
+export * from './credential-mapper'

package/src/types/did.ts

@@ -33,3 +33,51 @@ export interface IParsedDID {
     [index: string]: string
   }
 }
+
+export const parseDid = (did: string): IParsedDID => {
+  const parsedDid = parse(did)
+  if (parsedDid === null) {
+    throw new Error('invalid did')
+  }
+
+  return parsedDid
+}
+
+const parse = (didUrl: string): IParsedDID | null => {
+  const PCT_ENCODED = '(?:%[0-9a-fA-F]{2})'
+  const ID_CHAR = `(?:[a-zA-Z0-9._-]|${PCT_ENCODED})`
+  const METHOD = '([a-z0-9]+)'
+  const METHOD_ID = `((?:${ID_CHAR}*:)*(${ID_CHAR}+))`
+  const PARAM_CHAR = '[a-zA-Z0-9_.:%-]'
+  const PARAM = `;${PARAM_CHAR}+=${PARAM_CHAR}*`
+  const PARAMS = `((${PARAM})*)`
+  const PATH = `(/[^#?]*)?`
+  const QUERY = `([?][^#]*)?`
+  const FRAGMENT = `(#.*)?`
+  const DID_MATCHER = new RegExp(`^did:${METHOD}:${METHOD_ID}${PARAMS}${PATH}${QUERY}${FRAGMENT}$`)
+
+  if (didUrl === '' || !didUrl) return null
+  const sections = didUrl.match(DID_MATCHER)
+  if (sections) {
+    const parts: IParsedDID = {
+      did: `did:${sections[1]}:${sections[2]}`,
+      method: sections[1],
+      id: sections[2],
+      didUrl,
+    }
+    if (sections[4]) {
+      const params = sections[4].slice(1).split(';')
+      parts.params = {}
+      for (const p of params) {
+        const kv = p.split('=')
+        parts.params[kv[0]] = kv[1]
+      }
+    }
+    if (sections[6]) parts.path = sections[6]
+    if (sections[7]) parts.query = sections[7].slice(1)
+    if (sections[8]) parts.fragment = sections[8].slice(1)
+    return parts
+  }
+
+  return null
+}

package/src/types/pex.ts

@@ -1,5 +1,5 @@
 /**
- * It express how the inputs presented as proofs to a Verifier.
+ * It expresses how the inputs are presented as proofs to a Verifier.
  */
 export interface PresentationSubmission {
   /**
@@ -16,18 +16,6 @@ export interface PresentationSubmission {
   descriptor_map: Array<Descriptor>
 }
 
-/**
- * Presentation Echange API
- * Presentation Exchange API
- *
- * The version of the OpenAPI document: 1.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
 /**
  * descriptor map laying out the structure of the presentation submission.
  */

package/src/types/vc.ts

@@ -1,6 +1,8 @@
 import { PresentationSubmission } from './pex'
 import { IProofPurpose, IProofType } from './did'
 
+export type AdditionalClaims = Record<string, any>
+
 export interface ICredential {
   // If exp is present, the UNIX timestamp MUST be converted to an [XMLSCHEMA11-2] date-time, and MUST be used to set the value of the expirationDate property of credentialSubject of the new JSON object.
   expirationDate?: string
@@ -9,9 +11,9 @@ export interface ICredential {
   // If nbf is present, the UNIX timestamp MUST be converted to an [XMLSCHEMA11-2] date-time, and MUST be used to set the value of the issuanceDate property of the new JSON object.
   issuanceDate: string
   // If sub is present, the value MUST be used to set the value of the id property of credentialSubject of the new credential JSON object.
-  credentialSubject: ICredentialSubject
+  credentialSubject: ICredentialSubject & AdditionalClaims
   // If jti is present, the value MUST be used to set the value of the id property of the new JSON object.
-  id: string
+  id?: string
   '@context': ICredentialContextType[] | ICredentialContextType
   credentialStatus?: ICredentialStatus
   credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[]
@@ -19,21 +21,18 @@ export interface ICredential {
   name?: string
   type: string[]
 
-  [x: string]: unknown
+  [x: string]: any
 }
 
 export interface ICredentialSubject {
   id?: string
-
-  [x: string]: unknown
 }
 
-export type ICredentialContextType = ICredentialContext | string
+export type ICredentialContextType = (ICredentialContext & AdditionalClaims) | string
 
 export interface ICredentialContext {
   name?: string
   did?: string
-  [x: string]: unknown
 }
 
 export type ICredentialSchemaType = ICredentialSchema | string
@@ -54,8 +53,6 @@ export interface IProof {
   jws?: string // JWS based proof
   nonce?: string // Similar to challenge. A nonce to protect against replay attacks, used in some ZKP proofs
   requiredRevealStatements?: string[] // The parts of the proof that must be revealed in a derived proof
-
-  [x: string]: string | string[] | undefined
 }
 
 export interface ICredentialStatus {
@@ -66,7 +63,7 @@ export interface ICredentialStatus {
 export interface IIssuer {
   id: string
 
-  [x: string]: unknown
+  [x: string]: any
 }
 
 export interface IHasProof {
@@ -76,11 +73,14 @@ export interface IHasProof {
 export type IVerifiableCredential = ICredential & IHasProof
 
 export interface IPresentation {
+  id?: string
   '@context': ICredentialContextType | ICredentialContextType[]
   type: string[]
-  verifiableCredential: IVerifiableCredential[]
+  verifiableCredential: IVerifiableCredential[] // we relax to ICredential for internal decoded stable representations without proofs
   presentation_submission?: PresentationSubmission
   holder?: string
+
+  [x: string]: any
 }
 
 export type IVerifiablePresentation = IPresentation & IHasProof
@@ -89,36 +89,59 @@ export interface WrappedVerifiableCredential {
   /**
    * Original VC that we've received
    */
-  original: string | JwtWrappedVerifiableCredential | IVerifiableCredential
+  original: OriginalVerifiableCredential
   /**
    * In case of JWT credential it will be the decoded version. In other cases it will be the same as original one
    */
-  decoded: JwtWrappedVerifiableCredential | IVerifiableCredential
+  decoded: JwtDecodedVerifiableCredential | IVerifiableCredential
   /**
-   * Type of this credential. Supported types are json-ld and jwt
+   * Type of this credential. Supported types are json-ld and jwt (decoded/encoded)
    */
-  type: VerifiableDataExchangeType
+  type: OriginalType
   /**
-   * created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   * The claim format, typically used during exchange transport protocols
    */
-  internalCredential: ICredential
+  format: ClaimFormat
+  /**
+   * Internal stable representation of a Credential without Proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   */
+  credential: ICredential
 }
 
 export interface WrappedVerifiablePresentation {
-  original: string | JwtWrappedVerifiablePresentation | IVerifiablePresentation
-  decoded: JwtWrappedVerifiablePresentation | IVerifiablePresentation
-  type: VerifiableDataExchangeType
-  internalPresentation: InternalPresentation
+  /**
+   * Original VP that we've received
+   */
+  original: OriginalVerifiablePresentation
+  /**
+   * In case of JWT VP it will be the decoded version. In other cases it will be the same as original one
+   */
+  decoded: JwtDecodedVerifiablePresentation | IVerifiablePresentation
+  /**
+   * Type of this Presentation. Supported types are json-ld and jwt (decoded/encoded)
+   */
+  type: OriginalType
+  /**
+   * The claim format, typically used during exchange transport protocols
+   */
+  format: ClaimFormat
+  /**
+   * Internal stable representation of a Presentation without proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   */
+  presentation: UniformVerifiablePresentation
+  /**
+   * Wrapped Verifiable Credentials belonging to the Presentation
+   */
   vcs: WrappedVerifiableCredential[]
 }
 
-export enum VerifiableDataExchangeType {
-  JSONLD,
-  JWT_ENCODED,
-  JWT_DECODED,
+export enum OriginalType {
+  JSONLD = 'json-ld',
+  JWT_ENCODED = 'jwt-encoded',
+  JWT_DECODED = 'jwt-decoded',
 }
 
-export interface InternalPresentation {
+export interface UniformVerifiablePresentation {
   '@context': ICredentialContextType | ICredentialContextType[]
   type: string[]
   verifiableCredential: WrappedVerifiableCredential[]
@@ -126,20 +149,30 @@ export interface InternalPresentation {
   holder?: string
 }
 
-export interface JwtWrappedVerifiableCredential {
+export interface JwtDecodedVerifiableCredential {
   vc: ICredential
   exp: string
   iss: string
   nbf: string
   sub: string
   jti: string
+
+  [x: string]: any
 }
 
-export interface JwtWrappedVerifiablePresentation {
+export interface JwtDecodedVerifiablePresentation {
   vp: IVerifiablePresentation
   exp: string
   iss: string
   nbf: string
   sub: string
   jti: string
+
+  [x: string]: any
 }
+
+export type ClaimFormat = 'jwt' | 'jwt_vc' | 'jwt_vp' | 'ldp' | 'ldp_vc' | 'ldp_vp' | string
+
+export type OriginalVerifiableCredential = IVerifiableCredential | JwtDecodedVerifiableCredential | string
+export type OriginalVerifiablePresentation = IPresentation | JwtDecodedVerifiablePresentation | string
+export type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './object'

package/src/utils/object.ts

@@ -0,0 +1,19 @@
+export class ObjectUtils {
+  public static asArray(value: unknown) {
+    return Array.isArray(value) ? value : [value]
+  }
+
+  public static isObject(value: unknown) {
+    return Object.prototype.toString.call(value) === '[object Object]'
+  }
+
+  public static isUrlAbsolute(url: string) {
+    // regex to check for absolute IRI (starting scheme and ':') or blank node IRI
+    const isAbsoluteRegex = /^([A-Za-z][A-Za-z0-9+-.]*|_):[^\s]*$/
+    ObjectUtils.isString(url) && isAbsoluteRegex.test(url)
+  }
+
+  public static isString(value: unknown): boolean {
+    return typeof value === 'string' || Object.prototype.toString.call(value) === '[object String]'
+  }
+}