@sd-jwt/sd-jwt-vc 0.3.2-next.99 → 0.4.1-next.12

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.4.0 (2024-03-08)
+
+
+### Bug Fixes
+
+* change SDJwtPayload to SdJwtPayload ([9f06ef7](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/9f06ef7bd31a1dff4e9bf988e425200a5e1aa82d))
+* make sdjwt instance non abstract ([#122](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/122)) ([e85aae8](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/e85aae89910f5d9468e29ef14ef3b3d3215b86fd))
+
+
+### Features
+
+* add new package for sd-jwt-vc ([ed99188](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/ed99188f13184d58db64b4211e39fb67f3f78cb5))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/sd-jwt-vc",
-  "version": "0.3.2-next.99+94f33f1",
+  "version": "0.4.1-next.12+eb259c7",
   "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.99+94f33f1"
+    "@sd-jwt/core": "0.4.1-next.12+eb259c7"
   },
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.3.2-next.99+94f33f1",
-    "@sd-jwt/types": "0.3.2-next.99+94f33f1"
+    "@sd-jwt/crypto-nodejs": "0.4.1-next.12+eb259c7",
+    "@sd-jwt/types": "0.4.1-next.12+eb259c7"
   },
   "publishConfig": {
     "access": "public"
@@ -61,5 +61,5 @@
       "esm"
     ]
   },
-  "gitHead": "94f33f1931393345ad1d0977adad67d407615607"
+  "gitHead": "eb259c74a386b0ca867b373f6ffa08b6b6b78d7b"
 }

package/src/index.ts

@@ -1,7 +1,7 @@
 import { SDJwtInstance } from '@sd-jwt/core';
-import { DisclosureFrame } from '@sd-jwt/types';
+import type { DisclosureFrame } from '@sd-jwt/types';
 import { SDJWTException } from '../../utils/dist';
-import { SdJwtVcPayload } from './sd-jwt-vc-payload';
+import type { SdJwtVcPayload } from './sd-jwt-vc-payload';
 
 export { SdJwtVcPayload } from './sd-jwt-vc-payload';
 

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

@@ -1,4 +1,4 @@
-import { SdJwtPayload } from '@sd-jwt/core';
+import type { 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.

package/src/test/index.spec.ts

@@ -1,9 +1,9 @@
 import { digest, generateSalt } from '@sd-jwt/crypto-nodejs';
-import { DisclosureFrame } from '@sd-jwt/types';
+import type { 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';
+import type { SdJwtVcPayload } from '../sd-jwt-vc-payload';
 
 const iss = 'ExampleIssuer';
 const vct = 'https://example.com/schema/1';

package/test/app-e2e.spec.ts

@@ -1,8 +1,13 @@
 import Crypto from 'node:crypto';
 import { SDJwtVcInstance, SdJwtVcPayload } from '../src/index';
-import { DisclosureFrame, Signer, Verifier } from '@sd-jwt/types';
-import fs from 'fs';
-import path from 'path';
+import type {
+  DisclosureFrame,
+  PresentationFrame,
+  Signer,
+  Verifier,
+} from '@sd-jwt/types';
+import fs from 'node:fs';
+import path from 'node:path';
 import { describe, expect, test } from 'vitest';
 import { digest, generateSalt } from '@sd-jwt/crypto-nodejs';
 
@@ -53,6 +58,9 @@ describe('App', () => {
       data2: {
         hi: 'bye',
       },
+      iat,
+      iss,
+      vct,
     };
     const disclosureFrame: DisclosureFrame<typeof claims> = {
       _sd: ['firstname', 'id', 'data2'],
@@ -72,8 +80,7 @@ describe('App', () => {
       },
     };
 
-    const expectedPayload: SdJwtVcPayload = { iat, iss, vct, ...claims };
-    const encodedSdjwt = await sdjwt.issue(expectedPayload, disclosureFrame);
+    const encodedSdjwt = await sdjwt.issue(claims, disclosureFrame);
     expect(encodedSdjwt).toBeDefined();
     const validated = await sdjwt.validate(encodedSdjwt);
     expect(validated).toBeDefined();
@@ -101,7 +108,7 @@ describe('App', () => {
       'vct',
     ]);
     const payloads = await decoded.getClaims(digest);
-    expect(payloads).toEqual(expectedPayload);
+    expect(payloads).toEqual(claims);
     const presentableKeys = await decoded.presentableKeys(digest);
     expect(presentableKeys).toEqual([
       'data.list',
@@ -114,7 +121,10 @@ describe('App', () => {
       'id',
     ]);
 
-    const presentationFrame = ['firstname', 'id'];
+    const presentationFrame = {
+      firstname: true,
+      id: true,
+    };
     const presentedSDJwt = await sdjwt.present(encodedSdjwt, presentationFrame);
     expect(presentedSDJwt).toBeDefined();
 
@@ -228,7 +238,7 @@ async function JSONtest(filename: string) {
 
   const presentedSDJwt = await sdjwt.present(
     encodedSdjwt,
-    test.presentationKeys,
+    test.presentationFrames,
   );
 
   expect(presentedSDJwt).toBeDefined();
@@ -254,7 +264,7 @@ async function JSONtest(filename: string) {
 type TestJson = {
   claims: object;
   disclosureFrame: DisclosureFrame<object>;
-  presentationKeys: string[];
+  presentationFrames: PresentationFrame<object>;
   presenatedClaims: object;
   requiredClaimKeys: string[];
 };

package/test/array_data_types.json

@@ -7,14 +7,16 @@
       "_sd": [0, 1, 2, 3, 4, 5]
     }
   },
-  "presentationKeys": [
-    "data_types.0",
-    "data_types.1",
-    "data_types.2",
-    "data_types.3",
-    "data_types.4",
-    "data_types.5"
-  ],
+  "presentationFrames": {
+    "data_types": {
+      "0": true,
+      "1": true,
+      "2": true,
+      "3": true,
+      "4": true,
+      "5": true
+    }
+  },
   "presenatedClaims": {
     "data_types": [null, 42, 3.14, "foo", ["Test"], { "foo": "bar" }]
   },

package/test/array_full_sd.json

@@ -11,7 +11,7 @@
       "_sd": ["13", "18", "21"]
     }
   },
-  "presentationKeys": ["is_over.18"],
+  "presentationFrames": { "is_over": { "18": true } },
   "presenatedClaims": {
     "is_over": {
       "18": false

package/test/array_in_sd.json

@@ -5,7 +5,7 @@
   "disclosureFrame": {
     "_sd": ["sd_array"]
   },
-  "presentationKeys": ["sd_array"],
+  "presentationFrames": { "sd_array": true },
   "presenatedClaims": {
     "sd_array": ["32", "23"]
   },

package/test/array_nested_in_plain.json

@@ -12,7 +12,16 @@
       }
     }
   },
-  "presentationKeys": ["nested_array.0.0", "nested_array.1.1"],
+  "presentationFrames": {
+    "nested_array": {
+      "0": {
+        "0": true
+      },
+      "1": {
+        "1": true
+      }
+    }
+  },
   "presenatedClaims": {
     "nested_array": [["foo"], ["qux"]]
   },

package/test/array_none_disclosed.json

@@ -11,7 +11,7 @@
       "_sd": ["13", "18", "21"]
     }
   },
-  "presentationKeys": [],
+  "presentationFrames": {},
   "presenatedClaims": {},
   "requiredClaimKeys": []
 }

package/test/array_of_nulls.json

@@ -7,7 +7,7 @@
       "_sd": [1, 2]
     }
   },
-  "presentationKeys": [],
+  "presentationFrames": {},
   "presenatedClaims": {
     "null_values": [null, null]
   },

package/test/array_of_objects.json

@@ -28,7 +28,14 @@
       "_sd": ["foo"]
     }
   },
-  "presentationKeys": ["addresses.1", "array_with_one_sd_object.foo"],
+  "presentationFrames": {
+    "addresses": {
+      "1": true
+    },
+    "array_with_one_sd_object": {
+      "foo": true
+    }
+  },
   "presenatedClaims": {
     "addresses": [
       {

package/test/array_of_scalars.json

@@ -7,7 +7,11 @@
       "_sd": [0, 1]
     }
   },
-  "presentationKeys": ["nationalities.1"],
+  "presentationFrames": {
+    "nationalities": {
+      "1": true
+    }
+  },
   "presenatedClaims": {
     "nationalities": ["CA", "DE"]
   },

package/test/array_recursive_sd.json

@@ -26,7 +26,7 @@
       "_sd": [0, 1]
     }
   },
-  "presentationKeys": [],
+  "presentationFrames": {},
   "presenatedClaims": {
     "array_with_recursive_sd": ["boring", []],
     "test2": []

package/test/array_recursive_sd_some_disclosed.json

@@ -25,12 +25,20 @@
       "_sd": [0, 1]
     }
   },
-  "presentationKeys": [
-    "array_with_recursive_sd.1.baz",
-    "array_with_recursive_sd.2.1",
-    "test2.0",
-    "test2.1"
-  ],
+  "presentationFrames": {
+    "array_with_recursive_sd": {
+      "1": {
+        "baz": true
+      },
+      "2": {
+        "1": true
+      }
+    },
+    "test2": {
+      "0": true,
+      "1": true
+    }
+  },
   "presenatedClaims": {
     "array_with_recursive_sd": [
       "boring",

package/test/complex.json

@@ -31,7 +31,7 @@
       "_sd": ["hi"]
     }
   },
-  "presentationKeys": ["firstname", "id"],
+  "presentationFrames": { "firstname": true, "id": true },
   "presenatedClaims": {
     "lastname": "Doe",
     "ssn": "123-45-6789",

package/test/header_mod.json

@@ -24,7 +24,11 @@
       "birthdate"
     ]
   },
-  "presentationKeys": ["given_name", "family_name", "address"],
+  "presentationFrames": {
+    "given_name": true,
+    "family_name": true,
+    "address": true
+  },
   "presenatedClaims": {
     "given_name": "John",
     "family_name": "Deo",

package/test/json_serialization.json

@@ -24,7 +24,11 @@
       "birthdate"
     ]
   },
-  "presentationKeys": ["given_name", "family_name", "address"],
+  "presentationFrames": {
+    "given_name": true,
+    "family_name": true,
+    "address": true
+  },
   "presenatedClaims": {
     "given_name": "John",
     "family_name": "Deo",

package/test/key_binding.json

@@ -24,7 +24,11 @@
       "birthdate"
     ]
   },
-  "presentationKeys": ["given_name", "family_name", "address"],
+  "presentationFrames": {
+    "given_name": true,
+    "family_name": true,
+    "address": true
+  },
   "presenatedClaims": {
     "given_name": "John",
     "family_name": "Deo",

package/test/no_sd.json

@@ -13,7 +13,7 @@
     "test2": ["foo", "bar"]
   },
   "disclosureFrame": {},
-  "presentationKeys": [],
+  "presentationFrames": {},
   "presenatedClaims": {
     "recursive": [
       "boring",

package/test/object_data_types.json

@@ -25,15 +25,17 @@
       ]
     }
   },
-  "presentationKeys": [
-    "value_Data_types.test_null",
-    "value_Data_types.test_int",
-    "value_Data_types.test_float",
-    "value_Data_types.test_str",
-    "value_Data_types.test_bool",
-    "value_Data_types.test_arr",
-    "value_Data_types.test_object"
-  ],
+  "presentationFrames": {
+    "value_Data_types": {
+      "test_null": true,
+      "test_int": true,
+      "test_float": true,
+      "test_str": true,
+      "test_bool": true,
+      "test_arr": true,
+      "test_object": true
+    }
+  },
   "presenatedClaims": {
     "value_Data_types": {
       "test_null": null,

package/test/recursions.json

@@ -50,23 +50,42 @@
       }
     }
   },
-  "presentationKeys": [
-    "foo.1",
-    "bar.green",
-    "qux.0",
-    "qux.0.0",
-    "qux.0.1",
-    "baz.0",
-    "baz.0.0",
-    "baz.0.1",
-    "baz.1",
-    "baz.1.0",
-    "baz.1.1",
-    "animals.snake",
-    "animals.snake.age",
-    "animals.bird",
-    "animals.bird.age"
-  ],
+  "presentationFrames": {
+    "foo": {
+      "1": true
+    },
+    "bar": {
+      "green": true
+    },
+    "qux": {
+      "0": {
+        "0": true,
+        "1": true
+      },
+      "1": {
+        "0": true,
+        "1": true
+      }
+    },
+    "baz": {
+      "0": {
+        "0": true,
+        "1": true
+      },
+      "1": {
+        "0": true,
+        "1": true
+      }
+    },
+    "animals": {
+      "snake": {
+        "age": true
+      },
+      "bird": {
+        "age": true
+      }
+    }
+  },
   "presenatedClaims": {
     "foo": ["two"],
     "bar": {