klasik 1.0.16 → 1.0.19

package/README.md

@@ -6,7 +6,7 @@ Download OpenAPI specifications from remote URLs and generate TypeScript clients
 
 - 📥 **Download OpenAPI specs** from remote URLs or local files
 - 📁 **Multiple input formats** - HTTP/HTTPS URLs, file:// URLs, absolute/relative paths
-- 📄 **JSON and YAML support** - Automatically parse and handle both formats
+- 📄 **JSON and YAML support** - Automatically parse and handle both formats (YAML specs are converted to JSON for code generation)
 - 🔐 **Authentication support** - Custom headers including Bearer tokens and API keys
 - 🔗 **External reference resolution** - Automatically download referenced schema files (`$ref`)
 - 🔄 **Automatic transformation** - Converts API responses to class instances using class-transformer
@@ -95,11 +95,14 @@ Generate a TypeScript client from an OpenAPI spec (remote URL or local file).
 - `-u, --url <url>` - URL or file path to the OpenAPI spec (required)
   - Supports: `https://...`, `http://...`, `file://...`, `/absolute/path`, `./relative/path`
 - `-o, --output <dir>` - Output directory for generated client code (required)
+- `-m, --mode <mode>` - Generation mode: `full` (models + APIs + config) or `models-only` (default: `full`)
+  - `full`: Generates complete axios client with APIs, models, and configuration
+  - `models-only`: Generates only model classes with class-transformer decorators (no API client code)
 - `-H, --header <header...>` - Custom headers for HTTP requests (format: "Key: Value")
   - Can be used multiple times for multiple headers
   - Perfect for authorization: `--header "Authorization: Bearer token"`
 - `-r, --resolve-refs` - Resolve and download external `$ref` references
-- `-t, --template <dir>` - Custom template directory
+- `-t, --template <dir>` - Custom template directory (klasik includes enhanced TSDoc templates by default)
 - `-k, --keep-spec` - Keep the downloaded spec file after generation
 - `--timeout <ms>` - Request timeout in milliseconds for HTTP requests (default: 30000)
 
@@ -220,40 +223,93 @@ The generated TypeScript client includes:
 - ✅ **Automatic response transformation** - API responses converted to class instances
 - ✅ **Runtime type metadata** - Static `attributeTypeMap` on all models
 - ✅ **Union type support** - `anyOf` schemas become TypeScript unions
+- ✅ **Rich TSDoc comments** - Comprehensive documentation from OpenAPI spec metadata
 - ✅ **Vendor extensions** - Preserved in JSDoc comments and metadata
 - ✅ **Error handling** - Configurable transformation error handlers
 - ✅ **Configuration options** - Enable/disable transformation, custom error handlers
 
-### Example Generated Model
+### Enhanced TSDoc Documentation
 
-```typescript
-import { Expose, Type } from 'class-transformer';
+Klasik includes enhanced Mustache templates that generate rich TSDoc comments from your OpenAPI specification. The generated code includes:
+
+**For Models:**
+- Class-level documentation with description
+- Property descriptions from OpenAPI schema
+- Type information with `@type` tags
+- Validation constraints (`@minimum`, `@maximum`, `@minLength`, `@maxLength`, `@pattern`)
+- Format specifications (`@format`)
+- Example values (`@example`)
+- Required field markers (`@required`)
+- Deprecation warnings (`@deprecated`)
+
+**For API Endpoints:**
+- Method name and HTTP verb (`@method`)
+- Summary and detailed descriptions
+- Parameter documentation with types and requirements
+- Return type information
+- Error scenarios (`@throws`)
+- Deprecation notices
+
+Example generated model with rich TSDoc:
 
+```typescript
+/**
+ * User
+ *
+ * Represents a user in the system
+ *
+ * @export
+ * @class User
+ */
 export class User {
+    /**
+     * id - Unique identifier for the user
+     *
+     * @type {string}
+     * @memberof User
+     * @required
+     * @format uuid
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     */
     @Expose()
     'id': string;
 
+    /**
+     * email - User's email address
+     *
+     * @type {string}
+     * @memberof User
+     * @required
+     * @format email
+     * @pattern ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
+     */
     @Expose()
-    'name': string;
-
-    @Expose()
-    @Type(() => Profile)
-    'profile'?: Profile;
-
-    static readonly attributeTypeMap = [
-        {
-            "name": "id",
-            "baseName": "id",
-            "type": "string",
-            "format": "",
-            "description": "User ID",
-            "vendorExtensions": {}
-        },
-        // ... more properties
-    ];
+    'email': string;
 }
 ```
 
+Example generated API method:
+
+```typescript
+/**
+ * getUserById - Get user by ID
+ *
+ * Retrieves a single user by their unique identifier
+ *
+ * @method GET
+ * @summary Get user by ID
+ * @param {string} userId - The user's unique identifier (required)
+ * @param {RawAxiosRequestConfig} [options] Override http request option.
+ * @throws {RequiredError} When required parameters are missing
+ * @returns {Promise<AxiosResponse<User>>}
+ */
+async getUserById(userId: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<User>>
+```
+
+These templates automatically extract metadata from your OpenAPI spec and format it as proper TSDoc comments, making your generated client code well-documented and IDE-friendly with IntelliSense support.
+
+**Note:** Klasik's templates automatically handle special characters in descriptions by using proper escaping, ensuring your TSDoc comments are always valid even when OpenAPI descriptions contain characters like `*`, `/`, `@`, etc.
+
 ### Using the Generated Client
 
 ```typescript
@@ -364,6 +420,78 @@ await new K8sClientGenerator().generate({
 });
 ```
 
+## Best Practices for Existing Projects
+
+When integrating klasik into an existing TypeScript project, follow these best practices to avoid conflicts:
+
+### Generate into a Subdirectory
+
+```bash
+# Generate models into src/generated to avoid overwriting project files
+npx klasik generate \
+  --url https://api.example.com/openapi.yaml \
+  --output ./src/generated \
+  --mode models-only \
+  --resolve-refs
+```
+
+### Clean Up Generated Config Files
+
+klasik generates `package.json` and `tsconfig.json` files. Remove them after generation:
+
+```json
+// package.json
+{
+  "scripts": {
+    "generate-client": "npx klasik generate --url $API_URL --output ./src/generated --mode models-only --resolve-refs && npm run cleanup-generated",
+    "cleanup-generated": "rm -f ./src/generated/package.json ./src/generated/tsconfig*.json ./src/generated/.openapi-generator*"
+  }
+}
+```
+
+### TypeScript Configuration for class-transformer
+
+Add these settings to your `tsconfig.json` for compatibility:
+
+```json
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true  // Skip type checking in node_modules (recommended for class-transformer)
+  }
+}
+```
+
+### Models-Only Mode
+
+Use `--mode models-only` when you:
+- Only need data models with class-transformer decorators
+- Want to use your own API client (axios, fetch, etc.)
+- Are integrating into an existing project with its own HTTP layer
+- Want to avoid package.json/tsconfig.json conflicts
+
+```bash
+npx klasik generate \
+  --url https://api.example.com/openapi.yaml \
+  --output ./src/generated \
+  --mode models-only  # ✅ Generates only models, no API client
+```
+
+### Full Mode
+
+Use `--mode full` (default) when you:
+- Want a complete ready-to-use axios client
+- Are starting a new project from scratch
+- Want automatic response transformation with class-transformer
+
+```bash
+npx klasik generate \
+  --url https://api.example.com/openapi.yaml \
+  --output ./api-client \
+  --mode full  # Generates complete client with APIs
+```
+
 ## Advanced Configuration
 
 ### Custom Error Handling

package/dist/k8s-client-generator.d.ts

@@ -50,6 +50,11 @@ export declare class K8sClientGenerator {
      * Prepare the output directory
      */
     private prepareOutputDirectory;
+    /**
+     * Ensure the spec file is in JSON format (convert YAML if needed)
+     * openapi-class-transformer requires JSON format
+     */
+    private ensureJsonFormat;
     /**
      * Clean up the downloaded spec file
      */

package/dist/k8s-client-generator.js

@@ -38,6 +38,7 @@ const openapi_class_transformer_1 = require("openapi-class-transformer");
 const spec_downloader_1 = require("./spec-downloader");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
+const yaml = __importStar(require("js-yaml"));
 class K8sClientGenerator {
     constructor() {
         this.downloader = new spec_downloader_1.SpecDownloader();
@@ -63,11 +64,13 @@ class K8sClientGenerator {
             // Step 2: Validate output directory
             console.log('Step 2: Preparing output directory...');
             this.prepareOutputDirectory(outputDir);
+            // Step 2.5: Ensure spec is in JSON format for openapi-class-transformer
+            const jsonSpecPath = await this.ensureJsonFormat(specPath, outputDir, keepSpec);
             // Step 3: Generate client using openapi-class-transformer
             const modeLabel = mode === 'models-only' ? 'models only' : 'full client';
             console.log(`Step 3: Generating TypeScript ${modeLabel}...`);
             const generatorOptions = {
-                inputSpec: specPath,
+                inputSpec: jsonSpecPath,
                 outputDir,
                 modelsOnly: mode === 'models-only',
             };
@@ -103,6 +106,49 @@ class K8sClientGenerator {
             console.log(`Using existing output directory: ${outputDir}`);
         }
     }
+    /**
+     * Ensure the spec file is in JSON format (convert YAML if needed)
+     * openapi-class-transformer requires JSON format
+     */
+    async ensureJsonFormat(specPath, outputDir, keepSpec) {
+        const content = fs.readFileSync(specPath, 'utf-8');
+        let spec;
+        // Try to parse as JSON first
+        try {
+            spec = JSON.parse(content);
+            // Already JSON, return as-is
+            return specPath;
+        }
+        catch {
+            // Not JSON, try YAML
+            try {
+                spec = yaml.load(content);
+            }
+            catch {
+                throw new Error('Failed to parse spec: not valid JSON or YAML');
+            }
+        }
+        // Convert YAML to JSON
+        console.log('Converting YAML spec to JSON format for code generation...');
+        const jsonContent = JSON.stringify(spec, null, 2);
+        // Determine output path for JSON spec
+        let jsonSpecPath;
+        if (keepSpec) {
+            // Save as openapi-spec.json in output directory
+            jsonSpecPath = path.join(outputDir, 'openapi-spec.json');
+        }
+        else {
+            // Create a temporary JSON file
+            const tempDir = path.join(process.cwd(), '.tmp');
+            if (!fs.existsSync(tempDir)) {
+                fs.mkdirSync(tempDir, { recursive: true });
+            }
+            jsonSpecPath = path.join(tempDir, `openapi-${Date.now()}.json`);
+        }
+        fs.writeFileSync(jsonSpecPath, jsonContent, 'utf-8');
+        console.log(`JSON spec saved to: ${jsonSpecPath}`);
+        return jsonSpecPath;
+    }
     /**
      * Clean up the downloaded spec file
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "klasik",
-  "version": "1.0.16",
+  "version": "1.0.19",
   "description": "Download OpenAPI specs from remote URLs and generate TypeScript clients with class-transformer support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/templates/apiInner.mustache

@@ -0,0 +1,526 @@
+{{#withSeparateModelsAndApi}}
+/* tslint:disable */
+/* eslint-disable */
+{{>licenseInfo}}
+
+import type { Configuration } from '{{apiRelativeToRoot}}configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios, { type AxiosResponse } from 'axios';
+import { plainToInstance } from 'class-transformer';
+{{#withNodeImports}}
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+{{#multipartFormData}}
+import FormData from 'form-data'
+{{/multipartFormData}}
+{{/withNodeImports}}
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '{{apiRelativeToRoot}}common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '{{apiRelativeToRoot}}base';
+{{#imports}}
+// @ts-ignore
+import { {{classname}} } from '{{apiRelativeToRoot}}{{tsModelPackage}}';
+{{/imports}}
+{{/withSeparateModelsAndApi}}
+{{^withSeparateModelsAndApi}}
+{{/withSeparateModelsAndApi}}
+{{#operations}}
+/**
+ * {{classname}} - Axios parameter creator
+ *{{#description}}
+ * {{&description}}
+ *{{/description}}
+ * Generates request parameters for {{classname}} API endpoints.
+ *
+ * @export
+ * @returns Parameter creators for each API endpoint
+ */
+export const {{classname}}AxiosParamCreator = function (configuration?: Configuration) {
+    return {
+    {{#operation}}
+        /**
+         * {{nickname}}{{#summary}} - {{&summary}}{{/summary}}
+         *
+         {{#notes}}
+         * {{&notes}}
+         *
+         {{/notes}}
+         * @method {{httpMethod}}{{#summary}}
+         * @summary {{&summary}}{{/summary}}
+         {{#allParams}}
+         * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}}{{#description}} - {{&description}}{{/description}}{{#required}} (required){{/required}}
+         {{/allParams}}
+         * @param {RawAxiosRequestConfig} [options] Override http request option.{{#isDeprecated}}
+         * @deprecated This endpoint is deprecated{{/isDeprecated}}
+         * @throws {RequiredError} When required parameters are missing
+         * @returns {Promise<RequestArgs>} Request configuration
+         */
+        {{nickname}}: async ({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+    {{#allParams}}
+    {{#required}}
+            // verify required parameter '{{paramName}}' is not null or undefined
+            assertParamExists('{{nickname}}', '{{paramName}}', {{paramName}})
+    {{/required}}
+    {{/allParams}}
+            const localVarPath = `{{{path}}}`{{#pathParams}}
+                .replace(`{${"{{baseName}}"}}`, encodeURIComponent(String({{paramName}}))){{/pathParams}};
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: '{{httpMethod}}', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;{{#vendorExtensions}}{{#hasFormParams}}
+            const localVarFormParams = new {{^multipartFormData}}URLSearchParams(){{/multipartFormData}}{{#multipartFormData}}((configuration && configuration.formDataCtor) || FormData)(){{/multipartFormData}};{{/hasFormParams}}{{/vendorExtensions}}
+
+    {{#authMethods}}
+            // authentication {{name}} required
+            {{#isApiKey}}
+            {{#isKeyInHeader}}
+            await setApiKeyToObject(localVarHeaderParameter, "{{keyParamName}}", configuration)
+            {{/isKeyInHeader}}
+            {{#isKeyInQuery}}
+            await setApiKeyToObject(localVarQueryParameter, "{{keyParamName}}", configuration)
+            {{/isKeyInQuery}}
+            {{/isApiKey}}
+            {{#isBasicBasic}}
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+            {{/isBasicBasic}}
+            {{#isBasicBearer}}
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+            {{/isBasicBearer}}
+            {{#isOAuth}}
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "{{name}}", [{{#scopes}}"{{{scope}}}"{{^-last}}, {{/-last}}{{/scopes}}], configuration)
+            {{/isOAuth}}
+
+    {{/authMethods}}
+    {{#queryParams}}
+            {{#isArray}}
+            if ({{paramName}}) {
+            {{#isCollectionFormatMulti}}
+                {{#uniqueItems}}
+                localVarQueryParameter['{{baseName}}'] = Array.from({{paramName}});
+                {{/uniqueItems}}
+                {{^uniqueItems}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}};
+                {{/uniqueItems}}
+            {{/isCollectionFormatMulti}}
+            {{^isCollectionFormatMulti}}
+                {{#uniqueItems}}
+                localVarQueryParameter['{{baseName}}'] = Array.from({{paramName}}).join(COLLECTION_FORMATS.{{collectionFormat}});
+                {{/uniqueItems}}
+                {{^uniqueItems}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}}.join(COLLECTION_FORMATS.{{collectionFormat}});
+                {{/uniqueItems}}
+            {{/isCollectionFormatMulti}}
+            }
+            {{/isArray}}
+            {{^isArray}}
+            if ({{paramName}} !== undefined) {
+                {{#isDateTime}}
+                localVarQueryParameter['{{baseName}}'] = ({{paramName}} as any instanceof Date) ?
+                    ({{paramName}} as any).toISOString() :
+                    {{paramName}};
+                {{/isDateTime}}
+                {{^isDateTime}}
+                {{#isDate}}
+                localVarQueryParameter['{{baseName}}'] = ({{paramName}} as any instanceof Date) ?
+                    ({{paramName}} as any).toISOString().substring(0,10) :
+                    {{paramName}};
+                {{/isDate}}
+                {{^isDate}}
+                {{#isExplode}}
+                {{#isPrimitiveType}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}};
+                {{/isPrimitiveType}}
+                {{^isPrimitiveType}}
+                {{^isEnumRef}}
+                {{^isEnum}}
+                for (const [key, value] of Object.entries({{paramName}})) {
+                    localVarQueryParameter[key] = value;
+                }
+                {{/isEnum}}
+                {{/isEnumRef}}
+                {{#isEnum}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}};
+                {{/isEnum}}
+                {{#isEnumRef}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}};
+                {{/isEnumRef}}
+                {{/isPrimitiveType}}
+                {{/isExplode}}
+                {{^isExplode}}
+                localVarQueryParameter['{{baseName}}'] = {{paramName}};
+                {{/isExplode}}
+                {{/isDate}}
+                {{/isDateTime}}
+            }
+            {{/isArray}}
+
+    {{/queryParams}}
+    {{#vendorExtensions}}
+    {{#formParams}}
+            {{#isArray}}
+            if ({{paramName}}) {
+            {{#isCollectionFormatMulti}}
+              {{#contentType}}
+                localVarFormParams.append('{{baseName}}', new Blob([JSON.stringify({{paramName}})], { type: "{{contentType}}", }));
+              {{/contentType}}
+              {{^contentType}}
+                {{paramName}}.forEach((element) => {
+                    localVarFormParams.{{#multipartFormData}}append{{/multipartFormData}}{{^multipartFormData}}set{{/multipartFormData}}('{{baseName}}{{#useSquareBracketsInArrayNames}}[]{{/useSquareBracketsInArrayNames}}', element as any);
+                })
+              {{/contentType}}
+            {{/isCollectionFormatMulti}}
+            {{^isCollectionFormatMulti}}
+                localVarFormParams.{{#multipartFormData}}append{{/multipartFormData}}{{^multipartFormData}}set{{/multipartFormData}}('{{baseName}}{{#useSquareBracketsInArrayNames}}[]{{/useSquareBracketsInArrayNames}}', {{paramName}}.join(COLLECTION_FORMATS.{{collectionFormat}}));
+            {{/isCollectionFormatMulti}}
+            }{{/isArray}}
+            {{^isArray}}
+            if ({{paramName}} !== undefined) { {{^multipartFormData}}
+                localVarFormParams.set('{{baseName}}', {{paramName}} as any);{{/multipartFormData}}{{#multipartFormData}}{{#isPrimitiveType}}{{^isBoolean}}
+                localVarFormParams.append('{{baseName}}', {{paramName}} as any);{{/isBoolean}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isBoolean}}
+                localVarFormParams.append('{{baseName}}', String({{paramName}}) as any);{{/isBoolean}}{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isEnumRef}}
+                localVarFormParams.append('{{baseName}}', {{paramName}} as any);{{/isEnumRef}}{{^isEnumRef}}
+                localVarFormParams.append('{{baseName}}', new Blob([JSON.stringify({{paramName}})], { type: "application/json", }));{{/isEnumRef}}{{/isPrimitiveType}}{{/multipartFormData}}
+            }{{/isArray}}
+    {{/formParams}}{{/vendorExtensions}}
+    {{#vendorExtensions}}{{#hasFormParams}}{{^multipartFormData}}
+            localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';{{/multipartFormData}}{{#multipartFormData}}
+            localVarHeaderParameter['Content-Type'] = 'multipart/form-data';{{/multipartFormData}}
+    {{/hasFormParams}}{{/vendorExtensions}}
+    {{#bodyParam}}
+            {{^consumes}}
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            {{/consumes}}
+            {{#consumes.0}}
+            localVarHeaderParameter['Content-Type'] = '{{{mediaType}}}';
+            {{/consumes.0}}
+
+    {{/bodyParam}}
+    {{#headerParams}}
+            {{#isArray}}
+            if ({{paramName}}) {
+                {{#uniqueItems}}
+                let mapped = Array.from({{paramName}}).map(value => (<any>"{{{dataType}}}" !== "Set<string>") ? JSON.stringify(value) : (value || ""));
+                {{/uniqueItems}}
+                {{^uniqueItems}}
+                let mapped = {{paramName}}.map(value => (<any>"{{{dataType}}}" !== "Array<string>") ? JSON.stringify(value) : (value || ""));
+                {{/uniqueItems}}
+                localVarHeaderParameter['{{baseName}}'] = mapped.join(COLLECTION_FORMATS["{{collectionFormat}}"]);
+            }
+            {{/isArray}}
+            {{^isArray}}
+            {{! `val == null` covers for both `null` and `undefined`}}
+            if ({{paramName}} != null) {
+                {{#isString}}
+                localVarHeaderParameter['{{baseName}}'] = String({{paramName}});
+                {{/isString}}
+                {{^isString}}
+                {{! isString is falsy also for $ref that defines a string or enum type}}
+                localVarHeaderParameter['{{baseName}}'] = typeof {{paramName}} === 'string'
+                    ? {{paramName}}
+                    : JSON.stringify({{paramName}});
+                {{/isString}}
+            }
+            {{/isArray}}
+    {{/headerParams}}
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions,{{#hasFormParams}}{{#multipartFormData}} ...(localVarFormParams as any).getHeaders?.(),{{/multipartFormData}}{{/hasFormParams}} ...options.headers};
+    {{#hasFormParams}}
+            localVarRequestOptions.data = localVarFormParams{{#vendorExtensions}}{{^multipartFormData}}.toString(){{/multipartFormData}}{{/vendorExtensions}};
+    {{/hasFormParams}}
+    {{#bodyParam}}
+            localVarRequestOptions.data = serializeDataIfNeeded({{paramName}}, localVarRequestOptions, configuration)
+    {{/bodyParam}}
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    {{/operation}}
+    }
+};
+
+/**
+ * {{classname}} - functional programming interface{{#description}}
+ * {{{.}}}{{/description}}
+ * @export
+ */
+export const {{classname}}Fp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = {{classname}}AxiosParamCreator(configuration)
+    return {
+    {{#operation}}
+        /**
+         * {{nickname}}{{#summary}} - {{&summary}}{{/summary}}
+         *
+         {{#notes}}
+         * {{&notes}}
+         *
+         {{/notes}}
+         * @method {{httpMethod}}{{#summary}}
+         * @summary {{&summary}}{{/summary}}
+         {{#allParams}}
+         * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}}{{#description}} - {{&description}}{{/description}}{{#required}} (required){{/required}}
+         {{/allParams}}
+         * @param {RawAxiosRequestConfig} [options] Override http request option.{{#isDeprecated}}
+         * @deprecated This endpoint is deprecated{{/isDeprecated}}
+         * @throws {RequiredError} When required parameters are missing
+         * @returns {Promise<RequestArgs>} Request configuration
+         */
+        async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['{{classname}}.{{nickname}}']?.[localVarOperationServerIndex]?.url;
+            {{#returnType}}
+            {{^returnTypeIsPrimitive}}
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath).then(response => {
+                // Check if response transformation is enabled (default: true)
+                if (configuration?.enableResponseTransformation !== false) {
+                    try {
+                        {{#isArray}}
+                        response.data = plainToInstance({{returnBaseType}}, response.data as any[]);
+                        {{/isArray}}
+                        {{^isArray}}
+                        response.data = plainToInstance({{returnBaseType}}, response.data);
+                        {{/isArray}}
+                    } catch (error) {
+                        // Handle transformation errors
+                        if (configuration?.onTransformationError) {
+                            configuration.onTransformationError(error as Error, {{returnBaseType}}, response.data);
+                        } else {
+                            console.error('class-transformer failed to transform response:', error);
+                            console.error('Returning original response data. To handle this error, provide onTransformationError in Configuration.');
+                        }
+                        // Return original data on error (cast for type safety)
+                        {{#isArray}}
+                        response.data = response.data as any as {{returnBaseType}}[];
+                        {{/isArray}}
+                        {{^isArray}}
+                        response.data = response.data as any as {{returnBaseType}};
+                        {{/isArray}}
+                    }
+                }
+                return response as AxiosResponse<{{#isArray}}{{returnBaseType}}[]{{/isArray}}{{^isArray}}{{returnBaseType}}{{/isArray}}>;
+            });
+            {{/returnTypeIsPrimitive}}
+            {{#returnTypeIsPrimitive}}
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            {{/returnTypeIsPrimitive}}
+            {{/returnType}}
+            {{^returnType}}
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            {{/returnType}}
+        },
+    {{/operation}}
+    }
+};
+
+/**
+ * {{classname}} - factory interface{{#description}}
+ * {{&description}}{{/description}}
+ * @export
+ */
+export const {{classname}}Factory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = {{classname}}Fp(configuration)
+    return {
+    {{#operation}}
+        /**
+         * {{&notes}}
+         {{#summary}}
+         * @summary {{&summary}}
+         {{/summary}}
+        {{#useSingleRequestParameter}}
+         {{#allParams.0}}
+         * @param {{=<% %>=}}{<%& classname %><%& operationIdCamelCase %>Request}<%={{ }}=%> requestParameters Request parameters.
+         {{/allParams.0}}
+        {{/useSingleRequestParameter}}
+        {{^useSingleRequestParameter}}
+         {{#allParams}}
+         * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}}
+         {{/allParams}}
+        {{/useSingleRequestParameter}}
+         * @param {*} [options] Override http request option.{{#isDeprecated}}
+         * @deprecated{{/isDeprecated}}
+         * @throws {RequiredError}
+         */
+        {{#useSingleRequestParameter}}
+        {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, {{/allParams.0}}options?: RawAxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}> {
+            return localVarFp.{{nickname}}({{#allParams.0}}{{#allParams}}requestParameters.{{paramName}}, {{/allParams}}{{/allParams.0}}options).then((request) => request(axios, basePath));
+        },
+        {{/useSingleRequestParameter}}
+        {{^useSingleRequestParameter}}
+        {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: RawAxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}> {
+            return localVarFp.{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options).then((request) => request(axios, basePath));
+        },
+        {{/useSingleRequestParameter}}
+    {{/operation}}
+    };
+};
+
+{{#withInterfaces}}
+/**
+ * {{classname}} - interface{{#description}}
+ * {{&description}}{{/description}}
+ * @export
+ * @interface {{classname}}
+ */
+export interface {{classname}}Interface {
+{{#operation}}
+    /**
+     * {{nickname}}{{#summary}} - {{&summary}}{{/summary}}
+     *
+     {{#notes}}
+     * {{&notes}}
+     *
+     {{/notes}}
+     * @method {{httpMethod}}{{#summary}}
+     * @summary {{&summary}}{{/summary}}
+     {{#useSingleRequestParameter}}
+     {{#allParams.0}}
+     * @param {{=<% %>=}}{<%& classname %><%& operationIdCamelCase %>Request}<%={{ }}=%> requestParameters Request parameters.
+     {{/allParams.0}}
+     {{/useSingleRequestParameter}}
+     {{^useSingleRequestParameter}}
+     {{#allParams}}
+     * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}}{{#description}} - {{&description}}{{/description}}{{#required}} (required){{/required}}
+     {{/allParams}}
+     {{/useSingleRequestParameter}}
+     * @param {RawAxiosRequestConfig} [options] Override http request option.{{#isDeprecated}}
+     * @deprecated This endpoint is deprecated{{/isDeprecated}}
+     * @throws {RequiredError} When required parameters are missing
+     * @memberof {{classname}}Interface
+     * @returns {{=<% %>=}}{Promise<AxiosResponse<<%returnType%><%^returnType%>void<%/returnType%>>>}<%={{ }}=%>
+     */
+    {{#useSingleRequestParameter}}
+    {{nickname}}({{#allParams.0}}requestParameters{{^hasRequiredParams}}?{{/hasRequiredParams}}: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}options?: RawAxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>;
+    {{/useSingleRequestParameter}}
+    {{^useSingleRequestParameter}}
+    {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: RawAxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>;
+    {{/useSingleRequestParameter}}
+
+{{/operation}}
+}
+
+{{/withInterfaces}}
+{{#useSingleRequestParameter}}
+{{#operation}}
+{{#allParams.0}}
+/**
+ * Request parameters for {{nickname}} operation in {{classname}}.
+ * @export
+ * @interface {{classname}}{{operationIdCamelCase}}Request
+ */
+export interface {{classname}}{{operationIdCamelCase}}Request {
+    {{#allParams}}
+    /**
+     * {{description}}
+     * @type {{=<% %>=}}{<%&dataType%>}<%={{ }}=%>
+     * @memberof {{classname}}{{operationIdCamelCase}}
+     */
+    readonly {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}
+    {{^-last}}
+
+    {{/-last}}
+    {{/allParams}}
+}
+
+{{/allParams.0}}
+{{/operation}}
+{{/useSingleRequestParameter}}
+/**
+ * {{classname}} - object-oriented interface{{#description}}
+ * {{{.}}}{{/description}}
+ * @export
+ * @class {{classname}}
+ * @extends {BaseAPI}
+ */
+{{#withInterfaces}}
+export class {{classname}} extends BaseAPI implements {{classname}}Interface {
+{{/withInterfaces}}
+{{^withInterfaces}}
+export class {{classname}} extends BaseAPI {
+{{/withInterfaces}}
+    {{#operation}}
+    /**
+     * {{&notes}}
+     {{#summary}}
+     * @summary {{&summary}}
+     {{/summary}}
+     {{#useSingleRequestParameter}}
+     {{#allParams.0}}
+     * @param {{=<% %>=}}{<%& classname %><%& operationIdCamelCase %>Request}<%={{ }}=%> requestParameters Request parameters.
+     {{/allParams.0}}
+     {{/useSingleRequestParameter}}
+     {{^useSingleRequestParameter}}
+     {{#allParams}}
+     * @param {{=<% %>=}}{<%#isEnum%><%&datatypeWithEnum%><%/isEnum%><%^isEnum%><%&dataType%><%#isNullable%> | null<%/isNullable%><%/isEnum%>}<%={{ }}=%> {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}}
+     {{/allParams}}
+     {{/useSingleRequestParameter}}
+     * @param {*} [options] Override http request option.{{#isDeprecated}}
+     * @deprecated{{/isDeprecated}}
+     * @throws {RequiredError}
+     * @memberof {{classname}}
+     */
+    {{#useSingleRequestParameter}}
+    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, {{/allParams.0}}options?: RawAxiosRequestConfig) {
+        return {{classname}}Fp(this.configuration).{{nickname}}({{#allParams.0}}{{#allParams}}requestParameters.{{paramName}}, {{/allParams}}{{/allParams.0}}options).then((request) => request(this.axios, this.basePath));
+    }
+    {{/useSingleRequestParameter}}
+    {{^useSingleRequestParameter}}
+    public {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}options?: RawAxiosRequestConfig) {
+        return {{classname}}Fp(this.configuration).{{nickname}}({{#allParams}}{{paramName}}, {{/allParams}}options).then((request) => request(this.axios, this.basePath));
+    }
+    {{/useSingleRequestParameter}}
+    {{^-last}}
+
+    {{/-last}}
+    {{/operation}}
+}
+{{/operations}}
+
+{{#operations}}
+{{#operation}}
+{{#allParams}}
+{{#isEnum}}
+{{#stringEnums}}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum {{operationIdCamelCase}}{{enumName}} {
+{{#allowableValues}}
+    {{#enumVars}}
+    {{{name}}} = {{{value}}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+{{/allowableValues}}
+}
+{{/stringEnums}}
+{{^stringEnums}}
+/**
+ * @export
+ */
+export const {{operationIdCamelCase}}{{enumName}} = {
+{{#allowableValues}}
+    {{#enumVars}}
+    {{{name}}}: {{{value}}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+{{/allowableValues}}
+} as const;
+export type {{operationIdCamelCase}}{{enumName}} = typeof {{operationIdCamelCase}}{{enumName}}[keyof typeof {{operationIdCamelCase}}{{enumName}}];
+{{/stringEnums}}
+{{/isEnum}}
+{{/allParams}}
+{{/operation}}
+{{/operations}}

package/templates/modelGeneric.mustache

@@ -0,0 +1,137 @@
+
+import { Expose, Type } from 'class-transformer';{{#nestJsSwagger}}
+import { ApiProperty } from '@nestjs/swagger';{{/nestJsSwagger}}
+
+{{#description}}
+/**
+ * {{classname}}
+ *
+ * {{{description}}}
+ *
+ * @export
+ * @class {{classname}}{{#parent}}
+ * @extends {{=<% %>=}}{<%parent%>}<%={{ }}=%>{{/parent}}
+ */
+{{/description}}
+{{^description}}
+/**
+ * {{classname}}
+ *
+ * @export
+ * @class {{classname}}{{#parent}}
+ * @extends {{=<% %>=}}{<%parent%>}<%={{ }}=%>{{/parent}}
+ */
+{{/description}}
+export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
+{{#additionalPropertiesType}}
+    [key: string]: {{{additionalPropertiesType}}}{{#additionalPropertiesIsAnyType}}{{#hasVars}} | any{{/hasVars}}{{/additionalPropertiesIsAnyType}};
+
+{{/additionalPropertiesType}}
+{{#vars}}
+    /**
+     * {{baseName}}{{#description}} - {{{description}}}{{/description}}
+     *
+     * @type {{=<% %>=}}{<%&dataType%><%#isNullable%> | null<%/isNullable%>}<%={{ }}=%>
+     * @memberof {{classname}}{{#required}}
+     * @required{{/required}}{{#deprecated}}
+     * @deprecated{{/deprecated}}{{#dataFormat}}
+     * @format {{dataFormat}}{{/dataFormat}}{{#minimum}}
+     * @minimum {{minimum}}{{/minimum}}{{#maximum}}
+     * @maximum {{maximum}}{{/maximum}}{{#minLength}}
+     * @minLength {{minLength}}{{/minLength}}{{#maxLength}}
+     * @maxLength {{maxLength}}{{/maxLength}}{{#pattern}}
+     * @pattern {{pattern}}{{/pattern}}{{#example}}
+     * @example {{=<% %>=}}<%&example%><%={{ }}=%>{{/example}}
+     */{{#nestJsSwagger}}
+    @ApiProperty({
+        description: {{#description}}`{{{description}}}`{{/description}}{{^description}}undefined{{/description}},{{#required}}
+        required: true,{{/required}}{{^required}}
+        required: false,{{/required}}{{#isNullable}}
+        nullable: true,{{/isNullable}}{{#deprecated}}
+        deprecated: true,{{/deprecated}}{{#isEnum}}
+        enum: {{enumName}},{{/isEnum}}{{^isEnum}}{{#isContainer}}
+        type: () => [{{#items}}{{^isPrimitiveType}}{{{complexType}}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{{datatype}}}{{/isPrimitiveType}}{{/items}}],{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
+        type: () => {{{dataType}}},{{/isPrimitiveType}}{{#isPrimitiveType}}
+        type: '{{{datatype}}}',{{/isPrimitiveType}}{{/isContainer}}{{/isEnum}}{{#dataFormat}}
+        format: '{{dataFormat}}',{{/dataFormat}}{{#example}}
+        example: {{=<% %>=}}<%&example%><%={{ }}=%>,{{/example}}{{#minimum}}
+        minimum: {{minimum}},{{/minimum}}{{#maximum}}
+        maximum: {{maximum}},{{/maximum}}{{#minLength}}
+        minLength: {{minLength}},{{/minLength}}{{#maxLength}}
+        maxLength: {{maxLength}},{{/maxLength}}{{#pattern}}
+        pattern: '{{pattern}}',{{/pattern}}
+    }){{/nestJsSwagger}}
+    @Expose()
+    {{^isPrimitiveType}}{{^isEnum}}{{#isContainer}}{{#items}}{{^isPrimitiveType}}@Type(() => {{{complexType}}}){{/isPrimitiveType}}{{/items}}{{/isContainer}}{{^isContainer}}@Type(() => {{{dataType}}}){{/isContainer}}
+    {{/isEnum}}{{/isPrimitiveType}}'{{baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
+{{/vars}}
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string, description?: string, vendorExtensions?: any, modelClass?: any}> = [
+{{#vars}}
+        {
+            "name": "{{name}}",
+            "baseName": "{{baseName}}",
+            "type": "{{#isContainer}}Array<{{#items}}{{datatype}}{{/items}}>{{/isContainer}}{{^isContainer}}{{datatype}}{{/isContainer}}",
+            "format": "{{dataFormat}}",
+            "description": {{#description}}`{{description}}`{{/description}}{{^description}}undefined{{/description}},
+            "vendorExtensions": {}{{^isPrimitiveType}}{{^isEnum}},
+            "modelClass": {{#isContainer}}{{#items}}{{^isPrimitiveType}}{{{complexType}}}{{/isPrimitiveType}}{{#isPrimitiveType}}undefined{{/isPrimitiveType}}{{/items}}{{/isContainer}}{{^isContainer}}{{{dataType}}}{{/isContainer}}{{/isEnum}}{{/isPrimitiveType}}
+        }{{^-last}},{{/-last}}
+{{/vars}}
+    ];
+}{{#hasEnums}}
+
+{{#vars}}
+{{#isEnum}}
+{{#stringEnums}}
+{{#allowableValues}}
+/**
+ * Enum for {{enumName}}{{#description}}
+ *
+ * {{{description}}}{{/description}}
+ *
+ * @export
+ * @enum {string}
+ */
+{{/allowableValues}}
+export enum {{enumName}} {
+{{#allowableValues}}
+    {{#enumVars}}
+    {{#enumDescription}}
+    /**
+     * {{.}}
+     */
+    {{/enumDescription}}
+    {{{name}}} = {{{value}}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+{{/allowableValues}}
+}
+{{/stringEnums}}
+{{^stringEnums}}
+{{#allowableValues}}
+/**
+ * Constant for {{enumName}}{{#description}}
+ *
+ * {{{description}}}{{/description}}
+ *
+ * @export
+ */
+{{/allowableValues}}
+export const {{enumName}} = {
+{{#allowableValues}}
+    {{#enumVars}}
+    {{#enumDescription}}
+    /**
+     * {{.}}
+     */
+    {{/enumDescription}}
+    {{{name}}}: {{{value}}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+{{/allowableValues}}
+} as const;
+
+export type {{enumName}} = typeof {{enumName}}[keyof typeof {{enumName}}];
+{{/stringEnums}}
+{{/isEnum}}
+{{/vars}}
+{{/hasEnums}}