ng-openapi 0.0.3 → 0.0.4

package/README.md

@@ -1,5 +1,10 @@
-# ng-openapi Usage Guide
+# Angular OpenAPI client generator
 
+[![npm version](https://img.shields.io/npm/v/ng-openapi.svg)](https://www.npmjs.com/package/ng-openapi)
+## 💪 Made with ❤️ by Angular Devs for Angular Devs
+
+
+## Quick Start Guide
 ## Installation
 
 ```bash
@@ -84,13 +89,13 @@ ng-openapi -i ./swagger.json -o ./src/api --date-type string
 
 ### Optional Fields
 
-- `options.dateType` - How to handle date types: `'string'` or `'Date'` (default: `'Date'`)
-- `options.enumStyle` - Enum generation style: `'enum'` or `'union'` (default: `'enum'`)
-- `options.generateEnumBasedOnDescription` - Parse enum values from description field (default: `true`)
-- `options.generateServices` - Generate Angular services (default: `true`)
-- `options.customHeaders` - Headers to add to all HTTP requests
-- `options.responseTypeMapping` - Map content types to Angular HttpClient response types
-- `options.customizeMethodName` - Function to customize generated method names
+- `dateType` - How to handle date types: `'string'` or `'Date'` (default: `'Date'`)
+- `enumStyle` - Enum generation style: `'enum'` or `'union'` (default: `'enum'`)
+- `generateEnumBasedOnDescription` - Parse enum values from description field (default: `true`)
+- `generateServices` - Generate Angular services (default: `true`)
+- `customHeaders` - Headers to add to all HTTP requests
+- `responseTypeMapping` - Map content types to Angular HttpClient response types
+- `customizeMethodName` - Function to customize generated method names
 - `compilerOptions` - TypeScript compiler options for code generation
 
 ## Generated Files Structure
@@ -104,44 +109,60 @@ output/
 │   └── *.service.ts    # Angular services
 ├── tokens/
 │   └── index.ts        # Injection tokens
-└── utils/
-    ├── date-transformer.ts  # Date transformation interceptor
-    └── file-download.ts     # File download helpers
+├── utils/
+│   ├── date-transformer.ts  # Date transformation interceptor
+│   └── file-download.ts     # File download helpers
+├── providers.ts        # Provider functions for easy setup
+└── index.ts           # Main exports
 ```
 
 ## Angular Integration
 
-### 1. Configure Base Path
+### 🚀 Easy Setup (Recommended)
+
+The simplest way to integrate ng-openapi is using the provider function:
 
 ```typescript
-import { BASE_PATH } from './api/tokens';
+// In your app.config.ts
+import { ApplicationConfig } from '@angular/core';
+import { provideNgOpenapi } from './api/providers';
 
-// In your app.config.ts or module
 export const appConfig: ApplicationConfig = {
   providers: [
-    { provide: BASE_PATH, useValue: 'https://api.example.com' },
+    // One-line setup with automatic interceptor configuration
+    provideNgOpenapi({
+      basePath: 'https://api.example.com'
+    }),
     // other providers...
   ]
 };
 ```
 
-### 2. Add Date Interceptor (if using Date type)
+That's it! This automatically configures:
+- ✅ BASE_PATH token
+- ✅ Date transformation interceptor (if using Date type)
 
-```typescript
-import { DateInterceptor } from './api/utils/date-transformer';
-import { HTTP_INTERCEPTORS } from '@angular/common/http';
 
-export const appConfig: ApplicationConfig = {
-  providers: [
-    { provide: HTTP_INTERCEPTORS, useClass: DateInterceptor, multi: true },
-    // other providers...
-  ]
-};
+### Advanced Provider Options
+
+```typescript
+// Disable date transformation
+provideNgOpenapi({
+  basePath: 'https://api.example.com',
+  enableDateTransform: false
+});
+
+// Async configuration
+provideNgOpenapiAsync({
+  basePath: () => import('./config').then(c => c.apiConfig.baseUrl)
+});
 ```
 
-### 3. Use Generated Services
+## Using Generated Services
 
 ```typescript
+import { Component, inject } from '@angular/core';
+import { toSignal } from '@angular/core/rxjs-interop';
 import { UserService } from './api/services';
 import { User } from './api/models';
 
@@ -150,19 +171,19 @@ import { User } from './api/models';
   template: `...`
 })
 export class UsersComponent {
-  users$ = this.userService.getUsers();
-
-  constructor(private userService: UserService) {}
+  private readonly userService = inject(UserService);
+  readonly users = toSignal(this.userService.getUsers());
 }
 ```
 
 ## File Download Example
 
 ```typescript
+import { Component, inject } from '@angular/core';
 import { downloadFileOperator } from './api/utils/file-download';
 
 export class ReportComponent {
-  constructor(private reportService: ReportService) {}
+  private readonly reportService = inject(ReportService);
 
   downloadReport() {
     this.reportService.getReport('pdf', { reportId: 123 })
@@ -181,8 +202,7 @@ Add these scripts to your `package.json`:
 ```json
 {
   "scripts": {
-    "generate:api": "ng-openapi -c openapi.config.ts",
-    "generate:api:watch": "nodemon --watch swagger.json --exec npm run generate:api"
+    "generate:api": "ng-openapi -c openapi.config.ts"
   }
 }
 ```

package/cli.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // src/lib/cli.ts
 var import_commander = require("commander");
-var path7 = __toESM(require("path"));
+var path8 = __toESM(require("path"));
 var fs4 = __toESM(require("fs"));
 
 // src/lib/core/swagger-parser.ts
@@ -89,6 +89,10 @@ var MAIN_INDEX_GENERATOR_HEADER_COMMENT = defaultHeaderComment + `* Entrypoint f
 * Do not edit this file manually
 */
 `;
+var PROVIDER_GENERATOR_HEADER_COMMENT = defaultHeaderComment + `* Generated provider functions for easy setup
+* Do not edit this file manually
+*/
+`;
 
 // src/lib/generators/type/type.generator.ts
 var TypeGenerator = class {
@@ -731,11 +735,16 @@ var MainIndexGenerator = class {
       moduleSpecifier: "./models"
     });
     sourceFile.addExportDeclaration({
-      moduleSpecifier: "./services"
+      moduleSpecifier: "./tokens"
     });
     sourceFile.addExportDeclaration({
-      moduleSpecifier: "./tokens"
+      moduleSpecifier: "./providers"
     });
+    if (this.config.options.generateServices !== false) {
+      sourceFile.addExportDeclaration({
+        moduleSpecifier: "./services"
+      });
+    }
     if (this.config.options.dateType === "Date") {
       sourceFile.addExportDeclaration({
         moduleSpecifier: "./utils/date-transformer"
@@ -1487,7 +1496,7 @@ var ServiceGenerator = class {
   extractPaths() {
     const paths = [];
     const swaggerPaths = this.spec.paths || {};
-    Object.entries(swaggerPaths).forEach(([path8, pathItem]) => {
+    Object.entries(swaggerPaths).forEach(([path9, pathItem]) => {
       const methods = [
         "get",
         "post",
@@ -1501,7 +1510,7 @@ var ServiceGenerator = class {
         if (pathItem[method]) {
           const operation = pathItem[method];
           paths.push({
-            path: path8,
+            path: path9,
             method: method.toUpperCase(),
             operationId: operation.operationId,
             summary: operation.summary,
@@ -1533,12 +1542,12 @@ var ServiceGenerator = class {
   }
   groupPathsByController(paths) {
     const groups = {};
-    paths.forEach((path8) => {
+    paths.forEach((path9) => {
       let controllerName = "Default";
-      if (path8.tags && path8.tags.length > 0) {
-        controllerName = path8.tags[0];
+      if (path9.tags && path9.tags.length > 0) {
+        controllerName = path9.tags[0];
       } else {
-        const pathParts = path8.path.split("/").filter((p) => p && !p.startsWith("{"));
+        const pathParts = path9.path.split("/").filter((p) => p && !p.startsWith("{"));
         if (pathParts.length > 1) {
           controllerName = pascalCase(pathParts[1]);
         }
@@ -1547,7 +1556,7 @@ var ServiceGenerator = class {
       if (!groups[controllerName]) {
         groups[controllerName] = [];
       }
-      groups[controllerName].push(path8);
+      groups[controllerName].push(path9);
     });
     return groups;
   }
@@ -1740,6 +1749,198 @@ var ServiceIndexGenerator = class {
   }
 };
 
+// src/lib/generators/utility/provider.generator.ts
+var path7 = __toESM(require("path"));
+var ProviderGenerator = class {
+  static {
+    __name(this, "ProviderGenerator");
+  }
+  project;
+  config;
+  constructor(project, config) {
+    this.project = project;
+    this.config = config;
+  }
+  generate(outputDir) {
+    const filePath = path7.join(outputDir, "providers.ts");
+    const sourceFile = this.project.createSourceFile(filePath, "", {
+      overwrite: true
+    });
+    sourceFile.insertText(0, PROVIDER_GENERATOR_HEADER_COMMENT);
+    sourceFile.addImportDeclarations([
+      {
+        namedImports: [
+          "EnvironmentProviders",
+          "Provider",
+          "makeEnvironmentProviders"
+        ],
+        moduleSpecifier: "@angular/core"
+      },
+      {
+        namedImports: [
+          "HTTP_INTERCEPTORS"
+        ],
+        moduleSpecifier: "@angular/common/http"
+      },
+      {
+        namedImports: [
+          "BASE_PATH"
+        ],
+        moduleSpecifier: "./tokens"
+      }
+    ]);
+    if (this.config.options.dateType === "Date") {
+      sourceFile.addImportDeclaration({
+        namedImports: [
+          "DateInterceptor"
+        ],
+        moduleSpecifier: "./utils/date-transformer"
+      });
+    }
+    sourceFile.addInterface({
+      name: "NgOpenapiConfig",
+      isExported: true,
+      docs: [
+        "Configuration options for ng-openapi providers"
+      ],
+      properties: [
+        {
+          name: "basePath",
+          type: "string",
+          docs: [
+            "Base API URL"
+          ]
+        },
+        {
+          name: "enableDateTransform",
+          type: "boolean",
+          hasQuestionToken: true,
+          docs: [
+            "Enable automatic date transformation (default: true)"
+          ]
+        }
+      ]
+    });
+    this.addMainProviderFunction(sourceFile);
+    this.addAsyncProviderFunction(sourceFile);
+    sourceFile.saveSync();
+  }
+  addMainProviderFunction(sourceFile) {
+    const hasDateInterceptor = this.config.options.dateType === "Date";
+    const functionBody = `
+const providers: Provider[] = [
+    // Base path token
+    {
+        provide: BASE_PATH,
+        useValue: config.basePath
+    }
+];
+
+${hasDateInterceptor ? `// Add date interceptor if enabled (default: true)
+if (config.enableDateTransform !== false) {
+    providers.push({
+        provide: HTTP_INTERCEPTORS,
+        useClass: DateInterceptor,
+        multi: true
+    });
+}` : `// Date transformation not available (dateType: 'string' was used in generation)`}
+
+return makeEnvironmentProviders(providers);`;
+    sourceFile.addFunction({
+      name: "provideNgOpenapi",
+      isExported: true,
+      docs: [
+        "Provides all necessary configuration for ng-openapi generated services",
+        "",
+        "@example",
+        "```typescript",
+        "// In your app.config.ts",
+        "import { provideNgOpenapi } from './api/providers';",
+        "",
+        "export const appConfig: ApplicationConfig = {",
+        "  providers: [",
+        "    provideNgOpenapi({",
+        "      basePath: 'https://api.example.com'",
+        "    }),",
+        "    // other providers...",
+        "  ]",
+        "};",
+        "```"
+      ],
+      parameters: [
+        {
+          name: "config",
+          type: "NgOpenapiConfig"
+        }
+      ],
+      returnType: "EnvironmentProviders",
+      statements: functionBody
+    });
+  }
+  addAsyncProviderFunction(sourceFile) {
+    const hasDateInterceptor = this.config.options.dateType === "Date";
+    const functionBody = `
+const providers: Provider[] = [];
+
+// Handle async base path
+if (typeof config.basePath === 'string') {
+    providers.push({
+        provide: BASE_PATH,
+        useValue: config.basePath
+    });
+} else {
+    providers.push({
+        provide: BASE_PATH,
+        useFactory: config.basePath
+    });
+}
+
+${hasDateInterceptor ? `// Add date interceptor if enabled (default: true)
+if (config.enableDateTransform !== false) {
+    providers.push({
+        provide: HTTP_INTERCEPTORS,
+        useClass: DateInterceptor,
+        multi: true
+    });
+}` : `// Date transformation not available (dateType: 'string' was used in generation)`}
+
+return makeEnvironmentProviders(providers);`;
+    sourceFile.addFunction({
+      name: "provideNgOpenapiAsync",
+      isExported: true,
+      docs: [
+        "Alternative function for cases where you need to handle async configuration",
+        "",
+        "@example",
+        "```typescript",
+        "// In your app.config.ts",
+        "import { provideNgOpenapiAsync } from './api/providers';",
+        "",
+        "export const appConfig: ApplicationConfig = {",
+        "  providers: [",
+        "    provideNgOpenapiAsync({",
+        "      basePath: () => import('./config').then(c => c.apiConfig.baseUrl)",
+        "    }),",
+        "    // other providers...",
+        "  ]",
+        "};",
+        "```"
+      ],
+      parameters: [
+        {
+          name: "config",
+          type: `{
+  basePath: string | (() => Promise<string>);
+  enableDateTransform?: boolean;
+}`
+        }
+      ],
+      returnType: "EnvironmentProviders",
+      statements: functionBody
+    });
+  }
+};
+
 // src/lib/core/generator.ts
 var fs3 = __toESM(require("fs"));
 async function generateFromConfig(config) {
@@ -1783,6 +1984,9 @@ async function generateFromConfig(config) {
       indexGenerator.generateIndex(outputPath);
       console.log(`\u2705 Angular services generated`);
     }
+    const providerGenerator = new ProviderGenerator(project, config);
+    providerGenerator.generate(outputPath);
+    console.log(`\u2705 Provider functions generated`);
     const mainIndexGenerator = new MainIndexGenerator(project, config);
     mainIndexGenerator.generateMainIndex(outputPath);
     console.log("\u{1F389} Generation completed successfully at:", outputPath);
@@ -1800,7 +2004,7 @@ __name(generateFromConfig, "generateFromConfig");
 // src/lib/cli.ts
 var program = new import_commander.Command();
 async function loadConfigFile(configPath) {
-  const resolvedPath = path7.resolve(configPath);
+  const resolvedPath = path8.resolve(configPath);
   if (!fs4.existsSync(resolvedPath)) {
     throw new Error(`Configuration file not found: ${resolvedPath}`);
   }
@@ -1826,7 +2030,7 @@ async function generateFromOptions(options) {
       const config = await loadConfigFile(options.config);
       await generateFromConfig(config);
     } else if (options.input) {
-      const inputPath = path7.resolve(options.input);
+      const inputPath = path8.resolve(options.input);
       if (!fs4.existsSync(inputPath)) {
         console.error(`Error: Input file not found: ${inputPath}`);
         process.exit(1);

package/index.js

@@ -131,6 +131,10 @@ var MAIN_INDEX_GENERATOR_HEADER_COMMENT = defaultHeaderComment + `* Entrypoint f
 * Do not edit this file manually
 */
 `;
+var PROVIDER_GENERATOR_HEADER_COMMENT = defaultHeaderComment + `* Generated provider functions for easy setup
+* Do not edit this file manually
+*/
+`;
 
 // src/lib/generators/type/type.generator.ts
 var _TypeGenerator = class _TypeGenerator {
@@ -768,11 +772,16 @@ var _MainIndexGenerator = class _MainIndexGenerator {
       moduleSpecifier: "./models"
     });
     sourceFile.addExportDeclaration({
-      moduleSpecifier: "./services"
+      moduleSpecifier: "./tokens"
     });
     sourceFile.addExportDeclaration({
-      moduleSpecifier: "./tokens"
+      moduleSpecifier: "./providers"
     });
+    if (this.config.options.generateServices !== false) {
+      sourceFile.addExportDeclaration({
+        moduleSpecifier: "./services"
+      });
+    }
     if (this.config.options.dateType === "Date") {
       sourceFile.addExportDeclaration({
         moduleSpecifier: "./utils/date-transformer"
@@ -1530,7 +1539,7 @@ var _ServiceGenerator = class _ServiceGenerator {
   extractPaths() {
     const paths = [];
     const swaggerPaths = this.spec.paths || {};
-    Object.entries(swaggerPaths).forEach(([path7, pathItem]) => {
+    Object.entries(swaggerPaths).forEach(([path8, pathItem]) => {
       const methods = [
         "get",
         "post",
@@ -1544,7 +1553,7 @@ var _ServiceGenerator = class _ServiceGenerator {
         if (pathItem[method]) {
           const operation = pathItem[method];
           paths.push({
-            path: path7,
+            path: path8,
             method: method.toUpperCase(),
             operationId: operation.operationId,
             summary: operation.summary,
@@ -1576,12 +1585,12 @@ var _ServiceGenerator = class _ServiceGenerator {
   }
   groupPathsByController(paths) {
     const groups = {};
-    paths.forEach((path7) => {
+    paths.forEach((path8) => {
       let controllerName = "Default";
-      if (path7.tags && path7.tags.length > 0) {
-        controllerName = path7.tags[0];
+      if (path8.tags && path8.tags.length > 0) {
+        controllerName = path8.tags[0];
       } else {
-        const pathParts = path7.path.split("/").filter((p) => p && !p.startsWith("{"));
+        const pathParts = path8.path.split("/").filter((p) => p && !p.startsWith("{"));
         if (pathParts.length > 1) {
           controllerName = pascalCase(pathParts[1]);
         }
@@ -1590,7 +1599,7 @@ var _ServiceGenerator = class _ServiceGenerator {
       if (!groups[controllerName]) {
         groups[controllerName] = [];
       }
-      groups[controllerName].push(path7);
+      groups[controllerName].push(path8);
     });
     return groups;
   }
@@ -1785,6 +1794,197 @@ var _ServiceIndexGenerator = class _ServiceIndexGenerator {
 __name(_ServiceIndexGenerator, "ServiceIndexGenerator");
 var ServiceIndexGenerator = _ServiceIndexGenerator;
 
+// src/lib/generators/utility/provider.generator.ts
+var path7 = __toESM(require("path"));
+var _ProviderGenerator = class _ProviderGenerator {
+  constructor(project, config) {
+    __publicField(this, "project");
+    __publicField(this, "config");
+    this.project = project;
+    this.config = config;
+  }
+  generate(outputDir) {
+    const filePath = path7.join(outputDir, "providers.ts");
+    const sourceFile = this.project.createSourceFile(filePath, "", {
+      overwrite: true
+    });
+    sourceFile.insertText(0, PROVIDER_GENERATOR_HEADER_COMMENT);
+    sourceFile.addImportDeclarations([
+      {
+        namedImports: [
+          "EnvironmentProviders",
+          "Provider",
+          "makeEnvironmentProviders"
+        ],
+        moduleSpecifier: "@angular/core"
+      },
+      {
+        namedImports: [
+          "HTTP_INTERCEPTORS"
+        ],
+        moduleSpecifier: "@angular/common/http"
+      },
+      {
+        namedImports: [
+          "BASE_PATH"
+        ],
+        moduleSpecifier: "./tokens"
+      }
+    ]);
+    if (this.config.options.dateType === "Date") {
+      sourceFile.addImportDeclaration({
+        namedImports: [
+          "DateInterceptor"
+        ],
+        moduleSpecifier: "./utils/date-transformer"
+      });
+    }
+    sourceFile.addInterface({
+      name: "NgOpenapiConfig",
+      isExported: true,
+      docs: [
+        "Configuration options for ng-openapi providers"
+      ],
+      properties: [
+        {
+          name: "basePath",
+          type: "string",
+          docs: [
+            "Base API URL"
+          ]
+        },
+        {
+          name: "enableDateTransform",
+          type: "boolean",
+          hasQuestionToken: true,
+          docs: [
+            "Enable automatic date transformation (default: true)"
+          ]
+        }
+      ]
+    });
+    this.addMainProviderFunction(sourceFile);
+    this.addAsyncProviderFunction(sourceFile);
+    sourceFile.saveSync();
+  }
+  addMainProviderFunction(sourceFile) {
+    const hasDateInterceptor = this.config.options.dateType === "Date";
+    const functionBody = `
+const providers: Provider[] = [
+    // Base path token
+    {
+        provide: BASE_PATH,
+        useValue: config.basePath
+    }
+];
+
+${hasDateInterceptor ? `// Add date interceptor if enabled (default: true)
+if (config.enableDateTransform !== false) {
+    providers.push({
+        provide: HTTP_INTERCEPTORS,
+        useClass: DateInterceptor,
+        multi: true
+    });
+}` : `// Date transformation not available (dateType: 'string' was used in generation)`}
+
+return makeEnvironmentProviders(providers);`;
+    sourceFile.addFunction({
+      name: "provideNgOpenapi",
+      isExported: true,
+      docs: [
+        "Provides all necessary configuration for ng-openapi generated services",
+        "",
+        "@example",
+        "```typescript",
+        "// In your app.config.ts",
+        "import { provideNgOpenapi } from './api/providers';",
+        "",
+        "export const appConfig: ApplicationConfig = {",
+        "  providers: [",
+        "    provideNgOpenapi({",
+        "      basePath: 'https://api.example.com'",
+        "    }),",
+        "    // other providers...",
+        "  ]",
+        "};",
+        "```"
+      ],
+      parameters: [
+        {
+          name: "config",
+          type: "NgOpenapiConfig"
+        }
+      ],
+      returnType: "EnvironmentProviders",
+      statements: functionBody
+    });
+  }
+  addAsyncProviderFunction(sourceFile) {
+    const hasDateInterceptor = this.config.options.dateType === "Date";
+    const functionBody = `
+const providers: Provider[] = [];
+
+// Handle async base path
+if (typeof config.basePath === 'string') {
+    providers.push({
+        provide: BASE_PATH,
+        useValue: config.basePath
+    });
+} else {
+    providers.push({
+        provide: BASE_PATH,
+        useFactory: config.basePath
+    });
+}
+
+${hasDateInterceptor ? `// Add date interceptor if enabled (default: true)
+if (config.enableDateTransform !== false) {
+    providers.push({
+        provide: HTTP_INTERCEPTORS,
+        useClass: DateInterceptor,
+        multi: true
+    });
+}` : `// Date transformation not available (dateType: 'string' was used in generation)`}
+
+return makeEnvironmentProviders(providers);`;
+    sourceFile.addFunction({
+      name: "provideNgOpenapiAsync",
+      isExported: true,
+      docs: [
+        "Alternative function for cases where you need to handle async configuration",
+        "",
+        "@example",
+        "```typescript",
+        "// In your app.config.ts",
+        "import { provideNgOpenapiAsync } from './api/providers';",
+        "",
+        "export const appConfig: ApplicationConfig = {",
+        "  providers: [",
+        "    provideNgOpenapiAsync({",
+        "      basePath: () => import('./config').then(c => c.apiConfig.baseUrl)",
+        "    }),",
+        "    // other providers...",
+        "  ]",
+        "};",
+        "```"
+      ],
+      parameters: [
+        {
+          name: "config",
+          type: `{
+  basePath: string | (() => Promise<string>);
+  enableDateTransform?: boolean;
+}`
+        }
+      ],
+      returnType: "EnvironmentProviders",
+      statements: functionBody
+    });
+  }
+};
+__name(_ProviderGenerator, "ProviderGenerator");
+var ProviderGenerator = _ProviderGenerator;
+
 // src/lib/core/generator.ts
 var fs3 = __toESM(require("fs"));
 function generateFromConfig(config) {
@@ -1829,6 +2029,9 @@ function generateFromConfig(config) {
         indexGenerator.generateIndex(outputPath);
         console.log(`\u2705 Angular services generated`);
       }
+      const providerGenerator = new ProviderGenerator(project, config);
+      providerGenerator.generate(outputPath);
+      console.log(`\u2705 Provider functions generated`);
       const mainIndexGenerator = new MainIndexGenerator(project, config);
       mainIndexGenerator.generateMainIndex(outputPath);
       console.log("\u{1F389} Generation completed successfully at:", outputPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-openapi",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Generate Angular services and TypeScript types from OpenAPI/Swagger specifications",
   "keywords": [
     "angular",