@twin.org/web 0.0.1-next.1

package/dist/types/utils/jwt.d.ts

@@ -0,0 +1,85 @@
+import type { IJwtHeader } from "../models/IJwtHeader";
+import type { IJwtPayload } from "../models/IJwtPayload";
+import { JwtAlgorithms } from "../models/jwtAlgorithms";
+/**
+ * Class to encode and decode JSON Web Tokens.
+ */
+export declare class Jwt {
+    /**
+     * Encode a token.
+     * @param header The header to encode.
+     * @param payload The payload to encode.
+     * @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>;
+    /**
+     * Encode a token.
+     * @param header The header to encode.
+     * @param payload The payload to encode.
+     * @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>;
+    /**
+     * Decode a token.
+     * @param token The token to decode.
+     * @returns The decoded payload.
+     */
+    static decode<U extends IJwtHeader, T extends IJwtPayload>(token: string): Promise<{
+        header?: U;
+        payload?: T;
+        signature?: Uint8Array;
+    }>;
+    /**
+     * Verify a token.
+     * @param token The token to verify.
+     * @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;
+    }>;
+    /**
+     * Verify a token.
+     * @param token The token to verify.
+     * @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;
+    }>;
+    /**
+     * Verify a token by parts.
+     * @param header The header to verify.
+     * @param payload The payload to verify.
+     * @param signature The signature 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>;
+    /**
+     * The default signer for the JWT.
+     * @param alg The algorithm to use.
+     * @param key The key to sign with.
+     * @param payload The payload to sign.
+     * @returns The signature.
+     */
+    static defaultSigner(alg: JwtAlgorithms, key: Uint8Array | undefined, payload: Uint8Array): Promise<Uint8Array>;
+    /**
+     * The default verifier for the JWT.
+     * @param alg The algorithm to use.
+     * @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>;
+}

package/dist/types/utils/mimeTypeHelper.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Class to help with mime types.
+ */
+export declare class MimeTypeHelper {
+    /**
+     * Detect the mime type from a byte array.
+     * @param data The data to test.
+     * @returns The mime type if detected.
+     */
+    static detect(data: Uint8Array): Promise<string | undefined>;
+    /**
+     * Return the default extension for a mime type.
+     * @param mimeType The mimetype to get the extension for.
+     * @returns The extension for the mime type.
+     */
+    static defaultExtension(mimeType: string | undefined): string | undefined;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/web - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/web - Examples

package/docs/reference/classes/FetchError.md

@@ -0,0 +1,379 @@
+# Class: FetchError
+
+Class to represent errors from fetch.
+
+## Extends
+
+- `BaseError`
+
+## Constructors
+
+### new FetchError()
+
+> **new FetchError**(`source`, `message`, `httpStatus`, `properties`?, `inner`?): [`FetchError`](FetchError.md)
+
+Create a new instance of FetchError.
+
+#### Parameters
+
+• **source**: `string`
+
+The source of the error.
+
+• **message**: `string`
+
+The message as a code.
+
+• **httpStatus**: [`HttpStatusCode`](../type-aliases/HttpStatusCode.md)
+
+The http status code.
+
+• **properties?**
+
+Any additional information for the error.
+
+• **inner?**: `unknown`
+
+The inner error if we have wrapped another error.
+
+#### Returns
+
+[`FetchError`](FetchError.md)
+
+#### Overrides
+
+`BaseError.constructor`
+
+## Properties
+
+### source?
+
+> `optional` **source**: `string`
+
+The source of the error.
+
+#### Inherited from
+
+`BaseError.source`
+
+***
+
+### properties?
+
+> `optional` **properties**: `object`
+
+Any additional information for the error.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+#### Inherited from
+
+`BaseError.properties`
+
+***
+
+### inner?
+
+> `optional` **inner**: `IError`
+
+The inner error if there was one.
+
+#### Inherited from
+
+`BaseError.inner`
+
+***
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### fromError()
+
+> `static` **fromError**(`err`): `BaseError`
+
+Construct an error from an existing one.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The existing error.
+
+#### Returns
+
+`BaseError`
+
+The new instance.
+
+#### Inherited from
+
+`BaseError.fromError`
+
+***
+
+### flatten()
+
+> `static` **flatten**(`err`): `IError`[]
+
+Flatten an error tree.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The starting error.
+
+#### Returns
+
+`IError`[]
+
+The list of all internal errors.
+
+#### Inherited from
+
+`BaseError.flatten`
+
+***
+
+### expand()
+
+> `static` **expand**(`errors`): `undefined` \| `IError`
+
+Expand an error tree.
+
+#### Parameters
+
+• **errors**: `undefined` \| `IError`[]
+
+The list of errors to expand.
+
+#### Returns
+
+`undefined` \| `IError`
+
+The first level error.
+
+#### Inherited from
+
+`BaseError.expand`
+
+***
+
+### isErrorName()
+
+> `static` **isErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if the error has the specified error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+`BaseError.isErrorName`
+
+***
+
+### isErrorMessage()
+
+> `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if the error has the specified error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+`BaseError.isErrorMessage`
+
+***
+
+### isErrorCode()
+
+> `static` **isErrorCode**(`error`, `code`): `boolean`
+
+Test to see if the error has the specified error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`boolean`
+
+True if the error has the code.
+
+#### Inherited from
+
+`BaseError.isErrorCode`
+
+***
+
+### someErrorName()
+
+> `static` **someErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+`BaseError.someErrorName`
+
+***
+
+### someErrorMessage()
+
+> `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+`BaseError.someErrorMessage`
+
+***
+
+### someErrorClass()
+
+> `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
+
+Test to see if any of the errors or children are from a specific class.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **cls**: `string`
+
+The class to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the specific class.
+
+#### Inherited from
+
+`BaseError.someErrorClass`
+
+***
+
+### someErrorCode()
+
+> `static` **someErrorCode**(`error`, `code`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+`BaseError.someErrorCode`
+
+***
+
+### toJsonObject()
+
+> **toJsonObject**(): `IError`
+
+Serialize the error to the error model.
+
+#### Returns
+
+`IError`
+
+The error model.
+
+#### Inherited from
+
+`BaseError.toJsonObject`

package/docs/reference/classes/FetchHelper.md

@@ -0,0 +1,185 @@
+# Class: FetchHelper
+
+Class to helper with fetch operations.
+
+## Constructors
+
+### new FetchHelper()
+
+> **new FetchHelper**(): [`FetchHelper`](FetchHelper.md)
+
+#### Returns
+
+[`FetchHelper`](FetchHelper.md)
+
+## Methods
+
+### fetch()
+
+> `static` **fetch**(`source`, `url`, `method`, `body`?, `options`?): `Promise`\<`Response`\>
+
+Perform a fetch request.
+
+#### Parameters
+
+• **source**: `string`
+
+The source for the request.
+
+• **url**: `string`
+
+The url for the request.
+
+• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+
+The http method.
+
+• **body?**: `string` \| `Uint8Array`
+
+Request to send to the endpoint.
+
+• **options?**: `Omit`\<[`IFetchOptions`](../interfaces/IFetchOptions.md), `"cacheTtlSeconds"`\>
+
+Options for sending the requests.
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+The response.
+
+***
+
+### fetchJson()
+
+> `static` **fetchJson**\<`T`, `U`\>(`source`, `url`, `method`, `requestData`?, `options`?): `Promise`\<`U`\>
+
+Perform a request in json format.
+
+#### Type Parameters
+
+• **T**
+
+• **U**
+
+#### Parameters
+
+• **source**: `string`
+
+The source for the request.
+
+• **url**: `string`
+
+The url for the request.
+
+• **method**: [`HttpMethod`](../type-aliases/HttpMethod.md)
+
+The http method.
+
+• **requestData?**: `T`
+
+Request to send to the endpoint.
+
+• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+
+Options for sending the requests.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+The response.
+
+***
+
+### fetchBinary()
+
+> `static` **fetchBinary**\<`T`\>(`source`, `url`, `method`, `requestData`?, `options`?): `Promise`\<`Uint8Array` \| `T`\>
+
+Perform a request for binary data.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **source**: `string`
+
+The source for the request.
+
+• **url**: `string`
+
+The url for the request.
+
+• **method**: `"GET"` \| `"POST"`
+
+The http method.
+
+• **requestData?**: `Uint8Array`
+
+Request to send to the endpoint.
+
+• **options?**: [`IFetchOptions`](../interfaces/IFetchOptions.md)
+
+Options for sending the requests.
+
+#### Returns
+
+`Promise`\<`Uint8Array` \| `T`\>
+
+The response.
+
+***
+
+### clearCache()
+
+> `static` **clearCache**(): `void`
+
+Clears the cache.
+
+#### Returns
+
+`void`
+
+***
+
+### getCacheEntry()
+
+> `static` **getCacheEntry**\<`T`\>(`url`): `Promise`\<`undefined` \| `T`\>
+
+Get a cache entry.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **url**: `string`
+
+The url for the request.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The cache entry if it exists.
+
+***
+
+### removeCacheEntry()
+
+> `static` **removeCacheEntry**(`url`): `void`
+
+Remove a cache entry.
+
+#### Parameters
+
+• **url**: `string`
+
+The url for the request.
+
+#### Returns
+
+`void`