@twin.org/web 0.0.1-next.4 → 0.0.1-next.40

package/dist/types/utils/jwt.d.ts

@@ -1,8 +1,8 @@
 import type { IJwtHeader } from "../models/IJwtHeader";
 import type { IJwtPayload } from "../models/IJwtPayload";
-import { JwtAlgorithms } from "../models/jwtAlgorithms";
+import type { JwkCryptoKey } from "../models/jwkCryptoKey";
 /**
- * Class to encode and decode JSON Web Tokens.
+ * Class to handle JSON Web Tokens.
  */
 export declare class Jwt {
     /**
@@ -12,7 +12,7 @@ export declare class Jwt {
      * @param key The key for signing the token, can be omitted if a signer is provided.
      * @returns The encoded token.
      */
-    static encode<U extends IJwtHeader, T extends IJwtPayload>(header: U, payload: T, key: Uint8Array): Promise<string>;
+    static encode<T extends IJwtHeader, U extends IJwtPayload>(header: T, payload: U, key: JwkCryptoKey): Promise<string>;
     /**
      * Encode a token.
      * @param header The header to encode.
@@ -20,15 +20,15 @@ export declare class Jwt {
      * @param signer Custom signer method.
      * @returns The encoded token.
      */
-    static encodeWithSigner<U extends IJwtHeader, T extends IJwtPayload>(header: U, payload: T, signer: (alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array) => Promise<Uint8Array>): Promise<string>;
+    static encodeWithSigner<T extends IJwtHeader, U extends IJwtPayload>(header: T, payload: U, signer: (header: IJwtHeader, payload: IJwtPayload, key: JwkCryptoKey | undefined) => Promise<string>): Promise<string>;
     /**
      * Decode a token.
      * @param token The token to decode.
      * @returns The decoded payload.
      */
-    static decode<U extends IJwtHeader, T extends IJwtPayload>(token: string): Promise<{
-        header?: U;
-        payload?: T;
+    static decode<T extends IJwtHeader, U extends IJwtPayload>(token: string): Promise<{
+        header?: T;
+        payload?: U;
         signature?: Uint8Array;
     }>;
     /**
@@ -37,11 +37,9 @@ export declare class Jwt {
      * @param key The key for verifying the token
      * @returns The decoded payload.
      */
-    static verify<U extends IJwtHeader, T extends IJwtPayload>(token: string, key: Uint8Array): Promise<{
-        verified: boolean;
-        header?: U;
-        payload?: T;
-        signature?: Uint8Array;
+    static verify<T extends IJwtHeader, U extends IJwtPayload>(token: string, key: JwkCryptoKey): Promise<{
+        header: T;
+        payload: U;
     }>;
     /**
      * Verify a token.
@@ -49,37 +47,77 @@ export declare class Jwt {
      * @param verifier Custom verification method.
      * @returns The decoded payload.
      */
-    static verifyWithVerifier<U extends IJwtHeader, T extends IJwtPayload>(token: string, verifier: (alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array, signature: Uint8Array) => Promise<boolean>): Promise<{
-        verified: boolean;
-        header?: U;
-        payload?: T;
-        signature?: Uint8Array;
+    static verifyWithVerifier<T extends IJwtHeader, U extends IJwtPayload>(token: string, verifier: (token: string, key: JwkCryptoKey | undefined) => Promise<{
+        header: T;
+        payload: U;
+    }>): Promise<{
+        header: T;
+        payload: U;
     }>;
     /**
      * Verify a token by parts.
-     * @param header The header to verify.
-     * @param payload The payload to verify.
-     * @param signature The signature to verify.
+     * @param token The token to verify.
      * @param key The key for verifying the token, if not provided no verification occurs.
      * @param verifier Custom verification method.
      * @returns True if the parts are verified.
      */
-    static verifySignature<U extends IJwtHeader, T extends IJwtPayload>(header?: U, payload?: T, signature?: Uint8Array, key?: Uint8Array, verifier?: (alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array, signature: Uint8Array) => Promise<boolean>): Promise<boolean>;
+    static verifySignature<T extends IJwtHeader, U extends IJwtPayload>(token: string, key?: JwkCryptoKey, verifier?: (token: string, key: JwkCryptoKey | undefined) => Promise<{
+        header: T;
+        payload: U;
+    }>): Promise<{
+        header: T;
+        payload: U;
+    }>;
     /**
      * The default signer for the JWT.
-     * @param alg The algorithm to use.
-     * @param key The key to sign with.
+     * @param header The header to sign.
      * @param payload The payload to sign.
+     * @param key The optional key to sign with.
      * @returns The signature.
      */
-    static defaultSigner(alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array): Promise<Uint8Array>;
+    static defaultSigner(header: IJwtHeader, payload: IJwtPayload, key: JwkCryptoKey | undefined): Promise<string>;
     /**
      * The default verifier for the JWT.
-     * @param alg The algorithm to use.
+     * @param token The token to verify.
      * @param key The key to verify with.
-     * @param payload The payload to verify.
-     * @param signature The signature to verify.
-     * @returns True if the signature was verified.
+     * @returns The header and payload if verification successful.
+     */
+    static defaultVerifier<T extends IJwtHeader, U extends IJwtPayload>(token: string, key: JwkCryptoKey | undefined): Promise<{
+        header: T;
+        payload: U;
+    }>;
+    /**
+     * Create bytes for signing from header and payload.
+     * @param header The header.
+     * @param payload The payload.
+     * @returns The bytes to sign.
+     */
+    static toSigningBytes<T extends IJwtHeader, U extends IJwtPayload>(header: T, payload: U): Uint8Array;
+    /**
+     * Create header and payload from signing bytes.
+     * @param signingBytes The signing bytes from a token.
+     * @returns The header and payload.
+     * @throws If the signing bytes are invalid
+     */
+    static fromSigningBytes<T extends IJwtHeader, U extends IJwtPayload>(signingBytes: Uint8Array): {
+        header: T;
+        payload: U;
+    };
+    /**
+     * Convert signed bytes and signature bytes to token.
+     * @param signingBytes The signed bytes.
+     * @param signature The signature.
+     * @returns The token.
+     */
+    static tokenFromBytes(signingBytes: Uint8Array, signature: Uint8Array): string;
+    /**
+     * Convert the token to signing bytes and signature bytes.
+     * @param token The token to convert to bytes.
+     * @returns The decoded bytes.
+     * @throws If the token is invalid.
      */
-    static defaultVerifier(alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    static tokenToBytes(token: string): {
+        signingBytes: Uint8Array;
+        signature: Uint8Array;
+    };
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/web - Changelog
 
-## 0.0.1-next.4
+## 0.0.1-next.40
 
 - Initial Release

package/docs/reference/classes/FetchError.md

@@ -16,23 +16,31 @@ Create a new instance of FetchError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **httpStatus**: [`HttpStatusCode`](../type-aliases/HttpStatusCode.md)
+##### httpStatus
+
+[`HttpStatusCode`](../type-aliases/HttpStatusCode.md)
 
 The http status code.
 
-• **properties?**
+##### properties?
 
 Any additional information for the error.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 

package/docs/reference/classes/FetchHelper.md

@@ -22,23 +22,33 @@ Perform a fetch request.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source for the request.
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 
-• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+##### method
+
+[`HttpMethod`](../type-aliases/HttpMethod.md)
 
 The http method.
 
-• **body?**: `string` \| `Uint8Array`
+##### body?
 
 Request to send to the endpoint.
 
-• **options?**: `Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
+`string` | `Uint8Array`
+
+##### options?
+
+`Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
 
 Options for sending the requests.
 
@@ -64,23 +74,33 @@ Perform a request in json format.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source for the request.
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 
-• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+##### method
+
+[`HttpMethod`](../type-aliases/HttpMethod.md)
 
 The http method.
 
-• **requestData?**: `T`
+##### requestData?
+
+`T`
 
 Request to send to the endpoint.
 
-• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+##### options?
+
+[`IFetchOptions`](../interfaces/IFetchOptions.md)
 
 Options for sending the requests.
 
@@ -104,23 +124,33 @@ Perform a request for binary data.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source for the request.
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 
-• **method**: `"GET"` \| `"POST"`
+##### method
 
 The http method.
 
-• **requestData?**: `Uint8Array`
+`"GET"` | `"POST"`
+
+##### requestData?
+
+`Uint8Array`
 
 Request to send to the endpoint.
 
-• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+##### options?
+
+[`IFetchOptions`](../interfaces/IFetchOptions.md)
 
 Options for sending the requests.
 
@@ -156,7 +186,9 @@ Get a cache entry.
 
 #### Parameters
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 
@@ -176,7 +208,9 @@ Remove a cache entry.
 
 #### Parameters
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 

package/docs/reference/classes/Jwk.md

@@ -0,0 +1,35 @@
+# Class: Jwk
+
+Class to handle JSON Web Keys.
+
+## Constructors
+
+### new Jwk()
+
+> **new Jwk**(): [`Jwk`](Jwk.md)
+
+#### Returns
+
+[`Jwk`](Jwk.md)
+
+## Methods
+
+### toCryptoKey()
+
+> `static` **toCryptoKey**(`jwk`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+Convert the JWK to a crypto key.
+
+#### Parameters
+
+##### jwk
+
+[`IJwk`](../interfaces/IJwk.md)
+
+The JWK to convert.
+
+#### Returns
+
+`Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+The crypto key.