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

package/README.md

@@ -32,7 +32,8 @@ Ensure you have Node.js installed as a prerequisite.
 
 ### Usage
 
-This library can not be used on it's own, it is a dependency for other implementations like `@sd-jwt/sd-jwt-vc`.
+The library can be used to create sd-jwt based credentials. To be compliant with the  `sd-jwt-vc` standard, you can use the `@sd-jwt/sd-jwt-vc` that is implementing this spec.
+If you want to use the pure sd-jwt class or implement your own sd-jwt credential approach, you can use this library.
 
 ### Dependencies
 

package/dist/index.d.mts

@@ -67,8 +67,8 @@ declare const pack: <T extends Record<string, unknown>>(claims: T, disclosureFra
 declare const createDecoy: (hash: HasherAndAlg, saltGenerator: SaltGenerator) => Promise<string>;
 
 type SdJwtPayload = Record<string, unknown>;
-declare abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
-    protected abstract type: string;
+declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+    protected type?: string;
     static DEFAULT_hashAlg: string;
     private userConfig;
     constructor(userConfig?: SDJWTConfig);
@@ -78,7 +78,12 @@ declare abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     issue<Payload extends ExtendedPayload>(payload: Payload, disclosureFrame?: DisclosureFrame<Payload>, options?: {
         header?: object;
     }): Promise<SDJWTCompact>;
-    protected abstract validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     * @returns
+     */
+    protected validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
     present(encodedSDJwt: string, presentationKeys?: string[], options?: {
         kb?: KBOptions;
     }): Promise<SDJWTCompact>;

package/dist/index.d.ts

@@ -67,8 +67,8 @@ declare const pack: <T extends Record<string, unknown>>(claims: T, disclosureFra
 declare const createDecoy: (hash: HasherAndAlg, saltGenerator: SaltGenerator) => Promise<string>;
 
 type SdJwtPayload = Record<string, unknown>;
-declare abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
-    protected abstract type: string;
+declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+    protected type?: string;
     static DEFAULT_hashAlg: string;
     private userConfig;
     constructor(userConfig?: SDJWTConfig);
@@ -78,7 +78,12 @@ declare abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     issue<Payload extends ExtendedPayload>(payload: Payload, disclosureFrame?: DisclosureFrame<Payload>, options?: {
         header?: object;
     }): Promise<SDJWTCompact>;
-    protected abstract validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     * @returns
+     */
+    protected validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
     present(encodedSDJwt: string, presentationKeys?: string[], options?: {
         kb?: KBOptions;
     }): Promise<SDJWTCompact>;

package/dist/index.js

@@ -489,6 +489,14 @@ var _SDJwtInstance = class _SDJwtInstance {
       return sdJwt.encodeSDJwt();
     });
   }
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   * @returns
+   */
+  validateReservedFields(disclosureFrame) {
+    return;
+  }
   present(encodedSDJwt, presentationKeys, options) {
     return __async(this, null, function* () {
       var _a;

package/dist/index.mjs

@@ -469,6 +469,14 @@ var _SDJwtInstance = class _SDJwtInstance {
       return sdJwt.encodeSDJwt();
     });
   }
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   * @returns
+   */
+  validateReservedFields(disclosureFrame) {
+    return;
+  }
   present(encodedSDJwt, presentationKeys, options) {
     return __async(this, null, function* () {
       var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/core",
-  "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",
@@ -14,10 +14,9 @@
   "scripts": {
     "build": "rm -rf **/dist && tsup",
     "lint": "biome lint ./src",
-    "test": "pnpm run test:node && pnpm run test:browser && pnpm run test:e2e && pnpm run test:cov",
-    "test:node": "vitest run ./src/test/*.spec.ts && vitest run ./src/test/*.spec.ts --environment jsdom",
+    "test": "pnpm run test:node && pnpm run test:browser && pnpm run test:cov",
+    "test:node": "vitest run ./src/test/*.spec.ts",
     "test:browser": "vitest run ./src/test/*.spec.ts --environment jsdom",
-    "test:e2e": "vitest run ./test/*e2e.spec.ts --environment node",
     "test:cov": "vitest run --coverage"
   },
   "keywords": [
@@ -39,12 +38,12 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.3.2-next.94+32af6cf"
+    "@sd-jwt/crypto-nodejs": "0.3.2-next.95+a2daee4"
   },
   "dependencies": {
-    "@sd-jwt/decode": "0.3.2-next.94+32af6cf",
-    "@sd-jwt/types": "0.3.2-next.94+32af6cf",
-    "@sd-jwt/utils": "0.3.2-next.94+32af6cf"
+    "@sd-jwt/decode": "0.3.2-next.95+a2daee4",
+    "@sd-jwt/types": "0.3.2-next.95+a2daee4",
+    "@sd-jwt/utils": "0.3.2-next.95+a2daee4"
   },
   "publishConfig": {
     "access": "public"
@@ -62,5 +61,5 @@
       "esm"
     ]
   },
-  "gitHead": "32af6cfa150fceb440fc9225bcaf2791a6aeee90"
+  "gitHead": "a2daee4acc8def8b4d5871b36f740f0f5d50479d"
 }

package/src/index.ts

@@ -19,9 +19,9 @@ export * from './decoy';
 
 export type SdJwtPayload = Record<string, unknown>;
 
-export abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
   //header type
-  protected abstract type: string;
+  protected type?: string;
 
   public static DEFAULT_hashAlg = 'sha-256';
 
@@ -127,9 +127,16 @@ export abstract class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     return sdJwt.encodeSDJwt();
   }
 
-  protected abstract validateReservedFields<T extends ExtendedPayload>(
+  /**
+   * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+   * @param disclosureFrame
+   * @returns
+   */
+  protected validateReservedFields<T extends ExtendedPayload>(
     disclosureFrame: DisclosureFrame<T>,
-  ): void;
+  ) {
+    return;
+  }
 
   public async present(
     encodedSDJwt: string,

package/src/test/index.spec.ts

@@ -1,19 +1,9 @@
 import { SDJwtInstance, SdJwtPayload } from '../index';
-import { DisclosureFrame, Signer, Verifier } from '@sd-jwt/types';
+import { Signer, Verifier } from '@sd-jwt/types';
 import Crypto from 'node:crypto';
 import { describe, expect, test } from 'vitest';
 import { digest, generateSalt } from '@sd-jwt/crypto-nodejs';
 
-export class TestInstance extends SDJwtInstance<SdJwtPayload> {
-  protected type = 'sd-jwt';
-
-  protected validateReservedFields(
-    disclosureFrame: DisclosureFrame<SdJwtPayload>,
-  ): void {
-    return;
-  }
-}
-
 export const createSignerVerifier = () => {
   const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
   const signer: Signer = async (data: string) => {
@@ -33,13 +23,13 @@ export const createSignerVerifier = () => {
 
 describe('index', () => {
   test('create', async () => {
-    const sdjwt = new TestInstance();
+    const sdjwt = new SDJwtInstance<SdJwtPayload>();
     expect(sdjwt).toBeDefined();
   });
 
   test('kbJwt', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier,
@@ -77,7 +67,7 @@ describe('index', () => {
 
   test('issue', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier,
@@ -111,7 +101,7 @@ describe('index', () => {
       );
     };
 
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier: failedverifier,
@@ -149,7 +139,7 @@ describe('index', () => {
         Buffer.from(sig, 'base64url'),
       );
     };
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier,
@@ -191,7 +181,7 @@ describe('index', () => {
 
   test('verify with kbJwt', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier,
@@ -229,7 +219,7 @@ describe('index', () => {
   });
 
   test('Hasher not found', async () => {
-    const sdjwt = new TestInstance({});
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({});
     try {
       const credential = await sdjwt.issue(
         {
@@ -250,7 +240,7 @@ describe('index', () => {
   });
 
   test('SaltGenerator not found', async () => {
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       hasher: digest,
     });
     try {
@@ -273,7 +263,7 @@ describe('index', () => {
   });
 
   test('Signer not found', async () => {
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       hasher: digest,
       saltGenerator: generateSalt,
     });
@@ -298,7 +288,7 @@ describe('index', () => {
 
   test('Verifier not found', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       hasher: digest,
       saltGenerator: generateSalt,
@@ -338,7 +328,7 @@ describe('index', () => {
 
   test('kbSigner not found', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       verifier,
       hasher: digest,
@@ -376,7 +366,7 @@ describe('index', () => {
 
   test('kbVerifier not found', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       verifier,
       hasher: digest,
@@ -416,7 +406,7 @@ describe('index', () => {
 
   test('kbSignAlg not found', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       verifier,
       hasher: digest,
@@ -440,7 +430,6 @@ describe('index', () => {
     const presentation = sdjwt.present(credential, ['foo'], {
       kb: {
         payload: {
-          sd_hash: 'sha-256',
           aud: '1',
           iat: 1,
           nonce: '342',
@@ -452,8 +441,56 @@ describe('index', () => {
     );
   });
 
-  test('hasher is not found', () => {
-    const sdjwt = new TestInstance({});
+  test('hasher is not found', async () => {
+    const { signer } = createSignerVerifier();
+    const sdjwt_create = new SDJwtInstance<SdJwtPayload>({
+      signer,
+      hasher: digest,
+      saltGenerator: generateSalt,
+      signAlg: 'EdDSA',
+    });
+    const credential = await sdjwt_create.issue(
+      {
+        foo: 'bar',
+        iss: 'Issuer',
+        iat: new Date().getTime(),
+        vct: '',
+      },
+      {
+        _sd: ['foo'],
+      },
+    );
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({});
     expect(sdjwt.keys('')).rejects.toThrow('Hasher not found');
+    expect(sdjwt.presentableKeys('')).rejects.toThrow('Hasher not found');
+    expect(sdjwt.getClaims('')).rejects.toThrow('Hasher not found');
+    expect(() => sdjwt.decode('')).toThrowError('Hasher not found');
+    expect(sdjwt.present(credential, ['foo'])).rejects.toThrow(
+      'Hasher not found',
+    );
+  });
+
+  test('presentableKeys', async () => {
+    const { signer } = createSignerVerifier();
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
+      signer,
+      hasher: digest,
+      saltGenerator: generateSalt,
+      signAlg: 'EdDSA',
+    });
+    const credential = await sdjwt.issue(
+      {
+        foo: 'bar',
+        iss: 'Issuer',
+        iat: new Date().getTime(),
+        vct: '',
+      },
+      {
+        _sd: ['foo'],
+      },
+    );
+    const keys = await sdjwt.presentableKeys(credential);
+    expect(keys).toBeDefined();
+    expect(keys).toEqual(['foo']);
   });
 });

package/test/app-e2e.spec.ts

@@ -1,11 +1,10 @@
 import Crypto from 'node:crypto';
-import { SdJwtPayload } from '../src';
-import { DisclosureFrame, SD, Signer, Verifier } from '@sd-jwt/types';
+import { SDJwtInstance, SdJwtPayload } from '../src';
+import { DisclosureFrame, Signer, Verifier } from '@sd-jwt/types';
 import fs from 'fs';
 import path from 'path';
 import { describe, expect, test } from 'vitest';
 import { digest, generateSalt } from '@sd-jwt/crypto-nodejs';
-import { TestInstance } from '../src/test/index.spec';
 
 export const createSignerVerifier = () => {
   const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
@@ -27,7 +26,7 @@ export const createSignerVerifier = () => {
 describe('App', () => {
   test('Example', async () => {
     const { signer, verifier } = createSignerVerifier();
-    const sdjwt = new TestInstance({
+    const sdjwt = new SDJwtInstance<SdJwtPayload>({
       signer,
       signAlg: 'EdDSA',
       verifier,
@@ -193,7 +192,7 @@ describe('App', () => {
 async function JSONtest(filename: string) {
   const test = loadTestJsonFile(filename);
   const { signer, verifier } = createSignerVerifier();
-  const sdjwt = new TestInstance({
+  const sdjwt = new SDJwtInstance<SdJwtPayload>({
     signer,
     signAlg: 'EdDSA',
     verifier,
@@ -210,7 +209,7 @@ async function JSONtest(filename: string) {
 
   expect(validated).toBeDefined();
   expect(validated).toStrictEqual({
-    header: { alg: 'EdDSA', typ: 'sd-jwt' },
+    header: { alg: 'EdDSA' },
     payload: test.claims,
   });
 
@@ -229,7 +228,7 @@ async function JSONtest(filename: string) {
 
   expect(verified).toBeDefined();
   expect(verified).toStrictEqual({
-    header: { alg: 'EdDSA', typ: 'sd-jwt' },
+    header: { alg: 'EdDSA' },
     payload: test.claims,
   });
 }