@map-colonies/openapi-helpers 1.0.0

package/README.md

@@ -0,0 +1,56 @@
+# openapi-helpers
+This package contains scripts, types and functions to help you work with openapi.
+
+
+## Installation
+Run the following commands:
+
+```bash
+npm install --save-dev @map-colonies/openapi-helpers supertest prettier openapi-typescript @types/express
+```
+
+## types-generator
+The package contains a script that wraps the `openapi-typescript` package and generates types for the openapi schema. The script also formats the generated types using `prettier`.
+
+The command structure is as follows:
+```bash
+npx @map-colonies/openapi-helpers <input-file> <output-file> --format
+```
+
+For example:
+```bash
+npx @map-colonies/openapi-helpers ./openapi3.yaml ./src/openapi.d.ts --format
+```
+
+## RequestSender
+The package contains a wrapper for the `supertest` package that provides autocomplete for all the requests to the API based on the openapi. The requestSender is initialized with the server's base url and the openapi schema and the types exported by `openapi-typescript`.
+
+```typescript
+import { RequestSender } from '@map-colonies/openapi-helpers/requestSender';
+import type { paths, operations } from './src/openapi.d.ts';
+
+const requestSender = await createRequestSender<paths, operations>('path/to/openapi3.yaml', expressApp);
+```
+
+The requestSender object contains all the paths and operations defined in the openapi schema. For example, to send a request to the `getUsers` operation with the `/users` path and with the `GET` method, you can use the following code:
+
+```typescript
+const response = await requestSender.getUsers();
+
+// or
+
+const response = await requestSender.sendRequest({ 
+  method: 'get', 
+  path: '/simple-request'
+});
+```
+
+The package supports all the operations defined in the openapi schema, either by operation name, or by using the `sendRequest` function with the method, path and parameters.
+
+
+> [!IMPORTANT]
+> For the package function properly, you need to make sure that the following values are configured in your  `tsconfig.json` or `jsconfig.json` files under compilerOptions:
+> - module: "NodeNext"
+> - moduleResolution: "NodeNext"
+
+

package/dist/common/types.d.ts

@@ -0,0 +1,4 @@
+import { WritableKeys } from 'ts-essentials';
+export type AddIfNotNever<T, U> = [U] extends [never] ? T : T & U;
+export type PickWritable<T extends NonNullable<unknown>> = Pick<T, WritableKeys<T>>;
+//# sourceMappingURL=types.d.ts.map

package/dist/common/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAClE,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/common/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":""}

package/dist/generator/generateTypes.d.mts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=generateTypes.d.mts.map

package/dist/generator/generateTypes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateTypes.d.mts","sourceRoot":"","sources":["../../src/generator/generateTypes.mts"],"names":[],"mappings":""}

package/dist/generator/generateTypes.mjs

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+import fs from 'node:fs/promises';
+import { parseArgs } from 'node:util';
+import { format, resolveConfig } from 'prettier';
+import openapiTS, { astToString } from 'openapi-typescript';
+const ARGS_SLICE = 2;
+const { values: { format: shouldFormat }, positionals, } = parseArgs({
+    args: process.argv.slice(ARGS_SLICE),
+    options: {
+        format: { type: 'boolean', alias: 'f' },
+    },
+    allowPositionals: true,
+});
+const [openapiPath, destinationPath] = positionals;
+const ESLINT_DISABLE = '/* eslint-disable */\n';
+const ast = await openapiTS(await fs.readFile(openapiPath, 'utf-8'), { exportType: true });
+let content = ESLINT_DISABLE + astToString(ast);
+if (shouldFormat === true) {
+    const prettierOptions = await resolveConfig('./src/index.ts');
+    content = await format(content, { ...prettierOptions, parser: 'typescript' });
+}
+await fs.writeFile(destinationPath, content);
+console.log('Types generated successfully');
+//# sourceMappingURL=generateTypes.mjs.map

package/dist/generator/generateTypes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateTypes.mjs","sourceRoot":"","sources":["../../src/generator/generateTypes.mts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,MAAM,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAChC,WAAW,GACZ,GAAG,SAAS,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IACpC,OAAO,EAAE;QACP,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;KACxC;IACD,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAC;AAEH,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,WAAW,CAAC;AAEnD,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AAE3F,IAAI,OAAO,GAAG,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;AAEhD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;IAC1B,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAE9D,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,EAAE,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAE7C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC"}

package/dist/requestSender/requestSender.d.ts

@@ -0,0 +1,15 @@
+import type express from 'express';
+import type { PathsTemplate, OperationsTemplate, RequestSender } from './types';
+export { RequestSender };
+/**
+ * Creates a request sender object that can be used to send fake HTTP requests using supertest based on an OpenAPI specification.
+ * The openapi types should be generated using the openapi-typescript package.
+ *
+ * @template Paths - The type representing the paths defined in the OpenAPI specification.
+ * @template Operations - The type representing the operations defined in the OpenAPI specification.
+ * @param {string} openapiFilePath - The file path to the OpenAPI specification file.
+ * @param {express.Application} app - The Express application instance.
+ * @returns {Promise<RequestSender<Paths, Operations>>} A promise that resolves to a RequestSender object.
+ */
+export declare function createRequestSender<Paths extends PathsTemplate = never, Operations extends OperationsTemplate = never>(openapiFilePath: Operations extends never ? never : string, app: express.Application): Promise<RequestSender<Paths, Operations>>;
+//# sourceMappingURL=requestSender.d.ts.map

package/dist/requestSender/requestSender.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestSender.d.ts","sourceRoot":"","sources":["../../src/requestSender/requestSender.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAInC,OAAO,KAAK,EACV,aAAa,EAKb,kBAAkB,EAClB,aAAa,EAEd,MAAM,SAAS,CAAC;AAkFjB,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,SAAS,aAAa,GAAG,KAAK,EAAE,UAAU,SAAS,kBAAkB,GAAG,KAAK,EAC1H,eAAe,EAAE,UAAU,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,EAC1D,GAAG,EAAE,OAAO,CAAC,WAAW,GACvB,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAqB3C"}

package/dist/requestSender/requestSender.js

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestSender = void 0;
+const node_fs_1 = require("node:fs");
+const supertest_1 = __importDefault(require("supertest"));
+const oas_normalize_1 = __importDefault(require("oas-normalize"));
+function sendRequest(app, options) {
+    const method = options.method;
+    let actualPath = options.path;
+    if ('pathParams' in options && options.pathParams !== undefined) {
+        actualPath = Object.entries(options.pathParams).reduce((acc, [key, value]) => acc.replace(`{${key}}`, value), actualPath);
+    }
+    /* istanbul ignore next */
+    if (actualPath.includes('{') || actualPath.includes('}')) {
+        throw new Error('Path params are not provided');
+    }
+    let request = supertest_1.default.agent(app)[method](actualPath);
+    if (options.queryParams !== undefined) {
+        request = request.query(options.queryParams);
+    }
+    if ('requestBody' in options && options.requestBody !== undefined) {
+        request = request.send(options.requestBody);
+    }
+    if (options.headers !== undefined) {
+        for (const [key, value] of Object.entries(options.headers)) {
+            request = request.set(key, value);
+        }
+    }
+    request = request.set('Content-Type', 'application/json');
+    // @ts-expect-error whatever
+    return request;
+}
+const methods = ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'];
+function getOperationsPathAndMethod(openapi) {
+    const result = {};
+    /* istanbul ignore next */
+    if (openapi.paths === undefined) {
+        throw new Error('No paths found in the OpenAPI file');
+    }
+    for (const [path, pathValue] of Object.entries(openapi.paths)) {
+        /* istanbul ignore next */
+        if (pathValue === undefined) {
+            continue;
+        }
+        const pathObject = pathValue;
+        for (const method of methods) {
+            if (pathObject[method] !== undefined) {
+                const operationId = pathObject[method]?.operationId;
+                /* istanbul ignore next */
+                if (operationId === undefined) {
+                    throw new Error(`OperationId is not defined for ${method} method on ${path}`);
+                }
+                // @ts-expect-error typescript does not allow to assign a generic index, but it is safe in this case
+                // as we are iterating over all the paths and methods
+                result[operationId] = {
+                    path,
+                    method,
+                };
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Creates a request sender object that can be used to send fake HTTP requests using supertest based on an OpenAPI specification.
+ * The openapi types should be generated using the openapi-typescript package.
+ *
+ * @template Paths - The type representing the paths defined in the OpenAPI specification.
+ * @template Operations - The type representing the operations defined in the OpenAPI specification.
+ * @param {string} openapiFilePath - The file path to the OpenAPI specification file.
+ * @param {express.Application} app - The Express application instance.
+ * @returns {Promise<RequestSender<Paths, Operations>>} A promise that resolves to a RequestSender object.
+ */
+async function createRequestSender(openapiFilePath, app) {
+    const fileContent = (0, node_fs_1.readFileSync)(openapiFilePath, 'utf-8');
+    const normalized = new oas_normalize_1.default(fileContent);
+    const derefed = await normalized.deref();
+    const operationsPathAndMethod = getOperationsPathAndMethod(derefed);
+    const returnObj = {
+        // eslint-disable-next-line @typescript-eslint/promise-function-async
+        sendRequest: (options) => sendRequest(app, options),
+    };
+    for (const [operation, { path, method }] of Object.entries(operationsPathAndMethod)) {
+        // @ts-expect-error as we iterate over all the operations, the operationId is always defined
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        returnObj[operation] = async (options) => sendRequest(app, { path, method: method, ...options });
+    }
+    return returnObj;
+}
+exports.createRequestSender = createRequestSender;
+//# sourceMappingURL=requestSender.js.map

package/dist/requestSender/requestSender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestSender.js","sourceRoot":"","sources":["../../src/requestSender/requestSender.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AACvC,0DAAkC;AAElC,kEAAyC;AAczC,SAAS,WAAW,CAIlB,GAAwB,EAAE,OAAgD;IAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAiB,CAAC;IACzC,IAAI,UAAU,GAAG,OAAO,CAAC,IAAc,CAAC;IAExC,IAAI,YAAY,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAChE,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,KAAe,CAAC,EAAE,UAAU,CAAC,CAAC;IACtI,CAAC;IAED,0BAA0B;IAC1B,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,OAAO,GAAG,mBAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC;IAEvD,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,aAAa,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAClE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAqB,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAClC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAC1D,4BAA4B;IAC5B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AAE/F,SAAS,0BAA0B,CACjC,OAAmD;IAEnD,MAAM,MAAM,GAAG,EAA2E,CAAC;IAE3F,0BAA0B;IAC1B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,0BAA0B;QAC1B,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG,SAAqC,CAAC;QAEzD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;gBACrC,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;gBAEpD,0BAA0B;gBAC1B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,kCAAkC,MAAM,cAAc,IAAI,EAAE,CAAC,CAAC;gBAChF,CAAC;gBAED,oGAAoG;gBACpG,qDAAqD;gBACrD,MAAM,CAAC,WAAW,CAAC,GAAG;oBACpB,IAAI;oBACJ,MAAM;iBACP,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAqF,CAAC;AAC/F,CAAC;AAID;;;;;;;;;GASG;AACI,KAAK,UAAU,mBAAmB,CACvC,eAA0D,EAC1D,GAAwB;IAExB,MAAM,WAAW,GAAG,IAAA,sBAAY,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,IAAI,uBAAY,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;IACzC,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAEpE,MAAM,SAAS,GAAG;QAChB,qEAAqE;QACrE,WAAW,EAAE,CACX,OAAgD,EAChD,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC;KAC/B,CAAC;IAEF,KAAK,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACpF,4FAA4F;QAC5F,4EAA4E;QAC5E,SAAS,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAA+D,EAAE,EAAE,CAC/F,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAe,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,SAA6C,CAAC;AACvD,CAAC;AAxBD,kDAwBC"}

package/dist/requestSender/types.d.ts

@@ -0,0 +1,95 @@
+import type { OmitProperties, OptionalKeys, Prettify, RequiredKeys } from 'ts-essentials';
+import type * as supertest from 'supertest';
+import type { AddIfNotNever, PickWritable } from '../common/types';
+export type Methods = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';
+export type OperationsTemplate = Record<string, any>;
+export type PathsTemplate = Record<string, {
+    parameters: {
+        query?: any;
+        header?: any;
+        path?: any;
+        cookie?: any;
+    };
+} & {
+    [key in Methods]?: OperationsTemplate;
+}>;
+interface Headers {
+    headers?: Record<string, string>;
+}
+type HasContent<T> = [T] extends [{
+    content: any;
+}] ? T['content']['application/json'] : never;
+type ResponseObjectToFlat<T> = [T] extends [{
+    responses: any;
+}] ? {
+    [res in keyof T['responses']]: {
+        status: res;
+        body: HasContent<T['responses'][res]>;
+    };
+}[keyof T['responses']] : never;
+type PathParamsObj<T> = [T] extends [{
+    parameters: {
+        path: NonNullable<any>;
+    };
+}] ? {
+    pathParams: T['parameters']['path'];
+} : never;
+type QueryParamsObj<T> = [T] extends [{
+    parameters: {
+        query?: NonNullable<any>;
+    };
+}] ? [T] extends [{
+    parameters: {
+        query?: never;
+    };
+}] ? {
+    queryParams?: Record<string, string>;
+} : [RequiredKeys<T['parameters']['query']>] extends [OptionalKeys<T['parameters']['query']>] ? {
+    queryParams?: T['parameters']['query'];
+} : {
+    queryParams: T['parameters']['query'];
+} : {
+    queryParams?: Record<string, string>;
+};
+type ContentOrUndefined<T extends {
+    content: any;
+} | undefined> = [T] extends [{
+    content: any;
+}] ? PickWritable<T['content']['application/json']> : undefined;
+type RequestBodyObj<T> = [T] extends [{
+    requestBody: {
+        content: any;
+    };
+}] ? {
+    requestBody: PickWritable<T['requestBody']['content']['application/json']>;
+} : T extends {
+    requestBody?: undefined;
+} ? {
+    requestBody?: any;
+} : T extends {
+    requestBody?: {
+        content: any;
+    };
+} ? {
+    requestBody?: ContentOrUndefined<T['requestBody']>;
+} : {
+    requestBody?: any;
+};
+type RequestOptionsWithoutPathParams<T> = QueryParamsObj<T> & RequestBodyObj<T> & Headers;
+export type RequestOptions<T> = AddIfNotNever<RequestOptionsWithoutPathParams<T>, PathParamsObj<T>>;
+export type PathRequestOptions<Paths extends PathsTemplate, Path extends keyof Paths, Method extends keyof OmitProperties<Omit<Paths[Path], 'parameters'>, undefined>> = RequestOptions<Paths[Path][Method]> & {
+    path: Path;
+    method: Method;
+};
+export type RequestReturn<T> = Promise<ResponseObjectToFlat<T> & Omit<Awaited<supertest.Test>, 'body' | 'status'>> & supertest.Test;
+export type OperationsNames<Operations extends OperationsTemplate> = keyof Operations;
+type OperationRequestOptional<Operations extends OperationsTemplate, Operation extends OperationsNames<Operations>> = (options?: RequestOptions<Operations[Operation]>) => RequestReturn<Operations[Operation]>;
+type OperationRequestRequired<Operations extends OperationsTemplate, Operation extends OperationsNames<Operations>> = (options: RequestOptions<Operations[Operation]>) => RequestReturn<Operations[Operation]>;
+type SendRequest<Paths extends PathsTemplate> = <Path extends keyof Paths, Method extends keyof OmitProperties<Omit<Paths[Path], 'parameters'>, undefined>>(options: PathRequestOptions<Paths, Path, Method>) => RequestReturn<Paths[Path][Method]>;
+export type RequestSender<Paths extends PathsTemplate, Operations extends OperationsTemplate> = Prettify<{
+    sendRequest: SendRequest<Paths>;
+} & {
+    [operation in OperationsNames<Operations>]: RequiredKeys<RequestOptions<Operations[operation]>> extends OptionalKeys<RequestOptions<Operations[operation]>> ? OperationRequestOptional<Operations, operation> : OperationRequestRequired<Operations, operation>;
+}>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/requestSender/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/requestSender/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC1F,OAAO,KAAK,KAAK,SAAS,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAEjG,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG,MAAM,CAChC,MAAM,EACN;IACE,UAAU,EAAE;QACV,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ,MAAM,CAAC,EAAE,GAAG,CAAC;QACb,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,MAAM,CAAC,EAAE,GAAG,CAAC;KACd,CAAC;CACH,GAAG;KACD,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,kBAAkB;CACtC,CACF,CAAC;AAEF,UAAU,OAAO;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,OAAO,EAAE,GAAG,CAAA;CAAE,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC;AAE/F,KAAK,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,SAAS,EAAE,GAAG,CAAA;CAAE,CAAC,GAC3D;KACG,GAAG,IAAI,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;KAAE;CACtF,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,GACvB,KAAK,CAAC;AAEV,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,UAAU,EAAE;QAAE,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;KAAE,CAAA;CAAE,CAAC,GAAG;IAAE,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;CAAE,GAAG,KAAK,CAAC;AAEnI,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;KAAE,CAAA;CAAE,CAAC,GAC/E,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,CAAA;CAAE,CAAC,GAC7C;IAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GACvF;IAAE,WAAW,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAA;CAAE,GAC1C;IAAE,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAA;CAAE,GAC7C;IAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC;AAE7C,KAAK,kBAAkB,CAAC,CAAC,SAAS;IAAE,OAAO,EAAE,GAAG,CAAA;CAAE,GAAG,SAAS,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,OAAO,EAAE,GAAG,CAAA;CAAE,CAAC,GAC5F,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,GAC9C,SAAS,CAAC;AAEd,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE,CAAA;CAAE,CAAC,GACpE;IAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAA;CAAE,GAC9E,CAAC,SAAS;IAAE,WAAW,CAAC,EAAE,SAAS,CAAA;CAAE,GACnC;IAAE,WAAW,CAAC,EAAE,GAAG,CAAA;CAAE,GACrB,CAAC,SAAS;IAAE,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE,CAAA;CAAE,GAC1C;IAAE,WAAW,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAA;CAAE,GACtD;IAAE,WAAW,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AAE9B,KAAK,+BAA+B,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAE1F,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpG,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,aAAa,EAC3B,IAAI,SAAS,MAAM,KAAK,EACxB,MAAM,SAAS,MAAM,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,SAAS,CAAC,IAC7E,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC;AAEpI,MAAM,MAAM,eAAe,CAAC,UAAU,SAAS,kBAAkB,IAAI,MAAM,UAAU,CAAC;AAEtF,KAAK,wBAAwB,CAAC,UAAU,SAAS,kBAAkB,EAAE,SAAS,SAAS,eAAe,CAAC,UAAU,CAAC,IAAI,CACpH,OAAO,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAC5C,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAE1C,KAAK,wBAAwB,CAAC,UAAU,SAAS,kBAAkB,EAAE,SAAS,SAAS,eAAe,CAAC,UAAU,CAAC,IAAI,CACpH,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAC3C,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAE1C,KAAK,WAAW,CAAC,KAAK,SAAS,aAAa,IAAI,CAC9C,IAAI,SAAS,MAAM,KAAK,EACxB,MAAM,SAAS,MAAM,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,SAAS,CAAC,EAE/E,OAAO,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,KAC7C,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAExC,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,aAAa,EAAE,UAAU,SAAS,kBAAkB,IAAI,QAAQ,CACtG;IACE,WAAW,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;CACjC,GAAG;KACD,SAAS,IAAI,eAAe,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,YAAY,CAClH,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CACtC,GACG,wBAAwB,CAAC,UAAU,EAAE,SAAS,CAAC,GAC/C,wBAAwB,CAAC,UAAU,EAAE,SAAS,CAAC;CACpD,CACF,CAAC"}

package/dist/requestSender/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/requestSender/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/requestSender/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@map-colonies/openapi-helpers",
+  "version": "1.0.0",
+  "description": "A package that provides utilities for working with openapi files",
+  "exports": {
+    "./requestSender": {
+      "default": "./dist/requestSender/requestSender.js",
+      "types": "./dist/requestSender/requestSender.d.ts"
+    }
+  },
+  "bin": "./dist/generator/generateTypes.mjs",
+  "scripts": {
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "prelint:fix": "npm run format:fix",
+    "prelint": "npm run format",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "jest --config=./tests/configurations/jest.config.js",
+    "prebuild": "npm run clean",
+    "build": "tsc --project tsconfig.build.json",
+    "generate:test:types": "npm run build && node dist/generator/generateTypes.mjs tests/supertest/openapi3.yaml tests/supertest/types.d.ts",
+    "clean": "rimraf dist",
+    "prepublish": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MapColonies/openapi-helpers.git"
+  },
+  "author": "MapColonies",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/MapColonies/openapi-helpers/issues"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/MapColonies/openapi-helpers#readme",
+  "dependencies": {
+    "oas-normalize": "^11.1.1",
+    "ts-essentials": "^10.0.1",
+    "yaml": "^2.5.0"
+  },
+  "peerDependencies": {
+    "@types/express": "^4.17.21",
+    "openapi-typescript": "^7.3.0",
+    "prettier": "^3.3.3",
+    "supertest": "^7.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "@map-colonies/eslint-config": "^4.0.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.2.0",
+    "@types/supertest": "^6.0.2",
+    "body-parser": "^1.20.2",
+    "commitlint": "^11.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.56.0",
+    "expect-type": "^0.19.0",
+    "express": "^4.17.1",
+    "husky": "^4.3.5",
+    "jest": "^29.7.0",
+    "pretty-quick": "^4.0.0",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.4.5"
+  }
+}