@sphereon/oid4vci-common 0.8.1 → 0.8.2-next.12

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' /*| '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 {
+  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';
 }
 
-export type CredentialSupported = CommonCredentialSupported & (CredentialSupportedJwtVcJson | CredentialSupportedJwtVcJsonLdAndLdpVc);
+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 | 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';
+  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
  */
@@ -101,16 +136,17 @@ export type CredentialDataSupplierInput = any;
 
 export type CreateCredentialOfferURIResult = {
   uri: string;
+  qrCodeDataUri?: string;
   session: CredentialOfferSession;
   userPin?: string;
   userPinLength?: number;
   userPinRequired: boolean;
 };
 
-export interface IssuerCredentialDefinition {
+export interface JsonLdIssuerCredentialDefinition {
   '@context': ICredentialContextType[];
   types: string[];
-  credentialSubject: IssuerCredentialSubject;
+  credentialSubject?: IssuerCredentialSubject;
 }
 
 export interface ErrorResponse extends Response {
@@ -127,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';
   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 {
@@ -156,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

@@ -0,0 +1,227 @@
+export interface ComponentOptions {
+  /**
+   * Component options for data/ECC.
+   */
+  data?: {
+    /**
+     * Scale factor for data/ECC dots.
+     * @default 1
+     */
+    scale?: number;
+  };
+
+  /**
+   * Component options for timing patterns.
+   */
+  timing?: {
+    /**
+     * Scale factor for timing patterns.
+     * @default 1
+     */
+    scale?: number;
+
+    /**
+     * Protector for timing patterns.
+     * @default false
+     */
+    protectors?: boolean;
+  };
+
+  /**
+   * Component options for alignment patterns.
+   */
+  alignment?: {
+    /**
+     * Scale factor for alignment patterns.
+     * @default 1
+     */
+    scale?: number;
+
+    /**
+     * Protector for alignment patterns.
+     * @default false
+     */
+    protectors?: boolean;
+  };
+
+  /**
+   * Component options for alignment pattern on the bottom-right corner.
+   */
+  cornerAlignment?: {
+    /**
+     * Scale factor for alignment pattern on the bottom-right corner.
+     * @default 1
+     */
+    scale?: number;
+
+    /**
+     * Protector for alignment pattern on the bottom-right corner.
+     * @default true
+     */
+    protectors?: boolean;
+  };
+};
+
+export interface QRCodeOpts {
+  /**
+   * Size of the QR code in pixel.
+   *
+   * @defaultValue 400
+   */
+  size?: number;
+
+  /**
+   * Size of margins around the QR code body in pixel.
+   *
+   * @defaultValue 20
+   */
+  margin?: number;
+
+  /**
+   * Error correction level of the QR code.
+   *
+   * Accepts a value provided by _QRErrorCorrectLevel_.
+   *
+   * For more information, please refer to [https://www.qrcode.com/en/about/error_correction.html](https://www.qrcode.com/en/about/error_correction.html).
+   *
+   * @defaultValue 0
+   */
+  correctLevel?: number;
+
+  /**
+   * **This is an advanced option.**
+   *
+   * Specify the mask pattern to be used in QR code encoding.
+   *
+   * Accepts a value provided by _QRMaskPattern_.
+   *
+   * To find out all eight mask patterns, please refer to [https://en.wikipedia.org/wiki/File:QR_Code_Mask_Patterns.svg](https://en.wikipedia.org/wiki/File:QR_Code_Mask_Patterns.svg)
+   *
+   * For more information, please refer to [https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders#Masking](https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders#Masking).
+   */
+  maskPattern?: number;
+
+  /**
+   * **This is an advanced option.**
+   *
+   * Specify the version to be used in QR code encoding.
+   *
+   * Accepts an integer in range [1, 40].
+   *
+   * For more information, please refer to [https://www.qrcode.com/en/about/version.html](https://www.qrcode.com/en/about/version.html).
+   */
+  version?: number;
+
+  /**
+   * Options to control components in the QR code.
+   *
+   * @deafultValue undefined
+   */
+  components?: ComponentOptions;
+
+  /**
+   * Color of the blocks on the QR code.
+   *
+   * Accepts a CSS <color>.
+   *
+   * For more information about CSS <color>, please refer to [https://developer.mozilla.org/en-US/docs/Web/CSS/color_value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+   *
+   * @defaultValue "#000000"
+   */
+  colorDark?: string;
+
+  /**
+   * Color of the empty areas on the QR code.
+   *
+   * Accepts a CSS <color>.
+   *
+   * For more information about CSS <color>, please refer to [https://developer.mozilla.org/en-US/docs/Web/CSS/color_value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+   *
+   * @defaultValue "#ffffff"
+   */
+  colorLight?: string;
+
+  /**
+   * Automatically calculate the _colorLight_ value from the QR code's background.
+   *
+   * @defaultValue true
+   */
+  autoColor?: boolean;
+
+  /**
+   * Background image to be used in the QR code.
+   *
+   * Accepts a `data:` string in web browsers or a Buffer in Node.js.
+   *
+   * @defaultValue undefined
+   */
+  backgroundImage?: string | Buffer;
+
+  /**
+   * Color of the dimming mask above the background image.
+   *
+   * Accepts a CSS <color>.
+   *
+   * For more information about CSS <color>, please refer to [https://developer.mozilla.org/en-US/docs/Web/CSS/color_value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).
+   *
+   * @defaultValue "rgba(0, 0, 0, 0)"
+   */
+  backgroundDimming?: string;
+
+  /**
+   * GIF background image to be used in the QR code.
+   *
+   * @defaultValue undefined
+   */
+  gifBackground?: ArrayBuffer;
+
+  /**
+   * Use a white margin instead of a transparent one which reveals the background of the QR code on margins.
+   *
+   * @defaultValue true
+   */
+  whiteMargin?: boolean;
+
+  /**
+   * Logo image to be displayed at the center of the QR code.
+   *
+   * Accepts a `data:` string in web browsers or a Buffer in Node.js.
+   *
+   * When set to `undefined` or `null`, the logo is disabled.
+   *
+   * @defaultValue undefined
+   */
+  logoImage?: string | Buffer;
+
+  /**
+   * Ratio of the logo size to the QR code size.
+   *
+   * @defaultValue 0.2
+   */
+  logoScale?: number;
+
+  /**
+   * Size of margins around the logo image in pixels.
+   *
+   * @defaultValue 6
+   */
+  logoMargin?: number;
+
+  /**
+   * Corner radius of the logo image in pixels.
+   *
+   * @defaultValue 8
+   */
+  logoCornerRadius?: number;
+
+  /**
+   * @deprecated
+   *
+   * Ratio of the real size to the full size of the blocks.
+   *
+   * This can be helpful when you want to make more parts of the background visible.
+   *
+   * @deafultValue 0.4
+   */
+  dotScale?: number;
+};

package/lib/types/index.ts

@@ -9,3 +9,4 @@ export * from './OpenID4VCIErrors';
 export * from './OpenID4VCIVersions.types';
 export * from './StateManager.types';
 export * from './Token.types';
+export * from './QRCode.types';

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,11 +3,12 @@ import {
   CommonCredentialRequest,
   CredentialDataSupplierInput,
   CredentialOfferFormat,
-  CredentialRequestJwtVc,
-  CredentialRequestLdpVc,
+  CredentialRequestJwtVcJson,
+  CredentialRequestJwtVcJsonLdAndLdpVc,
+  CredentialRequestSdJwtVc,
   Grant,
-  IssuerCredentialDefinition,
 } from './Generic.types';
+import { QRCodeOpts } from './QRCode.types';
 
 export interface CredentialOfferV1_0_11 {
   credential_offer?: CredentialOfferPayloadV1_0_11;
@@ -18,10 +19,11 @@ export interface CredentialOfferRESTRequest extends CredentialOfferV1_0_11 {
   baseUri?: string;
   scheme?: string;
   pinLength?: number;
+  qrCodeOpts?: QRCodeOpts;
   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.
    */
@@ -48,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.1",
+  "version": "0.8.2-next.12+1595df2",
   "description": "OpenID 4 Verifiable Credential Issuance Common Types",
   "source": "lib/index.ts",
   "main": "dist/index.js",
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "535b3ca77228717a3a2e1def0287c5c402f334a1"
+  "gitHead": "1595df295c655d32eadf785d11c79fc69dffa8d6"
 }