@aligent/microservice-util-lib 0.1.1 → 0.1.3

package/docs/classes/S3Dao.md

@@ -0,0 +1,206 @@
+[@aligent/microservice-util-lib](../modules.md) / S3Dao
+
+# Class: S3Dao
+
+A data access object for an S3 bucket
+
+## Table of contents
+
+### Constructors
+
+- [constructor](S3Dao.md#constructor)
+
+### Properties
+
+- [bucket](S3Dao.md#bucket)
+- [s3](S3Dao.md#s3)
+
+### Methods
+
+- [deleteData](S3Dao.md#deletedata)
+- [fetchChunks](S3Dao.md#fetchchunks)
+- [fetchData](S3Dao.md#fetchdata)
+- [storeChunked](S3Dao.md#storechunked)
+- [storeData](S3Dao.md#storedata)
+
+## Constructors
+
+### <a id="constructor" name="constructor"></a> constructor
+
+• **new S3Dao**(`bucket`)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `bucket` | `string` | the location of the bucket that objects should be stored in |
+
+#### Defined in
+
+[s3/s3.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-14)
+
+## Properties
+
+### <a id="bucket" name="bucket"></a> bucket
+
+• `Private` **bucket**: `string`
+
+#### Defined in
+
+[s3/s3.ts:9](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-9)
+
+___
+
+### <a id="s3" name="s3"></a> s3
+
+• `Private` **s3**: `S3`
+
+#### Defined in
+
+[s3/s3.ts:8](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-8)
+
+## Methods
+
+### <a id="deletedata" name="deletedata"></a> deleteData
+
+▸ **deleteData**(`objectDetails`): `Promise`<`PromiseResult`<`DeleteObjectOutput`, `AWSError`\>\>
+
+Delete an object from the S3 bucket
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `objectDetails` | `GetObjectRequest` | the object to delete |
+
+#### Returns
+
+`Promise`<`PromiseResult`<`DeleteObjectOutput`, `AWSError`\>\>
+
+#### Defined in
+
+[s3/s3.ts:90](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-90)
+
+___
+
+### <a id="fetchchunks" name="fetchchunks"></a> fetchChunks
+
+▸ **fetchChunks**<`T`\>(`chunks`): `AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectRequest`  }, { `chunk`: `T` ; `s3Object`: `GetObjectRequest`  }, `unknown`\>
+
+Generator to fetch chunked data, chunk by chunk
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `chunks` | `GetObjectRequest`[] | the list of object chunks |
+
+#### Returns
+
+`AsyncGenerator`<{ `chunk`: `T` ; `s3Object`: `GetObjectRequest`  }, { `chunk`: `T` ; `s3Object`: `GetObjectRequest`  }, `unknown`\>
+
+#### Defined in
+
+[s3/s3.ts:70](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-70)
+
+___
+
+### <a id="fetchdata" name="fetchdata"></a> fetchData
+
+▸ **fetchData**<`T`\>(`objectDetails`): `Promise`<`T`\>
+
+Fetch an object from the S3 bucket
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `objectDetails` | `GetObjectRequest` | the object which describes the location of the object |
+
+#### Returns
+
+`Promise`<`T`\>
+
+the body of the object
+
+#### Defined in
+
+[s3/s3.ts:61](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-61)
+
+___
+
+### <a id="storechunked" name="storechunked"></a> storeChunked
+
+▸ **storeChunked**<`T`\>(`data`, `chunkSize`): `Promise`<`GetObjectRequest`[]\>
+
+Store an array of object as individual chunks in S3
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends `any`[] |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `T` | the data to store |
+| `chunkSize` | `number` | the number of entries that should be in each chunk |
+
+#### Returns
+
+`Promise`<`GetObjectRequest`[]\>
+
+an array of objects which can be used to fetch the chunks
+
+#### Defined in
+
+[s3/s3.ts:51](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-51)
+
+___
+
+### <a id="storedata" name="storedata"></a> storeData
+
+▸ **storeData**<`T`\>(`data`, `name?`): `Promise`<`GetObjectRequest`\>
+
+Store data in an S3 bucket
+
+**`Default`**
+
+the hash of the data
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `T` | the data to store |
+| `name?` | `string` | the name to call the object in S3 |
+
+#### Returns
+
+`Promise`<`GetObjectRequest`\>
+
+an object which can be used to fetch the data
+
+#### Defined in
+
+[s3/s3.ts:25](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/s3/s3.ts#lines-25)

package/docs/interfaces/RetryConfig.md

@@ -0,0 +1,90 @@
+[@aligent/microservice-util-lib](../modules.md) / RetryConfig
+
+# Interface: RetryConfig
+
+Configuration for the retryWrapper
+
+## Table of contents
+
+### Properties
+
+- [backoffAmount](RetryConfig.md#backoffamount)
+- [delay](RetryConfig.md#delay)
+- [onRetry](RetryConfig.md#onretry)
+- [retries](RetryConfig.md#retries)
+
+## Properties
+
+### <a id="backoffamount" name="backoffamount"></a> backoffAmount
+
+• `Optional` **backoffAmount**: `number`
+
+The amount to increase the delay by each retry (in ms)
+
+**`Default`**
+
+0
+
+#### Defined in
+
+[retryWrapper/retryWrapper.ts:17](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/retryWrapper/retryWrapper.ts#lines-17)
+
+___
+
+### <a id="delay" name="delay"></a> delay
+
+• `Optional` **delay**: `number`
+
+The base delay between retries (in ms)
+
+**`Default`**
+
+0
+
+#### Defined in
+
+[retryWrapper/retryWrapper.ts:12](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/retryWrapper/retryWrapper.ts#lines-12)
+
+___
+
+### <a id="onretry" name="onretry"></a> onRetry
+
+• `Optional` **onRetry**: (`retries`: `number`, `error`: `Error`, `config`: [`RetryConfig`](RetryConfig.md)) => `void`
+
+#### Type declaration
+
+▸ (`retries`, `error`, `config`): `void`
+
+A callback to run before each retry
+
+##### Parameters
+
+| 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 |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[retryWrapper/retryWrapper.ts:24](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/retryWrapper/retryWrapper.ts#lines-24)
+
+___
+
+### <a id="retries" name="retries"></a> retries
+
+• `Optional` **retries**: `number`
+
+The number of retries to attempt after the first run
+
+**`Default`**
+
+1
+
+#### Defined in
+
+[retryWrapper/retryWrapper.ts:7](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/retryWrapper/retryWrapper.ts#lines-7)

package/docs/modules.md

@@ -0,0 +1,281 @@
+@aligent/microservice-util-lib
+
+# @aligent/microservice-util-lib
+
+## Table of contents
+
+### Classes
+
+- [S3Dao](classes/S3Dao.md)
+
+### Interfaces
+
+- [RetryConfig](interfaces/RetryConfig.md)
+
+### Type Aliases
+
+- [ObjectMap](modules.md#objectmap)
+- [Remap](modules.md#remap)
+
+### Functions
+
+- [chunkBy](modules.md#chunkby)
+- [fetchSsmParams](modules.md#fetchssmparams)
+- [hasDefinedProperties](modules.md#hasdefinedproperties)
+- [remap](modules.md#remap-1)
+- [retryWrapper](modules.md#retrywrapper)
+
+## Type Aliases
+
+### <a id="objectmap" name="objectmap"></a> ObjectMap
+
+Ƭ **ObjectMap**: readonly readonly [`string`, `string`, Function?][]
+
+A list of keys to keys, with an optional transformer function
+
+#### Defined in
+
+[remap/remap.ts:15](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/remap/remap.ts#lines-15)
+
+___
+
+### <a id="remap" name="remap"></a> Remap
+
+Ƭ **Remap**<`MapArray`, `Original`\>: `SimplifyIntersection`<`ConstructTypeFromProperties`<`MapArray`, `Original`\>\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `MapArray` | extends [`ObjectMap`](modules.md#objectmap) |
+| `Original` | extends `Object` |
+
+#### Defined in
+
+[remap/remap.ts:159](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/remap/remap.ts#lines-159)
+
+## Functions
+
+### <a id="chunkby" name="chunkby"></a> chunkBy
+
+▸ **chunkBy**<`ArrayItem`\>(`source`, `chunkSize`): `ArrayItem`[][]
+
+Split an array into chunks of a certain size
+
+**`Example`**
+
+```ts
+chunkBy([1, 2, 3, 4, 5, 6, 7], 2) // [[1, 2], [3, 4], [5, 6], [7]]
+```
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `ArrayItem` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `source` | `ArrayItem`[] | the array to split up |
+| `chunkSize` | `number` | the size of each chunk. (The final chunk will be whatever is remaining) |
+
+#### Returns
+
+`ArrayItem`[][]
+
+#### Defined in
+
+[chunkBy/chunkBy.ts:10](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/chunkBy/chunkBy.ts#lines-10)
+
+___
+
+### <a id="fetchssmparams" name="fetchssmparams"></a> fetchSsmParams
+
+▸ **fetchSsmParams**(`param`): `Promise`<`SSM.Parameter`\>
+
+Fetch one SSM parameter
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `param` | `string` | key of the parameter to fetch |
+
+#### Returns
+
+`Promise`<`SSM.Parameter`\>
+
+#### Defined in
+
+[fetchSsmParams/fetchSsmParams.ts:9](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/fetchSsmParams/fetchSsmParams.ts#lines-9)
+
+▸ **fetchSsmParams**(`...params`): `Promise`<`SSM.ParameterList`\>
+
+Fetch a list of SSM parameters
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `...params` | `string`[] | list of parameter keys to fetch |
+
+#### Returns
+
+`Promise`<`SSM.ParameterList`\>
+
+#### Defined in
+
+[fetchSsmParams/fetchSsmParams.ts:16](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/fetchSsmParams/fetchSsmParams.ts#lines-16)
+
+___
+
+### <a id="hasdefinedproperties" name="hasdefinedproperties"></a> hasDefinedProperties
+
+▸ **hasDefinedProperties**<`T`, `K`\>(`obj`, `...keys`): obj is SimplifyIntersection<Required<Pick<T, K\>\> & Omit<T, K\>\>
+
+Ensure that the given properties are defined on the object.
+
+**`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;
+ //             }
+}
+```
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends `Object` |
+| `K` | extends `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `obj` | `object` \| `T` | The object to check. |
+| `...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.
+
+#### Defined in
+
+[hasPropertiesDefined/hasPropertiesDefined.ts:22](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/hasPropertiesDefined/hasPropertiesDefined.ts#lines-22)
+
+___
+
+### <a id="remap-1" name="remap-1"></a> remap
+
+▸ **remap**<`Original`, `MapArray`\>(`object`, `map`): [`Remap`](modules.md#remap)<`MapArray`, `Original`\>
+
+Map one object's values to another structure
+
+**`Example`**
+
+without a transformer function
+```ts
+const map = [
+  ['foo', 'baz'],
+  ['bar', 'qux.0']
+] as const;
+const obj = { foo: 'hi', bar: 7 }
+remap(obj, map); // { baz: 'hi', qux: [7] }
+```
+
+**`Example`**
+
+with a transformer function
+```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] }
+```
+
+**`Example`**
+
+with an empty initial key
+```ts
+const map = [
+  ['', 'baz', (x: { foo: number, bar: number }) => x.foo + x.bar]
+]
+const obj = { foo: 3, bar: 7 }
+remap(obj, map); // { baz: 10 }
+```
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Original` | extends `Object` |
+| `MapArray` | extends readonly readonly [`string`, `string`, (...`args`: `any`[]) => `any`][] |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `object` | `Original` | the object to map from |
+| `map` | `MapArray` | the keys for the mapping |
+
+#### Returns
+
+[`Remap`](modules.md#remap)<`MapArray`, `Original`\>
+
+the remapped object
+
+#### Defined in
+
+[remap/remap.ts:198](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/remap/remap.ts#lines-198)
+
+___
+
+### <a id="retrywrapper" name="retrywrapper"></a> retryWrapper
+
+▸ **retryWrapper**<`T`\>(`fn`, `config`): `Promise`<`T`\>
+
+Retry an async function if it fails
+
+**`Example`**
+
+```ts
+retryWrapper(someAsyncFunction, {
+  retries: 3,
+  onRetry: (_, error) => console.error(error)
+});
+```
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fn` | () => `Promise`<`T`\> | the function to be retried |
+| `config` | [`RetryConfig`](interfaces/RetryConfig.md) | the configuration for retries |
+
+#### Returns
+
+`Promise`<`T`\>
+
+#### Defined in
+
+[retryWrapper/retryWrapper.ts:78](https://bitbucket.org/aligent/microservice-util-lib/src/0052f4c/src/retryWrapper/retryWrapper.ts#lines-78)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aligent/microservice-util-lib",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A set of utility functions for Aligent Microservices",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && npm run docs",
     "lint": "eslint src/*.ts src/**/*.ts",
     "lint:fix": "eslint --fix src/*.ts src/**/*.ts",
     "test": "npm run lint && npm run test:types && npm run test:jest",
@@ -14,7 +14,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@bitbucket.org/aligent/microservices-utilities.git"
+    "url": "git+ssh://git@bitbucket.org/aligent/microservice-util-lib.git"
   },
   "author": "Aligent",
   "license": "ISC",
@@ -39,6 +39,7 @@
     "object-hash": "^3.0.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "docs"
   ]
 }