@sd-jwt/sd-jwt-vc 0.3.2-next.94 → 0.3.2-next.95

package/dist/index.d.mts

@@ -11,8 +11,16 @@ interface SdJwtVcPayload extends SdJwtPayload {
     status?: unknown;
     sub?: string;
 }
+
 declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
+    /**
+     * The type of the SD-JWT-VC set in the header.typ field.
+     */
     protected type: string;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     */
     protected validateReservedFields(disclosureFrame: DisclosureFrame<SdJwtVcPayload>): void;
 }
 

package/dist/index.d.ts

@@ -11,8 +11,16 @@ interface SdJwtVcPayload extends SdJwtPayload {
     status?: unknown;
     sub?: string;
 }
+
 declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
+    /**
+     * The type of the SD-JWT-VC set in the header.typ field.
+     */
     protected type: string;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     */
     protected validateReservedFields(disclosureFrame: DisclosureFrame<SdJwtVcPayload>): void;
 }
 

package/dist/index.js

@@ -428,8 +428,15 @@ var import_dist = __toESM(require_dist());
 var SDJwtVcInstance = class extends import_core.SDJwtInstance {
   constructor() {
     super(...arguments);
+    /**
+     * The type of the SD-JWT-VC set in the header.typ field.
+     */
     this.type = "sd-jwt-vc";
   }
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   */
   validateReservedFields(disclosureFrame) {
     if ((disclosureFrame == null ? void 0 : disclosureFrame._sd) && Array.isArray(disclosureFrame._sd) && disclosureFrame._sd.length > 0) {
       const reservedNames = [

package/dist/index.mjs

@@ -417,8 +417,15 @@ import { SDJwtInstance } from "@sd-jwt/core";
 var SDJwtVcInstance = class extends SDJwtInstance {
   constructor() {
     super(...arguments);
+    /**
+     * The type of the SD-JWT-VC set in the header.typ field.
+     */
     this.type = "sd-jwt-vc";
   }
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   */
   validateReservedFields(disclosureFrame) {
     if ((disclosureFrame == null ? void 0 : disclosureFrame._sd) && Array.isArray(disclosureFrame._sd) && disclosureFrame._sd.length > 0) {
       const reservedNames = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/sd-jwt-vc",
-  "version": "0.3.2-next.94+32af6cf",
+  "version": "0.3.2-next.95+a2daee4",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -39,11 +39,11 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@sd-jwt/core": "0.3.2-next.94+32af6cf"
+    "@sd-jwt/core": "0.3.2-next.95+a2daee4"
   },
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.3.2-next.94+32af6cf",
-    "@sd-jwt/types": "0.3.2-next.94+32af6cf"
+    "@sd-jwt/crypto-nodejs": "0.3.2-next.95+a2daee4",
+    "@sd-jwt/types": "0.3.2-next.95+a2daee4"
   },
   "publishConfig": {
     "access": "public"
@@ -61,5 +61,5 @@
       "esm"
     ]
   },
-  "gitHead": "32af6cfa150fceb440fc9225bcaf2791a6aeee90"
+  "gitHead": "a2daee4acc8def8b4d5871b36f740f0f5d50479d"
 }

package/src/index.ts

@@ -1,30 +1,20 @@
-import { SDJwt, SDJwtInstance, SdJwtPayload } from '@sd-jwt/core';
+import { SDJwtInstance } from '@sd-jwt/core';
 import { DisclosureFrame } from '@sd-jwt/types';
 import { SDJWTException } from '../../utils/dist';
+import { SdJwtVcPayload } from './sd-jwt-vc-payload';
 
-export interface SdJwtVcPayload extends SdJwtPayload {
-  // The Issuer of the Verifiable Credential. The value of iss MUST be a URI. See [RFC7519] for more information.
-  iss: string;
-  // The time of issuance of the Verifiable Credential. See [RFC7519] for more information.
-  iat: number;
-  // OPTIONAL. The time before which the Verifiable Credential MUST NOT be accepted before validating. See [RFC7519] for more information.
-  nbf?: number;
-  //OPTIONAL. The expiry time of the Verifiable Credential after which the Verifiable Credential is no longer valid. See [RFC7519] for more information.
-  exp?: number;
-  // REQUIRED when Cryptographic Key Binding is to be supported. Contains the confirmation method as defined in [RFC7800]. It is RECOMMENDED that this contains a JWK as defined in Section 3.2 of [RFC7800]. For Cryptographic Key Binding, the Key Binding JWT in the Combined Format for Presentation MUST be signed by the key identified in this claim.
-  cnf?: unknown;
-  //REQUIRED. The type of the Verifiable Credential, e.g., https://credentials.example.com/identity_credential, as defined in Section 3.2.2.1.1.
-  vct: string;
-  // OPTIONAL. The information on how to read the status of the Verifiable Credential. See [I-D.looker-oauth-jwt-cwt-status-list] for more information.
-  status?: unknown;
-
-  //The identifier of the Subject of the Verifiable Credential. The Issuer MAY use it to provide the Subject identifier known by the Issuer. There is no requirement for a binding to exist between sub and cnf claims.
-  sub?: string;
-}
+export { SdJwtVcPayload } from './sd-jwt-vc-payload';
 
 export class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
+  /**
+   * The type of the SD-JWT-VC set in the header.typ field.
+   */
   protected type = 'sd-jwt-vc';
 
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   */
   protected validateReservedFields(
     disclosureFrame: DisclosureFrame<SdJwtVcPayload>,
   ): void {

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

@@ -0,0 +1,21 @@
+import { SdJwtPayload } from '@sd-jwt/core';
+
+export interface SdJwtVcPayload extends SdJwtPayload {
+  // The Issuer of the Verifiable Credential. The value of iss MUST be a URI. See [RFC7519] for more information.
+  iss: string;
+  // The time of issuance of the Verifiable Credential. See [RFC7519] for more information.
+  iat: number;
+  // OPTIONAL. The time before which the Verifiable Credential MUST NOT be accepted before validating. See [RFC7519] for more information.
+  nbf?: number;
+  //OPTIONAL. The expiry time of the Verifiable Credential after which the Verifiable Credential is no longer valid. See [RFC7519] for more information.
+  exp?: number;
+  // REQUIRED when Cryptographic Key Binding is to be supported. Contains the confirmation method as defined in [RFC7800]. It is RECOMMENDED that this contains a JWK as defined in Section 3.2 of [RFC7800]. For Cryptographic Key Binding, the Key Binding JWT in the Combined Format for Presentation MUST be signed by the key identified in this claim.
+  cnf?: unknown;
+  //REQUIRED. The type of the Verifiable Credential, e.g., https://credentials.example.com/identity_credential, as defined in Section 3.2.2.1.1.
+  vct: string;
+  // OPTIONAL. The information on how to read the status of the Verifiable Credential. See [I-D.looker-oauth-jwt-cwt-status-list] for more information.
+  status?: unknown;
+
+  //The identifier of the Subject of the Verifiable Credential. The Issuer MAY use it to provide the Subject identifier known by the Issuer. There is no requirement for a binding to exist between sub and cnf claims.
+  sub?: string;
+}

package/src/test/index.spec.ts

@@ -0,0 +1,38 @@
+import { digest, generateSalt } from '@sd-jwt/crypto-nodejs';
+import { DisclosureFrame } from '@sd-jwt/types';
+import { describe, test, expect } from 'vitest';
+import { SDJwtVcInstance } from '..';
+import { createSignerVerifier } from '../../test/app-e2e.spec';
+import { SdJwtVcPayload } from '../sd-jwt-vc-payload';
+
+const iss = 'ExampleIssuer';
+const vct = 'https://example.com/schema/1';
+const iat = new Date().getTime() / 1000;
+
+describe('App', () => {
+  test('Example', async () => {
+    const { signer, verifier } = createSignerVerifier();
+    const sdjwt = new SDJwtVcInstance({
+      signer,
+      signAlg: 'EdDSA',
+      verifier,
+      hasher: digest,
+      hashAlg: 'SHA-256',
+      saltGenerator: generateSalt,
+    });
+
+    const claims = {
+      firstname: 'John',
+    };
+    const disclosureFrame = {
+      _sd: ['firstname', 'iss'],
+    };
+
+    const expectedPayload: SdJwtVcPayload = { iat, iss, vct, ...claims };
+    const encodedSdjwt = sdjwt.issue(
+      expectedPayload,
+      disclosureFrame as unknown as DisclosureFrame<SdJwtVcPayload>,
+    );
+    expect(encodedSdjwt).rejects.toThrowError();
+  });
+});

package/test/app-e2e.spec.ts

@@ -1,5 +1,5 @@
 import Crypto from 'node:crypto';
-import { SDJwtVcInstance } from '../src';
+import { SDJwtVcInstance, SdJwtVcPayload } from '../src/index';
 import { DisclosureFrame, Signer, Verifier } from '@sd-jwt/types';
 import fs from 'fs';
 import path from 'path';
@@ -72,7 +72,7 @@ describe('App', () => {
       },
     };
 
-    const expectedPayload = { iat, iss, vct, ...claims };
+    const expectedPayload: SdJwtVcPayload = { iat, iss, vct, ...claims };
     const encodedSdjwt = await sdjwt.issue(expectedPayload, disclosureFrame);
     expect(encodedSdjwt).toBeDefined();
     const validated = await sdjwt.validate(encodedSdjwt);