@twin.org/web 0.0.1-next.9 → 0.0.2-next.3

package/docs/reference/classes/FetchHelper.md

@@ -4,41 +4,51 @@ Class to helper with fetch operations.
 
 ## Constructors
 
-### new FetchHelper()
+### Constructor
 
-> **new FetchHelper**(): [`FetchHelper`](FetchHelper.md)
+> **new FetchHelper**(): `FetchHelper`
 
 #### Returns
 
-[`FetchHelper`](FetchHelper.md)
+`FetchHelper`
 
 ## Methods
 
 ### fetch()
 
-> `static` **fetch**(`source`, `url`, `method`, `body`?, `options`?): `Promise`\<`Response`\>
+> `static` **fetch**(`source`, `url`, `method`, `body?`, `options?`): `Promise`\<`Response`\>
 
 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`\<`ArrayBufferLike`\>
+
+##### options?
+
+`Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
 
 Options for sending the requests.
 
@@ -52,35 +62,49 @@ The response.
 
 ### fetchJson()
 
-> `static` **fetchJson**\<`T`, `U`\>(`source`, `url`, `method`, `requestData`?, `options`?): `Promise`\<`U`\>
+> `static` **fetchJson**\<`T`, `U`\>(`source`, `url`, `method`, `requestData?`, `options?`): `Promise`\<`U`\>
 
 Perform a request in json format.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
-• **U**
+##### U
+
+`U`
 
 #### 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.
 
@@ -94,39 +118,51 @@ The response.
 
 ### fetchBinary()
 
-> `static` **fetchBinary**\<`T`\>(`source`, `url`, `method`, `requestData`?, `options`?): `Promise`\<`Uint8Array` \| `T`\>
+> `static` **fetchBinary**\<`T`\>(`source`, `url`, `method`, `requestData?`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `T`\>
 
 Perform a request for binary data.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### 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`\<`ArrayBufferLike`\>
 
 Request to send to the endpoint.
 
-• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+##### options?
+
+[`IFetchOptions`](../interfaces/IFetchOptions.md)
 
 Options for sending the requests.
 
 #### Returns
 
-`Promise`\<`Uint8Array` \| `T`\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `T`\>
 
 The response.
 
@@ -152,11 +188,15 @@ Get a cache entry.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 
@@ -168,6 +208,40 @@ The cache entry if it exists.
 
 ***
 
+### setCacheEntry()
+
+> `static` **setCacheEntry**\<`T`\>(`url`, `value`): `Promise`\<`void`\>
+
+Set a cache entry.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url for the request.
+
+##### value
+
+`T`
+
+The value to cache.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The cache entry if it exists.
+
+***
+
 ### removeCacheEntry()
 
 > `static` **removeCacheEntry**(`url`): `void`
@@ -176,7 +250,9 @@ Remove a cache entry.
 
 #### Parameters
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url for the request.
 

package/docs/reference/classes/Jwk.md

@@ -0,0 +1,129 @@
+# Class: Jwk
+
+Class to handle JSON Web Keys.
+
+## Constructors
+
+### Constructor
+
+> **new Jwk**(): `Jwk`
+
+#### Returns
+
+`Jwk`
+
+## Methods
+
+### toCryptoKey()
+
+> `static` **toCryptoKey**(`jwk`, `alg?`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+Convert the JWK to a crypto key.
+
+#### Parameters
+
+##### jwk
+
+[`IJwk`](../interfaces/IJwk.md)
+
+The JWK to convert.
+
+##### alg?
+
+`string`
+
+The alg to be used, defaults to jwk.alg.
+
+#### Returns
+
+`Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+The crypto key.
+
+***
+
+### fromEd25519Private()
+
+> `static` **fromEd25519Private**(`privateKey`): `Promise`\<[`IJwk`](../interfaces/IJwk.md)\>
+
+Convert the Ed25519 private key to a crypto key.
+
+#### Parameters
+
+##### privateKey
+
+`Uint8Array`
+
+The private key to use.
+
+#### Returns
+
+`Promise`\<[`IJwk`](../interfaces/IJwk.md)\>
+
+The crypto key.
+
+***
+
+### fromEd25519Public()
+
+> `static` **fromEd25519Public**(`publicKey`): `Promise`\<[`IJwk`](../interfaces/IJwk.md)\>
+
+Convert the Ed25519 public key to a crypto key.
+
+#### Parameters
+
+##### publicKey
+
+`Uint8Array`
+
+The private key to use.
+
+#### Returns
+
+`Promise`\<[`IJwk`](../interfaces/IJwk.md)\>
+
+The crypto key.
+
+***
+
+### toRaw()
+
+> `static` **toRaw**(`jwk`): `Promise`\<\{ `publicKey?`: `Uint8Array`\<`ArrayBufferLike`\>; `privateKey?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
+
+Convert the JWK to raw keys.
+
+#### Parameters
+
+##### jwk
+
+[`IJwk`](../interfaces/IJwk.md)
+
+The JWK to convert to raw.
+
+#### Returns
+
+`Promise`\<\{ `publicKey?`: `Uint8Array`\<`ArrayBufferLike`\>; `privateKey?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
+
+The crypto key.
+
+***
+
+### generateKid()
+
+> `static` **generateKid**(`jwk`): `Promise`\<`string`\>
+
+Generate a KID for the JWK.
+
+#### Parameters
+
+##### jwk
+
+[`IJwk`](../interfaces/IJwk.md)
+
+The JWK to generate a KID for.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The KID.

package/docs/reference/classes/Jws.md

@@ -0,0 +1,81 @@
+# Class: Jws
+
+Class to handle JSON Web Signatures.
+
+## Constructors
+
+### Constructor
+
+> **new Jws**(): `Jws`
+
+#### Returns
+
+`Jws`
+
+## 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.