@mittwald/api-code-generator 0.0.0-development-f25b020-20260331 → 3.1.1

package/dist/{esm/openapi → openapi}/OpenApiSpec.js

@@ -2,8 +2,6 @@ import { OpenAPISchemaValidationError } from "./OpenAPISchemaValidationError.js"
 import VError from "verror";
 import { makeError } from "../lib/makeError.js";
 import OpenAPISchemaValidator from "openapi-schema-validator";
-import { convert } from "swagger2openapi";
-import { ux } from "@oclif/core";
 const validator = new OpenAPISchemaValidator.default({
     version: 3,
 });
@@ -12,25 +10,11 @@ export class OpenApiSpec {
     constructor(document) {
         this.document = document;
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    static async convertToOpenApi(doc) {
-        const version = doc.openapi ?? doc.swagger;
-        if (version.startsWith("3")) {
-            return doc;
-        }
-        ux.action.start("Converting doc to OpenAPI v3");
-        const spec = await convert(doc, {
-            patch: true,
-        });
-        ux.action.stop();
-        return spec.openapi;
-    }
     static async parse(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     doc, opts = {}) {
         try {
             const { skipValidation = false } = opts;
-            doc = await OpenApiSpec.convertToOpenApi(doc);
             const validationResult = await validator.validate(doc);
             if (validationResult.errors.length > 0 && !skipValidation) {
                 throw new OpenAPISchemaValidationError(validationResult.errors);

package/package.json

@@ -1,88 +1,63 @@
 {
   "name": "@mittwald/api-code-generator",
-  "version": "0.0.0-development-f25b020-20260331",
-  "type": "module",
-  "repository": "https://github.com/mittwald/api-client-js.git",
+  "version": "3.1.1",
   "license": "MIT",
-  "exports": {
-    ".": "./bin/cli.js",
-    "./js": {
-      "types": "./dist/types/index.d.ts",
-      "default": "./dist/esm/index.js"
-    }
-  },
+  "repository": "https://github.com/mittwald/api-client-js.git",
   "bin": {
     "acg": "./bin/cli.js"
   },
-  "files": [
-    "dist"
-  ],
+  "type": "module",
   "scripts": {
-    "build": "run build:clean && yarn tsc",
-    "build:clean": "run rimraf dist",
-    "format": "run prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
-    "lint": "run eslint .",
-    "test": "",
-    "test:compile": "run tsc --noEmit",
-    "test:unit": "node --experimental-vm-modules $(yarn bin jest)"
+    "test": "node --experimental-vm-modules $(yarn bin jest)"
   },
+  "files": [
+    "dist/**/*.{js,d.ts}",
+    "resources/**/*.*"
+  ],
   "dependencies": {
-    "@oclif/core": "^3.27.0",
-    "@oclif/plugin-help": "^6.2.33",
-    "@oclif/plugin-plugins": "^4.3.10",
-    "@sindresorhus/is": "^6.3.1",
-    "@types/clone-deep": "^4.0.4",
-    "@types/invariant": "^2.2.37",
-    "@types/js-yaml": "^4.0.9",
-    "@types/prettier": "^3.0.0",
-    "@types/verror": "^1.10.11",
-    "@types/yieldable-json": "^2.0.2",
-    "axios": "^1.13.5",
-    "camelcase": "^8.0.0",
+    "@oclif/core": "^2.8.11",
+    "@oclif/plugin-help": "^5.2.11",
+    "@oclif/plugin-plugins": "^3.1.6",
+    "@sindresorhus/is": "^5.4.1",
+    "@types/clone-deep": "^4.0.1",
+    "@types/invariant": "^2.2.35",
+    "@types/js-yaml": "^4.0.5",
+    "@types/prettier": "^2.7.3",
+    "@types/verror": "^1.10.6",
+    "@types/yieldable-json": "^2.0.0",
+    "axios": "^1.4.0",
+    "camelcase": "^7.0.1",
     "clone-deep": "^4.0.1",
-    "dot-prop": "^8.0.2",
+    "dot-prop": "^8.0.1",
     "fs-jetpack": "^5.1.0",
     "get-stdin": "^9.0.0",
     "invariant": "^2.2.4",
     "js-yaml": "^4.1.0",
-    "json-schema-to-typescript": "^15.0.4",
+    "json-schema-to-typescript": "^13.0.2",
+    "jsonata": "^2.0.3",
     "openapi-schema-validator": "^12.1.3",
     "openapi-types": "^12.1.3",
-    "prettier": "^3.6.2",
-    "swagger2openapi": "^7.0.8",
-    "type-fest": "^4.30.0",
+    "prettier": "^2.8.8",
+    "type-fest": "^3.12.0",
     "verror": "^1.10.1",
-    "yieldable-json": "^2.1.0",
-    "zod": "^3.25.76",
-    "zod-validation-error": "^3.5.3"
+    "yieldable-json": "^2.0.1",
+    "zod": "^3.21.4",
+    "zod-validation-error": "^1.3.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.14",
-    "@types/swagger2openapi": "^7.0.4",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.2",
-    "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-prettier": "^5.5.4",
-    "jest": "^29.7.0",
-    "prettier": "^3.6.2",
-    "prettier-plugin-jsdoc": "^1.3.3",
-    "prettier-plugin-pkgsort": "^0.2.1",
-    "prettier-plugin-sort-json": "^3.1.0",
-    "rimraf": "^5.0.10",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.2"
+    "@jest/globals": "^29.6.0",
+    "@types/jest": "^29.5.2",
+    "jest": "^29.6.0",
+    "ts-jest": "^29.1.1"
   },
+  "types": "./dist/index.d.ts",
   "oclif": {
     "bin": "acg",
     "dirname": "acg",
-    "commands": "./dist/esm/commands",
+    "commands": "./dist/commands",
     "plugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-plugins"
     ]
-  },
-  "gitHead": "0d6c44b5d7f417a4f396ec545fdb36ed083f27c7"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Mittwald CM Service GmbH & Co. KG and contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/esm/generation/model/paths/Paths.js

@@ -1,192 +0,0 @@
-import { Name } from "../global/Name.js";
-import { Path } from "./Path.js";
-import { asyncStringJoin } from "../../asyncStringJoin.js";
-import camelcase from "camelcase";
-export class Paths {
-    static ns = "Paths";
-    paths;
-    model;
-    name;
-    constructor(model, paths) {
-        this.model = model;
-        this.name = new Name(Paths.ns, model.rootNamespace);
-        this.paths = Object.entries(paths ?? {})
-            .map(([name, pathDoc]) => {
-            if (pathDoc) {
-                return Path.fromDoc(this, name, pathDoc);
-            }
-        })
-            .filter((p) => !!p);
-    }
-    async compileTypes(opts) {
-        const t = {
-            ns: Paths.ns,
-            types: await asyncStringJoin(this.paths, (path) => path.compileTypes(opts)),
-        };
-        return `\
-      namespace ${t.ns} {
-        ${t.types}
-      }
-    `;
-    }
-    async compileOperationTypes() {
-        const t = {
-            types: this.getFlattenedOperations()
-                .map((operation) => operation.compileRequestResponseTypes())
-                .join("\r\n"),
-        };
-        return `
-      namespace Operations {
-        ${t.types}      
-      }
-    `;
-    }
-    compileDescriptors() {
-        const t = {
-            ns: this.model.rootNamespace.tsType,
-            descriptors: this.getFlattenedOperations()
-                .map((operation) => operation.compileDescriptor())
-                .join("\r\n"),
-        };
-        return `\
-      import { Simplify } from "@mittwald/api-client-commons";
-      import { RequestType } from "@mittwald/api-client-commons";
-      import { Response } from "@mittwald/api-client-commons";
-      import { OpenAPIOperation } from "@mittwald/api-client-commons";    
-      import { ${t.ns} } from "./types.js";
-      
-      ${t.descriptors}
-    `;
-    }
-    getFlattenedOperations(httpMethod) {
-        return this.paths
-            .flatMap((p) => p.operations)
-            .filter((p) => httpMethod === undefined ||
-            p.httpMethod.raw.toLowerCase() === httpMethod.toLowerCase());
-    }
-    getGroupedOperationsByTag(httpMethod) {
-        const result = new Map();
-        for (const operation of this.getFlattenedOperations(httpMethod)) {
-            for (const tag of operation.tags) {
-                const operationsOfTag = result.get(tag);
-                if (operationsOfTag) {
-                    operationsOfTag.push(operation);
-                }
-                else {
-                    result.set(tag, [operation]);
-                }
-            }
-        }
-        return Array.from(result.entries());
-    }
-    compileClientMethodsOfTag(tag, operations) {
-        const t = {
-            tag: tag.name.tsVar,
-            comment: tag.description,
-            methods: operations
-                .map((op) => op.compileClientMethod(tag))
-                .join(",\r\n"),
-        };
-        return `\
-      /** ${t.comment} */
-      public readonly ${t.tag} = {
-        ${t.methods}      
-      }
-    `;
-    }
-    compileClient() {
-        const t = {
-            clientClassName: `${this.model.rootNamespace.tsType}Client`,
-            methods: this.getGroupedOperationsByTag()
-                .map(([tag, operations]) => this.compileClientMethodsOfTag(tag, operations))
-                .join("\r\n"),
-        };
-        return `\
-      import * as descriptors from "./descriptors.js";
-      import { ApiClientBase } from "@mittwald/api-client-commons";
-
-      export class ${t.clientClassName} extends ApiClientBase {
-        ${t.methods}
-      }
-      
-      export default ${t.clientClassName}
-    `;
-    }
-    compileReactClientApiName(tag) {
-        return `build${camelcase(tag.name.tsVar, {
-            pascalCase: true,
-        })}Api`;
-    }
-    compileReactClientApiBuilderOfTag(baseClientClassName, tag, operations) {
-        const t = {
-            apiName: this.compileReactClientApiName(tag),
-            methods: operations
-                .map((op) => op.compileReactClientMethod(tag))
-                .join(",\r\n"),
-            baseClientClassName,
-        };
-        return `\
-      const ${t.apiName} = (baseClient: ${t.baseClientClassName}) => ({
-        ${t.methods}      
-      })
-    `;
-    }
-    compileReactClientPropertyInitializer(tag) {
-        const tagName = tag.name.tsVar;
-        const t = {
-            apiName: this.compileReactClientApiName(tag),
-            comment: tag.description,
-        };
-        return `\
-      this.${tagName} = ${t.apiName}(baseClient);
-    `;
-    }
-    compileReactClientProperties(tag) {
-        const tagName = tag.name.tsVar;
-        const t = {
-            apiName: this.compileReactClientApiName(tag),
-            comment: tag.description,
-        };
-        return `\
-      /** ${t.comment} */
-      public readonly ${tagName}: ReturnType<typeof ${t.apiName}>;
-    `;
-    }
-    compileReactClient() {
-        const baseClientClassName = `${this.model.rootNamespace.tsType}Client`;
-        const clientClassName = `${this.model.rootNamespace.tsType}ClientReact`;
-        const t = {
-            baseClientClassName,
-            clientClassName,
-            apiBuilder: this.getGroupedOperationsByTag("GET")
-                .map(([tag, operations]) => this.compileReactClientApiBuilderOfTag(baseClientClassName, tag, operations))
-                .join("\r\n"),
-            clientProperties: this.getGroupedOperationsByTag("GET")
-                .map(([tag]) => this.compileReactClientProperties(tag))
-                .join("\r\n"),
-            clientPropertyInitializers: this.getGroupedOperationsByTag("GET")
-                .map(([tag]) => this.compileReactClientPropertyInitializer(tag))
-                .join("\r\n"),
-        };
-        return `\
-      import ${t.baseClientClassName} from "./client.js";
-      import { ApiCallAsyncResourceFactory } from "@mittwald/api-client-commons/react";
-      import * as descriptors from "./descriptors.js";
-      export * from "@mittwald/react-use-promise";
-      
-      ${t.apiBuilder}   
-      
-      export class ${t.clientClassName} {
-        ${t.clientProperties}
-        
-        private constructor(baseClient: ${t.baseClientClassName}) {
-          ${t.clientPropertyInitializers}
-        }
-        
-        public static fromBaseClient(baseClient: ${t.baseClientClassName}): ${t.clientClassName} {
-          return new ${t.clientClassName}(baseClient);        
-        }
-      }
-    `;
-    }
-}

package/dist/esm/generation/populateNullableTypes.js

@@ -1,26 +0,0 @@
-export function populateNullableTypes(schema) {
-    if (!schema || "$ref" in schema) {
-        return schema;
-    }
-    if (schema.properties) {
-        for (const key in schema.properties) {
-            schema.properties[key] = populateNullableTypes(schema.properties[key]);
-        }
-    }
-    if ("items" in schema && schema.items) {
-        schema.items = populateNullableTypes(schema.items);
-    }
-    const compositionKeys = ["allOf", "anyOf", "oneOf"];
-    compositionKeys.forEach((key) => {
-        const entries = schema[key];
-        if (Array.isArray(entries)) {
-            schema[key] = entries.map(populateNullableTypes);
-        }
-    });
-    if (schema.nullable) {
-        return {
-            anyOf: [schema, { type: "null" }],
-        };
-    }
-    return schema;
-}

package/dist/esm/generation/refs/extractComponentRefName.js

@@ -1,8 +0,0 @@
-import { splitRefNamespaces } from "./splitRefNamespaces.js";
-export const extractComponentRefName = (ref, component) => {
-    const parts = splitRefNamespaces(ref);
-    if (parts[parts.length - 2] === component) {
-        return parts[parts.length - 1];
-    }
-    throw new Error(`Could not extract ref name (component: ${component}, ref: ${ref})`);
-};

package/dist/esm/generation/refs/isRef.js

@@ -1,3 +0,0 @@
-export function isRef(obj) {
-    return "$ref" in obj && typeof obj.$ref === "string";
-}

package/dist/esm/index.js

@@ -1,7 +0,0 @@
-export * from "./loading/UniversalContentLoader.js";
-export * from "./loading/UniversalFileLoader.js";
-export * from "./openapi/OpenApiSpec.js";
-export * from "./generation/model/CodeGenerationModel.js";
-export * from "./generation/prepareTypeScriptOutput.js";
-export * from "./loading/UniversalFileLoader.js";
-export * from "./lib/writeIfChangedAsync.js";

package/dist/esm/lib/writeIfChangedAsync.js

@@ -1,8 +0,0 @@
-import jetpack from "fs-jetpack";
-export const writeIfChangedAsync = async (filename, content) => {
-    const existing = await jetpack.readAsync(filename);
-    if (existing === content) {
-        return;
-    }
-    await jetpack.writeAsync(filename, content);
-};

package/dist/types/generation/format.d.ts

@@ -1 +0,0 @@
-export declare const format: (ts: string) => Promise<string>;

package/dist/types/generation/populateNullableTypes.d.ts

@@ -1,2 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-export declare function populateNullableTypes(schema: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject): OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;

package/dist/types/generation/refs/extractComponentRefName.d.ts

@@ -1,2 +0,0 @@
-import { ComponentTypeName } from "../model/components/Components.js";
-export declare const extractComponentRefName: (ref: string, component: ComponentTypeName) => string;

package/dist/types/generation/refs/isRef.d.ts

@@ -1,2 +0,0 @@
-import { OpenAPIV3 } from "openapi-types";
-export declare function isRef<T extends object>(obj: T | OpenAPIV3.ReferenceObject): obj is OpenAPIV3.ReferenceObject;

package/dist/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./loading/UniversalContentLoader.js";
-export * from "./loading/UniversalFileLoader.js";
-export * from "./openapi/OpenApiSpec.js";
-export * from "./generation/model/CodeGenerationModel.js";
-export * from "./generation/prepareTypeScriptOutput.js";
-export * from "./loading/UniversalFileLoader.js";
-export * from "./lib/writeIfChangedAsync.js";

package/dist/types/lib/writeIfChangedAsync.d.ts

@@ -1 +0,0 @@
-export declare const writeIfChangedAsync: (filename: string, content: string) => Promise<void>;