@map-colonies/openapi-helpers 3.0.0 → 3.1.0

package/dist/generator/generateErrors.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/generator/generateErrors.mjs

@@ -0,0 +1,102 @@
+import fs from 'node:fs/promises';
+import { parseArgs } from 'node:util';
+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 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;
+if (openapiPath === undefined || destinationPath === undefined) {
+    console.error('Usage: generateErrors <openapiPath> <destinationPath>');
+    process.exit(1);
+}
+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);
+        }
+    }
+}
+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`;
+}
+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 = errorCodes.values().map(createError).toArray().join('\n');
+if (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,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,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,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,IAAI,WAAW,KAAK,SAAS,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;IAC/D,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAW,WAAW,CAAC,CAAC;AAEzD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;AAErC,SAAS,qBAAqB,CAAC,MAAoB;IACjD,8BAA8B;IAC9B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,IAAoB,CAAC;QAE5D,qBAAqB;QACrB,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;YACtB,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7C,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACrC,qBAAqB,CAAC,SAAyB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;AACH,CAAC;AAED,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,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAgC,EAAE,CAAC;QACtF,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5C,SAAS;QACX,CAAC;QAED,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAA+B,EAAE,CAAC;YAC7G,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7D,SAAS,CAAC,4CAA4C;YACxD,CAAC;YAED,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAkC,CAAC;YAC1F,IAAI,MAAM,EAAE,CAAC;gBACX,qBAAqB,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;IAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE1E,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;IAC1B,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAE9D,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,EAAE,GAAG,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AAChD,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAE/C,MAAM,EAAE,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@map-colonies/openapi-helpers",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A package that provides utilities for working with openapi files",
   "exports": {
     "./requestSender": {
@@ -49,6 +49,8 @@
   },
   "homepage": "https://github.com/MapColonies/openapi-helpers#readme",
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^14.1.1",
+    "change-case": "^5.4.4",
     "oas-normalize": "^14.1.2",
     "ts-essentials": "^10.1.1",
     "yaml": "^2.8.0"