@map-colonies/openapi-helpers 3.0.0 → 4.0.0

package/README.md

@@ -9,22 +9,132 @@ Run the following commands:
 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:
+## CLI Usage
+
+The package provides a unified CLI for generating TypeScript types and error classes from OpenAPI specifications. All code generation is now performed using the `generate` command, which supports subcommands for types and errors.
+
+#### CLI Arguments Reference
+
+**Positional Arguments:**
+For both `generate types` and `generate errors` commands, the positional arguments are:
+
+- `<openapi-file>`: Path to the OpenAPI YAML or JSON file to use as the source schema.
+- `<output-file>`: Path to the file where the generated code will be written.
+
+These arguments are required and must be provided in the order shown.
+
+**Optional Arguments:**
+
+For `generate types`:
+- `-f, --format`: Format the generated types using Prettier
+- `-t, --add-typed-request-handler`: Add the TypedRequestHandler type to the generated types
+
+For `generate errors`:
+- `-f, --format`: Format the generated code using Prettier  
+- `-e, --errors-output <all|map|classes>`: Specify what to generate (default: all)
+  - `all`: generate both error classes and error code mapping
+  - `map`: generate only the error code mapping
+  - `classes`: generate only the error classes
+
+### Generate Types
+
+Generate TypeScript types from an OpenAPI schema:
 ```bash
-npx @map-colonies/openapi-helpers <input-file> <output-file> --format --add-typed-request-handler
+npx @map-colonies/openapi-helpers generate types <openapi-file> <output-file> [options]
 ```
 
 For example:
 ```bash
-npx @map-colonies/openapi-helpers ./openapi3.yaml ./src/openapi.d.ts --format --add-typed-request-handler
+npx @map-colonies/openapi-helpers generate types ./openapi3.yaml ./src/openapi.d.ts --format --add-typed-request-handler
+```
+
+Options:
+- `-f, --format` - Format the generated types using `prettier`.
+- `-t, --add-typed-request-handler` - Add the `TypedRequestHandler` type to the generated types.
+
+### Generate Errors
+
+Generate error classes and error code mappings from an OpenAPI schema:
+```bash
+npx @map-colonies/openapi-helpers generate errors <openapi-file> <output-file> [options]
+```
+
+For example:
+```bash
+npx @map-colonies/openapi-helpers generate errors ./openapi3.yaml ./src/errors.ts --format
+```
+
+
+Options:
+- `-f, --format` - Format the generated code using `prettier`.
+- `-e, --errors-output <all|map|classes>` - Specify what to generate:
+  - `all` (default): generate both error classes and error code mapping
+  - `map`: generate only the error code mapping
+  - `classes`: generate only the error classes
+
+### Help and Examples
+
+To see all available commands and options:
+```bash
+npx @map-colonies/openapi-helpers --help
+npx @map-colonies/openapi-helpers generate --help
+npx @map-colonies/openapi-helpers generate types --help
+npx @map-colonies/openapi-helpers generate errors --help
+```
+
+
+#### Example: Run all generations
+
+You can run both types and errors generation in sequence:
+```bash
+npx @map-colonies/openapi-helpers generate types ./openapi3.yaml ./src/openapi.d.ts --format --add-typed-request-handler
+npx @map-colonies/openapi-helpers generate errors ./openapi3.yaml ./src/errors.ts --format --errors-output all
+```
+
+
+
+## Programmatic Support
+
+
+> [!NOTE]
+> **Programmatic usage of the CLI (importing and using the generators directly) is only supported in ECMAScript modules (ESM).** CommonJS is not supported for direct imports.
+
+The code generators (`generateTypes.mts` and `generateErrors.mts`) now support functional programming patterns. You can inject custom transformation logic or AST manipulation by providing functional arguments, making the generators more flexible and composable for advanced use cases.
+
+
+### API Usage
+
+You can import and use the generators directly in your own scripts for full functional programming flexibility:
+
+```typescript
+import { generateTypes, generateErrors } from '@map-colonies/openapi-helpers/generators';
+
+// Generate types
+await generateTypes(
+  'openapi3.yaml',
+  'src/openapi.d.ts',
+  {
+    shouldFormat: true,
+    addTypedRequestHandler: true,
+    // inject?: string,
+    // transform?: (schemaObject, metadata) => ...
+  }
+);
+
+// Generate errors
+await generateErrors(
+  'openapi3.yaml',
+  'src/errors.ts',
+  {
+    shouldFormat: true,
+    includeMapping: true,
+    includeErrorClasses: true
+  }
+);
 ```
 
-### options
-- `--format` - format the generated types using `prettier`.
-- `--add-typed-request-handler` - add the `TypedRequestHandler` type to the generated types.
+You can pass custom `inject` or `transform` functions to `generateTypes` for advanced AST/code manipulation, enabling highly composable and functional workflows.
 
 ## TypedRequestHandler
 The package contains a wrapper for the `express` types package that provides autocomplete for all the request handlers to the API based on the OpenAPI schema. The TypedRequestHandler is initialized with the types generated by `openapi-typescript`, and is configured based on operation name or method and path.

package/dist/cli/entrypoint.d.mts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/entrypoint.mjs

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+import { setTimeout as sleep } from 'node:timers/promises';
+import { program } from '@commander-js/extra-typings';
+import { generateTypes } from '../generator/generateTypes.mjs';
+import { generateErrors } from '../generator/generateErrors.mjs';
+import ora from 'ora';
+import { PACKAGE_VERSION } from '../common/constants.js';
+const errorOutput = ['all', 'map', 'classes'];
+function isErrorsOutput(value) {
+    return errorOutput.includes(value);
+}
+const SECOND = 1000;
+program.name('openapi-helpers').description('Generate TypeScript types and error classes from OpenAPI specifications').version(PACKAGE_VERSION);
+const command = program.command('generate').description('Generate code artifacts (types, error classes) from OpenAPI specifications');
+command
+    .command('types')
+    .description('Generate TypeScript types from OpenAPI spec')
+    .argument('<openapiPath>', 'Path to the OpenAPI specification file')
+    .argument('<destinationPath>', 'Path where the generated types will be saved')
+    .option('-f, --format', 'Format the generated code using Prettier')
+    .option('-t, --add-typed-request-handler', 'Add typed request handler types to the generated output')
+    .action(async (openapiPath, destinationPath, options) => {
+    try {
+        const spinner = ora('Generating types').start();
+        await generateTypes(openapiPath, destinationPath, { shouldFormat: options.format, addTypedRequestHandler: options.addTypedRequestHandler });
+        await sleep(SECOND);
+        spinner.stop();
+        console.log('Types generated successfully');
+    }
+    catch (error) {
+        console.error('Error generating types:', error);
+        process.exit(1);
+    }
+});
+command
+    .command('errors')
+    .description('Generate error classes from OpenAPI spec')
+    .argument('<openapiPath>', 'Path to the OpenAPI specification file')
+    .argument('<destinationPath>', 'Path where the generated error classes will be saved')
+    .option('-f, --format', 'Format the generated code using Prettier')
+    .option('-e, --errors-output <all|map|classes>', 'Specify the errors output type', 'all')
+    .action(async (openapiPath, destinationPath, options) => {
+    try {
+        if (!isErrorsOutput(options.errorsOutput)) {
+            console.error(`Invalid errors output type: ${options.errorsOutput}`);
+            process.exit(1);
+        }
+        const includeMapping = options.errorsOutput === 'map' || options.errorsOutput === 'all';
+        const includeErrorClasses = options.errorsOutput === 'classes' || options.errorsOutput === 'all';
+        const spinner = ora('Generating errors').start();
+        await generateErrors(openapiPath, destinationPath, {
+            shouldFormat: options.format,
+            includeMapping,
+            includeErrorClasses,
+        });
+        await sleep(SECOND);
+        spinner.stop();
+        console.log('Errors generated successfully');
+    }
+    catch (error) {
+        console.error('Error generating errors:', error);
+        process.exit(1);
+    }
+});
+// Add examples to the help
+program.addHelpText('after', `
+Examples:
+  $ openapi-helpers generate types api.yaml types.ts
+  $ openapi-helpers generate types api.yaml types.ts --format
+  $ openapi-helpers generate types api.yaml types.ts --add-typed-request-handler
+  $ openapi-helpers generate types api.yaml types.ts --add-typed-request-handler --format
+  $ openapi-helpers generate errors api.yaml errors.ts
+  $ openapi-helpers generate errors api.yaml errors.ts --format
+  $ openapi-helpers generate errors api.yaml errors.ts --no-mapping
+  $ openapi-helpers generate errors api.yaml errors.ts --no-error-classes
+  $ openapi-helpers generate errors api.yaml errors.ts --no-mapping --no-error-classes
+  $ openapi-helpers --help
+  $ openapi-helpers generate --help
+  $ openapi-helpers generate types --help
+  $ openapi-helpers generate errors --help
+`);
+program.parse();
+//# sourceMappingURL=entrypoint.mjs.map

package/dist/cli/entrypoint.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entrypoint.mjs","sourceRoot":"","sources":["../../src/cli/entrypoint.mts"],"names":[],"mappings":";AACA,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAU,CAAC;AAGvD,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,WAAW,CAAC,QAAQ,CAAC,KAAqB,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,MAAM,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC,yEAAyE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AAEhJ,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,4EAA4E,CAAC,CAAC;AAEtI,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,6CAA6C,CAAC;KAC1D,QAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC;KACnE,QAAQ,CAAC,mBAAmB,EAAE,8CAA8C,CAAC;KAC7E,MAAM,CAAC,cAAc,EAAE,0CAA0C,CAAC;KAClE,MAAM,CAAC,iCAAiC,EAAE,yDAAyD,CAAC;KACpG,MAAM,CACL,KAAK,EACH,WAAmB,EACnB,eAAuB,EACvB,OAGC,EACD,EAAE;IACF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAChD,MAAM,aAAa,CAAC,WAAW,EAAE,eAAe,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC5I,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CACF,CAAC;AAEJ,OAAO;KACJ,OAAO,CAAC,QAAQ,CAAC;KACjB,WAAW,CAAC,0CAA0C,CAAC;KACvD,QAAQ,CAAC,eAAe,EAAE,wCAAwC,CAAC;KACnE,QAAQ,CAAC,mBAAmB,EAAE,sDAAsD,CAAC;KACrF,MAAM,CAAC,cAAc,EAAE,0CAA0C,CAAC;KAClE,MAAM,CAAC,uCAAuC,EAAE,gCAAgC,EAAE,KAAK,CAAC;KACxF,MAAM,CAAC,KAAK,EAAE,WAAmB,EAAE,eAAuB,EAAE,OAAO,EAAE,EAAE;IACtE,IAAI,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,+BAA+B,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,cAAc,GAAG,OAAO,CAAC,YAAY,KAAK,KAAK,IAAI,OAAO,CAAC,YAAY,KAAK,KAAK,CAAC;QACxF,MAAM,mBAAmB,GAAG,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,KAAK,KAAK,CAAC;QAEjG,MAAM,OAAO,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC,KAAK,EAAE,CAAC;QAEjD,MAAM,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE;YACjD,YAAY,EAAE,OAAO,CAAC,MAAM;YAC5B,cAAc;YACd,mBAAmB;SACpB,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,CAAC,IAAI,EAAE,CAAC;QAEf,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,2BAA2B;AAC3B,OAAO,CAAC,WAAW,CACjB,OAAO,EACP;;;;;;;;;;;;;;;CAeD,CACA,CAAC;AAEF,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/common/constants.d.ts

@@ -0,0 +1,2 @@
+declare const PACKAGE_VERSION: string;
+export { PACKAGE_VERSION };

package/dist/common/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_VERSION = void 0;
+const read_pkg_1 = require("@map-colonies/read-pkg");
+const packageJson = (0, read_pkg_1.readPackageJsonSync)();
+const PACKAGE_VERSION = packageJson.version ?? 'unknown';
+exports.PACKAGE_VERSION = PACKAGE_VERSION;
+//# sourceMappingURL=constants.js.map

package/dist/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":";;;AAAA,qDAA6D;AAE7D,MAAM,WAAW,GAAG,IAAA,8BAAmB,GAAE,CAAC;AAC1C,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,IAAI,SAAS,CAAC;AAChD,0CAAe"}

package/dist/generator/generateErrors.d.mts

@@ -0,0 +1,5 @@
+export declare function generateErrors(openapiPath: string, destinationPath: string, options: {
+    shouldFormat?: boolean;
+    includeMapping?: boolean;
+    includeErrorClasses?: boolean;
+}): Promise<void>;

package/dist/generator/generateErrors.mjs

@@ -0,0 +1,104 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { dereference } from '@apidevtools/json-schema-ref-parser';
+import { format, resolveConfig } from 'prettier';
+import * as changeCase from 'change-case';
+const ESLINT_DISABLE = '/* eslint-disable */\n';
+const FILE_HEADER = `${ESLINT_DISABLE}// This file was auto-generated. Do not edit manually.
+// To update, run the error generation script again.\n\n`;
+function createError(code) {
+    let className = changeCase.pascalCase(code);
+    if (!className.endsWith('Error')) {
+        className += 'Error';
+    }
+    return `export class ${className} extends Error {
+  public readonly code = '${code}';
+  /**
+   * Creates an instance of ${className}.
+   * @param message - The error message.
+   * @param cause - Optional original error or server response data.
+   */
+  public constructor(message: string, cause?: unknown) {
+    super(message, { cause });
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+};\n`;
+}
+function buildErrorMapping(errorCodes) {
+    return Array.from(errorCodes)
+        .map((code) => `'${code}': '${code}'`)
+        .join(', ');
+}
+export async function generateErrors(openapiPath, destinationPath, options) {
+    const openapi = await dereference(openapiPath);
+    if (openapi.paths === undefined) {
+        console.error('No paths found in the OpenAPI document.');
+        process.exit(1);
+    }
+    const errorCodes = new Set();
+    function extractCodeFromSchema(schema) {
+        // Handle direct code property
+        if (schema.type === 'object' && schema.properties?.code) {
+            const codeProperty = schema.properties.code;
+            // Handle enum values
+            if (codeProperty.enum) {
+                codeProperty.enum.map(String).forEach((code) => {
+                    errorCodes.add(code);
+                });
+            }
+        }
+        // Handle allOf combinations
+        if (schema.allOf) {
+            for (const subSchema of schema.allOf) {
+                extractCodeFromSchema(subSchema);
+            }
+        }
+        // Handle oneOf combinations
+        if (schema.oneOf) {
+            for (const subSchema of schema.oneOf) {
+                extractCodeFromSchema(subSchema);
+            }
+        }
+        // Handle anyOf combinations
+        if (schema.anyOf) {
+            for (const subSchema of schema.anyOf) {
+                extractCodeFromSchema(subSchema);
+            }
+        }
+    }
+    for (const [, methods] of Object.entries(openapi.paths)) {
+        for (const [key, operation] of Object.entries(methods)) {
+            if (['servers', 'parameters'].includes(key)) {
+                continue;
+            }
+            for (const [statusCode, response] of Object.entries(operation.responses ?? {})) {
+                if (statusCode.startsWith('2') || statusCode.startsWith('3')) {
+                    continue; // Skip successful and redirection responses
+                }
+                const schema = response.content?.['application/json']?.schema;
+                if (schema) {
+                    extractCodeFromSchema(schema);
+                }
+            }
+        }
+    }
+    if (errorCodes.size === 0) {
+        console.warn('No error codes found in the OpenAPI document.');
+        process.exit(0);
+    }
+    let errorFile = FILE_HEADER;
+    if (options.includeErrorClasses === true) {
+        errorFile += errorCodes.values().map(createError).toArray().join('\n');
+    }
+    if (options.includeMapping === true) {
+        errorFile += ` export const API_ERRORS_MAP = { ${buildErrorMapping(errorCodes)} } as const;\n`;
+    }
+    if (options.shouldFormat === true) {
+        const prettierOptions = await resolveConfig('./src/index.ts');
+        errorFile = await format(errorFile, { ...prettierOptions, parser: 'typescript' });
+    }
+    const directory = path.dirname(destinationPath);
+    await fs.mkdir(directory, { recursive: true });
+    await fs.writeFile(destinationPath, errorFile);
+}
+//# sourceMappingURL=generateErrors.mjs.map

package/dist/generator/generateErrors.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateErrors.mjs","sourceRoot":"","sources":["../../src/generator/generateErrors.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,aAAa,CAAC;AAG1C,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAChD,MAAM,WAAW,GAAG,GAAG,cAAc;yDACoB,CAAC;AAE1D,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE5C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,SAAS,IAAI,OAAO,CAAC;IACvB,CAAC;IAED,OAAO,gBAAgB,SAAS;4BACN,IAAI;;8BAEF,SAAS;;;;;;;;KAQlC,CAAC;AACN,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAuB;IAChD,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;SAC1B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,OAAO,IAAI,GAAG,CAAC;SACrC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,WAAmB,EACnB,eAAuB,EACvB,OAIC;IAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAW,WAAW,CAAC,CAAC;IAEzD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IAErC,SAAS,qBAAqB,CAAC,MAAoB;QACjD,8BAA8B;QAC9B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;YACxD,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,IAAoB,CAAC;YAE5D,qBAAqB;YACrB,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC7C,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,4BAA4B;QAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAgC,EAAE,CAAC;YACtF,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5C,SAAS;YACX,CAAC;YAED,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAA+B,EAAE,CAAC;gBAC7G,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7D,SAAS,CAAC,4CAA4C;gBACxD,CAAC;gBAED,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAkC,CAAC;gBAC1F,IAAI,MAAM,EAAE,CAAC;oBACX,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,IAAI,SAAS,GAAG,WAAW,CAAC;IAE5B,IAAI,OAAO,CAAC,mBAAmB,KAAK,IAAI,EAAE,CAAC;QACzC,SAAS,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,OAAO,CAAC,cAAc,KAAK,IAAI,EAAE,CAAC;QACpC,SAAS,IAAI,oCAAoC,iBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACjG,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;QAClC,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAC9D,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,EAAE,GAAG,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAChD,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/C,MAAM,EAAE,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;AACjD,CAAC"}

package/dist/generator/generateTypes.d.mts

@@ -1,2 +1,9 @@
 #!/usr/bin/env node
-export {};
+import { SchemaObject, TransformNodeOptions, TransformObject } from 'openapi-typescript';
+import { TypeNode } from 'typescript';
+export declare function generateTypes(openapiPath: string, destinationPath: string, options: {
+    shouldFormat?: boolean;
+    addTypedRequestHandler?: boolean;
+    inject?: string;
+    transform?: (schemaObject: SchemaObject, metadata: TransformNodeOptions) => TypeNode | TransformObject | undefined;
+}): Promise<void>;

package/dist/generator/generateTypes.mjs

@@ -1,35 +1,23 @@
 #!/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, 'add-typed-request-handler': addTypedRequestHandler }, positionals, } = parseArgs({
-    args: process.argv.slice(ARGS_SLICE),
-    options: {
-        format: { type: 'boolean', alias: 'f' },
-        'add-typed-request-handler': { type: 'boolean', alias: 't' },
-    },
-    allowPositionals: true,
-});
-const [openapiPath, destinationPath] = positionals;
-if (openapiPath === undefined || destinationPath === undefined) {
-    console.error('Usage: generateTypes <openapiPath> <destinationPath>');
-    process.exit(1);
-}
 const ESLINT_DISABLE = '/* eslint-disable */\n';
+const FILE_HEADER = `${ESLINT_DISABLE}// This file was auto-generated. Do not edit manually.
+// To update, run the error generation script again.\n\n`;
 const typedRequestHandlerImport = "import type { TypedRequestHandlers as ImportedTypedRequestHandlers } from '@map-colonies/openapi-helpers/typedRequestHandler';\n";
 const exportTypedRequestHandlers = 'export type TypedRequestHandlers = ImportedTypedRequestHandlers<paths, operations>;\n';
-const ast = await openapiTS(await fs.readFile(openapiPath, 'utf-8'), { exportType: true });
-let content = astToString(ast);
-if (addTypedRequestHandler === true) {
-    content = typedRequestHandlerImport + content + exportTypedRequestHandlers;
-}
-content = ESLINT_DISABLE + content;
-if (shouldFormat === true) {
-    const prettierOptions = await resolveConfig('./src/index.ts');
-    content = await format(content, { ...prettierOptions, parser: 'typescript' });
+export async function generateTypes(openapiPath, destinationPath, options) {
+    const ast = await openapiTS(await fs.readFile(openapiPath, 'utf-8'), { exportType: true, inject: options.inject, transform: options.transform });
+    let content = astToString(ast);
+    if (options.addTypedRequestHandler === true) {
+        content = typedRequestHandlerImport + content + exportTypedRequestHandlers;
+    }
+    content = FILE_HEADER + content;
+    if (options.shouldFormat === true) {
+        const prettierOptions = await resolveConfig('./src/index.ts');
+        content = await format(content, { ...prettierOptions, parser: 'typescript' });
+    }
+    await fs.writeFile(destinationPath, content);
 }
-await fs.writeFile(destinationPath, content);
-console.log('Types generated successfully');
 //# sourceMappingURL=generateTypes.mjs.map

package/dist/generator/generateTypes.mjs.map

@@ -1 +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,2BAA2B,EAAE,sBAAsB,EAAE,EACrF,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;QACvC,2BAA2B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;KAC7D;IACD,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAC;AAEH,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,WAAW,CAAC;AAEnD,IAAI,WAAW,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;IAC/D,OAAO,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACtE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD,MAAM,yBAAyB,GAC7B,kIAAkI,CAAC;AACrI,MAAM,0BAA0B,GAAG,uFAAuF,CAAC;AAE3H,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,WAAW,CAAC,GAAG,CAAC,CAAC;AAE/B,IAAI,sBAAsB,KAAK,IAAI,EAAE,CAAC;IACpC,OAAO,GAAG,yBAAyB,GAAG,OAAO,GAAG,0BAA0B,CAAC;AAC7E,CAAC;AAED,OAAO,GAAG,cAAc,GAAG,OAAO,CAAC;AAEnC,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"}
+{"version":3,"file":"generateTypes.mjs","sourceRoot":"","sources":["../../src/generator/generateTypes.mts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,SAAS,EAAE,EAAE,WAAW,EAAuD,MAAM,oBAAoB,CAAC;AAGjH,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAChD,MAAM,WAAW,GAAG,GAAG,cAAc;yDACoB,CAAC;AAE1D,MAAM,yBAAyB,GAC7B,kIAAkI,CAAC;AACrI,MAAM,0BAA0B,GAAG,uFAAuF,CAAC;AAE3H,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,WAAmB,EACnB,eAAuB,EACvB,OAKC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAEjJ,IAAI,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAE/B,IAAI,OAAO,CAAC,sBAAsB,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,GAAG,yBAAyB,GAAG,OAAO,GAAG,0BAA0B,CAAC;IAC7E,CAAC;IAED,OAAO,GAAG,WAAW,GAAG,OAAO,CAAC;IAEhC,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;QAClC,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAE9D,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,EAAE,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC"}

package/dist/generator/index.d.mts

@@ -0,0 +1,2 @@
+export * from './generateTypes.mjs';
+export * from './generateErrors.mjs';

package/dist/generator/index.mjs

@@ -0,0 +1,3 @@
+export * from './generateTypes.mjs';
+export * from './generateErrors.mjs';
+//# sourceMappingURL=index.mjs.map

package/dist/generator/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/generator/index.mts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@map-colonies/openapi-helpers",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "A package that provides utilities for working with openapi files",
   "exports": {
     "./requestSender": {
@@ -10,9 +10,13 @@
     "./typedRequestHandler": {
       "default": "./dist/typedRequestHandler/typedRequestHandler.js",
       "types": "./dist/typedRequestHandler/typedRequestHandler.d.ts"
+    },
+    "./generators": {
+      "import": "./dist/generator/index.mjs",
+      "types": "./dist/generator/index.d.mts"
     }
   },
-  "bin": "./dist/generator/generateTypes.mjs",
+  "bin": "./dist/cli/entrypoint.mjs",
   "scripts": {
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
@@ -26,6 +30,7 @@
     "generate:test:types": "npm run build && node dist/generator/generateTypes.mjs tests/openapi3.yaml tests/types.d.ts",
     "clean": "rimraf dist",
     "prepublish": "npm run build",
+    "prepack": "npm run build",
     "prepare": "husky",
     "docs": "typedoc"
   },
@@ -49,7 +54,13 @@
   },
   "homepage": "https://github.com/MapColonies/openapi-helpers#readme",
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^14.1.1",
+    "@commander-js/extra-typings": "^14.0.0",
+    "@map-colonies/read-pkg": "^1.0.0",
+    "change-case": "^5.4.4",
+    "commander": "^14.0.0",
     "oas-normalize": "^14.1.2",
+    "ora": "^8.2.0",
     "ts-essentials": "^10.1.1",
     "yaml": "^2.8.0"
   },