@paulpugovkin/api-docs-axios-ts-generator 1.0.5 → 1.0.7

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@paulpugovkin/api-docs-axios-ts-generator",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Generate TypeScript interfaces and axios classes from OpenAPI documentation",
-  "main": "src/index.min.js",
+  "main": "src/index.js",
   "bin": {
-    "api-docs-generator": "./src/index.min.js"
+    "api-docs-generator": "./bin/cli.js"
   },
   "types": "src/types/index.d.ts",
   "scripts": {
@@ -37,7 +37,22 @@
     "node": ">=14.0.0"
   },
   "files": [
-    "src",
+    "src/index.min.js",
+    "src/clean-generated-folder",
+    "src/collect-genereted-files",
+    "src/generate-class",
+    "src/generate-index-file-with-public-api",
+    "src/generate-interface",
+    "src/generate-js-doc",
+    "src/generate-main-index-file",
+    "src/generate-method",
+    "src/generators",
+    "src/map-type",
+    "src/parse-and-generate",
+    "src/resolve-type",
+    "src/scripts",
+    "src/templates",
+    "src/update-api-docs-json",
     "bin",
     "README.md",
     "LICENSE"

package/src/config/defaultConfig.ts

@@ -1,33 +0,0 @@
-/**
- * Конфигурация по умолчанию для генератора
- */
-import { GeneratorConfig } from '../types/config.types';
-
-export const defaultConfig: Partial<GeneratorConfig> = {
-  outputDir: './generated',
-  interfacesDir: './generated/interfaces',
-  classesDir: './generated/classes',
-  groupBy: 'tag',
-  classMode: 'multiple',
-  tags: {
-    prefix: 'api_tag_',
-  },
-  imports: {
-    axiosPath: 'axios',
-    baseUrlPath: './config/axios/axios',
-  },
-  options: {
-    generateJSDoc: true,
-    generateIndexFiles: true,
-    cleanOutputDir: true,
-    generateAxiosConfig: true,
-    allowAxiosConfigSpread: true,
-  },
-  axios: {
-    baseURL: '',
-    timeout: 30000,
-    headers: {
-      'Content-Type': 'application/json',
-    },
-  },
-};

package/src/config/loadConfig.ts

@@ -1,112 +0,0 @@
-/**
- * Загрузка конфигурации генератора
- */
-// @ts-ignore - Node.js types
-import fs from 'fs';
-// @ts-ignore - Node.js types
-import path from 'path';
-import { GeneratorConfig } from '../types/config.types';
-import { defaultConfig } from './defaultConfig';
-import { validateConfig } from './validateConfig';
-
-/**
- * Загружает конфигурацию из файла
- * @param configPath - Путь к файлу конфигурации
- * @returns Объект конфигурации
- */
-async function loadConfigFile(configPath: string): Promise<Partial<GeneratorConfig>> {
-  const resolvedPath = path.resolve(configPath);
-
-  if (!fs.existsSync(resolvedPath)) {
-    throw new Error(`Configuration file not found: ${resolvedPath}`);
-  }
-
-  // Удаляем кэш для поддержки горячей перезагрузки
-  // @ts-ignore
-  delete require.cache[require.resolve(resolvedPath)];
-
-  try {
-    // @ts-ignore
-    const userConfig = require(resolvedPath);
-    return userConfig.default || userConfig;
-  } catch (error) {
-    throw new Error(`Failed to load configuration from ${resolvedPath}: ${error}`);
-  }
-}
-
-/**
- * Объединяет конфигурации (пользовательская перекрывает дефолтную)
- * @param defaults - Конфигурация по умолчанию
- * @param userConfig - Пользовательская конфигурация
- * @returns Объединённая конфигурация
- */
-function mergeConfigs(
-  defaults: Partial<GeneratorConfig>,
-  userConfig: Partial<GeneratorConfig>
-): GeneratorConfig {
-  const merged: any = {
-    ...defaults,
-    ...userConfig,
-  };
-
-  // Глубокое слияние для вложенных объектов
-  if (defaults.tags && userConfig.tags) {
-    merged.tags = { ...defaults.tags, ...userConfig.tags };
-  }
-
-  if (defaults.naming && userConfig.naming) {
-    merged.naming = { ...defaults.naming, ...userConfig.naming };
-  }
-
-  if (defaults.imports && userConfig.imports) {
-    merged.imports = { ...defaults.imports, ...userConfig.imports };
-  }
-
-  if (defaults.options && userConfig.options) {
-    merged.options = { ...defaults.options, ...userConfig.options };
-  }
-
-  if (defaults.axios && userConfig.axios) {
-    merged.axios = { ...defaults.axios, ...userConfig.axios };
-    // Глубокое слияние для headers
-    if (defaults.axios.headers && userConfig.axios.headers) {
-      merged.axios.headers = { ...defaults.axios.headers, ...userConfig.axios.headers };
-    }
-  }
-
-  return merged as GeneratorConfig;
-}
-
-/**
- * Загружает конфигурацию генератора
- * @param configPath - Путь к файлу конфигурации (опционально)
- * @param cliOverrides - Переопределения из CLI аргументов
- * @returns Полная конфигурация генератора
- */
-export async function loadConfig(
-  configPath?: string,
-  cliOverrides?: Partial<GeneratorConfig>
-): Promise<GeneratorConfig> {
-  let userConfig: Partial<GeneratorConfig> = {};
-
-  // Загрузка из файла, если указан
-  if (configPath) {
-    console.log(`Loading configuration from: ${configPath}`);
-    userConfig = await loadConfigFile(configPath);
-  } else {
-    console.log('No configuration file specified, using default configuration');
-  }
-
-  // Слияние с конфигурацией по умолчанию
-  let mergedConfig = mergeConfigs(defaultConfig, userConfig);
-
-  // Применение переопределений из CLI
-  if (cliOverrides) {
-    mergedConfig = mergeConfigs(mergedConfig, cliOverrides);
-  }
-
-  // Валидация конфигурации
-  validateConfig(mergedConfig);
-
-  return mergedConfig;
-}

package/src/config/validateConfig.ts

@@ -1,58 +0,0 @@
-/**
- * Валидация конфигурации генератора
- */
-import { GeneratorConfig } from '../types/config.types';
-
-export function validateConfig(config: GeneratorConfig): void {
-  // Проверка обязательного поля outputDir
-  if (!config.outputDir) {
-    throw new Error('Configuration error: outputDir is required');
-  }
-
-  // Проверка, что указан либо apiDocsUrl, либо apiDocsPath
-  if (!config.apiDocsUrl && !config.apiDocsPath) {
-    throw new Error('Configuration error: either apiDocsUrl or apiDocsPath must be specified');
-  }
-
-  // Проверка groupBy
-  if (config.groupBy && !['tag', 'all', 'path'].includes(config.groupBy)) {
-    throw new Error(`Configuration error: invalid groupBy value "${config.groupBy}". Must be one of: tag, all, path`);
-  }
-
-  // Проверка classMode
-  if (config.classMode && !['single', 'multiple'].includes(config.classMode)) {
-    throw new Error(`Configuration error: invalid classMode value "${config.classMode}". Must be one of: single, multiple`);
-  }
-
-  // Проверка фильтрации по тегам
-  if (config.tags) {
-    if (config.tags.include && config.tags.exclude) {
-      console.warn('Warning: Both include and exclude tags are specified. Include will take precedence.');
-    }
-
-    if (config.tags.include && config.tags.include.length === 0) {
-      console.warn('Warning: tags.include is empty. No tags will be filtered.');
-    }
-  }
-
-  // Проверка совместимости groupBy и classMode
-  if (config.groupBy === 'all' && config.classMode === 'multiple') {
-    console.warn('Warning: groupBy="all" with classMode="multiple" will generate only one class. Consider using classMode="single".');
-  }
-
-  // Проверка настроек axios
-  if (config.axios) {
-    if (config.axios.timeout !== undefined && config.axios.timeout < 0) {
-      throw new Error('Configuration error: axios.timeout must be a positive number');
-    }
-  }
-
-  // Проверка опций генерации
-  if (config.options) {
-    if (config.options.generateAxiosConfig && !config.axios) {
-      console.warn('Warning: generateAxiosConfig is true but no axios config provided. Using default values.');
-    }
-  }
-
-  console.log('Configuration validated successfully.');
-}

package/src/index.min.js

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-const fs=require('fs'),path=require('path'),{program}=require('commander'),{loadConfig}=require('./config/loadConfig'),{parseAndGenerate}=require('./parse-and-generate/parseAndGenerate'),{cleanGeneratedFolder}=require('./clean-generated-folder/cleanGeneratedFolder'),{collectGeneratedFiles}=require('./collect-genereted-files/collectGeneratedFiles'),{generateInterface}=require('./generate-interface/generateInterface'),{generateClass}=require('./generate-class/generateClass'),{generateMethod}=require('./generate-method/generateMethod'),{generateJSDoc}=require('./generate-js-doc/generateJSDoc'),{generateIndexFileWithPublicApi}=require('./generate-index-file-with-public-api/generateIndexFileWithPublicApi'),{generateMainIndexFile}=require('./generate-main-index-file/generateMainIndexFile'),{generateAxiosConfig}=require('./generators/axiosConfigGenerator'),{mapType}=require('./map-type/mapType'),{resolveType}=require('./resolve-type/resolveType'),{updateApiDocsJson}=require('./update-api-docs-json/updateApiDocsJson');program.name('api-docs-generator').description('Generate TypeScript interfaces and axios classes from OpenAPI documentation').version('1.0.0').option('-c, --config <path>','Path to configuration file').option('--api-docs-url <url>','URL to fetch OpenAPI documentation').option('--api-docs-path <path>','Local path to OpenAPI documentation file').option('--output-dir <dir>','Output directory for generated files').option('--clean','Clean output directory before generation');program.parse(process.argv);async function main(){let config;const options=program.opts();if(options.config){try{const configPath=path.resolve(options.config);if(!fs.existsSync(configPath)){console.error(`Configuration file not found: ${configPath}`);process.exit(1);}const configContent=fs.readFileSync(configPath,'utf8');const ext=path.extname(configPath);if(ext==='.js'){const modulePath=path.resolve(configPath);config=eval(`require('${modulePath.replace(/\\/g,'\\\\')}')`);}else if(ext==='.json'){config=JSON.parse(configContent);}else if(ext==='.ts'){const ts=require('typescript');const result=ts.transpileModule(configContent,{compilerOptions:{module:1,target:99,esModuleInterop:!0}});const modulePath=path.resolve(configPath.replace('.ts','.js'));fs.writeFileSync(modulePath,result);config=eval(`require('${modulePath.replace(/\\/g,'\\\\')}')`);}else{console.error('Unsupported configuration file format. Use .js, .json, or .ts');process.exit(1);}}catch(error){console.error(`Failed to load configuration: ${error.message}`);process.exit(1);}}else{const apiDocsUrl=options.apiDocsUrl;if(!apiDocsUrl){console.error('Error: API documentation URL is required.');console.error('Please specify --api-docs-url or --api-docs-path, or create a configuration file.');console.error('Run "api-docs-generator --help" for more information.');process.exit(1);}const outputDir=options.outputDir||path.resolve(__dirname,"../generated");config={apiDocsUrl:apiDocsUrl,outputDir:outputDir,interfacesDir:path.join(outputDir,"interfaces"),classesDir:path.join(outputDir,"classes"),groupBy:"tag",classMode:"multiple",options:{cleanOutputDir:options.clean!==undefined?options.clean:!0,generateAxiosConfig:!1,allowAxiosConfigSpread:!0}};}await cleanGeneratedFolder(config);const apiDocs=await updateApiDocsJson(config);const schemaData=apiDocs.paths?apiDocs.paths:apiDocs.components?.schemas||{};const generatedFiles=await collectGeneratedFiles(config);const interfaces=generatedFiles.filter(f=>f.endsWith('.ts')&&!f.includes('index'));const classes=generatedFiles.filter(f=>f.endsWith('.ts')&&!f.includes('index'));await generateInterface(schemaData,interfaces,config);await generateClass(schemaData,classes,config);await generateJSDoc(schemaData,classes,config);await generateMethod(schemaData,classes,config);await generateIndexFileWithPublicApi(config);await generateMainIndexFile(config);await generateAxiosConfig(config);console.log('✓ API client generated successfully!');console.log(`  Output directory: ${config.outputDir}`);}main().catch(error=>{console.error('Error:',error.message);process.exit(1);});

package/src/types/config.types.ts

@@ -1,183 +0,0 @@
-/**
- * Типы конфигурации для генератора API клиента
- */
-
-/**
- * Основная конфигурация генератора
- */
-export interface GeneratorConfig {
-  /**
-   * URL для загрузки OpenAPI спецификации
-   */
-  apiDocsUrl?: string;
-
-  /**
-   * Локальный путь к файлу OpenAPI спецификации
-   */
-  apiDocsPath?: string;
-
-  /**
-   * Директория для вывода сгенерированных файлов
-   */
-  outputDir: string;
-
-  /**
-   * Директория для интерфейсов (опционально, по умолчанию outputDir/interfaces)
-   */
-  interfacesDir?: string;
-
-  /**
-   * Директория для классов (опционально, по умолчанию outputDir/classes)
-   */
-  classesDir?: string;
-
-  /**
-   * Настройки фильтрации по тегам
-   */
-  tags?: TagFilter;
-
-  /**
-   * Режим группировки методов
-   * - 'tag' - группировка по тегам (несколько классов)
-   * - 'all' - все методы в одном классе
-   * - 'path' - группировка по путям API
-   */
-  groupBy: 'tag' | 'all' | 'path';
-
-  /**
-   * Режим генерации классов
-   * - 'single' - один класс для всех методов
-   * - 'multiple' - несколько классов по группировке
-   */
-  classMode: 'single' | 'multiple';
-
-  /**
-   * Настройки именования
-   */
-  naming?: NamingOptions;
-
-  /**
-   * Настройки импортов
-   */
-  imports?: ImportOptions;
-
-  /**
-   * Дополнительные опции генерации
-   */
-  options?: GeneratorOptions;
-
-  /**
-   * Настройки axios
-   */
-  axios?: AxiosConfig;
-}
-
-/**
- * Настройки фильтрации по тегам
- */
-export interface TagFilter {
-  /**
-   * Список тегов для включения в генерацию
-   */
-  include?: string[];
-
-  /**
-   * Список тегов для исключения из генерации
-   */
-  exclude?: string[];
-
-  /**
-   * Префикс тегов для фильтрации (например, "api_tag_")
-   */
-  prefix?: string;
-}
-
-/**
- * Настройки именования
- */
-export interface NamingOptions {
-  /**
-   * Функция для генерации имени класса из тега
-   */
-  className?: (tag: string) => string;
-
-  /**
-   * Функция для генерации имени интерфейса из схемы
-   */
-  interfaceName?: (name: string) => string;
-
-  /**
-   * Функция для генерации имени метода из operationId
-   */
-  methodName?: (operationId: string) => string;
-}
-
-/**
- * Настройки импортов
- */
-export interface ImportOptions {
-  /**
-   * Путь для импорта axios
-   */
-  axiosPath?: string;
-
-  /**
-   * Путь для импорта BASE_URL
-   */
-  baseUrlPath?: string;
-}
-
-/**
- * Опции генерации
- */
-export interface GeneratorOptions {
-  /**
-   * Генерировать JSDoc комментарии
-   */
-  generateJSDoc?: boolean;
-
-  /**
-   * Генерировать index файлы
-   */
-  generateIndexFiles?: boolean;
-
-  /**
-   * Очищать директорию вывода перед генерацией
-   */
-  cleanOutputDir?: boolean;
-
-  /**
-   * Генерировать конфигурацию axios
-   */
-  generateAxiosConfig?: boolean;
-
-  /**
-   * Разрешить распыление пользовательских конфигураций axios
-   */
-  allowAxiosConfigSpread?: boolean;
-}
-
-/**
- * Настройки axios
- */
-export interface AxiosConfig {
-  /**
-   * Базовый URL для всех запросов
-   */
-  baseURL?: string;
-
-  /**
-   * Таймаут запроса в миллисекундах
-   */
-  timeout?: number;
-
-  /**
-   * Заголовки по умолчанию
-   */
-  headers?: Record<string, string>;
-
-  /**
-   * Отправлять куки с кросс-доменными запросами
-   */
-  withCredentials?: boolean;
-}

package/src/types/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * TypeScript declaration files for the generator
- */
-
-declare module './config/loadConfig' {
-    export function loadConfig(
-        configPath?: string,
-        cliOverrides?: import('./config.types').GeneratorConfig
-    ): Promise<import('./config.types').GeneratorConfig>;
-}
-
-declare module './config/defaultConfig' {
-    export const defaultConfig: Partial<import('./config.types').GeneratorConfig>;
-}
-
-declare module './config/validateConfig' {
-    export function validateConfig(config: import('./config.types').GeneratorConfig): void;
-}
-
-declare module './generators/axiosConfigGenerator' {
-    export function generateAxiosConfig(config: any, outputDir: string): void;
-}