@aligent/microservice-util-lib 1.0.0 → 1.2.0

package/docs/modules.md

@@ -1,316 +1,35 @@
-@aligent/microservice-util-lib
+**@aligent/microservice-util-lib**
 
-# @aligent/microservice-util-lib
+***
 
-## Table of contents
+# @aligent/microservice-util-lib
 
-### Classes
+## Classes
 
 - [S3Dao](classes/S3Dao.md)
 
-### Interfaces
+## Interfaces
 
+- [ApiKey](interfaces/ApiKey.md)
+- [Basic](interfaces/Basic.md)
+- [OAuth10a](interfaces/OAuth10a.md)
+- [OAuth20](interfaces/OAuth20.md)
 - [RetryConfig](interfaces/RetryConfig.md)
 
-### Type Aliases
-
-- [ObjectMap](modules.md#objectmap)
-- [Remap](modules.md#remap)
-
-### Functions
-
-- [chunkBy](modules.md#chunkby)
-- [fetchSsmParams](modules.md#fetchssmparams)
-- [getAwsIdFromArn](modules.md#getawsidfromarn)
-- [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/5ba81bd/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/5ba81bd/src/remap/remap.ts#lines-159)
+- [ObjectMap](type-aliases/ObjectMap.md)
+- [Remap](type-aliases/Remap.md)
 
 ## 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/5ba81bd/src/chunkBy/chunkBy.ts#lines-10)
-
-___
-
-### <a id="fetchssmparams" name="fetchssmparams"></a> fetchSsmParams
-
-▸ **fetchSsmParams**(`param`): `Promise`<`Parameter`\>
-
-Fetch one SSM parameter
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `param` | `string` | key of the parameter to fetch |
-
-#### Returns
-
-`Promise`<`Parameter`\>
-
-#### Defined in
-
-[fetchSsmParams/fetchSsmParams.ts:14](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/fetchSsmParams/fetchSsmParams.ts#lines-14)
-
-▸ **fetchSsmParams**(`...params`): `Promise`<`Parameter`[]\>
-
-Fetch a list of SSM parameters
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `...params` | `string`[] | list of parameter keys to fetch |
-
-#### Returns
-
-`Promise`<`Parameter`[]\>
-
-#### Defined in
-
-[fetchSsmParams/fetchSsmParams.ts:21](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/fetchSsmParams/fetchSsmParams.ts#lines-21)
-
-___
-
-### <a id="getawsidfromarn" name="getawsidfromarn"></a> getAwsIdFromArn
-
-▸ **getAwsIdFromArn**(`resourceArn`): `string`
-
-Get the AWS ID from its resource ARN
-
-**`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')
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `resourceArn` | `string` | the ARN of the AWS resource |
-
-#### Returns
-
-`string`
-
-the ID (if present in the ARN) of the AWS resource/execution
-
-#### Defined in
-
-[getAwsIdFromArn/getAwsIdFromArn.ts:11](https://bitbucket.org/aligent/microservice-util-lib/src/5ba81bd/src/getAwsIdFromArn/getAwsIdFromArn.ts#lines-11)
-
-___
-
-### <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/5ba81bd/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/5ba81bd/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/5ba81bd/src/retryWrapper/retryWrapper.ts#lines-78)
+- [apiKeyAuthMiddleware](functions/apiKeyAuthMiddleware.md)
+- [basicAuthMiddleware](functions/basicAuthMiddleware.md)
+- [chunkBy](functions/chunkBy.md)
+- [fetchSsmParams](functions/fetchSsmParams.md)
+- [getAwsIdFromArn](functions/getAwsIdFromArn.md)
+- [hasDefinedProperties](functions/hasDefinedProperties.md)
+- [oAuth10aAuthMiddleware](functions/oAuth10aAuthMiddleware.md)
+- [oAuth20AuthMiddleware](functions/oAuth20AuthMiddleware.md)
+- [remap](functions/remap.md)
+- [retryWrapper](functions/retryWrapper.md)

package/docs/type-aliases/ObjectMap.md

@@ -0,0 +1,13 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / ObjectMap
+
+# Type Alias: ObjectMap
+
+> **ObjectMap** = `ReadonlyArray`\<readonly \[`string`, `string`, (...`args`) => `any`?\]\>
+
+Defined in: [remap/remap.ts:13](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/remap/remap.ts#L13)
+
+A list of keys to keys, with an optional transformer function

package/docs/type-aliases/Remap.md

@@ -0,0 +1,21 @@
+[**@aligent/microservice-util-lib**](../modules.md)
+
+***
+
+[@aligent/microservice-util-lib](../modules.md) / Remap
+
+# Type Alias: Remap\<MapArray, Original\>
+
+> **Remap**\<`MapArray`, `Original`\> = `SimplifyIntersection`\<`ConstructTypeFromProperties`\<`MapArray`, `Original`\>\>
+
+Defined in: [remap/remap.ts:145](https://github.com/aligent/microservice-development-utilities/blob/e13483771966234032f5249dc36c2c31c71d7cf1/packages/microservice-util-lib/src/remap/remap.ts#L145)
+
+## Type Parameters
+
+### MapArray
+
+`MapArray` *extends* [`ObjectMap`](ObjectMap.md)
+
+### Original
+
+`Original` *extends* `object`

package/package.json

@@ -1,48 +1,23 @@
 {
   "name": "@aligent/microservice-util-lib",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "A set of utility functions for Aligent Microservices",
-  "main": "dist/index.js",
-  "scripts": {
-    "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",
-    "test:jest": "jest src/",
-    "test:types": "tsc --noEmit",
-    "docs": "typedoc --readme none --githubPages false --plugin typedoc-plugin-markdown --entryDocument modules.md --namedAnchors true --out docs src/index.ts"
-  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@bitbucket.org/aligent/microservice-util-lib.git"
-  },
-  "author": "Aligent",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^29.2.4",
-    "@types/lodash": "^4.14.191",
-    "@types/node": "^18.11.17",
-    "@types/object-hash": "^3.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.46.1",
-    "@typescript-eslint/parser": "^5.46.1",
-    "aws-sdk-client-mock": "^2.1.1",
-    "aws-sdk-client-mock-jest": "^2.1.1",
-    "eslint": "^8.30.0",
-    "jest": "^29.3.1",
-    "ts-jest": "^29.0.3",
-    "typedoc": "^0.23.23",
-    "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^4.9.4"
+    "url": "https://github.com/aligent/microservice-development-utilities.git",
+    "directory": "packages/microservice-util-lib"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.332.0",
-    "@aws-sdk/client-ssm": "^3.332.0",
-    "axios": "^1.2.1",
-    "lodash": "^4.17.21",
-    "object-hash": "^3.0.0"
+    "@aws-sdk/client-s3": "^3.922.0",
+    "@aws-sdk/client-ssm": "^3.922.0",
+    "oauth-sign": "^0.9.0",
+    "object-hash": "^3.0.0",
+    "openapi-fetch": "^0.15.0"
   },
-  "files": [
-    "dist",
-    "docs"
-  ]
-}
+  "author": "Aligent",
+  "license": "MIT",
+  "types": "./src/index.d.ts"
+}

package/{dist/chunkBy/chunkBy.js → src/chunk-by/chunk-by.js}

@@ -11,12 +11,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 function chunkBy(source, chunkSize) {
     if (chunkSize <= 0) {
-        throw new Error("Cannot create chunks of size ".concat(chunkSize, " (0 or less)"));
+        throw new Error(`Cannot create chunks of size ${chunkSize} (0 or less)`);
     }
-    var numberOfChunks = Math.ceil(source.length / chunkSize);
-    return Array.from(new Array(numberOfChunks), function (_, i) {
+    const numberOfChunks = Math.ceil(source.length / chunkSize);
+    return Array.from(new Array(numberOfChunks), (_, i) => {
         return source.slice(i * chunkSize, (i + 1) * chunkSize);
     });
 }
 exports.default = chunkBy;
-//# sourceMappingURL=chunkBy.js.map

package/{dist/fetchSsmParams/fetchSsmParams.d.ts → src/fetch-ssm-params/fetch-ssm-params.d.ts}

@@ -3,10 +3,10 @@ import { Parameter } from '@aws-sdk/client-ssm';
  * Fetch one SSM parameter
  * @param param key of the parameter to fetch
  */
-declare function fetchSsmParams(param: string): Promise<Parameter>;
+declare function fetchSsmParams(param: string): Promise<Parameter | undefined>;
 /**
  * Fetch a list of SSM parameters
  * @param params list of parameter keys to fetch
  */
-declare function fetchSsmParams(...params: string[]): Promise<Parameter[]>;
+declare function fetchSsmParams(...params: string[]): Promise<Array<Parameter | undefined>>;
 export default fetchSsmParams;

package/src/fetch-ssm-params/fetch-ssm-params.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const ssm = new client_ssm_1.SSMClient({});
+/**
+ * Fetch SSM Parameters
+ * @param params the keys of the parameters to fetch
+ */
+async function fetchSsmParams(...params) {
+    if (params.length === 0) {
+        throw new Error('No SSM Params supplied');
+    }
+    if (params.length === 1) {
+        const result = await ssm.send(new client_ssm_1.GetParameterCommand({
+            Name: params[0],
+            WithDecryption: true,
+        }));
+        return result.Parameter;
+    }
+    const result = await ssm.send(new client_ssm_1.GetParametersCommand({
+        Names: params,
+        WithDecryption: true,
+    }));
+    return params.map(paramName => {
+        return result.Parameters?.find(param => param.Name === paramName);
+    });
+}
+exports.default = fetchSsmParams;

package/{dist/getAwsIdFromArn/getAwsIdFromArn.js → src/get-aws-id-from-arn/get-aws-id-from-arn.js}

@@ -10,12 +10,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * getAwsIdFromArn('arn:aws:states:ap-southeast-2:123123123:execution:prj-int-entity-ac-dc-dev-machine-name:this-is-the-id')
  * ```
  */
-var getAwsIdFromArn = function (resourceArn) {
+const getAwsIdFromArn = (resourceArn) => {
     if (resourceArn.length === 0) {
         throw new Error('Received an empty resourceArn, unable to get an ID.');
     }
-    var startIdx = resourceArn.lastIndexOf(':') + 1;
+    const startIdx = resourceArn.lastIndexOf(':') + 1;
     return resourceArn.substring(startIdx);
 };
 exports.default = getAwsIdFromArn;
-//# sourceMappingURL=getAwsIdFromArn.js.map

package/{dist/hasPropertiesDefined/hasPropertiesDefined.js → src/has-properties-defined/has-properties-defined.js}

@@ -19,13 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * }
  * ```
  */
-function hasDefinedProperties(obj) {
-    var keys = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        keys[_i - 1] = arguments[_i];
-    }
-    for (var _a = 0, keys_1 = keys; _a < keys_1.length; _a++) {
-        var key = keys_1[_a];
+function hasDefinedProperties(obj, ...keys) {
+    for (const key of keys) {
         if (obj[key] === undefined || obj[key] === null) {
             return false;
         }
@@ -33,4 +28,3 @@ function hasDefinedProperties(obj) {
     return true;
 }
 exports.default = hasDefinedProperties;
-//# sourceMappingURL=hasPropertiesDefined.js.map

package/src/index.d.ts

@@ -0,0 +1,11 @@
+import chunkBy from './chunk-by/chunk-by';
+import fetchSsmParams from './fetch-ssm-params/fetch-ssm-params';
+import getAwsIdFromArn from './get-aws-id-from-arn/get-aws-id-from-arn';
+import hasDefinedProperties from './has-properties-defined/has-properties-defined';
+import { ApiKey, Basic, OAuth10a, OAuth20, apiKeyAuthMiddleware, basicAuthMiddleware, oAuth10aAuthMiddleware, oAuth20AuthMiddleware } from './openapi-fetch-middlewares/authentications';
+import { RetryConfig as RetryMiddlewareConfig, retryMiddleware } from './openapi-fetch-middlewares/retry';
+import remap, { ObjectMap, Remap } from './remap/remap';
+import retryWrapper, { RetryConfig } from './retry-wrapper/retry-wrapper';
+import S3Dao from './s3/s3';
+export type { ApiKey, Basic, OAuth10a, OAuth20, ObjectMap, Remap, RetryConfig, RetryMiddlewareConfig, S3Dao, };
+export { apiKeyAuthMiddleware, basicAuthMiddleware, chunkBy, fetchSsmParams, getAwsIdFromArn, hasDefinedProperties, oAuth10aAuthMiddleware, oAuth20AuthMiddleware, remap, retryMiddleware, retryWrapper, };

package/src/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retryWrapper = exports.retryMiddleware = exports.remap = exports.oAuth20AuthMiddleware = exports.oAuth10aAuthMiddleware = exports.hasDefinedProperties = exports.getAwsIdFromArn = exports.fetchSsmParams = exports.chunkBy = exports.basicAuthMiddleware = exports.apiKeyAuthMiddleware = void 0;
+/* v8 ignore start */
+const chunk_by_1 = __importDefault(require("./chunk-by/chunk-by"));
+exports.chunkBy = chunk_by_1.default;
+const fetch_ssm_params_1 = __importDefault(require("./fetch-ssm-params/fetch-ssm-params"));
+exports.fetchSsmParams = fetch_ssm_params_1.default;
+const get_aws_id_from_arn_1 = __importDefault(require("./get-aws-id-from-arn/get-aws-id-from-arn"));
+exports.getAwsIdFromArn = get_aws_id_from_arn_1.default;
+const has_properties_defined_1 = __importDefault(require("./has-properties-defined/has-properties-defined"));
+exports.hasDefinedProperties = has_properties_defined_1.default;
+const authentications_1 = require("./openapi-fetch-middlewares/authentications");
+Object.defineProperty(exports, "apiKeyAuthMiddleware", { enumerable: true, get: function () { return authentications_1.apiKeyAuthMiddleware; } });
+Object.defineProperty(exports, "basicAuthMiddleware", { enumerable: true, get: function () { return authentications_1.basicAuthMiddleware; } });
+Object.defineProperty(exports, "oAuth10aAuthMiddleware", { enumerable: true, get: function () { return authentications_1.oAuth10aAuthMiddleware; } });
+Object.defineProperty(exports, "oAuth20AuthMiddleware", { enumerable: true, get: function () { return authentications_1.oAuth20AuthMiddleware; } });
+const retry_1 = require("./openapi-fetch-middlewares/retry");
+Object.defineProperty(exports, "retryMiddleware", { enumerable: true, get: function () { return retry_1.retryMiddleware; } });
+const remap_1 = __importDefault(require("./remap/remap"));
+exports.remap = remap_1.default;
+const retry_wrapper_1 = __importDefault(require("./retry-wrapper/retry-wrapper"));
+exports.retryWrapper = retry_wrapper_1.default;

package/src/openapi-fetch-middlewares/authentications.d.ts

@@ -0,0 +1,66 @@
+import type { Middleware } from 'openapi-fetch';
+import type { ApiKey, Basic, OAuth10a, OAuth20 } from './types/authentications';
+/**
+ * Creates an openapi-fetch middleware for API key authentication.
+ * This middleware sets the API key in the specified header for each request.
+ *
+ * @param {ApiKey} config - The configuration for API key authentication.
+ * @returns {Middleware} The middleware for API key authentication.
+ *
+ * @example
+ * const middleware = apiKeyAuthMiddleware({
+ *     header: 'x-api-key',
+ *     value: async () => 'your-api-key',
+ * });
+ */
+declare function apiKeyAuthMiddleware(config: ApiKey): Middleware;
+/**
+ * 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.
+ *
+ * @param {Basic} config - The configuration for Basic authentication.
+ * @returns {Middleware} The middleware for Basic authentication.
+ *
+ * @example
+ * const middleware = basicAuthMiddleware({
+ *     credentials: async () => ({ username: 'user', password: 'pass' }),
+ * });
+ */
+declare function basicAuthMiddleware(config: Basic): Middleware;
+/**
+ * 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.
+ *
+ * @param {OAuth10a} config - The configuration for OAuth 1.0a authentication.
+ * @returns {Middleware} The middleware for OAuth 1.0a authentication.
+ *
+ * @example
+ * const middleware = oAuth10aAuthMiddleware({
+ *     algorithm: 'HMAC-SHA256',
+ *     credentials: async () => ({
+ *         consumerKey: 'key',
+ *         consumerSecret: 'secret',
+ *         token: 'token',
+ *         tokenSecret: 'tokenSecret',
+ *     }),
+ * });
+ */
+declare function oAuth10aAuthMiddleware(config: OAuth10a): Middleware;
+/**
+ * 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.
+ *
+ * @param {OAuth20} options - The configuration for OAuth 2.0 authentication.
+ * @returns {Middleware} The middleware for OAuth 2.0 authentication.
+ *
+ * @example
+ * const middleware = oAuth20AuthMiddleware({
+ *     token: async () => 'your-access-token',
+ *     tokenType: 'Bearer',
+ * });
+ */
+declare function oAuth20AuthMiddleware(options: OAuth20): Middleware;
+export type { ApiKey, Basic, OAuth10a, OAuth20 };
+export { apiKeyAuthMiddleware, basicAuthMiddleware, oAuth10aAuthMiddleware, oAuth20AuthMiddleware };