@aligent/microservice-util-lib 1.0.0 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
 # Microservices Utilities Library
 
-This library includes utility functions to simplify & standardise common 
+This library includes utility functions to simplify & standardise common
 MicroServices tasks.
 
 ## Documentation
@@ -29,7 +29,7 @@ from your project root.
 
 ## Testing & Linting
 
-Jest tests, linting & type-checking can be run with
+Vitest tests, linting & type-checking can be run with
 
 ```sh
 npm run test

package/docs/classes/S3Dao.md

@@ -1,206 +1,201 @@
-[@aligent/microservice-util-lib](../modules.md) / S3Dao
-
-# Class: S3Dao
-
-A data access object for an S3 bucket
-
-## Table of contents
+[**@aligent/microservice-util-lib**](../modules.md)
 
-### Constructors
+***
 
-- [constructor](S3Dao.md#constructor)
-
-### Properties
+[@aligent/microservice-util-lib](../modules.md) / S3Dao
 
-- [bucket](S3Dao.md#bucket)
-- [s3](S3Dao.md#s3)
+# Class: S3Dao
 
-### Methods
+Defined in: [s3/s3.ts:12](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L12)
 
-- [deleteData](S3Dao.md#deletedata)
-- [fetchChunks](S3Dao.md#fetchchunks)
-- [fetchData](S3Dao.md#fetchdata)
-- [storeChunked](S3Dao.md#storechunked)
-- [storeData](S3Dao.md#storedata)
+A data access object for an S3 bucket
 
 ## Constructors
 
-### <a id="constructor" name="constructor"></a> constructor
+<a id="constructor"></a>
 
-• **new S3Dao**(`bucket`)
+### Constructor
 
-#### Parameters
+> **new S3Dao**(`bucket`): `S3Dao`
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `bucket` | `string` | the location of the bucket that objects should be stored in |
+Defined in: [s3/s3.ts:19](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L19)
 
-#### Defined in
-
-[s3/s3.ts:19](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-19)
-
-## Properties
-
-### <a id="bucket" name="bucket"></a> bucket
-
-• `Private` **bucket**: `string`
+#### Parameters
 
-#### Defined in
+##### bucket
 
-[s3/s3.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-14)
+`string`
 
-___
+the location of the bucket that objects should be stored in
 
-### <a id="s3" name="s3"></a> s3
+#### Returns
 
-• `Private` **s3**: `S3Client`
+`S3Dao`
 
-#### Defined in
+## Methods
 
-[s3/s3.ts:13](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-13)
+<a id="deletedata"></a>
 
-## Methods
+### deleteData()
 
-### <a id="deletedata" name="deletedata"></a> deleteData
+> **deleteData**(`objectDetails`): `Promise`\<`DeleteObjectCommandOutput`\>
 
-▸ **deleteData**(`objectDetails`): `Promise`<`DeleteObjectCommandOutput`\>
+Defined in: [s3/s3.ts:100](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L100)
 
 Delete an object from the S3 bucket
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `objectDetails` | `GetObjectCommandInput` | the object to delete |
+##### objectDetails
+
+`GetObjectCommandInput`
+
+the object to delete
 
 #### Returns
 
-`Promise`<`DeleteObjectCommandOutput`\>
+`Promise`\<`DeleteObjectCommandOutput`\>
 
-#### Defined in
+***
 
-[s3/s3.ts:96](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-96)
+<a id="fetchchunks"></a>
 
-___
+### fetchChunks()
 
-### <a id="fetchchunks" name="fetchchunks"></a> fetchChunks
+> **fetchChunks**\<`T`\>(`chunks`): `AsyncGenerator`\<\{ `chunk`: `T`; `s3Object`: `undefined` \| `GetObjectCommandInput`; \}, `Awaited`\<`T`\>, `unknown`\>
 
-▸ **fetchChunks**<`T`\>(`chunks`): `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectCommandInput`  }, `Awaited`<`T`\>, `unknown`\>
+Defined in: [s3/s3.ts:81](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L81)
 
 Generator to fetch chunked data, chunk by chunk
 
-#### Type parameters
+#### Type Parameters
 
-| Name |
-| :------ |
-| `T` |
+##### T
+
+`T`
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `chunks` | `GetObjectCommandInput`[] | the list of object chunks |
+##### chunks
+
+`GetObjectCommandInput`[]
+
+the list of object chunks
 
 #### Returns
 
-`AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectCommandInput`  }, `Awaited`<`T`\>, `unknown`\>
+`AsyncGenerator`\<\{ `chunk`: `T`; `s3Object`: `undefined` \| `GetObjectCommandInput`; \}, `Awaited`\<`T`\>, `unknown`\>
 
-#### Defined in
+***
 
-[s3/s3.ts:77](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-77)
+<a id="fetchdata"></a>
 
-___
+### fetchData()
 
-### <a id="fetchdata" name="fetchdata"></a> fetchData
+> **fetchData**\<`T`\>(`objectDetails`): `Promise`\<`T`\>
 
-▸ **fetchData**<`T`\>(`objectDetails`): `Promise`<`T`\>
+Defined in: [s3/s3.ts:66](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L66)
 
 Fetch an object from the S3 bucket
 
-#### Type parameters
+#### Type Parameters
 
-| Name |
-| :------ |
-| `T` |
+##### T
+
+`T`
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `objectDetails` | `GetObjectCommandInput` | the object which describes the location of the object |
+##### objectDetails
+
+`GetObjectCommandInput`
+
+the object which describes the location of the object
 
 #### Returns
 
-`Promise`<`T`\>
+`Promise`\<`T`\>
 
 the body of the object
 
-#### Defined in
+***
 
-[s3/s3.ts:67](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-67)
+<a id="storechunked"></a>
 
-___
+### storeChunked()
 
-### <a id="storechunked" name="storechunked"></a> storeChunked
+> **storeChunked**\<`T`\>(`data`, `chunkSize`): `Promise`\<`GetObjectCommandInput`[]\>
 
-▸ **storeChunked**<`T`\>(`data`, `chunkSize`): `Promise`<`GetObjectCommandInput`[]\>
+Defined in: [s3/s3.ts:56](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L56)
 
 Store an array of object as individual chunks in S3
 
-#### Type parameters
+#### Type Parameters
+
+##### T
 
-| Name | Type |
-| :------ | :------ |
-| `T` | extends `any`[] |
+`T` *extends* `unknown`[]
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `T` | the data to store |
-| `chunkSize` | `number` | the number of entries that should be in each chunk |
+##### data
+
+`T`
+
+the data to store
+
+##### chunkSize
+
+`number`
+
+the number of entries that should be in each chunk
 
 #### Returns
 
-`Promise`<`GetObjectCommandInput`[]\>
+`Promise`\<`GetObjectCommandInput`[]\>
 
 an array of objects which can be used to fetch the chunks
 
-#### Defined in
+***
 
-[s3/s3.ts:57](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-57)
+<a id="storedata"></a>
 
-___
+### storeData()
 
-### <a id="storedata" name="storedata"></a> storeData
+> **storeData**\<`T`\>(`data`, `name`?): `Promise`\<`GetObjectCommandInput`\>
 
-▸ **storeData**<`T`\>(`data`, `name?`): `Promise`<`GetObjectCommandInput`\>
+Defined in: [s3/s3.ts:30](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/s3/s3.ts#L30)
 
 Store data in an S3 bucket
 
-**`Default`**
+#### Type Parameters
 
-the hash of the data
+##### T
 
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
+`T`
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `T` | the data to store |
-| `name?` | `string` | the name to call the object in S3 |
+##### data
+
+`T`
+
+the data to store
+
+##### name?
+
+`string`
+
+the name to call the object in S3
 
 #### Returns
 
-`Promise`<`GetObjectCommandInput`\>
+`Promise`\<`GetObjectCommandInput`\>
 
 an object which can be used to fetch the data
 
-#### Defined in
+#### Default
 
-[s3/s3.ts:30](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/s3/s3.ts#lines-30)
+```ts
+the hash of the data
+```

package/docs/functions/apiKeyAuthMiddleware.md

@@ -0,0 +1,37 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / apiKeyAuthMiddleware
+
+# Function: apiKeyAuthMiddleware()
+
+> **apiKeyAuthMiddleware**(`config`): `Middleware`
+
+Defined in: [openapi-fetch-middlewares/authentications.ts:18](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/authentications.ts#L18)
+
+Creates an openapi-fetch middleware for API key authentication.
+This middleware sets the API key in the specified header for each request.
+
+## Parameters
+
+### config
+
+[`ApiKey`](../interfaces/ApiKey.md)
+
+The configuration for API key authentication.
+
+## Returns
+
+`Middleware`
+
+The middleware for API key authentication.
+
+## Example
+
+```ts
+const middleware = apiKeyAuthMiddleware({
+    header: 'x-api-key',
+    value: async () => 'your-api-key',
+});
+```

package/docs/functions/basicAuthMiddleware.md

@@ -0,0 +1,37 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / basicAuthMiddleware
+
+# Function: basicAuthMiddleware()
+
+> **basicAuthMiddleware**(`config`): `Middleware`
+
+Defined in: [openapi-fetch-middlewares/authentications.ts:39](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/authentications.ts#L39)
+
+Creates an openapi-fetch middleware for Basic authentication.
+This middleware sets the `Authorization` header with the Basic authentication credentials
+(username and password) for each request.
+
+## Parameters
+
+### config
+
+[`Basic`](../interfaces/Basic.md)
+
+The configuration for Basic authentication.
+
+## Returns
+
+`Middleware`
+
+The middleware for Basic authentication.
+
+## Example
+
+```ts
+const middleware = basicAuthMiddleware({
+    credentials: async () => ({ username: 'user', password: 'pass' }),
+});
+```

package/docs/functions/chunkBy.md

@@ -0,0 +1,43 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / chunkBy
+
+# Function: chunkBy()
+
+> **chunkBy**\<`ArrayItem`\>(`source`, `chunkSize`): `ArrayItem`[][]
+
+Defined in: [chunk-by/chunk-by.ts:10](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/chunk-by/chunk-by.ts#L10)
+
+Split an array into chunks of a certain size
+
+## Type Parameters
+
+### ArrayItem
+
+`ArrayItem`
+
+## Parameters
+
+### source
+
+`ArrayItem`[]
+
+the array to split up
+
+### chunkSize
+
+`number`
+
+the size of each chunk. (The final chunk will be whatever is remaining)
+
+## Returns
+
+`ArrayItem`[][]
+
+## Example
+
+```ts
+chunkBy([1, 2, 3, 4, 5, 6, 7], 2) // [[1, 2], [3, 4], [5, 6], [7]]
+```

package/docs/functions/fetchSsmParams.md

@@ -0,0 +1,61 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / fetchSsmParams
+
+# Function: fetchSsmParams()
+
+Fetch SSM Parameters
+
+## Param
+
+the keys of the parameters to fetch
+
+## Call Signature
+
+> **fetchSsmParams**(`param`): `Promise`\<`undefined` \| `Parameter`\>
+
+Defined in: [fetch-ssm-params/fetch-ssm-params.ts:14](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/fetch-ssm-params/fetch-ssm-params.ts#L14)
+
+Fetch one SSM parameter
+
+### Parameters
+
+#### param
+
+`string`
+
+key of the parameter to fetch
+
+### Returns
+
+`Promise`\<`undefined` \| `Parameter`\>
+
+### Param
+
+the keys of the parameters to fetch
+
+## Call Signature
+
+> **fetchSsmParams**(...`params`): `Promise`\<(`undefined` \| `Parameter`)[]\>
+
+Defined in: [fetch-ssm-params/fetch-ssm-params.ts:20](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/fetch-ssm-params/fetch-ssm-params.ts#L20)
+
+Fetch a list of SSM parameters
+
+### Parameters
+
+#### params
+
+...`string`[]
+
+list of parameter keys to fetch
+
+### Returns
+
+`Promise`\<(`undefined` \| `Parameter`)[]\>
+
+### Param
+
+the keys of the parameters to fetch

package/docs/functions/getAwsIdFromArn.md

@@ -0,0 +1,37 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / getAwsIdFromArn
+
+# Function: getAwsIdFromArn()
+
+> **getAwsIdFromArn**(`resourceArn`): `string`
+
+Defined in: [get-aws-id-from-arn/get-aws-id-from-arn.ts:11](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/get-aws-id-from-arn/get-aws-id-from-arn.ts#L11)
+
+Get the AWS ID from its resource ARN
+
+## Parameters
+
+### resourceArn
+
+`string`
+
+the ARN of the AWS resource
+
+## Returns
+
+`string`
+
+the ID (if present in the ARN) of the AWS resource/execution
+
+## Throws
+
+when the provided ARN is empty
+
+## Example
+
+```ts
+getAwsIdFromArn('arn:aws:states:ap-southeast-2:123123123:execution:prj-int-entity-ac-dc-dev-machine-name:this-is-the-id')
+```

package/docs/functions/hasDefinedProperties.md

@@ -0,0 +1,57 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / hasDefinedProperties
+
+# Function: hasDefinedProperties()
+
+> **hasDefinedProperties**\<`T`, `K`\>(`obj`, ...`keys`): `obj is SimplifyIntersection<Required<Pick<T, K>> & Omit<T, K>>`
+
+Defined in: [has-properties-defined/has-properties-defined.ts:23](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/has-properties-defined/has-properties-defined.ts#L23)
+
+Ensure that the given properties are defined on the object.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### K
+
+`K` *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+### obj
+
+The object to check.
+
+`object` | `T`
+
+### keys
+
+...`K`[]
+
+The keys to check.
+
+## Returns
+
+`obj is SimplifyIntersection<Required<Pick<T, K>> & Omit<T, K>>`
+
+`true` if the object has the given properties defined, `false` otherwise.
+
+## Example
+
+```ts
+type Foo = { a?: number; b?: number };
+const foo: Foo = { a: 1, b: 2 };
+if (hasDefinedProperties(foo, 'a')) {
+  console.log(foo);
+ //          ^? const bar: {
+ //               a: number;
+ //               b?: number;
+ //             }
+}
+```

package/docs/functions/oAuth10aAuthMiddleware.md

@@ -0,0 +1,43 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / oAuth10aAuthMiddleware
+
+# Function: oAuth10aAuthMiddleware()
+
+> **oAuth10aAuthMiddleware**(`config`): `Middleware`
+
+Defined in: [openapi-fetch-middlewares/authentications.ts:71](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/authentications.ts#L71)
+
+Creates an openapi-fetch middleware for OAuth 1.0a authentication.
+This middleware generates OAuth 1.0a parameters and sets the `Authorization` header
+for each request.
+
+## Parameters
+
+### config
+
+[`OAuth10a`](../interfaces/OAuth10a.md)
+
+The configuration for OAuth 1.0a authentication.
+
+## Returns
+
+`Middleware`
+
+The middleware for OAuth 1.0a authentication.
+
+## Example
+
+```ts
+const middleware = oAuth10aAuthMiddleware({
+    algorithm: 'HMAC-SHA256',
+    credentials: async () => ({
+        consumerKey: 'key',
+        consumerSecret: 'secret',
+        token: 'token',
+        tokenSecret: 'tokenSecret',
+    }),
+});
+```

package/docs/functions/oAuth20AuthMiddleware.md

@@ -0,0 +1,37 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / oAuth20AuthMiddleware
+
+# Function: oAuth20AuthMiddleware()
+
+> **oAuth20AuthMiddleware**(`options`): `Middleware`
+
+Defined in: [openapi-fetch-middlewares/authentications.ts:94](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/openapi-fetch-middlewares/authentications.ts#L94)
+
+Creates an openapi-fetch middleware for OAuth 2.0 authentication.
+This middleware sets the `Authorization` header with the OAuth 2.0 token for each request.
+
+## Parameters
+
+### options
+
+[`OAuth20`](../interfaces/OAuth20.md)
+
+The configuration for OAuth 2.0 authentication.
+
+## Returns
+
+`Middleware`
+
+The middleware for OAuth 2.0 authentication.
+
+## Example
+
+```ts
+const middleware = oAuth20AuthMiddleware({
+    token: async () => 'your-access-token',
+    tokenType: 'Bearer',
+});
+```