@sphereon/ssi-types 0.8.1-unstable.9 → 0.9.0

package/dist/types/vc.d.ts

@@ -1,29 +1,30 @@
 import { PresentationSubmission } from './pex';
 import { IProofPurpose, IProofType } from './did';
-declare type AdditionalProperties = Record<string, any>;
+export type AdditionalClaims = Record<string, any>;
+export type IIssuerId = string;
 export interface ICredential {
-    expirationDate?: string;
-    issuer: string | IIssuer;
+    '@context': ICredentialContextType | ICredentialContextType[];
+    type: string[];
+    credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[];
+    issuer: IIssuerId | IIssuer;
     issuanceDate: string;
-    credentialSubject: ICredentialSubject & AdditionalProperties;
+    credentialSubject: (ICredentialSubject & AdditionalClaims) | (ICredentialSubject & AdditionalClaims)[];
+    expirationDate?: string;
     id?: string;
-    '@context': ICredentialContextType[] | ICredentialContextType;
     credentialStatus?: ICredentialStatus;
-    credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[];
     description?: string;
     name?: string;
-    type: string[];
     [x: string]: any;
 }
 export interface ICredentialSubject {
     id?: string;
 }
-export declare type ICredentialContextType = (ICredentialContext & AdditionalProperties) | string;
+export type ICredentialContextType = (ICredentialContext & AdditionalClaims) | string;
 export interface ICredentialContext {
     name?: string;
     did?: string;
 }
-export declare type ICredentialSchemaType = ICredentialSchema | string;
+export type ICredentialSchemaType = ICredentialSchema | string;
 export interface ICredentialSchema {
     id: string;
     type?: string;
@@ -37,8 +38,10 @@ export interface IProof {
     domain?: string;
     proofValue?: string;
     jws?: string;
+    jwt?: string;
     nonce?: string;
     requiredRevealStatements?: string[];
+    [x: string]: any;
 }
 export interface ICredentialStatus {
     id: string;
@@ -51,17 +54,33 @@ export interface IIssuer {
 export interface IHasProof {
     proof: IProof | IProof[];
 }
-export declare type IVerifiableCredential = ICredential & IHasProof;
+export type IVerifiableCredential = ICredential & IHasProof;
+/**
+ * Represents a Json Web Token in compact form.
+ */
+export type CompactJWT = string;
+/**
+ * Represents a signed Verifiable Credential (includes proof), in either JSON or compact JWT format.
+ * See {@link https://www.w3.org/TR/vc-data-model/#credentials | VC data model}
+ * See {@link https://www.w3.org/TR/vc-data-model/#proof-formats | proof formats}
+ */
+export type W3CVerifiableCredential = IVerifiableCredential | CompactJWT;
 export interface IPresentation {
     id?: string;
     '@context': ICredentialContextType | ICredentialContextType[];
-    type: string[];
-    verifiableCredential: IVerifiableCredential[];
+    type?: string | string[];
+    verifiableCredential?: W3CVerifiableCredential[];
     presentation_submission?: PresentationSubmission;
     holder?: string;
     [x: string]: any;
 }
-export declare type IVerifiablePresentation = IPresentation & IHasProof;
+export type IVerifiablePresentation = IPresentation & IHasProof;
+/**
+ * Represents a signed Verifiable Presentation (includes proof), in either JSON or compact JWT format.
+ * See {@link https://www.w3.org/TR/vc-data-model/#presentations | VC data model}
+ * See {@link https://www.w3.org/TR/vc-data-model/#proof-formats | proof formats}
+ */
+export type W3CVerifiablePresentation = IVerifiablePresentation | CompactJWT;
 export interface WrappedVerifiableCredential {
     /**
      * Original VC that we've received
@@ -78,11 +97,11 @@ export interface WrappedVerifiableCredential {
     /**
      * The claim format, typically used during exchange transport protocols
      */
-    format: ClaimFormat;
+    format: CredentialFormat;
     /**
-     * Internal stable representation of a Credential without Proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+     * Internal stable representation of a Credential
      */
-    credential: ICredential;
+    credential: IVerifiableCredential;
 }
 export interface WrappedVerifiablePresentation {
     /**
@@ -100,7 +119,7 @@ export interface WrappedVerifiablePresentation {
     /**
      * The claim format, typically used during exchange transport protocols
      */
-    format: ClaimFormat;
+    format: PresentationFormat;
     /**
      * Internal stable representation of a Presentation without proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
      */
@@ -117,13 +136,13 @@ export declare enum OriginalType {
 }
 export interface UniformVerifiablePresentation {
     '@context': ICredentialContextType | ICredentialContextType[];
-    type: string[];
+    type: string | string[];
     verifiableCredential: WrappedVerifiableCredential[];
     presentation_submission?: PresentationSubmission;
     holder?: string;
 }
 export interface JwtDecodedVerifiableCredential {
-    vc: ICredential;
+    vc: IVerifiableCredential;
     exp: string;
     iss: string;
     nbf: string;
@@ -140,9 +159,15 @@ export interface JwtDecodedVerifiablePresentation {
     jti: string;
     [x: string]: any;
 }
-export declare type ClaimFormat = 'jwt' | 'jwt_vc' | 'jwt_vp' | 'ldp' | 'ldp_vc' | 'ldp_vp' | string;
-export declare type OriginalVerifiableCredential = IVerifiableCredential | JwtDecodedVerifiableCredential | string;
-export declare type OriginalVerifiablePresentation = IPresentation | JwtDecodedVerifiablePresentation | string;
-export declare type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential;
-export {};
+export type CredentialFormat = 'jwt' | 'ldp' | 'jwt_vc' | 'ldp_vc' | string;
+export type PresentationFormat = 'jwt' | 'ldp' | 'jwt_vp' | 'ldp_vp' | string;
+export type ClaimFormat = CredentialFormat | PresentationFormat;
+export type OriginalVerifiableCredential = W3CVerifiableCredential | JwtDecodedVerifiableCredential;
+export type OriginalVerifiablePresentation = W3CVerifiablePresentation | JwtDecodedVerifiablePresentation;
+export type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential;
+export declare const enum DocumentFormat {
+    JWT = 0,
+    JSONLD = 1,
+    EIP712 = 2
+}
 //# sourceMappingURL=vc.d.ts.map

package/dist/types/vc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vc.d.ts","sourceRoot":"","sources":["../../src/types/vc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAEjD,aAAK,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE/C,MAAM,WAAW,WAAW;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;IAExB,YAAY,EAAE,MAAM,CAAA;IAEpB,iBAAiB,EAAE,kBAAkB,GAAG,oBAAoB,CAAA;IAE5D,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,sBAAsB,EAAE,GAAG,sBAAsB,CAAA;IAC7D,gBAAgB,CAAC,EAAE,iBAAiB,CAAA;IACpC,gBAAgB,CAAC,EAAE,SAAS,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAA;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAA;CAGZ;AAED,oBAAY,sBAAsB,GAAG,CAAC,kBAAkB,GAAG,oBAAoB,CAAC,GAAG,MAAM,CAAA;AAEzF,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CAGb;AAED,oBAAY,qBAAqB,GAAG,iBAAiB,GAAG,MAAM,CAAA;AAE9D,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,aAAa,GAAG,MAAM,CAAA;IACpC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;CAGpC;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IAEV,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,oBAAY,qBAAqB,GAAG,WAAW,GAAG,SAAS,CAAA;AAE3D,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAA;IAC7D,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,oBAAoB,EAAE,qBAAqB,EAAE,CAAA;IAC7C,uBAAuB,CAAC,EAAE,sBAAsB,CAAA;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,oBAAY,uBAAuB,GAAG,aAAa,GAAG,SAAS,CAAA;AAE/D,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,4BAA4B,CAAA;IACtC;;OAEG;IACH,OAAO,EAAE,8BAA8B,GAAG,qBAAqB,CAAA;IAC/D;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,WAAW,CAAA;CACxB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,8BAA8B,CAAA;IACxC;;OAEG;IACH,OAAO,EAAE,gCAAgC,GAAG,uBAAuB,CAAA;IACnE;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IACnB;;OAEG;IACH,YAAY,EAAE,6BAA6B,CAAA;IAC3C;;OAEG;IACH,GAAG,EAAE,2BAA2B,EAAE,CAAA;CACnC;AAED,oBAAY,YAAY;IACtB,MAAM,YAAY;IAClB,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;CAC5B;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAA;IAC7D,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,oBAAoB,EAAE,2BAA2B,EAAE,CAAA;IACnD,uBAAuB,CAAC,EAAE,sBAAsB,CAAA;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,WAAW,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IAEX,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,uBAAuB,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IAEX,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,oBAAY,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE5F,oBAAY,4BAA4B,GAAG,qBAAqB,GAAG,8BAA8B,GAAG,MAAM,CAAA;AAC1G,oBAAY,8BAA8B,GAAG,aAAa,GAAG,gCAAgC,GAAG,MAAM,CAAA;AACtG,oBAAY,QAAQ,GAAG,8BAA8B,GAAG,4BAA4B,CAAA"}
+{"version":3,"file":"vc.d.ts","sourceRoot":"","sources":["../../src/types/vc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAEjD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAElD,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAA;IAC7D,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,gBAAgB,CAAC,EAAE,SAAS,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAA;IAE9E,MAAM,EAAE,SAAS,GAAG,OAAO,CAAA;IAE3B,YAAY,EAAE,MAAM,CAAA;IAEpB,iBAAiB,EAAE,CAAC,kBAAkB,GAAG,gBAAgB,CAAC,GAAG,CAAC,kBAAkB,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAEtG,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,gBAAgB,CAAC,EAAE,iBAAiB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,kBAAkB,GAAG,gBAAgB,CAAC,GAAG,MAAM,CAAA;AAErF,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG,MAAM,CAAA;AAE9D,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,aAAa,GAAG,MAAM,CAAA;IACpC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;IAEnC,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IAEV,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG,SAAS,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,qBAAqB,GAAG,UAAU,CAAA;AAExE,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAA;IAC7D,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,oBAAoB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAChD,uBAAuB,CAAC,EAAE,sBAAsB,CAAA;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,MAAM,uBAAuB,GAAG,aAAa,GAAG,SAAS,CAAA;AAE/D;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,UAAU,CAAA;AAE5E,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,4BAA4B,CAAA;IACtC;;OAEG;IACH,OAAO,EAAE,8BAA8B,GAAG,qBAAqB,CAAA;IAC/D;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAA;IACxB;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAA;CAClC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,8BAA8B,CAAA;IACxC;;OAEG;IACH,OAAO,EAAE,gCAAgC,GAAG,uBAAuB,CAAA;IACnE;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAA;IAC1B;;OAEG;IACH,YAAY,EAAE,6BAA6B,CAAA;IAC3C;;OAEG;IACH,GAAG,EAAE,2BAA2B,EAAE,CAAA;CACnC;AAED,oBAAY,YAAY;IACtB,MAAM,YAAY;IAClB,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;CAC5B;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAA;IAC7D,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,oBAAoB,EAAE,2BAA2B,EAAE,CAAA;IACnD,uBAAuB,CAAC,EAAE,sBAAsB,CAAA;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,qBAAqB,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IAEX,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,uBAAuB,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IAEX,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAC3E,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAC7E,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,kBAAkB,CAAA;AAE/D,MAAM,MAAM,4BAA4B,GAAG,uBAAuB,GAAG,8BAA8B,CAAA;AACnG,MAAM,MAAM,8BAA8B,GAAG,yBAAyB,GAAG,gCAAgC,CAAA;AACzG,MAAM,MAAM,QAAQ,GAAG,8BAA8B,GAAG,4BAA4B,CAAA;AAEpF,0BAAkB,cAAc;IAC9B,GAAG,IAAA;IACH,MAAM,IAAA;IACN,MAAM,IAAA;CACP"}

package/dist/types/vc.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OriginalType = void 0;
+exports.DocumentFormat = exports.OriginalType = void 0;
 var OriginalType;
 (function (OriginalType) {
     OriginalType["JSONLD"] = "json-ld";
     OriginalType["JWT_ENCODED"] = "jwt-encoded";
     OriginalType["JWT_DECODED"] = "jwt-decoded";
 })(OriginalType = exports.OriginalType || (exports.OriginalType = {}));
+var DocumentFormat;
+(function (DocumentFormat) {
+    DocumentFormat[DocumentFormat["JWT"] = 0] = "JWT";
+    DocumentFormat[DocumentFormat["JSONLD"] = 1] = "JSONLD";
+    DocumentFormat[DocumentFormat["EIP712"] = 2] = "EIP712";
+})(DocumentFormat = exports.DocumentFormat || (exports.DocumentFormat = {}));
 //# sourceMappingURL=vc.js.map

package/dist/types/vc.js.map

@@ -1 +1 @@
-{"version":3,"file":"vc.js","sourceRoot":"","sources":["../../src/types/vc.ts"],"names":[],"mappings":";;;AA+IA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,kCAAkB,CAAA;IAClB,2CAA2B,CAAA;IAC3B,2CAA2B,CAAA;AAC7B,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
+{"version":3,"file":"vc.js","sourceRoot":"","sources":["../../src/types/vc.ts"],"names":[],"mappings":";;;AAiKA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,kCAAkB,CAAA;IAClB,2CAA2B,CAAA;IAC3B,2CAA2B,CAAA;AAC7B,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAwCD,IAAkB,cAIjB;AAJD,WAAkB,cAAc;IAC9B,iDAAG,CAAA;IACH,uDAAM,CAAA;IACN,uDAAM,CAAA;AACR,CAAC,EAJiB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAI/B"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sphereon/ssi-types",
   "description": "SSI Common Types",
-  "version": "0.8.1-unstable.9+af7f532",
+  "version": "0.9.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -12,6 +12,7 @@
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
+    "@veramo/core": "4.2.0",
     "jest": "^27.3.1",
     "prettier": "^2.4.1",
     "ts-jest": "^27.0.7",
@@ -37,5 +38,5 @@
     "Verifiable Credentials",
     "DIDs"
   ],
-  "gitHead": "af7f5324bc1718f724e3258c3f218eb85e4199cd"
+  "gitHead": "9119280fec93d685824f0baa454163d703431025"
 }

package/src/mapper/credential-mapper.ts

@@ -1,7 +1,9 @@
 import {
-  ClaimFormat,
-  ICredential,
+  DocumentFormat,
   IPresentation,
+  IProof,
+  IProofPurpose,
+  IProofType,
   IVerifiableCredential,
   IVerifiablePresentation,
   JwtDecodedVerifiableCredential,
@@ -9,6 +11,10 @@ import {
   OriginalType,
   OriginalVerifiableCredential,
   OriginalVerifiablePresentation,
+  PresentationFormat,
+  UniformVerifiablePresentation,
+  W3CVerifiableCredential,
+  W3CVerifiablePresentation,
   WrappedVerifiableCredential,
   WrappedVerifiablePresentation,
 } from '../types'
@@ -18,10 +24,20 @@ 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
+      const payload = jwt_decode(presentation as string) as JwtDecodedVerifiablePresentation
+      const header = jwt_decode(presentation as string, { header: true }) as Record<string, any>
+
+      payload.vp.proof = {
+        type: IProofType.JwtProof2020,
+        created: payload.nbf,
+        proofPurpose: IProofPurpose.authentication,
+        verificationMethod: header['kid'] ?? payload.iss,
+        jwt: presentation as string,
+      }
+      return payload
     } else if (CredentialMapper.isJwtDecodedPresentation(presentation)) {
       return presentation as JwtDecodedVerifiablePresentation
-    } else if (CredentialMapper.isJsonLdString(presentation)) {
+    } else if (CredentialMapper.isJsonLdAsString(presentation)) {
       return JSON.parse(presentation as string) as IVerifiablePresentation
     } else {
       return presentation as IVerifiablePresentation
@@ -30,51 +46,73 @@ export class CredentialMapper {
 
   static decodeVerifiableCredential(credential: OriginalVerifiableCredential): JwtDecodedVerifiableCredential | IVerifiableCredential {
     if (CredentialMapper.isJwtEncoded(credential)) {
-      return jwt_decode(credential as string) as JwtDecodedVerifiableCredential
+      const payload = jwt_decode(credential as string) as JwtDecodedVerifiableCredential
+      const header = jwt_decode(credential as string, { header: true }) as Record<string, any>
+      payload.vc.proof = {
+        type: IProofType.JwtProof2020,
+        created: payload.nbf,
+        proofPurpose: IProofPurpose.authentication,
+        verificationMethod: header['kid'] ?? payload.iss,
+        jwt: credential as string,
+      }
+      return payload
     } else if (CredentialMapper.isJwtDecodedCredential(credential)) {
       return credential as JwtDecodedVerifiableCredential
-    } else if (CredentialMapper.isJsonLdString(credential)) {
+    } else if (CredentialMapper.isJsonLdAsString(credential)) {
       return JSON.parse(credential as string) as IVerifiableCredential
     } else {
       return credential as IVerifiableCredential
     }
   }
 
-  static toWrappedVerifiablePresentation(presentation: OriginalVerifiablePresentation): WrappedVerifiablePresentation {
-    const original = presentation
+  static toWrappedVerifiablePresentation(
+    originalPresentation: OriginalVerifiablePresentation,
+    opts?: { maxTimeSkewInMS?: number },
+  ): WrappedVerifiablePresentation {
+    const original = originalPresentation
     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 format: PresentationFormat = 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)
+    let vp: OriginalVerifiablePresentation
+    if (isJwtEncoded || isJwtDecoded) {
+      vp = CredentialMapper.jwtDecodedPresentationToUniformPresentation(decoded as JwtDecodedVerifiablePresentation, false, opts)
+    } else {
+      vp = decoded as IVerifiablePresentation
+    }
+    if (!vp || !('verifiableCredential' in vp) || !vp.verifiableCredential || vp.verifiableCredential.length === 0) {
+      throw Error(`VP needs to have at least one verifiable credential at this point`)
+    }
+    const vcs: WrappedVerifiableCredential[] = CredentialMapper.toWrappedVerifiableCredentials(vp.verifiableCredential/*.map(value => value.original)*/, opts)
 
-    // todo: We probably want to add proofs as well
+    const 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
+    } as UniformVerifiablePresentation
     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
-      },
+      presentation,
       vcs,
     }
   }
 
-  static toWrappedVerifiableCredentials(verifiableCredentials: OriginalVerifiableCredential[]): WrappedVerifiableCredential[] {
-    return verifiableCredentials.map(CredentialMapper.toWrappedVerifiableCredential)
+  static toWrappedVerifiableCredentials(
+    verifiableCredentials: OriginalVerifiableCredential[],
+    opts?: { maxTimeSkewInMS?: number },
+  ): WrappedVerifiableCredential[] {
+    return verifiableCredentials.map((vc) => CredentialMapper.toWrappedVerifiableCredential(vc, opts))
   }
 
-  static toWrappedVerifiableCredential(verifiableCredential: OriginalVerifiableCredential): WrappedVerifiableCredential {
+  static toWrappedVerifiableCredential(
+    verifiableCredential: OriginalVerifiableCredential,
+    opts?: { maxTimeSkewInMS?: number },
+  ): WrappedVerifiableCredential {
     const original = verifiableCredential
-
     const decoded = CredentialMapper.decodeVerifiableCredential(verifiableCredential)
 
     const isJwtEncoded = CredentialMapper.isJwtEncoded(original)
@@ -82,11 +120,11 @@ export class CredentialMapper {
     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
+      isJwtEncoded || isJwtDecoded
+        ? CredentialMapper.jwtDecodedCredentialToUniformCredential(decoded as JwtDecodedVerifiableCredential, opts)
+        : (decoded as IVerifiableCredential)
+
+    const format = isJwtEncoded || isJwtDecoded ? 'jwt_vc' : 'ldp_vc'
     return {
       original,
       decoded,
@@ -100,7 +138,7 @@ export class CredentialMapper {
     return ObjectUtils.isString(original) && (original as string).startsWith('ey')
   }
 
-  private static isJsonLdString(original: OriginalVerifiableCredential | OriginalVerifiablePresentation) {
+  private static isJsonLdAsString(original: OriginalVerifiableCredential | OriginalVerifiablePresentation) {
     return ObjectUtils.isString(original) && (original as string).includes('@context')
   }
 
@@ -112,23 +150,30 @@ export class CredentialMapper {
     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 jwtEncodedPresentationToUniformPresentation(
+    jwt: string,
+    makeCredentialsUniform: boolean = true,
+    opts?: { maxTimeSkewInMS?: number },
+  ): IPresentation {
+    return CredentialMapper.jwtDecodedPresentationToUniformPresentation(jwt_decode(jwt), makeCredentialsUniform, opts)
   }
 
   static jwtDecodedPresentationToUniformPresentation(
     decoded: JwtDecodedVerifiablePresentation,
-    makeCredentialsUniform: boolean = true
-  ): IPresentation {
-    const presentation: IPresentation = {
-      ...(decoded.vp as IPresentation),
+    makeCredentialsUniform: boolean = true,
+    opts?: { maxTimeSkewInMS?: number },
+  ): IVerifiablePresentation {
+    const presentation: IVerifiablePresentation = {
+      ...(decoded.vp),
     }
     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)
+      if (!decoded.vp.verifiableCredential) {
+        throw Error('Verifiable Presentation should have a verifiable credential at this point')
+      }
+      presentation.verifiableCredential = decoded.vp.verifiableCredential.map((vc) =>
+        CredentialMapper.toUniformCredential(vc, opts),
+      )
     }
-    // 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) {
@@ -148,7 +193,7 @@ export class CredentialMapper {
     return presentation
   }
 
-  static toUniformCredential(verifiableCredential: OriginalVerifiableCredential): ICredential {
+  static toUniformCredential(verifiableCredential: OriginalVerifiableCredential, opts?: { maxTimeSkewInMS?: number }): IVerifiableCredential {
     const original = verifiableCredential
     const decoded = CredentialMapper.decodeVerifiableCredential(verifiableCredential)
 
@@ -156,13 +201,13 @@ export class CredentialMapper {
     const isJwtDecoded: boolean = CredentialMapper.isJwtDecodedCredential(original)
 
     if (isJwtDecoded || isJwtEncoded) {
-      return CredentialMapper.jwtDecodedCredentialToUniformCredential(decoded as JwtDecodedVerifiableCredential)
+      return CredentialMapper.jwtDecodedCredentialToUniformCredential(decoded as JwtDecodedVerifiableCredential, opts)
     } else {
-      return decoded as ICredential
+      return decoded as IVerifiableCredential
     }
   }
 
-  static toUniformPresentation(presentation: OriginalVerifiablePresentation): IPresentation {
+  static toUniformPresentation(presentation: OriginalVerifiablePresentation, opts?: { maxTimeSkewInMS?: number }): IVerifiablePresentation {
     const original = presentation
     const decoded = CredentialMapper.decodeVerifiablePresentation(original)
     const isJwtEncoded: boolean = CredentialMapper.isJwtEncoded(original)
@@ -170,33 +215,36 @@ export class CredentialMapper {
     const uniformPresentation =
       isJwtEncoded || isJwtDecoded
         ? CredentialMapper.jwtDecodedPresentationToUniformPresentation(decoded as JwtDecodedVerifiablePresentation, false)
-        : (decoded as IPresentation)
-    uniformPresentation.verifiableCredential = uniformPresentation.verifiableCredential?.map(
-      CredentialMapper.toUniformCredential
+        : (decoded as IVerifiablePresentation)
+    uniformPresentation.verifiableCredential = uniformPresentation.verifiableCredential?.map((vc) =>
+      CredentialMapper.toUniformCredential(vc, opts),
     ) 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 jwtEncodedCredentialToUniformCredential(jwt: string, opts?: { maxTimeSkewInMS?: number }): IVerifiableCredential {
+    return CredentialMapper.jwtDecodedCredentialToUniformCredential(jwt_decode(jwt), opts)
   }
 
-  static jwtDecodedCredentialToUniformCredential(decoded: JwtDecodedVerifiableCredential): ICredential {
-    const credential: ICredential = {
-      ...(decoded.vc as ICredential),
+  static jwtDecodedCredentialToUniformCredential(decoded: JwtDecodedVerifiableCredential, opts?: { maxTimeSkewInMS?: number }): IVerifiableCredential {
+    const credential: IVerifiableCredential = {
+      ...(decoded.vc),
     }
-    // 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
+
+    const maxSkewInMS = opts?.maxTimeSkewInMS !== undefined ? opts.maxTimeSkewInMS : 999
 
     if (decoded.exp) {
-      const expDate = credential.credentialSubject?.expirationDate
+      const expDate = credential.expirationDate
       const jwtExp = parseInt(decoded.exp.toString())
-      // fix seconds to millisecs for the date
+      // fix seconds to millisecond 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})`)
+        const diff = Math.abs(new Date(expDateAsStr).getTime() - new Date(expDate).getTime())
+        if (!maxSkewInMS || diff > maxSkewInMS) {
+          throw new Error(`Inconsistent expiration dates between JWT claim (${expDateAsStr}) and VC value (${expDate})`)
+        }
       }
-      credential.credentialSubject.expirationDate = expDateAsStr
+      credential.expirationDate = expDateAsStr
     }
 
     if (decoded.nbf) {
@@ -205,7 +253,10 @@ export class CredentialMapper {
       // 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})`)
+        const diff = Math.abs(new Date(nbfDateAsStr).getTime() - new Date(issuanceDate).getTime())
+        if (!maxSkewInMS || diff > maxSkewInMS) {
+          throw new Error(`Inconsistent issuance dates between JWT claim (${nbfDateAsStr}) and VC value (${issuanceDate})`)
+        }
       }
       credential.issuanceDate = nbfDateAsStr
     }
@@ -222,16 +273,22 @@ export class CredentialMapper {
             throw new Error(`Inconsistent issuers between JWT claim (${decoded.iss}) and VC value (${issuer.id})`)
           }
         }
+      } else {
+        credential.issuer = decoded.iss
       }
-      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})`)
+      const subjects = Array.isArray(credential.credentialSubject) ? credential.credentialSubject : [credential.credentialSubject]
+      for (let i = 0; i < subjects.length; i++) {
+        const csId = subjects[i].id
+        if (csId && csId !== decoded.sub) {
+          throw new Error(`Inconsistent credential subject ids between JWT claim (${decoded.sub}) and VC value (${csId})`)
+        }
+        Array.isArray(credential.credentialSubject)
+          ? (credential.credentialSubject[i].id = decoded.sub)
+          : (credential.credentialSubject.id = decoded.sub)
       }
-      credential.credentialSubject.id = decoded.sub
     }
     if (decoded.jti) {
       const id = credential.id
@@ -240,6 +297,105 @@ export class CredentialMapper {
       }
       credential.id = decoded.jti
     }
+
+    return credential
+  }
+
+  static toExternalVerifiableCredential(verifiableCredential: any): IVerifiableCredential {
+    let proof
+    if (verifiableCredential.proof) {
+      if (!verifiableCredential.proof.type) {
+        throw new Error('Verifiable credential proof is missing a type')
+      }
+
+      if (!verifiableCredential.proof.created) {
+        throw new Error('Verifiable credential proof is missing a created date')
+      }
+
+      if (!verifiableCredential.proof.proofPurpose) {
+        throw new Error('Verifiable credential proof is missing a proof purpose')
+      }
+
+      if (!verifiableCredential.proof.verificationMethod) {
+        throw new Error('Verifiable credential proof is missing a verification method')
+      }
+      proof = {
+        ...verifiableCredential.proof,
+        type: verifiableCredential.proof.type,
+        created: verifiableCredential.proof.created,
+        proofPurpose: verifiableCredential.proof.proofPurpose,
+        verificationMethod: verifiableCredential.proof.verificationMethod,
+      }
+    }
+
+    return {
+      ...verifiableCredential,
+      type: verifiableCredential.type
+        ? typeof verifiableCredential.type === 'string'
+          ? [verifiableCredential.type]
+          : verifiableCredential.type
+        : ['VerifiableCredential'],
+      proof,
+    }
+  }
+
+  static storedCredentialToOriginalFormat(credential: W3CVerifiableCredential): W3CVerifiableCredential {
+    const type: DocumentFormat = CredentialMapper.detectDocumentType(credential)
+    if (typeof credential === 'string') {
+      if (type === DocumentFormat.JWT) {
+        return CredentialMapper.toCompactJWT(credential)
+      } else if (type === DocumentFormat.JSONLD) {
+        return JSON.parse(credential)
+      }
+    }
     return credential
   }
+
+  static storedPresentationToOriginalFormat(presentation: W3CVerifiablePresentation): W3CVerifiablePresentation {
+    const type: DocumentFormat = CredentialMapper.detectDocumentType(presentation)
+    if (typeof presentation === 'string') {
+      if (type === DocumentFormat.JWT) {
+        return CredentialMapper.toCompactJWT(presentation)
+      } else if (type === DocumentFormat.JSONLD) {
+        return JSON.parse(presentation)
+      }
+    }
+    return presentation
+  }
+
+  static toCompactJWT(jwtDocument: W3CVerifiableCredential | JwtDecodedVerifiableCredential | W3CVerifiablePresentation | JwtDecodedVerifiablePresentation): string {
+    if (CredentialMapper.detectDocumentType(jwtDocument) !== DocumentFormat.JWT) {
+      throw Error('Cannot convert non JWT credential to JWT')
+    }
+    if (typeof jwtDocument === 'string') {
+      return jwtDocument
+    }
+    let proof: string | undefined
+    if ('vp' in jwtDocument) {
+      proof = jwtDocument.vp.proof
+    } else if ('vc' in jwtDocument) {
+      proof = jwtDocument.vc.proof
+    } else {
+      proof = Array.isArray(jwtDocument.proof) ? jwtDocument.proof[0].jwt : jwtDocument.proof.jwt
+    }
+    if (!proof) {
+      throw Error(`Could not get JWT from supplied document`)
+    }
+    return proof
+  }
+
+  static detectDocumentType(document: W3CVerifiableCredential | W3CVerifiablePresentation | JwtDecodedVerifiableCredential | JwtDecodedVerifiablePresentation): DocumentFormat {
+    if (typeof document === 'string') {
+      return this.isJsonLdAsString(document) ? DocumentFormat.JSONLD : DocumentFormat.JWT
+    }
+    const proofs = 'vc' in document ? document.vc.proof : 'vp' in document ? document.vp.proof : (<IVerifiableCredential>document).proof
+    const proof: IProof = Array.isArray(proofs) ? proofs[0] : proofs
+
+    if (proof.jwt) {
+      return DocumentFormat.JWT
+    } else if (proof.type === 'EthereumEip712Signature2021') {
+      return DocumentFormat.EIP712
+    }
+    return DocumentFormat.JSONLD
+  }
 }

package/src/types/did.ts

@@ -19,6 +19,7 @@ export enum IProofType {
   JcsEd25519Signature2020 = 'JcsEd25519Signature2020',
   BbsBlsSignatureProof2020 = 'BbsBlsSignatureProof2020',
   BbsBlsBoundSignatureProof2020 = 'BbsBlsBoundSignatureProof2020',
+  JwtProof2020 = 'JwtProof2020'
 }
 
 export interface IParsedDID {