@sd-jwt/types 0.3.2-next.99 → 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# 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
+
+* add publish config ([#93](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/93)) ([2e4c5c1](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/2e4c5c176dc88e58e49d06783b7658d8ad872313))
+* format file ([28202b2](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/28202b20daf80225cea0f5415a14b623276c6188))
+* implement kbverify function ([#127](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/127)) ([e5609f2](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/e5609f26fab8c4991d3bd6c36066a95a30cfb972))
+* update type of credential ([63d5ebb](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/63d5ebb4e3e5dd34ae8f82b2ef890a9b2647654f))
+
+
+### Features
+
+* add jwk type ([#130](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/130)) ([8ce255a](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/8ce255a64b0940e92e647aa544bf5990b48279b7))
+* add new package for sd-jwt-vc ([ed99188](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/ed99188f13184d58db64b4211e39fb67f3f78cb5))
+* calcuate sd_hash in kb JWT ([#117](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/117)) ([3415550](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/3415550fbcd99f97babff442a4928cc827c5c9cc))
+* restore rsa type in JWK ([#137](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/137)) ([fe0d8f6](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/fe0d8f6a3249dfea27b08f82165555de389efe1d))

package/dist/index.d.mts

@@ -31,6 +31,31 @@ type kbPayload = {
 type KBOptions = {
     payload: Omit<kbPayload, 'sd_hash'>;
 };
+interface RsaOtherPrimesInfo {
+    d?: string;
+    r?: string;
+    t?: string;
+}
+interface JsonWebKey {
+    alg?: string;
+    crv?: string;
+    d?: string;
+    dp?: string;
+    dq?: string;
+    e?: string;
+    ext?: boolean;
+    k?: string;
+    key_ops?: string[];
+    kty?: string;
+    n?: string;
+    oth?: RsaOtherPrimesInfo[];
+    p?: string;
+    q?: string;
+    qi?: string;
+    use?: string;
+    x?: string;
+    y?: string;
+}
 interface JwtPayload {
     cnf?: {
         jwk: JsonWebKey;
@@ -104,5 +129,52 @@ type Frame<Payload> = Payload extends Array<infer U> ? U extends object ? Record
     [K in keyof Payload]?: Payload[K] extends object ? Frame<Payload[K]> : never;
 } & SD<Payload> & DECOY> : SD<Payload> & DECOY;
 type DisclosureFrame<T extends object> = Frame<T>;
+/**
+ * This is a presentationFrame type that is used to represent the structure of what is being presented.
+ * PresentationFrame is made from the payload type.
+ * const claims = {
+      firstname: 'John',
+      lastname: 'Doe',
+      ssn: '123-45-6789',
+      id: '1234',
+      data: {
+        firstname: 'John',
+        lastname: 'Doe',
+        ssn: '123-45-6789',
+        list: [{ r: 'd' }, 'b', 'c'],
+        list2: ['1', '2', '3'],
+        list3: ['1', null, 2],
+      },
+      data2: {
+        hi: 'bye',
+      },
+    };
+
+  Example of a presentationFrame:
+  const presentationFrame: PresentationFrame<typeof claims> = {
+    firstname: true,
+    lastname: true,
+    ssn: true,
+    id: 'true',
+    data: {
+      firstname: true,
+      list: {
+        1: true,
+        0: {
+          r: true,
+        },
+      },
+      list2: {
+        1: true,
+      },
+      list3: true,
+    },
+    data2: true,
+  };
+*/
+type PFrame<Payload> = Payload extends Array<infer U> ? U extends object ? Record<number, PFrame<U> | boolean> | boolean : Record<number, boolean> | boolean : {
+    [K in keyof Payload]?: Payload[K] extends object ? PFrame<Payload[K]> | boolean : boolean;
+};
+type PresentationFrame<T extends object> = PFrame<T>;
 
-export { type Base64urlString, type DECOY, type DisclosureData, type DisclosureFrame, type Hasher, type HasherAndAlg, type HasherAndAlgSync, type HasherSync, type JwtPayload, type KBOptions, KB_JWT_TYP, type KbVerifier, type OrPromise, type SD, type SDJWTCompact, type SDJWTConfig, SD_DECOY, SD_DIGEST, SD_LIST_KEY, SD_SEPARATOR, type SaltGenerator, type SaltGeneratorSync, type Signer, type SignerSync, type Verifier, type VerifierSync, type kbHeader, type kbPayload };
+export { type Base64urlString, type DECOY, type DisclosureData, type DisclosureFrame, type Hasher, type HasherAndAlg, type HasherAndAlgSync, type HasherSync, type JwtPayload, type KBOptions, KB_JWT_TYP, type KbVerifier, type OrPromise, type PresentationFrame, type SD, type SDJWTCompact, type SDJWTConfig, SD_DECOY, SD_DIGEST, SD_LIST_KEY, SD_SEPARATOR, type SaltGenerator, type SaltGeneratorSync, type Signer, type SignerSync, type Verifier, type VerifierSync, type kbHeader, type kbPayload };

package/dist/index.d.ts

@@ -31,6 +31,31 @@ type kbPayload = {
 type KBOptions = {
     payload: Omit<kbPayload, 'sd_hash'>;
 };
+interface RsaOtherPrimesInfo {
+    d?: string;
+    r?: string;
+    t?: string;
+}
+interface JsonWebKey {
+    alg?: string;
+    crv?: string;
+    d?: string;
+    dp?: string;
+    dq?: string;
+    e?: string;
+    ext?: boolean;
+    k?: string;
+    key_ops?: string[];
+    kty?: string;
+    n?: string;
+    oth?: RsaOtherPrimesInfo[];
+    p?: string;
+    q?: string;
+    qi?: string;
+    use?: string;
+    x?: string;
+    y?: string;
+}
 interface JwtPayload {
     cnf?: {
         jwk: JsonWebKey;
@@ -104,5 +129,52 @@ type Frame<Payload> = Payload extends Array<infer U> ? U extends object ? Record
     [K in keyof Payload]?: Payload[K] extends object ? Frame<Payload[K]> : never;
 } & SD<Payload> & DECOY> : SD<Payload> & DECOY;
 type DisclosureFrame<T extends object> = Frame<T>;
+/**
+ * This is a presentationFrame type that is used to represent the structure of what is being presented.
+ * PresentationFrame is made from the payload type.
+ * const claims = {
+      firstname: 'John',
+      lastname: 'Doe',
+      ssn: '123-45-6789',
+      id: '1234',
+      data: {
+        firstname: 'John',
+        lastname: 'Doe',
+        ssn: '123-45-6789',
+        list: [{ r: 'd' }, 'b', 'c'],
+        list2: ['1', '2', '3'],
+        list3: ['1', null, 2],
+      },
+      data2: {
+        hi: 'bye',
+      },
+    };
+
+  Example of a presentationFrame:
+  const presentationFrame: PresentationFrame<typeof claims> = {
+    firstname: true,
+    lastname: true,
+    ssn: true,
+    id: 'true',
+    data: {
+      firstname: true,
+      list: {
+        1: true,
+        0: {
+          r: true,
+        },
+      },
+      list2: {
+        1: true,
+      },
+      list3: true,
+    },
+    data2: true,
+  };
+*/
+type PFrame<Payload> = Payload extends Array<infer U> ? U extends object ? Record<number, PFrame<U> | boolean> | boolean : Record<number, boolean> | boolean : {
+    [K in keyof Payload]?: Payload[K] extends object ? PFrame<Payload[K]> | boolean : boolean;
+};
+type PresentationFrame<T extends object> = PFrame<T>;
 
-export { type Base64urlString, type DECOY, type DisclosureData, type DisclosureFrame, type Hasher, type HasherAndAlg, type HasherAndAlgSync, type HasherSync, type JwtPayload, type KBOptions, KB_JWT_TYP, type KbVerifier, type OrPromise, type SD, type SDJWTCompact, type SDJWTConfig, SD_DECOY, SD_DIGEST, SD_LIST_KEY, SD_SEPARATOR, type SaltGenerator, type SaltGeneratorSync, type Signer, type SignerSync, type Verifier, type VerifierSync, type kbHeader, type kbPayload };
+export { type Base64urlString, type DECOY, type DisclosureData, type DisclosureFrame, type Hasher, type HasherAndAlg, type HasherAndAlgSync, type HasherSync, type JwtPayload, type KBOptions, KB_JWT_TYP, type KbVerifier, type OrPromise, type PresentationFrame, type SD, type SDJWTCompact, type SDJWTConfig, SD_DECOY, SD_DIGEST, SD_LIST_KEY, SD_SEPARATOR, type SaltGenerator, type SaltGeneratorSync, type Signer, type SignerSync, type Verifier, type VerifierSync, type kbHeader, type kbPayload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/types",
-  "version": "0.3.2-next.99+94f33f1",
+  "version": "0.4.0",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -53,5 +53,5 @@
       "esm"
     ]
   },
-  "gitHead": "94f33f1931393345ad1d0977adad67d407615607"
+  "gitHead": "391a36550a66833b3d393ff0deb699b1b72cca59"
 }

package/src/test/type.spec.ts

@@ -5,8 +5,28 @@ import {
   SD_DIGEST,
   SD_DECOY,
   KB_JWT_TYP,
+  DisclosureFrame,
+  PresentationFrame,
 } from '../index';
 
+const claims = {
+  firstname: 'John',
+  lastname: 'Doe',
+  ssn: '123-45-6789',
+  id: '1234',
+  data: {
+    firstname: 'John',
+    lastname: 'Doe',
+    ssn: '123-45-6789',
+    list: [{ r: 'd' }, 'b', 'c'],
+    list2: ['1', '2', '3'],
+    list3: ['1', null, 2],
+  },
+  data2: {
+    hi: 'bye',
+  },
+};
+
 describe('Variable tests', () => {
   test('SD_SEPARATOR', () => {
     expect(SD_SEPARATOR).toBe('~');
@@ -27,4 +47,42 @@ describe('Variable tests', () => {
   test('KB_JWT_TYP', () => {
     expect(KB_JWT_TYP).toBe('kb+jwt');
   });
+
+  test('DisclosureFrameType test', () => {
+    const disclosureFrame: DisclosureFrame<typeof claims> = {
+      _sd: ['data', 'firstname', 'data2'],
+      data: {
+        _sd: ['list', 'ssn'],
+        _sd_decoy: 2,
+        list: {
+          _sd: [0, 2],
+          0: {
+            _sd: ['r'],
+          },
+        },
+      },
+    };
+    expect(disclosureFrame).toBeDefined();
+  });
+
+  test('PresentationFrameType test', () => {
+    const presentationFrame: PresentationFrame<typeof claims> = {
+      firstname: true,
+      data: {
+        firstname: true,
+        list: {
+          1: true,
+          0: {
+            r: true,
+          },
+        },
+        list2: {
+          1: true,
+        },
+        list3: true,
+      },
+      data2: true,
+    };
+    expect(presentationFrame).toBeDefined();
+  });
 });

package/src/type.ts

@@ -34,6 +34,34 @@ export type KBOptions = {
   payload: Omit<kbPayload, 'sd_hash'>;
 };
 
+// This type declaration is from lib.dom.ts
+interface RsaOtherPrimesInfo {
+  d?: string;
+  r?: string;
+  t?: string;
+}
+
+interface JsonWebKey {
+  alg?: string;
+  crv?: string;
+  d?: string;
+  dp?: string;
+  dq?: string;
+  e?: string;
+  ext?: boolean;
+  k?: string;
+  key_ops?: string[];
+  kty?: string;
+  n?: string;
+  oth?: RsaOtherPrimesInfo[];
+  p?: string;
+  q?: string;
+  qi?: string;
+  use?: string;
+  x?: string;
+  y?: string;
+}
+
 export interface JwtPayload {
   cnf?: {
     jwk: JsonWebKey;
@@ -126,3 +154,58 @@ type Frame<Payload> = Payload extends Array<infer U>
     : SD<Payload> & DECOY;
 
 export type DisclosureFrame<T extends object> = Frame<T>;
+
+/**
+ * This is a presentationFrame type that is used to represent the structure of what is being presented.
+ * PresentationFrame is made from the payload type.
+ * const claims = {
+      firstname: 'John',
+      lastname: 'Doe',
+      ssn: '123-45-6789',
+      id: '1234',
+      data: {
+        firstname: 'John',
+        lastname: 'Doe',
+        ssn: '123-45-6789',
+        list: [{ r: 'd' }, 'b', 'c'],
+        list2: ['1', '2', '3'],
+        list3: ['1', null, 2],
+      },
+      data2: {
+        hi: 'bye',
+      },
+    };
+
+  Example of a presentationFrame:
+  const presentationFrame: PresentationFrame<typeof claims> = {
+    firstname: true,
+    lastname: true,
+    ssn: true,
+    id: 'true',
+    data: {
+      firstname: true,
+      list: {
+        1: true,
+        0: {
+          r: true,
+        },
+      },
+      list2: {
+        1: true,
+      },
+      list3: true,
+    },
+    data2: true,
+  };
+*/
+type PFrame<Payload> = Payload extends Array<infer U>
+  ? U extends object
+    ? Record<number, PFrame<U> | boolean> | boolean
+    : Record<number, boolean> | boolean
+  : {
+      [K in keyof Payload]?: Payload[K] extends object
+        ? PFrame<Payload[K]> | boolean
+        : boolean;
+    };
+
+export type PresentationFrame<T extends object> = PFrame<T>;