chore: some cleanup and typing improvements (#340)

Signed-off-by: Timo Glastra <timo@animo.id>

Author: TimoGlastra

.github/workflows/build-test-publish-on-push-cached.yaml

@@ -105,9 +105,12 @@ jobs:
           node-version: 20
           cache: 'pnpm'
         # we are not using the github action for biome, but the package.json script. this makes sure we are using the same versions.
-      - name: Run Biome      
+      - name: Run Biome
         run: pnpm run biome:ci
 
+      - name: Run test typecheck
+        run: pnpm run types:check:tests
+
   # Only run this job when the push is on main
   publish:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'

.github/workflows/release.yml

@@ -8,26 +8,26 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-        
+
       - name: Check if user is in CODEOWNERS
         id: check_user
         run: |
-            CODEOWNERS_PATH="CODEOWNERS"
-            if [ ! -f "$CODEOWNERS_PATH" ]; then
-                echo "CODEOWNERS file not found."
-                exit 1            
-            fi
-            
-            # Extract GitHub usernames from CODEOWNERS file (assumes usernames, not emails or teams)
-            USERS=$(grep '@' $CODEOWNERS_PATH | sed -E 's/.*@([^ ]+).*/\1/' | sed 's/://g' | tr '\n' ' ')
-            
-            # Check if the actor is in the list of users
-            if [[ ! " $USERS " =~ " ${{ github.actor }} " ]]; then
-                echo "Error: Actor ${{ github.actor }} is not listed in CODEOWNERS."
-                exit 1
-            else
-                echo "Actor ${{ github.actor }} is listed in CODEOWNERS."
-            fi
+          CODEOWNERS_PATH="CODEOWNERS"
+          if [ ! -f "$CODEOWNERS_PATH" ]; then
+              echo "CODEOWNERS file not found."
+              exit 1            
+          fi
+
+          # Extract GitHub usernames from CODEOWNERS file (assumes usernames, not emails or teams)
+          USERS=$(grep '@' $CODEOWNERS_PATH | sed -E 's/.*@([^ ]+).*/\1/' | sed 's/://g' | tr '\n' ' ')
+
+          # Check if the actor is in the list of users
+          if [[ ! " $USERS " =~ " ${{ github.actor }} " ]]; then
+              echo "Error: Actor ${{ github.actor }} is not listed in CODEOWNERS."
+              exit 1
+          else
+              echo "Actor ${{ github.actor }} is listed in CODEOWNERS."
+          fi
   # we can add an approval stage with the environment so it can only be run when accepted by two authorized users.
   build:
     needs: check-author
@@ -126,10 +126,13 @@ jobs:
           node-version: 20
           cache: 'pnpm'
         # we are not using the github action for biome, but the package.json script. this makes sure we are using the same versions.
-      - name: Run Biome      
+      - name: Run Biome
         run: pnpm run biome:ci
 
-  publish:    
+      - name: Run test typecheck
+        run: pnpm run types:check:tests
+
+  publish:
     # needs permissions to write tags to the repository
     permissions:
       contents: write
@@ -182,5 +185,5 @@ jobs:
           echo "registry=https://registry.npmjs.org/" >> .npmrc
           echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> .npmrc
 
-      - name: 'Publish latest version'        
-        run: pnpm publish:latest
+      - name: 'Publish latest version'
+        run: pnpm publish:latest

biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.2.5/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.3.8/schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",

package.json

@@ -3,15 +3,16 @@
   "description": "sd-jwt implementation in typescript",
   "scripts": {
     "build": "lerna run build --stream",
-    "lint": "biome lint ./packages",
+    "lint": "biome check .",
     "format": "biome format . --write",
     "biome:ci": "biome ci .",
     "test": "vitest run --coverage.enabled=true --coverage.include=packages/*",
     "test:watch": "vitest",
     "clean": "lerna clean -y",
     "publish:latest": "lerna publish --no-private --conventional-commits --include-merged-tags --create-release github --yes --dist-tag latest",
     "publish:next": "lerna publish --no-private --conventional-prerelease --force-publish --canary --no-git-tag-version --include-merged-tags --preid next --pre-dist-tag next --yes",
-    "prepare": "husky"
+    "prepare": "husky",
+    "types:check:tests": "tsc --project tsconfig.test.json"
   },
   "keywords": [
     "sd-jwt",

packages/core/src/test/index.spec.ts

@@ -59,7 +59,7 @@ describe('index', () => {
 
     expect(credential).toBeDefined();
 
-    const presentation = await sdjwt.present<typeof claims>(
+    const presentation = await sdjwt.present(
       credential,
       { foo: true },
       {
@@ -173,7 +173,7 @@ describe('index', () => {
       },
     );
 
-    const presentation = await sdjwt.present<typeof claims>(
+    const presentation = await sdjwt.present(
       credential,
       { foo: true },
       {
@@ -249,7 +249,7 @@ describe('index', () => {
       },
     );
 
-    const presentation = await sdjwt.present<typeof claims>(
+    const presentation = await sdjwt.present(
       credential,
       { foo: true },
       {
@@ -263,7 +263,9 @@ describe('index', () => {
       },
     );
 
-    const results = await sdjwt.verify(presentation, ['foo'], true);
+    const results = await sdjwt.verify(presentation, {
+      requiredClaimKeys: ['foo'],
+    });
     expect(results).toBeDefined();
   });
 
@@ -359,7 +361,7 @@ describe('index', () => {
       },
     );
 
-    const presentation = await sdjwt.present<typeof claims>(
+    const presentation = await sdjwt.present(
       credential,
       { foo: true },
       {
@@ -403,7 +405,7 @@ describe('index', () => {
       },
     );
     try {
-      await sdjwt.present<typeof claims>(
+      await sdjwt.present(
         credential,
         { foo: true },
         {
@@ -445,7 +447,7 @@ describe('index', () => {
       },
     );
 
-    const presentation = await sdjwt.present<typeof claims>(
+    const presentation = await sdjwt.present(
       credential,
       { foo: true },
       {
@@ -488,7 +490,7 @@ describe('index', () => {
       },
     );
 
-    const presentation = sdjwt.present<typeof claims>(
+    const presentation = sdjwt.present(
       credential,
       { foo: true },
       {
@@ -501,7 +503,7 @@ describe('index', () => {
         },
       },
     );
-    expect(presentation).rejects.toThrow(
+    await expect(presentation).rejects.toThrow(
       'Key Binding sign algorithm not specified',
     );
   });
@@ -526,13 +528,13 @@ describe('index', () => {
       },
     );
     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');
+    await expect(sdjwt.keys('')).rejects.toThrow('Hasher not found');
+    await expect(sdjwt.presentableKeys('')).rejects.toThrow('Hasher not found');
+    await expect(sdjwt.getClaims('')).rejects.toThrow('Hasher not found');
     expect(() => sdjwt.decode('')).toThrowError('Hasher not found');
-    expect(
-      sdjwt.present<typeof claims>(credential, { foo: true }),
-    ).rejects.toThrow('Hasher not found');
+    await expect(sdjwt.present(credential, { foo: true })).rejects.toThrow(
+      'Hasher not found',
+    );
   });
 
   test('presentableKeys', async () => {
@@ -581,19 +583,15 @@ describe('index', () => {
       },
     );
 
-    const presentation = await sdjwt.present<typeof claims>(
-      credential,
-      undefined,
-      {
-        kb: {
-          payload: {
-            aud: '1',
-            iat: 1,
-            nonce: '342',
-          },
+    const presentation = await sdjwt.present(credential, undefined, {
+      kb: {
+        payload: {
+          aud: '1',
+          iat: 1,
+          nonce: '342',
         },
       },
-    );
+    });
 
     const decoded = await sdjwt.decode(presentation);
     expect(decoded.jwt).toBeDefined();

packages/core/test/app-e2e.spec.ts

@@ -131,7 +131,7 @@ describe('App', () => {
     });
 
     const requiredClaimKeys = ['firstname', 'id', 'data.ssn'];
-    const verified = await sdjwt.verify(encodedSdjwt, requiredClaimKeys);
+    const verified = await sdjwt.verify(encodedSdjwt, { requiredClaimKeys });
     expect(verified).toBeDefined();
   });
 
@@ -233,9 +233,11 @@ async function JSONtest(filename: string) {
 
   const presentationClaims = await sdjwt.getClaims(presentedSDJwt);
 
-  expect(presentationClaims).toEqual(test.presenatedClaims);
+  expect(presentationClaims).toEqual(test.presentedClaims);
 
-  const verified = await sdjwt.verify(encodedSdjwt, test.requiredClaimKeys);
+  const verified = await sdjwt.verify(encodedSdjwt, {
+    requiredClaimKeys: test.requiredClaimKeys,
+  });
 
   expect(verified).toBeDefined();
   expect(verified).toStrictEqual({
@@ -248,7 +250,7 @@ type TestJson = {
   claims: SdJwtPayload;
   disclosureFrame: DisclosureFrame<SdJwtPayload>;
   presentationFrames: PresentationFrame<SdJwtPayload>;
-  presenatedClaims: object;
+  presentedClaims: object;
   requiredClaimKeys: string[];
 };
 

packages/core/test/array_data_types.json

@@ -17,7 +17,7 @@
       "5": true
     }
   },
-  "presenatedClaims": {
+  "presentedClaims": {
     "data_types": [null, 42, 3.14, "foo", ["Test"], { "foo": "bar" }]
   },
   "requiredClaimKeys": [

packages/core/test/array_full_sd.json

@@ -12,7 +12,7 @@
     }
   },
   "presentationFrames": { "is_over": { "18": true } },
-  "presenatedClaims": {
+  "presentedClaims": {
     "is_over": {
       "18": false
     }

packages/core/test/array_in_sd.json

@@ -6,7 +6,7 @@
     "_sd": ["sd_array"]
   },
   "presentationFrames": { "sd_array": true },
-  "presenatedClaims": {
+  "presentedClaims": {
     "sd_array": ["32", "23"]
   },
   "requiredClaimKeys": ["sd_array"]

packages/core/test/array_nested_in_plain.json

@@ -22,7 +22,7 @@
       }
     }
   },
-  "presenatedClaims": {
+  "presentedClaims": {
     "nested_array": [["foo"], ["qux"]]
   },
   "requiredClaimKeys": ["nested_array.0.0", "nested_array.1.0"]