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

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<U extends IJwtHeader, T extends IJwtPayload>(header: U, payload: T, key: JwkCryptoKey): Promise<string>;
     /**
      * Encode a token.
      * @param header The header to encode.
@@ -20,7 +20,7 @@ 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<U extends IJwtHeader, T extends IJwtPayload>(header: U, payload: T, signer: (alg: string, key: JwkCryptoKey | undefined, header: IJwtHeader, payload: IJwtPayload) => Promise<string>): Promise<string>;
     /**
      * Decode a token.
      * @param token The token to decode.
@@ -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,44 @@ 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.
      * @returns The signature.
      */
-    static defaultSigner(alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array): Promise<Uint8Array>;
+    static defaultSigner(alg: string, key: JwkCryptoKey | undefined, header: IJwtHeader, payload: IJwtPayload): 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;
+    }>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/web - Changelog
 
-## 0.0.1-next.36
+## 0.0.1-next.37
 
 - 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
 
@@ -42,7 +42,7 @@ 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.
 
@@ -82,7 +82,7 @@ The payload to encode.
 
 ##### signer
 
-(`alg`, `key`, `payload`) => `Promise`\<`Uint8Array`\>
+(`alg`, `key`, `header`, `payload`) => `Promise`\<`string`\>
 
 Custom signer method.
 
@@ -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,7 +232,7 @@ True if the parts are verified.
 
 ### defaultSigner()
 
-> `static` **defaultSigner**(`alg`, `key`, `payload`): `Promise`\<`Uint8Array`\>
+> `static` **defaultSigner**(`alg`, `key`, `header`, `payload`): `Promise`\<`string`\>
 
 The default signer for the JWT.
 
@@ -252,7 +240,7 @@ The default signer for the JWT.
 
 ##### alg
 
-[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+`string`
 
 The algorithm to use.
 
@@ -260,17 +248,23 @@ The algorithm to use.
 
 The key to sign with.
 
-`undefined` | `Uint8Array`
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+##### header
+
+[`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+The header to sign.
 
 ##### payload
 
-`Uint8Array`
+[`IJwtPayload`](../interfaces/IJwtPayload.md)
 
 The payload to sign.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`string`\>
 
 The signature.
 
@@ -278,38 +272,32 @@ 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.
 
-#### Parameters
-
-##### alg
+#### Type Parameters
 
-[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-The algorithm to use.
-
-##### key
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
-The key to verify with.
-
-`undefined` | `Uint8Array`
+#### Parameters
 
-##### payload
+##### token
 
-`Uint8Array`
+`string`
 
-The payload to verify.
+The token to verify.
 
-##### signature
+##### key
 
-`Uint8Array`
+The key to verify with.
 
-The signature to verify.
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 True if the signature was verified.

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)

package/docs/reference/interfaces/IJwk.md

@@ -2,110 +2,6 @@
 
 The fields in a JSON Web Key.
 
-## Indexable
+## Extends
 
-\[`key`: `string`\]: `unknown`
-
-## Properties
-
-### alg?
-
-> `optional` **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
-
-The cryptographic algorithm for the key.
-
-***
-
-### use?
-
-> `optional` **use**: `string`
-
-The intended use for the key.
-
-***
-
-### key\_ops?
-
-> `optional` **key\_ops**: `string`[]
-
-The operation(s) that the key is intended to be used for.
-
-***
-
-### kty
-
-> **kty**: `string`
-
-The key type parameter.
-
-***
-
-### n?
-
-> `optional` **n**: `string`
-
-The public key parameters.
-
-***
-
-### e?
-
-> `optional` **e**: `string`
-
-Exponent parameter.
-
-***
-
-### d?
-
-> `optional` **d**: `string`
-
-The private key parameters.
-
-***
-
-### p?
-
-> `optional` **p**: `string`
-
-The private key parameters.
-
-***
-
-### q?
-
-> `optional` **q**: `string`
-
-The private key parameters.
-
-***
-
-### dp?
-
-> `optional` **dp**: `string`
-
-The private key parameters.
-
-***
-
-### dq?
-
-> `optional` **dq**: `string`
-
-The private key parameters.
-
-***
-
-### qi?
-
-> `optional` **qi**: `string`
-
-The private key parameters.
-
-***
-
-### kid?
-
-> `optional` **kid**: `string`
-
-The key ID.
+- `JWK`

package/docs/reference/interfaces/IJwtHeader.md

@@ -2,30 +2,10 @@
 
 The fields in a JSON Web Token header.
 
-## Indexable
-
-\[`key`: `string`\]: `unknown`
-
-## Properties
-
-### typ?
-
-> `optional` **typ**: `string`
-
-The type of the token.
+## Extends
 
-***
+- `JWTHeaderParameters`
 
-### alg
-
-> **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
-
-The algorithm used to sign the token.
-
-***
-
-### kid?
-
-> `optional` **kid**: `string`
+## Indexable
 
-The key ID.
+\[`propName`: `string`\]: `unknown`

package/docs/reference/interfaces/IJwtPayload.md

@@ -2,62 +2,10 @@
 
 The fields in a JSON Web Token payload.
 
-## Indexable
-
-\[`key`: `string`\]: `unknown`
-
-## Properties
-
-### iss?
-
-> `optional` **iss**: `string`
-
-The issuer of the token.
-
-***
-
-### sub?
-
-> `optional` **sub**: `string`
-
-The subject of the token.
-
-***
-
-### aud?
-
-> `optional` **aud**: `string`
-
-The audience of the token.
+## Extends
 
-***
+- `JWTPayload`
 
-### exp?
-
-> `optional` **exp**: `number`
-
-The expiration time of the token.
-
-***
-
-### nbf?
-
-> `optional` **nbf**: `number`
-
-The not before time of the token.
-
-***
-
-### iat?
-
-> `optional` **iat**: `number`
-
-The issued at time of the token.
-
-***
-
-### jti?
-
-> `optional` **jti**: `string`
+## Indexable
 
-The JWT ID.
+\[`propName`: `string`\]: `unknown`

package/docs/reference/type-aliases/JwkCryptoKey.md

@@ -0,0 +1,5 @@
+# Type Alias: JwkCryptoKey
+
+> **JwkCryptoKey**: `CryptoKey` \| `Uint8Array`
+
+The crypto key for a JWK.

package/locales/en.json

@@ -9,7 +9,11 @@
 		},
 		"jwt": {
 			"noKeyOrSigner": "No key or signer was provided for JWT creation",
-			"noKeyOrVerifier": "No key or verifier was provided for JWT creation"
+			"noKeyOrVerifier": "No key or verifier was provided for JWT creation",
+			"verifyFailed": "Failed to verify JWT"
+		},
+		"jwk": {
+			"jwkImportFailed": "Failed to import JWK"
 		}
 	},
 	"errorMessages": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/web",
-	"version": "0.0.1-next.36",
+	"version": "0.0.1-next.37",
 	"description": "Contains classes for use with web operations",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,10 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.1-next.36",
-		"@twin.org/crypto": "0.0.1-next.36",
-		"@twin.org/nameof": "next"
+		"@twin.org/core": "0.0.1-next.37",
+		"@twin.org/crypto": "0.0.1-next.37",
+		"@twin.org/nameof": "next",
+		"jose": "6.0.8"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",

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

@@ -1,17 +0,0 @@
-/**
- * The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.
- */
-export declare const JwtAlgorithms: {
-    /**
-     * HMAC using SHA-256.
-     */
-    readonly HS256: "HS256";
-    /**
-     * EdDSA using Ed25519.
-     */
-    readonly EdDSA: "EdDSA";
-};
-/**
- * The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.
- */
-export type JwtAlgorithms = (typeof JwtAlgorithms)[keyof typeof JwtAlgorithms];