@sd-jwt/core 0.7.2 → 0.8.1-next.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.8.0](https://github.com/openwallet-foundation-labs/sd-jwt-js/compare/v0.7.2...v0.8.0) (2024-11-26)
+
+
+### Features
+
+* add jws serialization feature ([#253](https://github.com/openwallet-foundation-labs/sd-jwt-js/issues/253)) ([e83b494](https://github.com/openwallet-foundation-labs/sd-jwt-js/commit/e83b4946595d043f56647e6cdc98ad34edf0acde))
+
+
+
+
+
 ## [0.7.2](https://github.com/openwallet-foundation-labs/sd-jwt-js/compare/v0.7.1...v0.7.2) (2024-07-19)
 
 **Note:** Version bump only for package @sd-jwt/core

package/dist/index.d.mts

@@ -59,6 +59,7 @@ declare class SDJwt<Header extends Record<string, unknown> = Record<string, unkn
     }>;
     static fromEncode<Header extends Record<string, unknown> = Record<string, unknown>, Payload extends Record<string, unknown> = Record<string, unknown>, KBHeader extends kbHeader = kbHeader, KBPayload extends kbPayload = kbPayload>(encodedSdJwt: SDJWTCompact, hasher: Hasher): Promise<SDJwt<Header, Payload>>;
     present<T extends Record<string, unknown>>(presentFrame: PresentationFrame<T> | undefined, hasher: Hasher): Promise<SDJWTCompact>;
+    getPresentDisclosures<T extends Record<string, unknown>>(presentFrame: PresentationFrame<T> | undefined, hasher: Hasher): Promise<Disclosure<unknown>[]>;
     encodeSDJwt(): SDJWTCompact;
     keys(hasher: Hasher): Promise<string[]>;
     presentableKeys(hasher: Hasher): Promise<string[]>;
@@ -70,12 +71,101 @@ declare const pack: <T extends Record<string, unknown>>(claims: T, disclosureFra
     disclosures: Array<Disclosure>;
 }>;
 
+type FlattenJSONData = {
+    jwtData: {
+        protected: string;
+        payload: string;
+        signature: string;
+    };
+    disclosures: Array<string>;
+    kb_jwt?: string;
+};
+type FlattenJSONSerialized = {
+    payload: string;
+    signature: string;
+    protected: string;
+    header: {
+        disclosures: Array<string>;
+        kb_jwt?: string;
+    };
+};
+declare class FlattenJSON {
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    payload: string;
+    signature: string;
+    protected: string;
+    constructor(data: FlattenJSONData);
+    static fromEncode(encodedSdJwt: string): FlattenJSON;
+    static fromSerialized(json: FlattenJSONSerialized): FlattenJSON;
+    toJson(): FlattenJSONSerialized;
+    toEncoded(): string;
+}
+
+type GeneralJSONData = {
+    payload: string;
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    signatures: Array<{
+        protected: string;
+        signature: string;
+        kid?: string;
+    }>;
+};
+type GeneralJSONSerialized = {
+    payload: string;
+    signatures: Array<{
+        header: {
+            disclosures?: Array<string>;
+            kid?: string;
+            kb_jwt?: string;
+        };
+        protected: string;
+        signature: string;
+    }>;
+};
+declare class GeneralJSON {
+    payload: string;
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    signatures: Array<{
+        protected: string;
+        signature: string;
+        kid?: string;
+    }>;
+    constructor(data: GeneralJSONData);
+    static fromEncode(encodedSdJwt: string): GeneralJSON;
+    static fromSerialized(json: GeneralJSONSerialized): GeneralJSON;
+    toJson(): {
+        payload: string;
+        signatures: ({
+            header: {
+                kid: string | undefined;
+                disclosures?: undefined;
+                kb_jwt?: undefined;
+            };
+            protected: string;
+            signature: string;
+        } | {
+            header: {
+                disclosures: string[];
+                kid: string | undefined;
+                kb_jwt: string | undefined;
+            };
+            protected: string;
+            signature: string;
+        })[];
+    };
+    toEncoded(index: number): string;
+    addSignature(protectedHeader: Record<string, unknown>, signer: Signer, kid?: string): Promise<void>;
+}
+
 declare const createDecoy: (hash: HasherAndAlg, saltGenerator: SaltGenerator) => Promise<string>;
 
 type SdJwtPayload = Record<string, unknown>;
 declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     protected type?: string;
-    static DEFAULT_hashAlg: string;
+    static readonly DEFAULT_hashAlg = "sha-256";
     protected userConfig: SDJWTConfig;
     constructor(userConfig?: SDJWTConfig);
     private createKBJwt;
@@ -116,6 +206,56 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     keys(endcodedSDJwt: SDJWTCompact): Promise<string[]>;
     presentableKeys(endcodedSDJwt: SDJWTCompact): Promise<string[]>;
     getClaims(endcodedSDJwt: SDJWTCompact): Promise<unknown>;
+    toFlattenJSON(endcodedSDJwt: SDJWTCompact): FlattenJSON;
+    toGeneralJSON(endcodedSDJwt: SDJWTCompact): GeneralJSON;
+}
+declare class SDJwtGeneralJSONInstance<ExtendedPayload extends SdJwtPayload> {
+    protected type?: string;
+    static readonly DEFAULT_hashAlg = "sha-256";
+    protected userConfig: SDJWTConfig;
+    constructor(userConfig?: SDJWTConfig);
+    private createKBJwt;
+    private encodeObj;
+    issue<Payload extends ExtendedPayload>(payload: Payload, disclosureFrame: DisclosureFrame<Payload> | undefined, options: {
+        sigs: Array<{
+            signer: Signer;
+            alg: string;
+            kid: string;
+            header?: Record<string, unknown>;
+        }>;
+    }): Promise<GeneralJSON>;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     * @returns
+     */
+    protected validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
+    present<T extends Record<string, unknown>>(generalJSON: GeneralJSON, presentationFrame?: PresentationFrame<T>, options?: {
+        kb?: KBOptions;
+    }): Promise<GeneralJSON>;
+    verify(generalJSON: GeneralJSON, requiredClaimKeys?: string[], requireKeyBindings?: boolean): Promise<{
+        payload: unknown;
+        headers: any[];
+        kb?: undefined;
+    } | {
+        payload: unknown;
+        headers: any[];
+        kb: {
+            payload: _sd_jwt_types.kbPayload;
+            header: _sd_jwt_types.kbHeader;
+        };
+    }>;
+    private calculateSDHash;
+    validate(generalJSON: GeneralJSON): Promise<{
+        payload: unknown;
+        headers: any[];
+    }>;
+    config(newConfig: SDJWTConfig): void;
+    encode(sdJwt: GeneralJSON, index: number): SDJWTCompact;
+    decode(endcodedSDJwt: SDJWTCompact): GeneralJSON;
+    keys(generalSdjwt: GeneralJSON): Promise<string[]>;
+    presentableKeys(generalSdjwt: GeneralJSON): Promise<string[]>;
+    getClaims(generalSdjwt: GeneralJSON): Promise<unknown>;
 }
 
-export { Jwt, type JwtData, KBJwt, SDJwt, type SDJwtData, SDJwtInstance, type SdJwtPayload, createDecoy, listKeys, pack };
+export { FlattenJSON, type FlattenJSONData, type FlattenJSONSerialized, GeneralJSON, type GeneralJSONData, type GeneralJSONSerialized, Jwt, type JwtData, KBJwt, SDJwt, type SDJwtData, SDJwtGeneralJSONInstance, SDJwtInstance, type SdJwtPayload, createDecoy, listKeys, pack };

package/dist/index.d.ts

@@ -59,6 +59,7 @@ declare class SDJwt<Header extends Record<string, unknown> = Record<string, unkn
     }>;
     static fromEncode<Header extends Record<string, unknown> = Record<string, unknown>, Payload extends Record<string, unknown> = Record<string, unknown>, KBHeader extends kbHeader = kbHeader, KBPayload extends kbPayload = kbPayload>(encodedSdJwt: SDJWTCompact, hasher: Hasher): Promise<SDJwt<Header, Payload>>;
     present<T extends Record<string, unknown>>(presentFrame: PresentationFrame<T> | undefined, hasher: Hasher): Promise<SDJWTCompact>;
+    getPresentDisclosures<T extends Record<string, unknown>>(presentFrame: PresentationFrame<T> | undefined, hasher: Hasher): Promise<Disclosure<unknown>[]>;
     encodeSDJwt(): SDJWTCompact;
     keys(hasher: Hasher): Promise<string[]>;
     presentableKeys(hasher: Hasher): Promise<string[]>;
@@ -70,12 +71,101 @@ declare const pack: <T extends Record<string, unknown>>(claims: T, disclosureFra
     disclosures: Array<Disclosure>;
 }>;
 
+type FlattenJSONData = {
+    jwtData: {
+        protected: string;
+        payload: string;
+        signature: string;
+    };
+    disclosures: Array<string>;
+    kb_jwt?: string;
+};
+type FlattenJSONSerialized = {
+    payload: string;
+    signature: string;
+    protected: string;
+    header: {
+        disclosures: Array<string>;
+        kb_jwt?: string;
+    };
+};
+declare class FlattenJSON {
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    payload: string;
+    signature: string;
+    protected: string;
+    constructor(data: FlattenJSONData);
+    static fromEncode(encodedSdJwt: string): FlattenJSON;
+    static fromSerialized(json: FlattenJSONSerialized): FlattenJSON;
+    toJson(): FlattenJSONSerialized;
+    toEncoded(): string;
+}
+
+type GeneralJSONData = {
+    payload: string;
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    signatures: Array<{
+        protected: string;
+        signature: string;
+        kid?: string;
+    }>;
+};
+type GeneralJSONSerialized = {
+    payload: string;
+    signatures: Array<{
+        header: {
+            disclosures?: Array<string>;
+            kid?: string;
+            kb_jwt?: string;
+        };
+        protected: string;
+        signature: string;
+    }>;
+};
+declare class GeneralJSON {
+    payload: string;
+    disclosures: Array<string>;
+    kb_jwt?: string;
+    signatures: Array<{
+        protected: string;
+        signature: string;
+        kid?: string;
+    }>;
+    constructor(data: GeneralJSONData);
+    static fromEncode(encodedSdJwt: string): GeneralJSON;
+    static fromSerialized(json: GeneralJSONSerialized): GeneralJSON;
+    toJson(): {
+        payload: string;
+        signatures: ({
+            header: {
+                kid: string | undefined;
+                disclosures?: undefined;
+                kb_jwt?: undefined;
+            };
+            protected: string;
+            signature: string;
+        } | {
+            header: {
+                disclosures: string[];
+                kid: string | undefined;
+                kb_jwt: string | undefined;
+            };
+            protected: string;
+            signature: string;
+        })[];
+    };
+    toEncoded(index: number): string;
+    addSignature(protectedHeader: Record<string, unknown>, signer: Signer, kid?: string): Promise<void>;
+}
+
 declare const createDecoy: (hash: HasherAndAlg, saltGenerator: SaltGenerator) => Promise<string>;
 
 type SdJwtPayload = Record<string, unknown>;
 declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     protected type?: string;
-    static DEFAULT_hashAlg: string;
+    static readonly DEFAULT_hashAlg = "sha-256";
     protected userConfig: SDJWTConfig;
     constructor(userConfig?: SDJWTConfig);
     private createKBJwt;
@@ -116,6 +206,56 @@ declare class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
     keys(endcodedSDJwt: SDJWTCompact): Promise<string[]>;
     presentableKeys(endcodedSDJwt: SDJWTCompact): Promise<string[]>;
     getClaims(endcodedSDJwt: SDJWTCompact): Promise<unknown>;
+    toFlattenJSON(endcodedSDJwt: SDJWTCompact): FlattenJSON;
+    toGeneralJSON(endcodedSDJwt: SDJWTCompact): GeneralJSON;
+}
+declare class SDJwtGeneralJSONInstance<ExtendedPayload extends SdJwtPayload> {
+    protected type?: string;
+    static readonly DEFAULT_hashAlg = "sha-256";
+    protected userConfig: SDJWTConfig;
+    constructor(userConfig?: SDJWTConfig);
+    private createKBJwt;
+    private encodeObj;
+    issue<Payload extends ExtendedPayload>(payload: Payload, disclosureFrame: DisclosureFrame<Payload> | undefined, options: {
+        sigs: Array<{
+            signer: Signer;
+            alg: string;
+            kid: string;
+            header?: Record<string, unknown>;
+        }>;
+    }): Promise<GeneralJSON>;
+    /**
+     * Validates if the disclosureFrame contains any reserved fields. If so it will throw an error.
+     * @param disclosureFrame
+     * @returns
+     */
+    protected validateReservedFields<T extends ExtendedPayload>(disclosureFrame: DisclosureFrame<T>): void;
+    present<T extends Record<string, unknown>>(generalJSON: GeneralJSON, presentationFrame?: PresentationFrame<T>, options?: {
+        kb?: KBOptions;
+    }): Promise<GeneralJSON>;
+    verify(generalJSON: GeneralJSON, requiredClaimKeys?: string[], requireKeyBindings?: boolean): Promise<{
+        payload: unknown;
+        headers: any[];
+        kb?: undefined;
+    } | {
+        payload: unknown;
+        headers: any[];
+        kb: {
+            payload: _sd_jwt_types.kbPayload;
+            header: _sd_jwt_types.kbHeader;
+        };
+    }>;
+    private calculateSDHash;
+    validate(generalJSON: GeneralJSON): Promise<{
+        payload: unknown;
+        headers: any[];
+    }>;
+    config(newConfig: SDJWTConfig): void;
+    encode(sdJwt: GeneralJSON, index: number): SDJWTCompact;
+    decode(endcodedSDJwt: SDJWTCompact): GeneralJSON;
+    keys(generalSdjwt: GeneralJSON): Promise<string[]>;
+    presentableKeys(generalSdjwt: GeneralJSON): Promise<string[]>;
+    getClaims(generalSdjwt: GeneralJSON): Promise<unknown>;
 }
 
-export { Jwt, type JwtData, KBJwt, SDJwt, type SDJwtData, SDJwtInstance, type SdJwtPayload, createDecoy, listKeys, pack };
+export { FlattenJSON, type FlattenJSONData, type FlattenJSONSerialized, GeneralJSON, type GeneralJSONData, type GeneralJSONSerialized, Jwt, type JwtData, KBJwt, SDJwt, type SDJwtData, SDJwtGeneralJSONInstance, SDJwtInstance, type SdJwtPayload, createDecoy, listKeys, pack };