@sd-jwt/sd-jwt-vc 0.10.1-next.1 → 0.10.1-next.2

package/dist/index.d.mts

@@ -87,6 +87,12 @@ declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
      * Verifies the SD-JWT-VC. It will validate the signature, the keybindings when required, the status, and the VCT.
      */
     verify(encodedSDJwt: string, requiredClaimKeys?: string[], requireKeyBindings?: boolean): Promise<VerificationResult>;
+    /**
+     * Gets VCT Metadata of the raw SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC is invalid or does not contain a vct claim, an error is thrown.
+     * @param encodedSDJwt
+     * @returns
+     */
+    getVct(encodedSDJwt: string): Promise<TypeMetadataFormat>;
     /**
      * Validates the integrity of the response if the integrity is passed. If the integrity does not match, an error is thrown.
      * @param integrity
@@ -111,6 +117,12 @@ declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
      * @returns
      */
     private verifyVct;
+    /**
+     * Fetches VCT Metadata of the SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC does not contain a vct claim, an error is thrown.
+     * @param result
+     * @returns
+     */
+    private fetchVct;
     /**
      * Verifies the status of the SD-JWT-VC.
      * @param result

package/dist/index.d.ts

@@ -87,6 +87,12 @@ declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
      * Verifies the SD-JWT-VC. It will validate the signature, the keybindings when required, the status, and the VCT.
      */
     verify(encodedSDJwt: string, requiredClaimKeys?: string[], requireKeyBindings?: boolean): Promise<VerificationResult>;
+    /**
+     * Gets VCT Metadata of the raw SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC is invalid or does not contain a vct claim, an error is thrown.
+     * @param encodedSDJwt
+     * @returns
+     */
+    getVct(encodedSDJwt: string): Promise<TypeMetadataFormat>;
     /**
      * Validates the integrity of the response if the integrity is passed. If the integrity does not match, an error is thrown.
      * @param integrity
@@ -111,6 +117,12 @@ declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
      * @returns
      */
     private verifyVct;
+    /**
+     * Fetches VCT Metadata of the SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC does not contain a vct claim, an error is thrown.
+     * @param result
+     * @returns
+     */
+    private fetchVct;
     /**
      * Verifies the status of the SD-JWT-VC.
      * @param result

package/dist/index.js

@@ -146,6 +146,25 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends import_core.SDJwtInstance {
       return result;
     });
   }
+  /**
+   * Gets VCT Metadata of the raw SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC is invalid or does not contain a vct claim, an error is thrown.
+   * @param encodedSDJwt
+   * @returns
+   */
+  getVct(encodedSDJwt) {
+    return __async(this, null, function* () {
+      const { payload, header } = yield import_core.SDJwt.extractJwt(encodedSDJwt);
+      if (!payload) {
+        throw new import_utils.SDJWTException("JWT payload is missing");
+      }
+      const result = {
+        payload,
+        header,
+        kb: void 0
+      };
+      return this.fetchVct(result);
+    });
+  }
   /**
    * Validates the integrity of the response if the integrity is passed. If the integrity does not match, an error is thrown.
    * @param integrity
@@ -223,12 +242,7 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends import_core.SDJwtInstance {
    */
   verifyVct(result) {
     return __async(this, null, function* () {
-      var _a;
-      const fetcher = (_a = this.userConfig.vctFetcher) != null ? _a : (uri, integrity) => this.fetch(uri, integrity);
-      const typeMetadataFormat = yield fetcher(
-        result.payload.vct,
-        result.payload["vct#Integrity"]
-      );
+      const typeMetadataFormat = yield this.fetchVct(result);
       if (typeMetadataFormat.extends) {
       }
       const schema = yield this.loadSchema(typeMetadataFormat);
@@ -259,6 +273,21 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends import_core.SDJwtInstance {
       return typeMetadataFormat;
     });
   }
+  /**
+   * Fetches VCT Metadata of the SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC does not contain a vct claim, an error is thrown.
+   * @param result
+   * @returns
+   */
+  fetchVct(result) {
+    return __async(this, null, function* () {
+      var _a;
+      if (!result.payload.vct) {
+        throw new import_utils.SDJWTException("vct claim is required");
+      }
+      const fetcher = (_a = this.userConfig.vctFetcher) != null ? _a : (uri, integrity) => this.fetch(uri, integrity);
+      return fetcher(result.payload.vct, result.payload["vct#Integrity"]);
+    });
+  }
   /**
    * Verifies the status of the SD-JWT-VC.
    * @param result

package/dist/index.mjs

@@ -23,7 +23,7 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // src/sd-jwt-vc-instance.ts
-import { Jwt, SDJwtInstance } from "@sd-jwt/core";
+import { Jwt, SDJwt, SDJwtInstance } from "@sd-jwt/core";
 import { SDJWTException } from "@sd-jwt/utils";
 import {
   getListFromStatusListJWT
@@ -114,6 +114,25 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends SDJwtInstance {
       return result;
     });
   }
+  /**
+   * Gets VCT Metadata of the raw SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC is invalid or does not contain a vct claim, an error is thrown.
+   * @param encodedSDJwt
+   * @returns
+   */
+  getVct(encodedSDJwt) {
+    return __async(this, null, function* () {
+      const { payload, header } = yield SDJwt.extractJwt(encodedSDJwt);
+      if (!payload) {
+        throw new SDJWTException("JWT payload is missing");
+      }
+      const result = {
+        payload,
+        header,
+        kb: void 0
+      };
+      return this.fetchVct(result);
+    });
+  }
   /**
    * Validates the integrity of the response if the integrity is passed. If the integrity does not match, an error is thrown.
    * @param integrity
@@ -191,12 +210,7 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends SDJwtInstance {
    */
   verifyVct(result) {
     return __async(this, null, function* () {
-      var _a;
-      const fetcher = (_a = this.userConfig.vctFetcher) != null ? _a : (uri, integrity) => this.fetch(uri, integrity);
-      const typeMetadataFormat = yield fetcher(
-        result.payload.vct,
-        result.payload["vct#Integrity"]
-      );
+      const typeMetadataFormat = yield this.fetchVct(result);
       if (typeMetadataFormat.extends) {
       }
       const schema = yield this.loadSchema(typeMetadataFormat);
@@ -227,6 +241,21 @@ var SDJwtVcInstance = class _SDJwtVcInstance extends SDJwtInstance {
       return typeMetadataFormat;
     });
   }
+  /**
+   * Fetches VCT Metadata of the SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC does not contain a vct claim, an error is thrown.
+   * @param result
+   * @returns
+   */
+  fetchVct(result) {
+    return __async(this, null, function* () {
+      var _a;
+      if (!result.payload.vct) {
+        throw new SDJWTException("vct claim is required");
+      }
+      const fetcher = (_a = this.userConfig.vctFetcher) != null ? _a : (uri, integrity) => this.fetch(uri, integrity);
+      return fetcher(result.payload.vct, result.payload["vct#Integrity"]);
+    });
+  }
   /**
    * Verifies the status of the SD-JWT-VC.
    * @param result

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/sd-jwt-vc",
-  "version": "0.10.1-next.1+d2f2cb5",
+  "version": "0.10.1-next.2+bc91fd7",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -39,15 +39,15 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@sd-jwt/core": "0.10.1-next.1+d2f2cb5",
-    "@sd-jwt/jwt-status-list": "0.10.1-next.1+d2f2cb5",
-    "@sd-jwt/utils": "0.10.1-next.1+d2f2cb5",
+    "@sd-jwt/core": "0.10.1-next.2+bc91fd7",
+    "@sd-jwt/jwt-status-list": "0.10.1-next.2+bc91fd7",
+    "@sd-jwt/utils": "0.10.1-next.2+bc91fd7",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1"
   },
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.10.1-next.1+d2f2cb5",
-    "@sd-jwt/types": "0.10.1-next.1+d2f2cb5",
+    "@sd-jwt/crypto-nodejs": "0.10.1-next.2+bc91fd7",
+    "@sd-jwt/types": "0.10.1-next.2+bc91fd7",
     "jose": "^5.2.2",
     "msw": "^2.3.5"
   },
@@ -67,5 +67,5 @@
       "esm"
     ]
   },
-  "gitHead": "d2f2cb5a4d9f40e5d90209f572665a9bf1f0844b"
+  "gitHead": "bc91fd71f7d721298ad5c08d4379bc870903f65f"
 }

package/src/sd-jwt-vc-instance.ts

@@ -1,4 +1,4 @@
-import { Jwt, SDJwtInstance } from '@sd-jwt/core';
+import { Jwt, SDJwt, SDJwtInstance } from '@sd-jwt/core';
 import type { DisclosureFrame, Hasher, Verifier } from '@sd-jwt/types';
 import { SDJWTException } from '@sd-jwt/utils';
 import type { SdJwtVcPayload } from './sd-jwt-vc-payload';
@@ -130,6 +130,31 @@ export class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
     return result;
   }
 
+  /**
+   * Gets VCT Metadata of the raw SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC is invalid or does not contain a vct claim, an error is thrown.
+   * @param encodedSDJwt
+   * @returns
+   */
+  async getVct(encodedSDJwt: string): Promise<TypeMetadataFormat> {
+    // Call the parent class's verify method
+    const { payload, header } = await SDJwt.extractJwt<
+      Record<string, unknown>,
+      SdJwtVcPayload
+    >(encodedSDJwt);
+
+    if (!payload) {
+      throw new SDJWTException('JWT payload is missing');
+    }
+
+    const result: VerificationResult = {
+      payload,
+      header,
+      kb: undefined,
+    };
+
+    return this.fetchVct(result);
+  }
+
   /**
    * Validates the integrity of the response if the integrity is passed. If the integrity does not match, an error is thrown.
    * @param integrity
@@ -213,13 +238,7 @@ export class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
   private async verifyVct(
     result: VerificationResult,
   ): Promise<TypeMetadataFormat | undefined> {
-    const fetcher: VcTFetcher =
-      this.userConfig.vctFetcher ??
-      ((uri, integrity) => this.fetch(uri, integrity));
-    const typeMetadataFormat = await fetcher(
-      result.payload.vct,
-      result.payload['vct#Integrity'],
-    );
+    const typeMetadataFormat = await this.fetchVct(result);
 
     if (typeMetadataFormat.extends) {
       // implement based on https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-08.html#name-extending-type-metadata
@@ -260,6 +279,24 @@ export class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
     return typeMetadataFormat;
   }
 
+  /**
+   * Fetches VCT Metadata of the SD-JWT-VC. Returns the type metadata format. If the SD-JWT-VC does not contain a vct claim, an error is thrown.
+   * @param result
+   * @returns
+   */
+  private async fetchVct(
+    result: VerificationResult,
+  ): Promise<TypeMetadataFormat> {
+    if (!result.payload.vct) {
+      throw new SDJWTException('vct claim is required');
+    }
+
+    const fetcher: VcTFetcher =
+      this.userConfig.vctFetcher ??
+      ((uri, integrity) => this.fetch(uri, integrity));
+    return fetcher(result.payload.vct, result.payload['vct#Integrity']);
+  }
+
   /**
    * Verifies the status of the SD-JWT-VC.
    * @param result

package/src/test/vct.spec.ts

@@ -151,5 +151,29 @@ describe('App', () => {
     );
   });
 
+  test('VCT Metadata retrieval', async () => {
+    const expectedPayload: SdJwtVcPayload = {
+      iat,
+      iss,
+      vct,
+      'vct#Integrity': vctIntegrity,
+      ...claims,
+    };
+    const encodedSdjwt = await sdjwt.issue(
+      expectedPayload,
+      disclosureFrame as unknown as DisclosureFrame<SdJwtVcPayload>,
+    );
+
+    const typeMetadataFormat = await sdjwt.getVct(encodedSdjwt);
+    expect(typeMetadataFormat).to.deep.eq({
+      description: 'An example credential type',
+      name: 'ExampleCredentialType',
+      schema_uri: 'http://example.com/schema/example',
+      'schema_uri#Integrity':
+        'sha256-48a61b283ded3b55e8d9a9b063327641dc4c53f76bd5daa96c23f232822167ae',
+      vct: 'http://example.com/example',
+    });
+  });
+
   //TODO: we need tests with an embedded schema, extended and maybe also to test the errors when schema information is not available or the integrity is not valid
 });