@sd-jwt/core 0.18.0 → 0.18.1-next.1

package/dist/index.d.mts

@@ -118,6 +118,10 @@ type VerifierOptions = {
      * nonce used to verify the key binding jwt to prevent replay attacks.
      */
     keyBindingNonce?: string;
+    /**
+     * any other custom options
+     */
+    [key: string]: unknown;
 };
 declare class Jwt<Header extends Record<string, unknown> = Record<string, unknown>, Payload extends Record<string, unknown> = Record<string, unknown>> {
     header?: Header;
@@ -143,7 +147,7 @@ declare class Jwt<Header extends Record<string, unknown> = Record<string, unknow
      * @param options - Options for verification, such as current date and skew seconds
      * @returns
      */
-    verify(verifier: Verifier, options?: VerifierOptions): Promise<{
+    verify<T>(verifier: Verifier<T>, options?: T & VerifierOptions): Promise<{
         payload: Payload | undefined;
         header: Header | undefined;
     }>;
@@ -194,11 +198,11 @@ 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 class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload, T = unknown> {
     protected type?: string;
     static readonly DEFAULT_hashAlg = "sha-256";
-    protected userConfig: SDJWTConfig;
-    constructor(userConfig?: SDJWTConfig);
+    protected userConfig: SDJWTConfig<T>;
+    constructor(userConfig?: SDJWTConfig<T>);
     private createKBJwt;
     private SignJwt;
     private VerifyJwt;
@@ -214,7 +218,7 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     present<T extends Record<string, unknown>>(encodedSDJwt: string, presentationFrame?: PresentationFrame<T>, options?: {
         kb?: KBOptions;
     }): Promise<SDJWTCompact>;
-    verify(encodedSDJwt: string, options?: VerifierOptions): Promise<{
+    verify(encodedSDJwt: string, options?: T & VerifierOptions): Promise<{
         payload: unknown;
         header: Record<string, unknown> | undefined;
         kb?: undefined;
@@ -234,7 +238,7 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
      * @param options
      * @returns
      */
-    validate(encodedSDJwt: string, options?: VerifierOptions): Promise<{
+    validate(encodedSDJwt: string, options?: T & VerifierOptions): Promise<{
         payload: unknown;
         header: Record<string, unknown> | undefined;
     }>;

package/dist/index.d.ts

@@ -118,6 +118,10 @@ type VerifierOptions = {
      * nonce used to verify the key binding jwt to prevent replay attacks.
      */
     keyBindingNonce?: string;
+    /**
+     * any other custom options
+     */
+    [key: string]: unknown;
 };
 declare class Jwt<Header extends Record<string, unknown> = Record<string, unknown>, Payload extends Record<string, unknown> = Record<string, unknown>> {
     header?: Header;
@@ -143,7 +147,7 @@ declare class Jwt<Header extends Record<string, unknown> = Record<string, unknow
      * @param options - Options for verification, such as current date and skew seconds
      * @returns
      */
-    verify(verifier: Verifier, options?: VerifierOptions): Promise<{
+    verify<T>(verifier: Verifier<T>, options?: T & VerifierOptions): Promise<{
         payload: Payload | undefined;
         header: Header | undefined;
     }>;
@@ -194,11 +198,11 @@ 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 class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload, T = unknown> {
     protected type?: string;
     static readonly DEFAULT_hashAlg = "sha-256";
-    protected userConfig: SDJWTConfig;
-    constructor(userConfig?: SDJWTConfig);
+    protected userConfig: SDJWTConfig<T>;
+    constructor(userConfig?: SDJWTConfig<T>);
     private createKBJwt;
     private SignJwt;
     private VerifyJwt;
@@ -214,7 +218,7 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     present<T extends Record<string, unknown>>(encodedSDJwt: string, presentationFrame?: PresentationFrame<T>, options?: {
         kb?: KBOptions;
     }): Promise<SDJWTCompact>;
-    verify(encodedSDJwt: string, options?: VerifierOptions): Promise<{
+    verify(encodedSDJwt: string, options?: T & VerifierOptions): Promise<{
         payload: unknown;
         header: Record<string, unknown> | undefined;
         kb?: undefined;
@@ -234,7 +238,7 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
      * @param options
      * @returns
      */
-    validate(encodedSDJwt: string, options?: VerifierOptions): Promise<{
+    validate(encodedSDJwt: string, options?: T & VerifierOptions): Promise<{
         payload: unknown;
         header: Record<string, unknown> | undefined;
     }>;

package/dist/index.js

@@ -340,7 +340,7 @@ var Jwt = class _Jwt {
         throw new import_utils3.SDJWTException("Verify Error: no signature in JWT");
       }
       const data = this.getUnsignedToken();
-      const verified = yield verifier(data, this.signature);
+      const verified = yield verifier(data, this.signature, options);
       if (!verified) {
         throw new import_utils3.SDJWTException("Verify Error: Invalid JWT Signature");
       }

package/dist/index.mjs

@@ -318,7 +318,7 @@ var Jwt = class _Jwt {
         throw new SDJWTException3("Verify Error: no signature in JWT");
       }
       const data = this.getUnsignedToken();
-      const verified = yield verifier(data, this.signature);
+      const verified = yield verifier(data, this.signature, options);
       if (!verified) {
         throw new SDJWTException3("Verify Error: Invalid JWT Signature");
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/core",
-  "version": "0.18.0",
+  "version": "0.18.1-next.1+a11aff6",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -37,13 +37,13 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.18.0"
+    "@sd-jwt/crypto-nodejs": "0.18.1-next.1+a11aff6"
   },
   "dependencies": {
-    "@sd-jwt/decode": "0.18.0",
-    "@sd-jwt/present": "0.18.0",
-    "@sd-jwt/types": "0.18.0",
-    "@sd-jwt/utils": "0.18.0"
+    "@sd-jwt/decode": "0.18.1-next.1+a11aff6",
+    "@sd-jwt/present": "0.18.1-next.1+a11aff6",
+    "@sd-jwt/types": "0.18.1-next.1+a11aff6",
+    "@sd-jwt/utils": "0.18.1-next.1+a11aff6"
   },
   "publishConfig": {
     "access": "public"
@@ -61,5 +61,5 @@
       "esm"
     ]
   },
-  "gitHead": "b22b6bebfa93f6d0f3f998d4503cac0e4534f92a"
+  "gitHead": "a11aff63d3c88139de5dd4fcfe03a25c56a64803"
 }

package/src/index.ts

@@ -32,15 +32,15 @@ export * from './sdjwt';
 
 export type SdJwtPayload = Record<string, unknown>;
 
-export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
+export class SDJwtInstance<ExtendedPayload extends SdJwtPayload, T = unknown> {
   //header type
   protected type?: string;
 
   public static readonly DEFAULT_hashAlg = 'sha-256';
 
-  protected userConfig: SDJWTConfig = {};
+  protected userConfig: SDJWTConfig<T> = {};
 
-  constructor(userConfig?: SDJWTConfig) {
+  constructor(userConfig?: SDJWTConfig<T>) {
     if (userConfig) {
       if (
         userConfig.hashAlg &&
@@ -86,11 +86,11 @@ export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     return jwt;
   }
 
-  private async VerifyJwt(jwt: Jwt, options?: VerifierOptions) {
+  private async VerifyJwt(jwt: Jwt, options?: T & VerifierOptions) {
     if (!this.userConfig.verifier) {
       throw new SDJWTException('Verifier not found');
     }
-    return jwt.verify(this.userConfig.verifier, options);
+    return jwt.verify<T>(this.userConfig.verifier, options);
   }
 
   public async issue<Payload extends ExtendedPayload>(
@@ -196,7 +196,7 @@ export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
   // This function is for verifying the SD JWT
   // If requiredClaimKeys is provided, it will check if the required claim keys are presentation in the SD JWT
   // If requireKeyBindings is true, it will check if the key binding JWT is presentation and verify it
-  public async verify(encodedSDJwt: string, options?: VerifierOptions) {
+  public async verify(encodedSDJwt: string, options?: T & VerifierOptions) {
     if (!this.userConfig.hasher) {
       throw new SDJWTException('Hasher not found');
     }
@@ -280,7 +280,7 @@ export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
    * @param options
    * @returns
    */
-  public async validate(encodedSDJwt: string, options?: VerifierOptions) {
+  public async validate(encodedSDJwt: string, options?: T & VerifierOptions) {
     if (!this.userConfig.hasher) {
       throw new SDJWTException('Hasher not found');
     }

package/src/jwt.ts

@@ -36,6 +36,11 @@ export type VerifierOptions = {
    * nonce used to verify the key binding jwt to prevent replay attacks.
    */
   keyBindingNonce?: string;
+
+  /**
+   * any other custom options
+   */
+  [key: string]: unknown;
 };
 
 // This class is used to create and verify JWT
@@ -146,7 +151,7 @@ export class Jwt<
    * @param options - Options for verification, such as current date and skew seconds
    * @returns
    */
-  public async verify(verifier: Verifier, options?: VerifierOptions) {
+  public async verify<T>(verifier: Verifier<T>, options?: T & VerifierOptions) {
     const skew = options?.skewSeconds ? options.skewSeconds : 0;
     const currentDate = options?.currentDate ?? Math.floor(Date.now() / 1000);
     if (
@@ -174,7 +179,7 @@ export class Jwt<
     }
     const data = this.getUnsignedToken();
 
-    const verified = await verifier(data, this.signature);
+    const verified = await verifier(data, this.signature, options);
     if (!verified) {
       throw new SDJWTException('Verify Error: Invalid JWT Signature');
     }