@twin.org/web 0.0.1-next.1

package/docs/reference/classes/Jwt.md

@@ -0,0 +1,313 @@
+# Class: Jwt
+
+Class to encode and decode JSON Web Tokens.
+
+## Constructors
+
+### new Jwt()
+
+> **new Jwt**(): [`Jwt`](Jwt.md)
+
+#### Returns
+
+[`Jwt`](Jwt.md)
+
+## Methods
+
+### encode()
+
+> `static` **encode**\<`U`, `T`\>(`header`, `payload`, `key`): `Promise`\<`string`\>
+
+Encode a token.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **header**: `U`
+
+The header to encode.
+
+• **payload**: `T`
+
+The payload to encode.
+
+• **key**: `Uint8Array`
+
+The key for signing the token, can be omitted if a signer is provided.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The encoded token.
+
+***
+
+### encodeWithSigner()
+
+> `static` **encodeWithSigner**\<`U`, `T`\>(`header`, `payload`, `signer`): `Promise`\<`string`\>
+
+Encode a token.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **header**: `U`
+
+The header to encode.
+
+• **payload**: `T`
+
+The payload to encode.
+
+• **signer**
+
+Custom signer method.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The encoded token.
+
+***
+
+### decode()
+
+> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<`object`\>
+
+Decode a token.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **token**: `string`
+
+The token to decode.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The decoded payload.
+
+##### header?
+
+> `optional` **header**: `U`
+
+##### payload?
+
+> `optional` **payload**: `T`
+
+##### signature?
+
+> `optional` **signature**: `Uint8Array`
+
+***
+
+### verify()
+
+> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<`object`\>
+
+Verify a token.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **token**: `string`
+
+The token to verify.
+
+• **key**: `Uint8Array`
+
+The key for verifying the token
+
+#### Returns
+
+`Promise`\<`object`\>
+
+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`\>
+
+Verify a token.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **token**: `string`
+
+The token to verify.
+
+• **verifier**
+
+Custom verification method.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The decoded payload.
+
+##### verified
+
+> **verified**: `boolean`
+
+##### header?
+
+> `optional` **header**: `U`
+
+##### payload?
+
+> `optional` **payload**: `T`
+
+##### signature?
+
+> `optional` **signature**: `Uint8Array`
+
+***
+
+### verifySignature()
+
+> `static` **verifySignature**\<`U`, `T`\>(`header`?, `payload`?, `signature`?, `key`?, `verifier`?): `Promise`\<`boolean`\>
+
+Verify a token by parts.
+
+#### Type Parameters
+
+• **U** *extends* [`IJwtHeader`](../interfaces/IJwtHeader.md)
+
+• **T** *extends* [`IJwtPayload`](../interfaces/IJwtPayload.md)
+
+#### Parameters
+
+• **header?**: `U`
+
+The header to verify.
+
+• **payload?**: `T`
+
+The payload to verify.
+
+• **signature?**: `Uint8Array`
+
+The signature to verify.
+
+• **key?**: `Uint8Array`
+
+The key for verifying the token, if not provided no verification occurs.
+
+• **verifier?**
+
+Custom verification method.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the parts are verified.
+
+***
+
+### defaultSigner()
+
+> `static` **defaultSigner**(`alg`, `key`, `payload`): `Promise`\<`Uint8Array`\>
+
+The default signer for the JWT.
+
+#### Parameters
+
+• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+
+The algorithm to use.
+
+• **key**: `undefined` \| `Uint8Array`
+
+The key to sign with.
+
+• **payload**: `Uint8Array`
+
+The payload to sign.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The signature.
+
+***
+
+### defaultVerifier()
+
+> `static` **defaultVerifier**(`alg`, `key`, `payload`, `signature`): `Promise`\<`boolean`\>
+
+The default verifier for the JWT.
+
+#### Parameters
+
+• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+
+The algorithm to use.
+
+• **key**: `undefined` \| `Uint8Array`
+
+The key to verify with.
+
+• **payload**: `Uint8Array`
+
+The payload to verify.
+
+• **signature**: `Uint8Array`
+
+The signature to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the signature was verified.

package/docs/reference/classes/MimeTypeHelper.md

@@ -0,0 +1,53 @@
+# Class: MimeTypeHelper
+
+Class to help with mime types.
+
+## Constructors
+
+### new MimeTypeHelper()
+
+> **new MimeTypeHelper**(): [`MimeTypeHelper`](MimeTypeHelper.md)
+
+#### Returns
+
+[`MimeTypeHelper`](MimeTypeHelper.md)
+
+## Methods
+
+### detect()
+
+> `static` **detect**(`data`): `Promise`\<`undefined` \| `string`\>
+
+Detect the mime type from a byte array.
+
+#### Parameters
+
+• **data**: `Uint8Array`
+
+The data to test.
+
+#### Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+The mime type if detected.
+
+***
+
+### defaultExtension()
+
+> `static` **defaultExtension**(`mimeType`): `undefined` \| `string`
+
+Return the default extension for a mime type.
+
+#### Parameters
+
+• **mimeType**: `undefined` \| `string`
+
+The mimetype to get the extension for.
+
+#### Returns
+
+`undefined` \| `string`
+
+The extension for the mime type.

package/docs/reference/index.md

@@ -0,0 +1,32 @@
+# @twin.org/web
+
+## Classes
+
+- [FetchError](classes/FetchError.md)
+- [FetchHelper](classes/FetchHelper.md)
+- [Jwt](classes/Jwt.md)
+- [MimeTypeHelper](classes/MimeTypeHelper.md)
+
+## Interfaces
+
+- [IFetchOptions](interfaces/IFetchOptions.md)
+- [IHttpHeaders](interfaces/IHttpHeaders.md)
+- [IJwk](interfaces/IJwk.md)
+- [IJwtHeader](interfaces/IJwtHeader.md)
+- [IJwtPayload](interfaces/IJwtPayload.md)
+
+## Type Aliases
+
+- [HeaderTypes](type-aliases/HeaderTypes.md)
+- [HttpMethod](type-aliases/HttpMethod.md)
+- [HttpStatusCode](type-aliases/HttpStatusCode.md)
+- [JwtAlgorithms](type-aliases/JwtAlgorithms.md)
+- [MimeTypes](type-aliases/MimeTypes.md)
+
+## Variables
+
+- [HeaderTypes](variables/HeaderTypes.md)
+- [HttpMethod](variables/HttpMethod.md)
+- [HttpStatusCode](variables/HttpStatusCode.md)
+- [JwtAlgorithms](variables/JwtAlgorithms.md)
+- [MimeTypes](variables/MimeTypes.md)

package/docs/reference/interfaces/IFetchOptions.md

@@ -0,0 +1,53 @@
+# Interface: IFetchOptions
+
+Options for call to the fetch helper.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: [`IHttpHeaders`](IHttpHeaders.md)
+
+#### Param
+
+The headers for the request.
+
+***
+
+### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Timeout for requests in milliseconds.
+
+***
+
+### includeCredentials?
+
+> `optional` **includeCredentials**: `boolean`
+
+Include credentials in the requests.
+
+***
+
+### retryCount?
+
+> `optional` **retryCount**: `number`
+
+The number of times to retry fetching defaults to no retries.
+
+***
+
+### retryDelayMs?
+
+> `optional` **retryDelayMs**: `number`
+
+The number of milliseconds we should delay before any retry.
+
+***
+
+### cacheTtlMs?
+
+> `optional` **cacheTtlMs**: `number`
+
+The number of milliseconds to cache the response for, leave undefined for no cache, 0 means infinite.

package/docs/reference/interfaces/IHttpHeaders.md

@@ -0,0 +1,7 @@
+# Interface: IHttpHeaders
+
+Model used for Http headers parameter.
+
+## Indexable
+
+ \[`key`: `string`\]: `string` \| `string`[]

package/docs/reference/interfaces/IJwk.md

@@ -0,0 +1,111 @@
+# Interface: IJwk
+
+The fields in a JSON Web Key.
+
+## Indexable
+
+ \[`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.

package/docs/reference/interfaces/IJwtHeader.md

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

package/docs/reference/interfaces/IJwtPayload.md

@@ -0,0 +1,63 @@
+# Interface: IJwtPayload
+
+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.
+
+***
+
+### 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`
+
+The JWT ID.

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

@@ -0,0 +1,5 @@
+# Type Alias: HeaderTypes
+
+> **HeaderTypes**: *typeof* [`HeaderTypes`](../variables/HeaderTypes.md)\[keyof *typeof* [`HeaderTypes`](../variables/HeaderTypes.md)\]
+
+Common http header types.

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

@@ -0,0 +1,5 @@
+# Type Alias: HttpMethod
+
+> **HttpMethod**: *typeof* [`HttpMethod`](../variables/HttpMethod.md)\[keyof *typeof* [`HttpMethod`](../variables/HttpMethod.md)\]
+
+The HTTP Methods.

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

@@ -0,0 +1,5 @@
+# Type Alias: HttpStatusCode
+
+> **HttpStatusCode**: *typeof* [`HttpStatusCode`](../variables/HttpStatusCode.md)\[keyof *typeof* [`HttpStatusCode`](../variables/HttpStatusCode.md)\]
+
+Standard HTTP status codes.

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

@@ -0,0 +1,5 @@
+# Type Alias: JwtAlgorithms
+
+> **JwtAlgorithms**: *typeof* [`JwtAlgorithms`](../variables/JwtAlgorithms.md)\[keyof *typeof* [`JwtAlgorithms`](../variables/JwtAlgorithms.md)\]
+
+The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.

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

@@ -0,0 +1,5 @@
+# Type Alias: MimeTypes
+
+> **MimeTypes**: *typeof* [`MimeTypes`](../variables/MimeTypes.md)\[keyof *typeof* [`MimeTypes`](../variables/MimeTypes.md)\]
+
+Common mime types.