@aligent/microservice-util-lib 1.0.0 → 1.1.0

package/docs/functions/remap.md

@@ -0,0 +1,71 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / remap
+
+# Function: remap()
+
+> **remap**\<`Original`, `MapArray`\>(`object`, `map`): `SimplifyIntersection`\<`ConstructTypeFromProperties`\<`MapArray`, `Original`, `0`\>\>
+
+Defined in: [remap/remap.ts:183](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/remap/remap.ts#L183)
+
+Map one object's values to another structure
+
+## Type Parameters
+
+### Original
+
+`Original` *extends* `object`
+
+### MapArray
+
+`MapArray` *extends* [`ObjectMap`](../type-aliases/ObjectMap.md)
+
+## Parameters
+
+### object
+
+`Original`
+
+the object to map from
+
+### map
+
+`MapArray`
+
+the keys for the mapping
+
+## Returns
+
+`SimplifyIntersection`\<`ConstructTypeFromProperties`\<`MapArray`, `Original`, `0`\>\>
+
+the remapped object
+
+## Examples
+
+```ts
+const map = [
+  ['foo', 'baz'],
+  ['bar', 'qux.0']
+] as const;
+const obj = { foo: 'hi', bar: 7 }
+remap(obj, map); // { baz: 'hi', qux: [7] }
+```
+
+```ts
+const map = [
+ ['foo', 'baz'],
+ ['bar', 'qux.0', (x: number) => x + 1]
+] as const;
+const obj = { foo: 'hi', bar: 7 }
+remap(obj, map); // { baz: 'hi', qux: [8] }
+```
+
+```ts
+const map = [
+  ['', 'baz', (x: { foo: number, bar: number }) => x.foo + x.bar]
+]
+const obj = { foo: 3, bar: 7 }
+remap(obj, map); // { baz: 10 }
+```

package/docs/functions/retryWrapper.md

@@ -0,0 +1,46 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / retryWrapper
+
+# Function: retryWrapper()
+
+> **retryWrapper**\<`T`\>(`fn`, `config`): `Promise`\<`T`\>
+
+Defined in: [retry-wrapper/retry-wrapper.ts:78](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L78)
+
+Retry an async function if it fails
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### fn
+
+() => `Promise`\<`T`\>
+
+the function to be retried
+
+### config
+
+[`RetryConfig`](../interfaces/RetryConfig.md)
+
+the configuration for retries
+
+## Returns
+
+`Promise`\<`T`\>
+
+## Example
+
+```ts
+retryWrapper(someAsyncFunction, {
+  retries: 3,
+  onRetry: (_, error) => console.error(error)
+});
+```

package/docs/interfaces/ApiKey.md

@@ -0,0 +1,44 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / ApiKey
+
+# Interface: ApiKey
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:11](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L11)
+
+Represents an API key authentication method.
+
+This interface is used for API key-based authentication, where the key is sent
+in a specific header. The value of the API key is retrieved asynchronously.
+
+ ApiKey
+
+## Properties
+
+<a id="header"></a>
+
+### header
+
+> **header**: `string`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:12](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L12)
+
+The header name where the API key will be set.
+
+***
+
+<a id="value"></a>
+
+### value()
+
+> **value**: () => `Promise`\<`string`\>
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:13](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L13)
+
+A function that returns a promise resolving to the API key value.
+
+#### Returns
+
+`Promise`\<`string`\>

package/docs/interfaces/Basic.md

@@ -0,0 +1,32 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / Basic
+
+# Interface: Basic
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:25](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L25)
+
+Represents basic authentication credentials.
+
+This interface is used for basic authentication, where the username and password
+are retrieved asynchronously.
+
+ Basic
+
+## Properties
+
+<a id="credentials"></a>
+
+### credentials()
+
+> **credentials**: () => `Promise`\<\{ `password`: `string`; `username`: `string`; \}\>
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:26](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L26)
+
+A function that returns a promise resolving to the username and password.
+
+#### Returns
+
+`Promise`\<\{ `password`: `string`; `username`: `string`; \}\>

package/docs/interfaces/OAuth10a.md

@@ -0,0 +1,93 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / OAuth10a
+
+# Interface: OAuth10a
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:44](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L44)
+
+Represents OAuth 1.0a authentication credentials.
+
+This interface is used for OAuth 1.0a authentication, where the consumer key, consumer secret,
+token, and token secret are retrieved asynchronously. It also supports optional parameters
+like body hash inclusion, realm, callback, and verifier.
+
+ OAuth10a
+
+## Properties
+
+<a id="algorithm"></a>
+
+### algorithm
+
+> **algorithm**: `"HMAC-SHA1"` \| `"HMAC-SHA256"`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:45](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L45)
+
+The signing algorithm to use.
+
+***
+
+<a id="callback"></a>
+
+### callback?
+
+> `optional` **callback**: `string`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:54](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L54)
+
+The callback URL for OAuth 1.0a.
+
+***
+
+<a id="credentials"></a>
+
+### credentials()
+
+> **credentials**: () => `Promise`\<\{ `consumerKey`: `string`; `consumerSecret`: `string`; `token`: `string`; `tokenSecret`: `string`; \}\>
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:46](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L46)
+
+A function that returns a promise resolving to the OAuth 1.0a credentials.
+
+#### Returns
+
+`Promise`\<\{ `consumerKey`: `string`; `consumerSecret`: `string`; `token`: `string`; `tokenSecret`: `string`; \}\>
+
+***
+
+<a id="includebodyhash"></a>
+
+### includeBodyHash?
+
+> `optional` **includeBodyHash**: `boolean` \| `"auto"`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:52](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L52)
+
+Whether to include a body hash in the signature. Defaults to 'auto'.
+
+***
+
+<a id="realm"></a>
+
+### realm?
+
+> `optional` **realm**: `string`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:53](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L53)
+
+The realm parameter for the Authorization header.
+
+***
+
+<a id="verifier"></a>
+
+### verifier?
+
+> `optional` **verifier**: `string`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:55](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L55)
+
+The verifier for OAuth 1.0a.

package/docs/interfaces/OAuth20.md

@@ -0,0 +1,44 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / OAuth20
+
+# Interface: OAuth20
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:68](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L68)
+
+Represents OAuth 2.0 authentication credentials.
+
+This interface is used for OAuth 2.0 authentication, where an access token is retrieved
+asynchronously. It also supports an optional token type (e.g., 'Bearer').
+
+ OAuth20
+
+## Properties
+
+<a id="token"></a>
+
+### token()
+
+> **token**: () => `Promise`\<`string`\>
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:69](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L69)
+
+A function that returns a promise resolving to the access token.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+***
+
+<a id="tokentype"></a>
+
+### tokenType?
+
+> `optional` **tokenType**: `string`
+
+Defined in: [openapi-fetch-middlewares/types/authentications.ts:70](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/types/authentications.ts#L70)
+
+The type of the token (e.g., 'Bearer'). Defaults to 'Bearer' if not specified.

package/docs/interfaces/RetryConfig.md

@@ -1,90 +1,101 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
 [@aligent/microservice-util-lib](../modules.md) / RetryConfig
 
 # Interface: RetryConfig
 
-Configuration for the retryWrapper
+Defined in: [retry-wrapper/retry-wrapper.ts:2](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L2)
 
-## Table of contents
+Configuration for the retryWrapper
 
-### Properties
+## Properties
 
-- [backoffAmount](RetryConfig.md#backoffamount)
-- [delay](RetryConfig.md#delay)
-- [onRetry](RetryConfig.md#onretry)
-- [retries](RetryConfig.md#retries)
+<a id="backoffamount"></a>
 
-## Properties
+### backoffAmount?
 
-### <a id="backoffamount" name="backoffamount"></a> backoffAmount
+> `optional` **backoffAmount**: `number`
 
-• `Optional` **backoffAmount**: `number`
+Defined in: [retry-wrapper/retry-wrapper.ts:17](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L17)
 
 The amount to increase the delay by each retry (in ms)
 
-**`Default`**
+#### Default
 
+```ts
 0
+```
 
-#### Defined in
+***
 
-[retryWrapper/retryWrapper.ts:17](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/retryWrapper/retryWrapper.ts#lines-17)
+<a id="delay"></a>
 
-___
+### delay?
 
-### <a id="delay" name="delay"></a> delay
+> `optional` **delay**: `number`
 
-• `Optional` **delay**: `number`
+Defined in: [retry-wrapper/retry-wrapper.ts:12](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L12)
 
 The base delay between retries (in ms)
 
-**`Default`**
+#### Default
 
+```ts
 0
+```
 
-#### Defined in
+***
 
-[retryWrapper/retryWrapper.ts:12](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/retryWrapper/retryWrapper.ts#lines-12)
+<a id="onretry"></a>
 
-___
+### onRetry()?
 
-### <a id="onretry" name="onretry"></a> onRetry
+> `optional` **onRetry**: (`retries`, `error`, `config`) => `void`
 
-• `Optional` **onRetry**: (`retries`: `number`, `error`: `Error`, `config`: [`RetryConfig`](RetryConfig.md)) => `void`
+Defined in: [retry-wrapper/retry-wrapper.ts:24](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L24)
 
-#### Type declaration
+A callback to run before each retry
 
-▸ (`retries`, `error`, `config`): `void`
+#### Parameters
 
-A callback to run before each retry
+##### retries
 
-##### Parameters
+`number`
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `retries` | `number` | the number of retries so far (will start at 1) |
-| `error` | `Error` | the error from the last attempt |
-| `config` | [`RetryConfig`](RetryConfig.md) | the configuration supplied to the retryWrapper |
+the number of retries so far (will start at 1)
 
-##### Returns
+##### error
+
+`Error`
+
+the error from the last attempt
+
+##### config
+
+`RetryConfig`
+
+the configuration supplied to the retryWrapper
+
+#### Returns
 
 `void`
 
-#### Defined in
+***
 
-[retryWrapper/retryWrapper.ts:24](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/retryWrapper/retryWrapper.ts#lines-24)
+<a id="retries"></a>
 
-___
+### retries?
 
-### <a id="retries" name="retries"></a> retries
+> `optional` **retries**: `number`
 
-• `Optional` **retries**: `number`
+Defined in: [retry-wrapper/retry-wrapper.ts:7](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/retry-wrapper/retry-wrapper.ts#L7)
 
 The number of retries to attempt after the first run
 
-**`Default`**
+#### Default
 
+```ts
 1
-
-#### Defined in
-
-[retryWrapper/retryWrapper.ts:7](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/retryWrapper/retryWrapper.ts#lines-7)
+```