@sphereon/oid4vci-common 0.8.2-next.6 → 0.8.2-unstable.16

package/lib/types/Generic.types.ts

@@ -15,7 +15,7 @@ export interface ImageInfo {
   [key: string]: unknown;
 }
 
-export type OID4VCICredentialFormat = 'jwt_vc_json' | 'jwt_vc_json-ld' | 'ldp_vc' /*| 'mso_mdoc'*/; // we do not support mdocs at this point
+export type OID4VCICredentialFormat = 'jwt_vc_json' | 'jwt_vc_json-ld' | 'ldp_vc' | 'vc+sd-jwt' | 'jwt_vc'; // jwt_vc is added for backwards compat /*| 'mso_mdoc'*/; // we do not support mdocs at this point
 
 export interface NameAndLocale {
   name?: string; // REQUIRED. String value of a display name for the Credential.
@@ -62,8 +62,6 @@ export interface CredentialIssuerMetadata extends CredentialIssuerMetadataOpts,
 }
 
 export interface CredentialSupportedBrief {
-  name?: string; // fixme: Probably should not be here, is part of the display object
-  types: string[]; // REQUIRED. JSON array designating the types a certain credential type supports
   cryptographic_binding_methods_supported?: string[]; // OPTIONAL. Array of case sensitive strings that identify how the Credential is bound to the identifier of the End-User who possesses the Credential
   cryptographic_suites_supported?: string[]; // OPTIONAL. Array of case sensitive strings that identify the cryptographic suites that are supported for the cryptographic_binding_methods_supported
 }
@@ -75,25 +73,62 @@ export type CommonCredentialSupported = CredentialSupportedBrief & {
   /**
    * following properties are non-mso_mdoc specific and we might wanna rethink them when we're going to support mso_mdoc
    */
-  credentialSubject?: IssuerCredentialSubject; // OPTIONAL. A JSON object containing a list of key value pairs, where the key identifies the claim offered in the Credential. The value MAY be a dictionary, which allows to represent the full (potentially deeply nested) structure of the verifiable credential to be issued.
-  order?: string[]; //An array of claims.display.name values that lists them in the order they should be displayed by the Wallet.
 };
 
 export interface CredentialSupportedJwtVcJsonLdAndLdpVc extends CommonCredentialSupported {
+  types: string[]; // REQUIRED. JSON array designating the types a certain credential type supports
   '@context': ICredentialContextType[]; // REQUIRED. JSON array as defined in [VC_DATA], Section 4.1.
+  credentialSubject?: IssuerCredentialSubject; // OPTIONAL. A JSON object containing a list of key value pairs, where the key identifies the claim offered in the Credential. The value MAY be a dictionary, which allows to represent the full (potentially deeply nested) structure of the verifiable credential to be issued.
+  order?: string[]; //An array of claims.display.name values that lists them in the order they should be displayed by the Wallet.
+  format: 'ldp_vc' | 'jwt_vc_json-ld';
 }
 
 export interface CredentialSupportedJwtVcJson extends CommonCredentialSupported {
-  format: 'jwt_vc_json';
+  types: string[]; // REQUIRED. JSON array designating the types a certain credential type supports
+  credentialSubject?: IssuerCredentialSubject; // OPTIONAL. A JSON object containing a list of key value pairs, where the key identifies the claim offered in the Credential. The value MAY be a dictionary, which allows to represent the full (potentially deeply nested) structure of the verifiable credential to be issued.
+  order?: string[]; //An array of claims.display.name values that lists them in the order they should be displayed by the Wallet.
+  format: 'jwt_vc_json' | 'jwt_vc'; // jwt_vc added for backwards compat
+}
+
+export interface SdJwtVcCredentialDefinition {
+  vct: string; // REQUIRED. JSON string designating the type of an SD-JWT vc
+  claims?: IssuerCredentialSubject;
+}
+
+export interface CredentialSupportedSdJwtVc extends CommonCredentialSupported {
+  format: 'vc+sd-jwt';
+
+  // REQUIRED. JSON object containing the detailed description of the credential type
+  credential_definition: SdJwtVcCredentialDefinition;
+  order?: string[]; //An array of claims.display.name values that lists them in the order they should be displayed by the Wallet.
 }
 
-export type CredentialSupported = CommonCredentialSupported & (CredentialSupportedJwtVcJson | CredentialSupportedJwtVcJsonLdAndLdpVc);
+export type CredentialSupported = CommonCredentialSupported &
+  (CredentialSupportedJwtVcJson | CredentialSupportedJwtVcJsonLdAndLdpVc | CredentialSupportedSdJwtVc);
 
-export interface CredentialOfferFormat {
+export interface CommonCredentialOfferFormat {
   format: OID4VCICredentialFormat | string;
-  types: string[];
 }
 
+export interface CredentialOfferFormatJwtVcJsonLdAndLdpVc extends CommonCredentialOfferFormat {
+  format: 'ldp_vc' | 'jwt_vc_json-ld';
+  // REQUIRED. JSON object containing (and isolating) the detailed description of the credential type. This object MUST be processed using full JSON-LD processing.
+  credential_definition: JsonLdIssuerCredentialDefinition;
+}
+
+export interface CredentialOfferFormatJwtVcJson extends CommonCredentialOfferFormat {
+  format: 'jwt_vc_json' | 'jwt_vc'; // jwt_vc is added for backwards compat
+  types: string[]; // REQUIRED. JSON array as defined in Appendix E.1.1.2. This claim contains the type values the Wallet shall request in the subsequent Credential Request.
+}
+
+export interface CredentialOfferFormatSdJwtVc extends CommonCredentialOfferFormat {
+  format: 'vc+sd-jwt';
+  credential_definition: SdJwtVcCredentialDefinition;
+}
+
+export type CredentialOfferFormat = CommonCredentialOfferFormat &
+  (CredentialOfferFormatJwtVcJsonLdAndLdpVc | CredentialOfferFormatJwtVcJson | CredentialOfferFormatSdJwtVc);
+
 /**
  * Optional storage that can help the credential Data Supplier. For instance to store credential input data during offer creation, if no additional data can be supplied later on
  */
@@ -108,10 +143,10 @@ export type CreateCredentialOfferURIResult = {
   userPinRequired: boolean;
 };
 
-export interface IssuerCredentialDefinition {
+export interface JsonLdIssuerCredentialDefinition {
   '@context': ICredentialContextType[];
   types: string[];
-  credentialSubject: IssuerCredentialSubject;
+  credentialSubject?: IssuerCredentialSubject;
 }
 
 export interface ErrorResponse extends Response {
@@ -128,15 +163,20 @@ export interface CommonCredentialRequest {
   proof?: ProofOfPossession;
 }
 
-export interface CredentialRequestJwtVc extends CommonCredentialRequest {
-  format: 'jwt_vc_json' | 'jwt_vc_json-ld';
+export interface CredentialRequestJwtVcJson extends CommonCredentialRequest {
+  format: 'jwt_vc_json' | 'jwt_vc'; // jwt_vc for backwards compat
   types: string[];
   credentialSubject?: IssuerCredentialSubject;
 }
 
-export interface CredentialRequestLdpVc extends CommonCredentialRequest {
-  format: 'ldp_vc';
-  credential_definition: IssuerCredentialDefinition;
+export interface CredentialRequestJwtVcJsonLdAndLdpVc extends CommonCredentialRequest {
+  format: 'ldp_vc' | 'jwt_vc_json-ld';
+  credential_definition: JsonLdIssuerCredentialDefinition;
+}
+
+export interface CredentialRequestSdJwtVc extends CommonCredentialRequest {
+  format: 'vc+sd-jwt';
+  credential_definition: SdJwtVcCredentialDefinition;
 }
 
 export interface CommonCredentialResponse {
@@ -157,6 +197,11 @@ export interface CredentialResponseJwtVc {
   credential: string;
 }
 
+export interface CredentialResponseSdJwtVc {
+  format: 'vc+sd-jwt';
+  credential: string;
+}
+
 // export type CredentialSubjectDisplay = NameAndLocale[];
 
 export type IssuerCredentialSubjectDisplay = CredentialSubjectDisplay & { [key: string]: CredentialSubjectDisplay };

package/lib/types/QRCode.types.ts

@@ -60,7 +60,7 @@ export interface ComponentOptions {
      */
     protectors?: boolean;
   };
-};
+}
 
 export interface QRCodeOpts {
   /**
@@ -224,4 +224,4 @@ export interface QRCodeOpts {
    * @deafultValue 0.4
    */
   dotScale?: number;
-};
+}

package/lib/types/v1_0_08.types.ts

@@ -6,7 +6,7 @@ import { CredentialsSupportedDisplay, CredentialSupportedBrief, IssuerCredential
 export interface CredentialRequestV1_0_08 {
   type: string;
   format: CredentialFormat;
-  proof: ProofOfPossession;
+  proof?: ProofOfPossession;
 }
 
 export interface IssuerMetadataV1_0_08 {
@@ -34,11 +34,16 @@ export interface CredentialSupportedTypeV1_0_08 {
   [credentialType: string]: CredentialSupportedV1_0_08;
 }
 
+export interface CredentialSupportedFormatV1_0_08 extends CredentialSupportedBrief {
+  name?: string;
+  types: string[];
+}
+
 export interface CredentialSupportedV1_0_08 {
   display?: CredentialsSupportedDisplay[];
   formats: {
     // REQUIRED. A JSON object containing a list of key value pairs, where the key is a string identifying the format of the Credential. Below is a non-exhaustive list of valid key values defined by this specification:
-    [credentialFormat: string]: CredentialSupportedBrief;
+    [credentialFormat: string]: CredentialSupportedFormatV1_0_08;
   };
   claims?: IssuerCredentialSubject; // REQUIRED. A JSON object containing a list of key value pairs, where the key identifies the claim offered in the Credential. The value is a JSON object detailing the specifics about the support for the claim with a following non-exhaustive list of parameters that MAY be included:
 }

package/lib/types/v1_0_11.types.ts

@@ -3,10 +3,10 @@ import {
   CommonCredentialRequest,
   CredentialDataSupplierInput,
   CredentialOfferFormat,
-  CredentialRequestJwtVc,
-  CredentialRequestLdpVc,
+  CredentialRequestJwtVcJson,
+  CredentialRequestJwtVcJsonLdAndLdpVc,
+  CredentialRequestSdJwtVc,
   Grant,
-  IssuerCredentialDefinition,
 } from './Generic.types';
 import { QRCodeOpts } from './QRCode.types';
 
@@ -23,7 +23,7 @@ export interface CredentialOfferRESTRequest extends CredentialOfferV1_0_11 {
   credentialDataSupplierInput?: CredentialDataSupplierInput;
 }
 
-export interface CommonCredentialOfferPayloadV1_0_11 {
+export interface CredentialOfferPayloadV1_0_11 {
   /**
    * REQUIRED. The URL of the Credential Issuer, the Wallet is requested to obtain one or more Credentials from.
    */
@@ -50,22 +50,8 @@ export interface CommonCredentialOfferPayloadV1_0_11 {
   grants?: Grant;
 }
 
-export interface CredentialOfferLdpVcV1_0_11 extends CommonCredentialOfferPayloadV1_0_11 {
-  /**
-   * REQUIRED. JSON object containing (and isolating) the detailed description of the credential type.
-   * This object MUST be processed using full JSON-LD processing. It consists of the following sub-claims:
-   *   - @context: REQUIRED. JSON array as defined in Appendix E.1.3.2
-   *   - types: REQUIRED. JSON array as defined in Appendix E.1.3.2.
-   *            This claim contains the type values the Wallet shall request in the subsequent Credential Request
-   */
-  credential_definition: IssuerCredentialDefinition;
-}
-
-export type CredentialOfferJwtVcV1_0_11 = CommonCredentialOfferPayloadV1_0_11;
-
-export type CredentialOfferPayloadV1_0_11 = CommonCredentialOfferPayloadV1_0_11 & (CredentialOfferLdpVcV1_0_11 | CredentialOfferJwtVcV1_0_11);
-
-export type CredentialRequestV1_0_11 = CommonCredentialRequest & (CredentialRequestJwtVc | CredentialRequestLdpVc);
+export type CredentialRequestV1_0_11 = CommonCredentialRequest &
+  (CredentialRequestJwtVcJson | CredentialRequestJwtVcJsonLdAndLdpVc | CredentialRequestSdJwtVc);
 
 export interface AuthorizationRequestV1_0_11 extends AuthorizationDetailsJwtVcJson, AuthorizationDetailsJwtVcJson {
   issuer_state?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/oid4vci-common",
-  "version": "0.8.2-next.6+094ebfc",
+  "version": "0.8.2-unstable.16+a504fb2",
   "description": "OpenID 4 Verifiable Credential Issuance Common Types",
   "source": "lib/index.ts",
   "main": "dist/index.js",
@@ -10,7 +10,7 @@
     "build:clean": "tsc --build --clean && tsc --build"
   },
   "dependencies": {
-    "@sphereon/ssi-types": "0.17.2",
+    "@sphereon/ssi-types": "0.17.6-unstable.23",
     "cross-fetch": "^3.1.8",
     "jwt-decode": "^3.1.2"
   },
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "094ebfc61e1650e3c7bb32e4a22ec576d7049f18"
+  "gitHead": "a504fb24a8d6127624e3e5497f1a6633e816253d"
 }