@twin.org/web 0.0.1-next.36 → 0.0.1-next.38

package/dist/types/models/IJwtPayload.d.ts

@@ -1,37 +1,6 @@
+import type { JWTPayload } from "jose";
 /**
  * The fields in a JSON Web Token payload.
  */
-export interface IJwtPayload {
-    /**
-     * Additional fields in the payload.
-     */
-    [key: string]: unknown;
-    /**
-     * The issuer of the token.
-     */
-    iss?: string;
-    /**
-     * The subject of the token.
-     */
-    sub?: string;
-    /**
-     * The audience of the token.
-     */
-    aud?: string;
-    /**
-     * The expiration time of the token.
-     */
-    exp?: number;
-    /**
-     * The not before time of the token.
-     */
-    nbf?: number;
-    /**
-     * The issued at time of the token.
-     */
-    iat?: number;
-    /**
-     * The JWT ID.
-     */
-    jti?: string;
+export interface IJwtPayload extends JWTPayload {
 }

package/dist/types/models/jwkCryptoKey.d.ts

@@ -0,0 +1,5 @@
+import type { CryptoKey } from "jose";
+/**
+ * The crypto key for a JWK.
+ */
+export type JwkCryptoKey = CryptoKey | Uint8Array;

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

@@ -0,0 +1,13 @@
+import type { IJwk } from "../models/IJwk";
+import type { JwkCryptoKey } from "../models/jwkCryptoKey";
+/**
+ * Class to handle JSON Web Keys.
+ */
+export declare class Jwk {
+    /**
+     * Convert the JWK to a crypto key.
+     * @param jwk The JWK to convert.
+     * @returns The crypto key.
+     */
+    static toCryptoKey(jwk: IJwk): Promise<JwkCryptoKey>;
+}

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,57 @@ 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.
      */
-    static defaultVerifier(alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    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 createSignBytes<T extends IJwtHeader, U extends IJwtPayload>(header: T, payload: U): Uint8Array;
+    /**
+     * Create token from bytes and signature.
+     * @param signedBytes The signed bytes.
+     * @param signature The signature.
+     * @returns The token.
+     */
+    static createTokenFromBytes(signedBytes: Uint8Array, signature: Uint8Array): string;
 }

package/docs/changelog.md

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

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.

package/docs/reference/classes/Jwt.md

@@ -1,6 +1,6 @@
 # Class: Jwt
 
-Class to encode and decode JSON Web Tokens.
+Class to handle JSON Web Tokens.
 
 ## Constructors
 
@@ -16,33 +16,33 @@ Class to encode and decode JSON Web Tokens.
 
 ### encode()
 
-> `static` **encode**\<`U`, `T`\>(`header`, `payload`, `key`): `Promise`\<`string`\>
+> `static` **encode**\<`T`, `U`\>(`header`, `payload`, `key`): `Promise`\<`string`\>
 
 Encode a token.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
 ##### header
 
-`U`
+`T`
 
 The header to encode.
 
 ##### payload
 
-`T`
+`U`
 
 The payload to encode.
 
 ##### key
 
-`Uint8Array`
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 The key for signing the token, can be omitted if a signer is provided.
 
@@ -56,33 +56,33 @@ The encoded token.
 
 ### encodeWithSigner()
 
-> `static` **encodeWithSigner**\<`U`, `T`\>(`header`, `payload`, `signer`): `Promise`\<`string`\>
+> `static` **encodeWithSigner**\<`T`, `U`\>(`header`, `payload`, `signer`): `Promise`\<`string`\>
 
 Encode a token.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
 ##### header
 
-`U`
+`T`
 
 The header to encode.
 
 ##### payload
 
-`T`
+`U`
 
 The payload to encode.
 
 ##### signer
 
-(`alg`, `key`, `payload`) => `Promise`\<`Uint8Array`\>
+(`header`, `payload`, `key`) => `Promise`\<`string`\>
 
 Custom signer method.
 
@@ -96,15 +96,15 @@ The encoded token.
 
 ### decode()
 
-> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+> `static` **decode**\<`T`, `U`\>(`token`): `Promise`\<\{ `header`: `T`; `payload`: `U`; `signature`: `Uint8Array`; \}\>
 
 Decode a token.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
@@ -116,7 +116,7 @@ The token to decode.
 
 #### Returns
 
-`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
@@ -124,15 +124,15 @@ The decoded payload.
 
 ### verify()
 
-> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+> `static` **verify**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 Verify a token.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
@@ -144,13 +144,13 @@ The token to verify.
 
 ##### key
 
-`Uint8Array`
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 The key for verifying the token
 
 #### Returns
 
-`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 The decoded payload.
 
@@ -158,15 +158,15 @@ The decoded payload.
 
 ### verifyWithVerifier()
 
-> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+> `static` **verifyWithVerifier**\<`T`, `U`\>(`token`, `verifier`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 Verify a token.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
@@ -178,13 +178,13 @@ The token to verify.
 
 ##### verifier
 
-(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
+(`token`, `key`) => `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 Custom verification method.
 
 #### Returns
 
-`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 The decoded payload.
 
@@ -192,51 +192,39 @@ The decoded payload.
 
 ### verifySignature()
 
-> `static` **verifySignature**\<`U`, `T`\>(`header`?, `payload`?, `signature`?, `key`?, `verifier`?): `Promise`\<`boolean`\>
+> `static` **verifySignature**\<`T`, `U`\>(`token`, `key`?, `verifier`?): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 Verify a token by parts.
 
 #### Type Parameters
 
-• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 #### Parameters
 
-##### header?
-
-`U`
-
-The header to verify.
-
-##### payload?
-
-`T`
-
-The payload to verify.
-
-##### signature?
+##### token
 
-`Uint8Array`
+`string`
 
-The signature to verify.
+The token to verify.
 
 ##### key?
 
-`Uint8Array`
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 The key for verifying the token, if not provided no verification occurs.
 
 ##### verifier?
 
-(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
+(`token`, `key`) => `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 Custom verification method.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 True if the parts are verified.
 
@@ -244,33 +232,33 @@ True if the parts are verified.
 
 ### defaultSigner()
 
-> `static` **defaultSigner**(`alg`, `key`, `payload`): `Promise`\<`Uint8Array`\>
+> `static` **defaultSigner**(`header`, `payload`, `key`): `Promise`\<`string`\>
 
 The default signer for the JWT.
 
 #### Parameters
 
-##### alg
+##### header
 
-[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+[`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-The algorithm to use.
+The header to sign.
 
-##### key
+##### payload
 
-The key to sign with.
+[`IJwtPayload`](../interfaces/IJwtPayload.md)
 
-`undefined` | `Uint8Array`
+The payload to sign.
 
-##### payload
+##### key
 
-`Uint8Array`
+The optional key to sign with.
 
-The payload to sign.
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`string`\>
 
 The signature.
 
@@ -278,38 +266,94 @@ The signature.
 
 ### defaultVerifier()
 
-> `static` **defaultVerifier**(`alg`, `key`, `payload`, `signature`): `Promise`\<`boolean`\>
+> `static` **defaultVerifier**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 The default verifier for the JWT.
 
+#### Type Parameters
+
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
 #### Parameters
 
-##### alg
+##### token
 
-[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+`string`
 
-The algorithm to use.
+The token to verify.
 
 ##### key
 
 The key to verify with.
 
-`undefined` | `Uint8Array`
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+#### Returns
+
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+True if the signature was verified.
+
+***
+
+### createSignBytes()
+
+> `static` **createSignBytes**\<`T`, `U`\>(`header`, `payload`): `Uint8Array`
+
+Create bytes for signing from header and payload.
+
+#### Type Parameters
+
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+##### header
+
+`T`
+
+The header.
 
 ##### payload
 
+`U`
+
+The payload.
+
+#### Returns
+
 `Uint8Array`
 
-The payload to verify.
+The bytes to sign.
+
+***
+
+### createTokenFromBytes()
+
+> `static` **createTokenFromBytes**(`signedBytes`, `signature`): `string`
+
+Create token from bytes and signature.
+
+#### Parameters
+
+##### signedBytes
+
+`Uint8Array`
+
+The signed bytes.
 
 ##### signature
 
 `Uint8Array`
 
-The signature to verify.
+The signature.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`string`
 
-True if the signature was verified.
+The token.

package/docs/reference/index.md

@@ -4,6 +4,7 @@
 
 - [FetchError](classes/FetchError.md)
 - [FetchHelper](classes/FetchHelper.md)
+- [Jwk](classes/Jwk.md)
 - [Jwt](classes/Jwt.md)
 - [MimeTypeHelper](classes/MimeTypeHelper.md)
 
@@ -20,7 +21,7 @@
 - [HeaderTypes](type-aliases/HeaderTypes.md)
 - [HttpMethod](type-aliases/HttpMethod.md)
 - [HttpStatusCode](type-aliases/HttpStatusCode.md)
-- [JwtAlgorithms](type-aliases/JwtAlgorithms.md)
+- [JwkCryptoKey](type-aliases/JwkCryptoKey.md)
 - [MimeTypes](type-aliases/MimeTypes.md)
 
 ## Variables
@@ -28,5 +29,4 @@
 - [HeaderTypes](variables/HeaderTypes.md)
 - [HttpMethod](variables/HttpMethod.md)
 - [HttpStatusCode](variables/HttpStatusCode.md)
-- [JwtAlgorithms](variables/JwtAlgorithms.md)
 - [MimeTypes](variables/MimeTypes.md)