@sphereon/oid4vci-common 0.10.4-unstable.81 → 0.12.0

package/lib/types/Generic.types.ts

@@ -1,5 +1,7 @@
 import { ICredentialContextType, IVerifiableCredential, W3CVerifiableCredential } from '@sphereon/ssi-types';
 
+import { ExperimentalSubjectIssuance } from '../experimental/holder-vci';
+
 import { ProofOfPossession } from './CredentialIssuance.types';
 import { AuthorizationServerMetadata } from './ServerMetadata';
 import { CredentialOfferSession } from './StateManager.types';
@@ -15,6 +17,8 @@ import {
 export type InputCharSet = 'numeric' | 'text';
 export type KeyProofType = 'jwt' | 'cwt' | 'ldp_vp';
 
+export type PoPMode = 'pop' | 'jwt'; // Proof of posession, or regular JWT
+
 /**
  * Important Note: please be aware that these Common interfaces are based on versions v1_0.11 and v1_0.09
  */
@@ -62,6 +66,7 @@ export interface CredentialIssuerMetadataOpts {
   credential_issuer: string; // REQUIRED. The Credential Issuer's identifier.
   authorization_server?: string; // OPTIONAL. Identifier of the OAuth 2.0 Authorization Server (as defined in [RFC8414]) the Credential Issuer relies on for authorization. If this element is omitted, the entity providing the Credential Issuer is also acting as the AS, i.e. the Credential Issuer's identifier is used as the OAuth 2.0 Issuer value to obtain the Authorization Server metadata as per [RFC8414].
   token_endpoint?: string;
+  notification_endpoint?: string;
   display?: MetadataDisplay[]; //  An array of objects, where each object contains display properties of a Credential Issuer for a certain language. Below is a non-exhaustive list of valid parameters that MAY be included:
   credential_supplier_config?: CredentialSupplierConfig;
 }
@@ -118,17 +123,18 @@ export interface ProofType {
   proof_signing_alg_values_supported: string[];
 }
 
-export type CommonCredentialSupported = CredentialSupportedBrief & {
-  format: OID4VCICredentialFormat | string; //REQUIRED. A JSON string identifying the format of this credential, e.g. jwt_vc_json or ldp_vc.
-  id?: string; // OPTIONAL. A JSON string identifying the respective object. The value MUST be unique across all credentials_supported entries in the Credential Issuer Metadata
-  display?: CredentialsSupportedDisplay[]; // OPTIONAL. An array of objects, where each object contains the display properties of the supported credential for a certain language
-  scope?: string; // OPTIONAL. A JSON string identifying the scope value that this Credential Issuer supports for this particular Credential. The value can be the same across multiple credential_configurations_supported objects. The Authorization Server MUST be able to uniquely identify the Credential Issuer based on the scope value. The Wallet can use this value in the Authorization Request as defined in Section 5.1.2. Scope values in this Credential Issuer metadata MAY duplicate those in the scopes_supported parameter of the Authorization Server.
-  proof_types_supported?: Record<KeyProofType, ProofType>;
+export type CommonCredentialSupported = CredentialSupportedBrief &
+  ExperimentalSubjectIssuance & {
+    format: OID4VCICredentialFormat | string; //REQUIRED. A JSON string identifying the format of this credential, e.g. jwt_vc_json or ldp_vc.
+    id?: string; // OPTIONAL. A JSON string identifying the respective object. The value MUST be unique across all credentials_supported entries in the Credential Issuer Metadata
+    display?: CredentialsSupportedDisplay[]; // OPTIONAL. An array of objects, where each object contains the display properties of the supported credential for a certain language
+    scope?: string; // OPTIONAL. A JSON string identifying the scope value that this Credential Issuer supports for this particular Credential. The value can be the same across multiple credential_configurations_supported objects. The Authorization Server MUST be able to uniquely identify the Credential Issuer based on the scope value. The Wallet can use this value in the Authorization Request as defined in Section 5.1.2. Scope values in this Credential Issuer metadata MAY duplicate those in the scopes_supported parameter of the Authorization Server.
+    proof_types_supported?: Record<KeyProofType, ProofType>;
 
-  /**
-   * following properties are non-mso_mdoc specific and we might wanna rethink them when we're going to support mso_mdoc
-   */
-};
+    /**
+     * following properties are non-mso_mdoc specific and we might wanna rethink them when we're going to support mso_mdoc
+     */
+  };
 
 export interface CredentialSupportedJwtVcJsonLdAndLdpVc extends CommonCredentialSupported {
   types: string[]; // REQUIRED. JSON array designating the types a certain credential type supports
@@ -217,7 +223,7 @@ export interface ErrorResponse extends Response {
 
 export type UniformCredentialRequest = CredentialRequestV1_0_11 | CredentialRequestV1_0_13;
 
-export interface CommonCredentialRequest {
+export interface CommonCredentialRequest extends ExperimentalSubjectIssuance {
   format: OID4VCICredentialFormat /* | OID4VCICredentialFormat[];*/; // for now it seems only one is supported in the spec
   proof?: ProofOfPossession;
 }
@@ -239,7 +245,7 @@ export interface CredentialRequestSdJwtVc extends CommonCredentialRequest {
   claims?: IssuerCredentialSubject;
 }
 
-export interface CommonCredentialResponse {
+export interface CommonCredentialResponse extends ExperimentalSubjectIssuance {
   // format: string;  TODO do we still need this for previous version support?
   credential?: W3CVerifiableCredential;
   acceptance_token?: string;
@@ -367,3 +373,23 @@ export const PRE_AUTH_CODE_LITERAL = 'pre-authorized_code';
 export type EndpointMetadataResult = EndpointMetadataResultV1_0_13 | EndpointMetadataResultV1_0_11;
 
 export type IssuerMetadata = IssuerMetadataV1_0_13 | IssuerMetadataV1_0_08;
+
+export type NotificationEventType = 'credential_accepted' | 'credential_failure' | 'credential_deleted';
+
+export interface NotificationRequest {
+  notification_id: string;
+  event: NotificationEventType | string;
+  event_description?: string;
+  credential?: any; // Experimental support to have a wallet sign a credential. Not part of the spec
+}
+
+export type NotificationError = 'invalid_notification_id' | 'invalid_notification_request';
+
+export type NotificationResult = {
+  error: boolean;
+  response?: NotificationErrorResponse;
+};
+
+export interface NotificationErrorResponse {
+  error: NotificationError | string;
+}

package/lib/types/StateManager.types.ts

@@ -13,6 +13,7 @@ export interface CredentialOfferSession extends StateType {
   status: IssueStatus;
   error?: string;
   lastUpdatedAt: number;
+  notification_id: string;
   issuerState?: string; //todo: Probably good to hash it here, since it would come in from the client and we could match the hash and thus use the client value
   preAuthorizedCode?: string; //todo: Probably good to hash it here, since it would come in from the client and we could match the hash and thus use the client value
 }

package/lib/types/v1_0_11.types.ts

@@ -1,3 +1,5 @@
+import { ExperimentalSubjectIssuance } from '../experimental/holder-vci';
+
 import { AuthorizationDetailsJwtVcJson, AuthorizationServerOpts, CommonAuthorizationRequest } from './Authorization.types';
 import { UniformCredentialOffer, UniformCredentialOfferRequest } from './CredentialIssuance.types';
 import {
@@ -80,6 +82,7 @@ export interface CredentialOfferPayloadV1_0_11 {
 }
 
 export type CredentialRequestV1_0_11 = CommonCredentialRequest &
+  ExperimentalSubjectIssuance &
   (CredentialRequestJwtVcJson | CredentialRequestJwtVcJsonLdAndLdpVc | CredentialRequestSdJwtVc);
 
 export interface CredentialIssuerMetadataV1_0_11 extends CredentialIssuerMetadataOpts, Partial<AuthorizationServerMetadata> {

package/lib/types/v1_0_13.types.ts

@@ -1,7 +1,12 @@
+import { ExperimentalSubjectIssuance } from '../experimental/holder-vci';
+
 import { JWK, ProofOfPossession } from './CredentialIssuance.types';
 import {
   AlgValue,
   CredentialDataSupplierInput,
+  CredentialRequestJwtVcJson,
+  CredentialRequestJwtVcJsonLdAndLdpVc,
+  CredentialRequestSdJwtVc,
   CredentialsSupportedDisplay,
   CredentialSupplierConfig,
   EncValue,
@@ -54,20 +59,20 @@ export type CredentialConfigurationSupportedV1_0_13 = {
   [x: string]: unknown;
 };
 
-export type CredentialRequestV1_0_13 = {
-  format: OID4VCICredentialFormat;
-  proof?: ProofOfPossession;
-  credential_identifier: string;
-  credential_response_encryption?: {
-    jwk: JWK;
-    alg: AlgValue;
-    enc: EncValue;
-  };
-  /**
-   * fixme: Added this to address sd-jwt requests. probably we need to revisit this
-   */
-  vct?: string;
-};
+export type CredentialRequestV1_0_13 =
+  | (ExperimentalSubjectIssuance & {
+      // We add them here to keep existing other request versions happy. They cannot co-exists with an identifier
+      format?: OID4VCICredentialFormat /* | OID4VCICredentialFormat[];*/; // for now it seems only one is supported in the spec
+      proof?: ProofOfPossession;
+
+      credential_identifier?: string;
+      credential_response_encryption?: {
+        jwk: JWK;
+        alg: AlgValue;
+        enc: EncValue;
+      };
+    })
+  | (CredentialRequestJwtVcJson | CredentialRequestJwtVcJsonLdAndLdpVc | CredentialRequestSdJwtVc);
 
 export interface CredentialOfferV1_0_13 {
   credential_offer?: CredentialOfferPayloadV1_0_13;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/oid4vci-common",
-  "version": "0.10.4-unstable.81+93cf0d0",
+  "version": "0.12.0",
   "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.23.0",
+    "@sphereon/ssi-types": "0.25.1-unstable.87",
     "cross-fetch": "^3.1.8",
     "jwt-decode": "^3.1.2",
     "sha.js": "^2.4.11",
@@ -21,14 +21,6 @@
     "@types/sha.js": "^2.4.4",
     "typescript": "5.4.5"
   },
-  "peerDependencies": {
-    "msrcrypto": "^1.5.8"
-  },
-  "peerDependenciesMeta": {
-    "msrcrypto": {
-      "optional": true
-    }
-  },
   "engines": {
     "node": ">=18"
   },
@@ -57,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "93cf0d03f678ec622f0c83308069e45601bfee04"
+  "gitHead": "a76c382a36e38428391c9e8d1a6b67e477fc659a"
 }