@sd-jwt/types 0.3.2-next.109 → 0.3.2-next.111

package/dist/index.d.mts

@@ -129,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

@@ -129,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.109+f02d6b0",
+  "version": "0.3.2-next.111+fae0aef",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -53,5 +53,5 @@
       "esm"
     ]
   },
-  "gitHead": "f02d6b093dd8105560ba327c23c0f383e92d31c7"
+  "gitHead": "fae0aefcf7076b31a80cafda42b1ebad2f95ff8c"
 }

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

@@ -154,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>;