@twin.org/web 0.0.1-next.17 → 0.0.1-next.19

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/web - Changelog
 
-## 0.0.1-next.17
+## 0.0.1-next.19
 
 - 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/Jwt.md

@@ -28,15 +28,21 @@ Encode a token.
 
 #### Parameters
 
-• **header**: `U`
+##### header
+
+`U`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`T`
 
 The payload to encode.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for signing the token, can be omitted if a signer is provided.
 
@@ -62,15 +68,21 @@ Encode a token.
 
 #### Parameters
 
-• **header**: `U`
+##### header
+
+`U`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`T`
 
 The payload to encode.
 
-• **signer**
+##### signer
+
+(`alg`, `key`, `payload`) => `Promise`\<`Uint8Array`\>
 
 Custom signer method.
 
@@ -84,7 +96,7 @@ The encoded token.
 
 ### decode()
 
-> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<`object`\>
+> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Decode a token.
 
@@ -96,33 +108,23 @@ Decode a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to decode.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verify()
 
-> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<`object`\>
+> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Verify a token.
 
@@ -134,41 +136,29 @@ Verify a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for verifying the token
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### verified
-
-> **verified**: `boolean`
-
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verifyWithVerifier()
 
-> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<`object`\>
+> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Verify a token.
 
@@ -180,36 +170,24 @@ Verify a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **verifier**
+##### verifier
+
+(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
 
 Custom verification method.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### verified
-
-> **verified**: `boolean`
-
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verifySignature()
@@ -226,23 +204,33 @@ Verify a token by parts.
 
 #### Parameters
 
-• **header?**: `U`
+##### header?
+
+`U`
 
 The header to verify.
 
-• **payload?**: `T`
+##### payload?
+
+`T`
 
 The payload to verify.
 
-• **signature?**: `Uint8Array`
+##### signature?
+
+`Uint8Array`
 
 The signature to verify.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 The key for verifying the token, if not provided no verification occurs.
 
-• **verifier?**
+##### verifier?
+
+(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
 
 Custom verification method.
 
@@ -262,15 +250,21 @@ The default signer for the JWT.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### alg
+
+[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
 
 The algorithm to use.
 
-• **key**: `undefined` \| `Uint8Array`
+##### key
 
 The key to sign with.
 
-• **payload**: `Uint8Array`
+`undefined` | `Uint8Array`
+
+##### payload
+
+`Uint8Array`
 
 The payload to sign.
 
@@ -290,19 +284,27 @@ The default verifier for the JWT.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### alg
+
+[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
 
 The algorithm to use.
 
-• **key**: `undefined` \| `Uint8Array`
+##### key
 
 The key to verify with.
 
-• **payload**: `Uint8Array`
+`undefined` | `Uint8Array`
+
+##### payload
+
+`Uint8Array`
 
 The payload to verify.
 
-• **signature**: `Uint8Array`
+##### signature
+
+`Uint8Array`
 
 The signature to verify.
 

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/interfaces/IHttpHeaders.md

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

package/docs/reference/interfaces/IJwk.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Key.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IJwtHeader.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Token header.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IJwtPayload.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Token payload.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/web",
-	"version": "0.0.1-next.17",
+	"version": "0.0.1-next.19",
 	"description": "Contains classes for use with web operations",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.1-next.17",
-		"@twin.org/crypto": "0.0.1-next.17",
+		"@twin.org/core": "0.0.1-next.19",
+		"@twin.org/crypto": "0.0.1-next.19",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",