@twin.org/web 0.0.1-next.5 → 0.0.1-next.50

package/docs/reference/classes/Jws.md

@@ -0,0 +1,81 @@
+# Class: Jws
+
+Class to handle JSON Web Signatures.
+
+## Constructors
+
+### new Jws()
+
+> **new Jws**(): [`Jws`](Jws.md)
+
+#### Returns
+
+[`Jws`](Jws.md)
+
+## Methods
+
+### create()
+
+> `static` **create**(`privateKey`, `hash`, `algOverride`?): `Promise`\<`string`\>
+
+Create a signature.
+
+#### Parameters
+
+##### privateKey
+
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+The private key to use.
+
+##### hash
+
+`Uint8Array`
+
+The hash to sign.
+
+##### algOverride?
+
+`string`
+
+An optional algorithm override.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The signature.
+
+***
+
+### verify()
+
+> `static` **verify**(`jws`, `publicKey`, `hash`): `Promise`\<`boolean`\>
+
+Verify a signature.
+
+#### Parameters
+
+##### jws
+
+`string`
+
+The signature to verify.
+
+##### publicKey
+
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+The public key to verify the signature with.
+
+##### hash
+
+`Uint8Array`
+
+The hash to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the signature was verified.

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,27 +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`
+##### header
+
+`T`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`U`
 
 The payload to encode.
 
-• **key**: `Uint8Array`
+##### key
+
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 The key for signing the token, can be omitted if a signer is provided.
 
@@ -50,27 +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`
+##### header
+
+`T`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`U`
 
 The payload to encode.
 
-• **signer**
+##### signer
+
+(`header`, `payload`, `key`) => `Promise`\<`string`\>
 
 Custom signer method.
 
@@ -84,230 +96,338 @@ The encoded token.
 
 ### decode()
 
-> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<`object`\>
+> `static` **decode**\<`T`, `U`\>(`token`): `Promise`\<\{ `header`: `T`; `payload`: `U`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
 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
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to decode.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
 The decoded payload.
 
-##### header?
+***
+
+### verify()
+
+> `static` **verify**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+Verify a token.
+
+#### Type Parameters
 
-> `optional` **header**: `U`
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
 
-##### payload?
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
 
-> `optional` **payload**: `T`
+#### Parameters
 
-##### signature?
+##### token
 
-> `optional` **signature**: `Uint8Array`
+`string`
+
+The token to verify.
+
+##### key
+
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+The key for verifying the token
+
+#### Returns
+
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+The decoded payload.
 
 ***
 
-### verify()
+### verifyWithVerifier()
 
-> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<`object`\>
+> `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
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **key**: `Uint8Array`
+##### verifier
 
-The key for verifying the token
+(`token`, `key`) => `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+Custom verification method.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
 The decoded payload.
 
-##### verified
+***
+
+### verifySignature()
+
+> `static` **verifySignature**\<`T`, `U`\>(`token`, `key`?, `verifier`?): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+Verify a token by parts.
+
+#### Type Parameters
+
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+##### token
 
-> **verified**: `boolean`
+`string`
 
-##### header?
+The token to verify.
+
+##### key?
+
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+The key for verifying the token, if not provided no verification occurs.
 
-> `optional` **header**: `U`
+##### verifier?
 
-##### payload?
+(`token`, `key`) => `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
-> `optional` **payload**: `T`
+Custom verification method.
 
-##### signature?
+#### Returns
 
-> `optional` **signature**: `Uint8Array`
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+True if the parts are verified.
 
 ***
 
-### verifyWithVerifier()
+### defaultSigner()
 
-> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<`object`\>
+> `static` **defaultSigner**(`header`, `payload`, `key`): `Promise`\<`string`\>
 
-Verify a token.
+The default signer for the JWT.
+
+#### Parameters
+
+##### header
+
+[`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+The header to sign.
+
+##### payload
+
+[`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+The payload to sign.
+
+##### key
+
+The optional key to sign with.
+
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The signature.
+
+***
+
+### defaultVerifier()
+
+> `static` **defaultVerifier**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+The default verifier for the JWT.
 
 #### 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
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **verifier**
+##### key
 
-Custom verification method.
+The key to verify with.
+
+`undefined` | [`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
-The decoded payload.
+The header and payload if verification successful.
+
+***
 
-##### verified
+### toSigningBytes()
 
-> **verified**: `boolean`
+> `static` **toSigningBytes**\<`T`, `U`\>(`header`, `payload`): `Uint8Array`
 
-##### header?
+Create bytes for signing from header and payload.
 
-> `optional` **header**: `U`
+#### Type Parameters
+
+• **T** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **U** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+##### header
 
-##### payload?
+`T`
 
-> `optional` **payload**: `T`
+The header.
 
-##### signature?
+##### payload
 
-> `optional` **signature**: `Uint8Array`
+`U`
+
+The payload.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes to sign.
 
 ***
 
-### verifySignature()
+### fromSigningBytes()
 
-> `static` **verifySignature**\<`U`, `T`\>(`header`?, `payload`?, `signature`?, `key`?, `verifier`?): `Promise`\<`boolean`\>
+> `static` **fromSigningBytes**\<`T`, `U`\>(`signingBytes`): `object`
 
-Verify a token by parts.
+Create header and payload from signing bytes.
 
 #### 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.
+##### signingBytes
 
-• **payload?**: `T`
+`Uint8Array`
 
-The payload to verify.
+The signing bytes from a token.
 
-• **signature?**: `Uint8Array`
+#### Returns
 
-The signature to verify.
+`object`
 
-• **key?**: `Uint8Array`
+The header and payload.
 
-The key for verifying the token, if not provided no verification occurs.
+##### header
 
-• **verifier?**
+> **header**: `T`
 
-Custom verification method.
+##### payload
 
-#### Returns
+> **payload**: `U`
 
-`Promise`\<`boolean`\>
+#### Throws
 
-True if the parts are verified.
+If the signing bytes are invalid
 
 ***
 
-### defaultSigner()
+### tokenFromBytes()
 
-> `static` **defaultSigner**(`alg`, `key`, `payload`): `Promise`\<`Uint8Array`\>
+> `static` **tokenFromBytes**(`signingBytes`, `signature`): `string`
 
-The default signer for the JWT.
+Convert signed bytes and signature bytes to token.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### signingBytes
 
-The algorithm to use.
+`Uint8Array`
 
-• **key**: `undefined` \| `Uint8Array`
+The signed bytes.
 
-The key to sign with.
+##### signature
 
-• **payload**: `Uint8Array`
+`Uint8Array`
 
-The payload to sign.
+The signature.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`string`
 
-The signature.
+The token.
 
 ***
 
-### defaultVerifier()
+### tokenToBytes()
 
-> `static` **defaultVerifier**(`alg`, `key`, `payload`, `signature`): `Promise`\<`boolean`\>
+> `static` **tokenToBytes**(`token`): `object`
 
-The default verifier for the JWT.
+Convert the token to signing bytes and signature bytes.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### token
 
-The algorithm to use.
+`string`
 
-• **key**: `undefined` \| `Uint8Array`
+The token to convert to bytes.
 
-The key to verify with.
+#### Returns
 
-• **payload**: `Uint8Array`
+`object`
 
-The payload to verify.
+The decoded bytes.
 
-• **signature**: `Uint8Array`
+##### signingBytes
 
-The signature to verify.
+> **signingBytes**: `Uint8Array`
 
-#### Returns
+##### signature
+
+> **signature**: `Uint8Array`
 
-`Promise`\<`boolean`\>
+#### Throws
 
-True if the signature was verified.
+If the token is invalid.

package/docs/reference/classes/MimeTypeHelper.md

@@ -22,7 +22,9 @@ Detect the mime type from a byte array.
 
 #### Parameters
 
-• **data**: `Uint8Array`
+##### data
+
+`Uint8Array`
 
 The data to test.
 
@@ -42,10 +44,12 @@ Return the default extension for a mime type.
 
 #### Parameters
 
-• **mimeType**: `undefined` \| `string`
+##### mimeType
 
 The mimetype to get the extension for.
 
+`undefined` | `string`
+
 #### Returns
 
 `undefined` \| `string`

package/docs/reference/index.md

@@ -4,6 +4,8 @@
 
 - [FetchError](classes/FetchError.md)
 - [FetchHelper](classes/FetchHelper.md)
+- [Jwk](classes/Jwk.md)
+- [Jws](classes/Jws.md)
 - [Jwt](classes/Jwt.md)
 - [MimeTypeHelper](classes/MimeTypeHelper.md)
 
@@ -20,7 +22,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 +30,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/IHttpHeaders.md

@@ -4,4 +4,4 @@ Model used for Http headers parameter.
 
 ## Indexable
 
- \[`key`: `string`\]: `string` \| `string`[]
+\[`key`: `string`\]: `string` \| `string`[]