vite-plugin-swagger-typescript-api-transform 0.0.1 → 0.0.2

package/dist/src-Cs3STwE3.js

@@ -0,0 +1,687 @@
+import { ensureDir, findYamlDirectories, findYamlFiles, formatModuleName } from "./utils-DGqLkcWK.js";
+import { createUnplugin } from "unplugin";
+import path from "node:path";
+import process from "node:process";
+import fs from "node:fs";
+import { generateApi } from "swagger-typescript-api";
+
+//#region src/core/constants.ts
+const PLUGIN_NAME = "swagger-typescript-api";
+const DEFAULT_OPTIONS = {
+	outputDir: "src/api",
+	generateClient: true,
+	httpClient: "fetch",
+	watch: true,
+	moduleNameFormat: "kebab"
+};
+
+//#endregion
+//#region src/core/generator.ts
+/**
+* 根据单个 YAML 文件生成 TypeScript API 代码
+*/
+async function generateTypeScriptFromYaml(yamlPath, outputDir, options) {
+	const fileName = path.basename(yamlPath, path.extname(yamlPath));
+	const moduleName = formatModuleName(fileName, options.moduleNameFormat);
+	const apiClassName = options.apiClassName || `${formatModuleName(fileName, "pascal")}Api`;
+	const moduleOutputDir = path.join(outputDir, moduleName);
+	ensureDir(moduleOutputDir);
+	console.log(`[${PLUGIN_NAME}] 正在生成 API: ${fileName} -> ${moduleName}`);
+	try {
+		const result = await generateApi({
+			input: yamlPath,
+			httpClientType: options.httpClient,
+			generateClient: options.generateClient,
+			generateRouteTypes: true,
+			generateResponses: true,
+			defaultResponseAsSuccess: false,
+			toJS: false,
+			extractRequestParams: true,
+			extractRequestBody: true,
+			extractEnums: true,
+			singleHttpClient: true,
+			modular: false,
+			unwrapResponseData: true,
+			apiClassName,
+			silent: true
+		});
+		const files = result.files;
+		for (const file of files) {
+			const fullFileName = `${file.fileName}${file.fileExtension}`;
+			const filePath = path.join(moduleOutputDir, fullFileName);
+			fs.writeFileSync(filePath, file.fileContent, "utf-8");
+			console.log(`[${PLUGIN_NAME}]   生成文件: ${fullFileName}`);
+		}
+		return {
+			moduleName,
+			apiClassName
+		};
+	} catch (error) {
+		console.error(`[${PLUGIN_NAME}] 生成 API 失败: ${yamlPath}`);
+		console.error(error);
+		throw error;
+	}
+}
+
+//#endregion
+//#region src/generators/example.ts
+/**
+* 为每个模块生成示例文件
+*/
+function generateModuleExampleFile(moduleOutputDir, moduleName, apiClassName) {
+	const instanceName = moduleName.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+	const exampleContent = `/**
+ * ${moduleName} API 使用示例
+ * 由 vite-plugin-swagger-typescript-api 自动生成
+ *
+ * 注意：此文件仅为示例，可以根据实际需求修改或删除
+ *
+ * @常见问题 - CORS 跨域请求失败
+ * 如果在 Network 面板看到 OPTIONS 请求（preflight）失败，这是因为跨域请求被浏览器拦截。
+ *
+ * 解决方案：使用 Vite 代理（推荐开发环境）
+ *
+ * 1. 在 vite.config.ts 中配置代理：
+ * \`\`\`typescript
+ * export default defineConfig({
+ *   server: {
+ *     proxy: {
+ *       '/api': {
+ *         target: 'https://your-api.example.com', // 替换为实际 API 地址
+ *         changeOrigin: true,
+ *       }
+ *     }
+ *   }
+ * })
+ * \`\`\`
+ *
+ * 2. 将 baseUrl 改为相对路径：
+ * \`\`\`typescript
+ * const httpClient = new HttpClient({
+ *   baseUrl: '/api',  // 走 Vite 代理，避免跨域
+ *   baseApiParams: {
+ *     headers: { Authorization: 'Bearer your-token' },
+ *   }
+ * })
+ * \`\`\`
+ */
+
+import { ${apiClassName}, HttpClient } from '.'
+
+// ============================================
+// 示例 1: 使用预配置的 API 实例（推荐）
+// ============================================
+// 从统一入口导入预配置的实例
+import { ${instanceName}Api } from '..'
+
+async function example1() {
+  try {
+    // 直接使用预配置的 API 实例
+    // const result = await ${instanceName}Api.xxx.xxxMethod({ ... })
+    console.log('使用预配置实例发起请求')
+    // return result
+  }
+  catch (error) {
+    console.error('请求失败:', error)
+    throw error
+  }
+}
+
+// ============================================
+// 示例 2: 使用自定义配置的 HTTP 客户端
+// ============================================
+
+async function example2() {
+  // 创建自定义配置的 HTTP 客户端
+  const httpClient = new HttpClient({
+    baseUrl: 'https://api.example.com/v1',
+    baseApiParams: {
+      headers: {
+        Authorization: 'Bearer your-token-here',
+      },
+    },
+  })
+
+  // 使用自定义客户端创建 API 实例
+  const api = new ${apiClassName}(httpClient)
+
+  try {
+    // const result = await api.xxx.xxxMethod({ ... })
+    console.log('使用自定义配置发起请求')
+    // return result
+  }
+  catch (error) {
+    console.error('请求失败:', error)
+    throw error
+  }
+}
+
+// ============================================
+// 示例 3: 带错误处理的请求封装
+// ============================================
+
+async function safeRequest<T>(
+  request: () => Promise<T>,
+): Promise<{ data?: T; error?: Error }> {
+  try {
+    const data = await request()
+    return { data }
+  }
+  catch (error) {
+    return { error: error as Error }
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+async function example3() {
+  // 替换 xxx 为实际的 API 分组名称（如 users、products 等）
+  // 替换 xxxMethod 为实际的方法名称（如 usersCreate、productsList 等）
+  // const { data, error } = await safeRequest(() =>
+  //   ${instanceName}Api.xxx.xxxMethod({ /* params */ }),
+  // )
+  const { data, error } = { data: undefined, error: undefined }
+
+  if (error) {
+    console.error('请求失败:', error.message)
+    return
+  }
+
+  console.log('请求成功:', data)
+}
+
+// ============================================
+// 导出示例函数
+// ============================================
+
+export { example1, example2, example3 }
+`;
+	const examplePath = path.join(moduleOutputDir, "example.ts");
+	fs.writeFileSync(examplePath, exampleContent, "utf-8");
+	console.log(`[${PLUGIN_NAME}]   生成示例文件: example.ts`);
+}
+
+//#endregion
+//#region src/generators/module-index.ts
+/**
+* 为每个模块生成 index.ts 导出文件
+* 解决命名冲突：将 API 类重命名为 XxxApi，避免与接口类型同名
+* 避免重复导出公共类型（HttpClient 等）
+*/
+function generateModuleIndexFile(moduleOutputDir, moduleName, apiClassName, isFirstModule) {
+	const apiInstanceName = apiClassName;
+	const moduleIndexContent = `/**
+ * ${apiClassName} 模块导出
+ * 由 vite-plugin-swagger-typescript-api 自动生成
+ */
+
+// 导出所有类型定义
+export * from './Api'
+
+// 重命名导出 API 类，避免与接口类型同名
+export { ${apiClassName} as ${apiInstanceName} } from './Api'
+${isFirstModule ? `
+// 导出公共类型（只在第一个模块导出）
+// HttpClient 是类，ContentType 是枚举，可以正常导出
+export { HttpClient, ContentType } from './Api'
+// ApiConfig, RequestParams, HttpResponse 是纯类型，使用 export type
+export type { ApiConfig, RequestParams, HttpResponse } from './Api'` : ""}
+`;
+	const moduleIndexPath = path.join(moduleOutputDir, "index.ts");
+	fs.writeFileSync(moduleIndexPath, moduleIndexContent, "utf-8");
+}
+
+//#endregion
+//#region src/generators/entry-index.ts
+/**
+* 生成统一导出的入口文件 index.ts
+*/
+function generateIndexFile(outputDir, modules, options) {
+	if (modules.length === 0) return;
+	const firstModule = modules[0];
+	const firstModuleExport = `// ${firstModule.moduleName} API（包含公共类型：HttpClient, ApiConfig 等）
+export * from './${firstModule.moduleName}'`;
+	const otherModuleExports = modules.slice(1).map(({ moduleName, apiClassName }) => {
+		return `// ${moduleName} API
+export {
+  // API 类
+  ${apiClassName},
+  // 模块特有的类型（接口、枚举、命名空间）
+  ${apiClassName} as ${apiClassName}Client,
+} from './${moduleName}'
+
+// 导出 ${moduleName} 模块的所有类型（通过命名空间访问）
+export * as ${apiClassName}Types from './${moduleName}'`;
+	}).join("\n\n");
+	const apiImports = modules.map(({ moduleName, apiClassName }) => {
+		return `import { ${apiClassName}, HttpClient as ${apiClassName}HttpClient } from './${moduleName}'`;
+	}).join("\n");
+	const apiInstances = modules.map(({ moduleName, apiClassName }) => {
+		const instanceName = moduleName.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+		return `/** ${moduleName} API 实例（使用默认配置） */
+export const ${instanceName}Api = new ${apiClassName}(new ${apiClassName}HttpClient())`;
+	}).join("\n\n");
+	const otherExportsSection = otherModuleExports ? `
+
+// ============================================
+// 其他模块导出（排除公共类型）
+// ============================================
+
+${otherModuleExports}` : "";
+	const indexContent = `/**
+ * 自动生成的 API 统一入口文件
+ * 由 vite-plugin-swagger-typescript-api 生成
+ *
+ * 注意：此文件由插件自动生成，请勿手动修改
+ *
+ * @example 简单使用方式
+ * \`\`\`typescript
+ * import { productApi, HttpClient } from './api'
+ *
+ * // 直接使用预配置的 API 实例
+ * const products = await productApi.products.productsList({ page: 1, limit: 10 })
+ * \`\`\`
+ *
+ * @example 自定义配置方式
+ * \`\`\`typescript
+ * import { ProductApi, HttpClient } from './api/product'
+ *
+ * // 创建自定义配置的 HTTP 客户端
+ * const http = new HttpClient({
+ *   baseUrl: 'https://custom-api.example.com',
+ *   headers: { Authorization: 'Bearer your-token' }
+ * })
+ *
+ * // 使用自定义客户端创建 API 实例
+ * const productApi = new ProductApi(http)
+ *
+ * // 发起请求
+ * const products = await productApi.products.productsList({ page: 1 })
+ * \`\`\`
+ */
+
+${firstModuleExport}
+${otherExportsSection}
+
+// ============================================
+// 预配置的 API 实例（开箱即用）
+// ============================================
+
+${apiImports}
+
+${apiInstances}
+`;
+	const indexPath = path.join(outputDir, "index.ts");
+	fs.writeFileSync(indexPath, indexContent, "utf-8");
+	console.log(`[${PLUGIN_NAME}] 生成入口文件: index.ts`);
+}
+
+//#endregion
+//#region src/generators/request.ts
+/**
+* 生成基于 Fetch 的 HTTP 请求工具函数
+*/
+function generateFetchRequestUtil(baseURL) {
+	return `/**
+ * HTTP 请求工具函数（基于 Fetch）
+ * 由 vite-plugin-swagger-typescript-api 生成
+ */
+
+/** 请求配置选项 */
+interface RequestConfig extends Omit<RequestInit, 'body'> {
+  /** 请求参数（查询字符串） */
+  params?: Record<string, any>
+  /** 请求体数据 */
+  body?: any
+  /** 请求超时时间（毫秒） */
+  timeout?: number
+}
+
+/** 响应结果包装 */
+interface ResponseResult<T> {
+  data: T
+  status: number
+  statusText: string
+  headers: Headers
+}
+
+/** 基础 URL 配置 */
+const BASE_URL = '${baseURL}'
+
+/** 默认请求头 */
+const defaultHeaders: HeadersInit = {
+  'Content-Type': 'application/json',
+}
+
+/**
+ * 获取认证 Token（可自定义实现）
+ */
+function getAuthToken(): string | null {
+  // 从 localStorage 或其他存储中获取 token
+  // return localStorage.getItem('token')
+  return null
+}
+
+/**
+ * 构建查询字符串
+ */
+function buildQueryString(params: Record<string, any>): string {
+  const searchParams = new URLSearchParams()
+  Object.entries(params).forEach(([key, value]) => {
+    if (value !== undefined && value !== null) {
+      searchParams.append(key, String(value))
+    }
+  })
+  return searchParams.toString()
+}
+
+/**
+ * 创建带超时的 fetch 请求
+ */
+async function fetchWithTimeout(
+  url: string,
+  config: RequestInit,
+  timeout: number = 10000,
+): Promise<Response> {
+  const controller = new AbortController()
+  const timeoutId = setTimeout(() => controller.abort(), timeout)
+
+  try {
+    const response = await fetch(url, {
+      ...config,
+      signal: controller.signal,
+    })
+    return response
+  }
+  finally {
+    clearTimeout(timeoutId)
+  }
+}
+
+/**
+ * 核心请求方法
+ */
+async function request<T>(
+  method: string,
+  url: string,
+  config: RequestConfig = {},
+): Promise<ResponseResult<T>> {
+  const { params, body, timeout = 10000, ...init } = config
+
+  // 构建完整 URL
+  let fullUrl = \`\${BASE_URL}\${url}\`
+  if (params && Object.keys(params).length > 0) {
+    fullUrl += \`?\${buildQueryString(params)}\`
+  }
+
+  // 设置请求头
+  const headers: HeadersInit = {
+    ...defaultHeaders,
+    ...init.headers,
+  }
+
+  // 添加认证 Token
+  const token = getAuthToken()
+  if (token) {
+    (headers as Record<string, string>)['Authorization'] = \`Bearer \${token}\`
+  }
+
+  // 发送请求
+  const response = await fetchWithTimeout(
+    fullUrl,
+    {
+      ...init,
+      method,
+      headers,
+      body: body ? JSON.stringify(body) : undefined,
+    },
+    timeout,
+  )
+
+  // 处理响应
+  if (!response.ok) {
+    const errorText = await response.text()
+    throw new Error(\`HTTP \${response.status}: \${errorText || response.statusText}\`)
+  }
+
+  // 解析 JSON 响应
+  const data = await response.json()
+
+  return {
+    data,
+    status: response.status,
+    statusText: response.statusText,
+    headers: response.headers,
+  }
+}
+
+/**
+ * HTTP 请求工具对象
+ */
+export const http = {
+  /**
+   * GET 请求
+   */
+  get: <T>(url: string, params?: Record<string, any>, config?: RequestConfig) =>
+    request<T>('GET', url, { ...config, params }),
+
+  /**
+   * POST 请求
+   */
+  post: <T>(url: string, body?: any, config?: RequestConfig) =>
+    request<T>('POST', url, { ...config, body }),
+
+  /**
+   * PUT 请求
+   */
+  put: <T>(url: string, body?: any, config?: RequestConfig) =>
+    request<T>('PUT', url, { ...config, body }),
+
+  /**
+   * DELETE 请求
+   */
+  delete: <T>(url: string, config?: RequestConfig) =>
+    request<T>('DELETE', url, config),
+
+  /**
+   * PATCH 请求
+   */
+  patch: <T>(url: string, body?: any, config?: RequestConfig) =>
+    request<T>('PATCH', url, { ...config, body }),
+}
+
+/** 默认导出 http 对象 */
+export default http
+`;
+}
+/**
+* 生成基于 Axios 的 HTTP 请求工具函数
+*/
+function generateAxiosRequestUtil(baseURL) {
+	return `/**
+ * HTTP 请求工具函数（基于 Axios）
+ * 由 vite-plugin-swagger-typescript-api 生成
+ *
+ * 注意：需要安装 axios 依赖
+ */
+
+import axios, { type AxiosInstance, type AxiosRequestConfig } from 'axios'
+
+/** 创建 axios 实例 */
+const instance: AxiosInstance = axios.create({
+  baseURL: '${baseURL}',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json',
+  },
+})
+
+/** 请求拦截器 */
+instance.interceptors.request.use(
+  (config) => {
+    // 在这里可以添加 token 等认证信息
+    // const token = localStorage.getItem('token')
+    // if (token) {
+    //   config.headers.Authorization = \`Bearer \${token}\`
+    // }
+    return config
+  },
+  (error) => {
+    return Promise.reject(error)
+  },
+)
+
+/** 响应拦截器 */
+instance.interceptors.response.use(
+  (response) => {
+    return response.data
+  },
+  (error) => {
+    // 统一错误处理
+    console.error('API Error:', error.message)
+    return Promise.reject(error)
+  },
+)
+
+/**
+ * HTTP 请求工具对象
+ */
+export const request = {
+  get: <T>(url: string, params?: Record<string, any>, config?: AxiosRequestConfig) =>
+    instance.get<T>(url, { params, ...config }),
+
+  post: <T>(url: string, data?: any, config?: AxiosRequestConfig) =>
+    instance.post<T>(url, data, config),
+
+  put: <T>(url: string, data?: any, config?: AxiosRequestConfig) =>
+    instance.put<T>(url, data, config),
+
+  delete: <T>(url: string, config?: AxiosRequestConfig) =>
+    instance.delete<T>(url, config),
+
+  patch: <T>(url: string, data?: any, config?: AxiosRequestConfig) =>
+    instance.patch<T>(url, data, config),
+}
+
+/** 默认导出 axios 实例 */
+export default instance
+
+/** 导出 axios 实例供高级使用 */
+export { instance as axios }
+`;
+}
+/**
+* 生成 HTTP 请求工具函数
+*/
+function generateRequestUtil(outputDir, options) {
+	if (!options.baseURL) return;
+	const requestContent = options.httpClient === "axios" ? generateAxiosRequestUtil(options.baseURL) : generateFetchRequestUtil(options.baseURL);
+	const requestPath = path.join(outputDir, "request.ts");
+	fs.writeFileSync(requestPath, requestContent, "utf-8");
+	console.log(`[${PLUGIN_NAME}] 生成请求工具: request.ts (${options.httpClient})`);
+}
+
+//#endregion
+//#region src/core/scanner.ts
+/**
+* 扫描并生成所有 API 代码
+*/
+async function scanAndGenerateApis(options, isRebuild = false) {
+	const rootDir = options.rootDir || process.cwd();
+	const outputDir = path.resolve(rootDir, options.outputDir);
+	if (isRebuild) console.log(`\n[${PLUGIN_NAME}] 检测到文件变化，重新生成 API...`);
+	else {
+		console.log(`\n[${PLUGIN_NAME}] 开始扫描 YAML 文件...`);
+		console.log(`[${PLUGIN_NAME}] 项目根目录: ${rootDir}`);
+		console.log(`[${PLUGIN_NAME}] 输出目录: ${outputDir}`);
+	}
+	const yamlDirs = findYamlDirectories(rootDir);
+	if (yamlDirs.length === 0) {
+		console.log(`[${PLUGIN_NAME}] 未找到名为 "yaml" 的文件夹`);
+		return [];
+	}
+	console.log(`[${PLUGIN_NAME}] 找到 ${yamlDirs.length} 个 yaml 目录:`);
+	yamlDirs.forEach((dir) => {
+		console.log(`[${PLUGIN_NAME}]   - ${path.relative(rootDir, dir)}`);
+	});
+	const yamlFiles = [];
+	for (const dir of yamlDirs) yamlFiles.push(...findYamlFiles(dir));
+	if (yamlFiles.length === 0) {
+		console.log(`[${PLUGIN_NAME}] 未找到 .yaml 或 .yml 文件`);
+		return [];
+	}
+	console.log(`[${PLUGIN_NAME}] 找到 ${yamlFiles.length} 个 YAML 文件:`);
+	yamlFiles.forEach((file) => {
+		console.log(`[${PLUGIN_NAME}]   - ${path.relative(rootDir, file)}`);
+	});
+	const { ensureDir: ensureDir$1 } = await import("./utils.js");
+	ensureDir$1(outputDir);
+	console.log(`\n[${PLUGIN_NAME}] 开始生成 TypeScript API 代码...`);
+	const modules = [];
+	for (const yamlFile of yamlFiles) try {
+		const moduleResult = await generateTypeScriptFromYaml(yamlFile, outputDir, options);
+		modules.push(moduleResult);
+	} catch (error) {
+		console.error(`[${PLUGIN_NAME}] 跳过文件: ${yamlFile}`);
+	}
+	modules.forEach(({ moduleName, apiClassName }, index) => {
+		const moduleOutputDir = path.join(outputDir, moduleName);
+		generateModuleIndexFile(moduleOutputDir, moduleName, apiClassName, index === 0);
+		generateModuleExampleFile(moduleOutputDir, moduleName, apiClassName);
+	});
+	if (modules.length > 0) {
+		generateIndexFile(outputDir, modules, options);
+		generateRequestUtil(outputDir, options);
+	}
+	console.log(`\n[${PLUGIN_NAME}] ✅ 成功生成 ${modules.length} 个 API 模块\n`);
+	return modules.map((m) => m.moduleName);
+}
+
+//#endregion
+//#region src/core/plugin.ts
+/**
+* 插件工厂函数
+*/
+const unpluginFactory = (options = {}) => {
+	const mergedOptions = {
+		...DEFAULT_OPTIONS,
+		...options
+	};
+	let hasGenerated = false;
+	return {
+		name: PLUGIN_NAME,
+		vite: {
+			configResolved() {
+				if (!hasGenerated) {
+					hasGenerated = true;
+					scanAndGenerateApis(mergedOptions);
+				}
+			},
+			configureServer(server) {
+				if (mergedOptions.watch) server.watcher.on("change", (file) => {
+					if (file.endsWith(".yaml") || file.endsWith(".yml")) {
+						hasGenerated = false;
+						scanAndGenerateApis(mergedOptions, true);
+					}
+				});
+			}
+		},
+		async buildStart() {
+			if (!hasGenerated) {
+				hasGenerated = true;
+				await scanAndGenerateApis(mergedOptions);
+			}
+		},
+		webpack(compiler) {
+			compiler.hooks.beforeRun.tapPromise(PLUGIN_NAME, async () => {
+				if (!hasGenerated) {
+					hasGenerated = true;
+					await scanAndGenerateApis(mergedOptions);
+				}
+			});
+		}
+	};
+};
+const unplugin = /* @__PURE__ */ createUnplugin(unpluginFactory);
+
+//#endregion
+export { DEFAULT_OPTIONS, PLUGIN_NAME, unplugin, unpluginFactory };

package/dist/types.d.ts

@@ -1,2 +1,2 @@
-import { HttpClientType, MergedOptions, Options } from "./types-CpgPraRT.js";
+import { HttpClientType, MergedOptions, Options } from "./types-BJUz_-Xc.js";
 export { HttpClientType, MergedOptions, Options };

package/dist/utils.js

@@ -1,3 +1,3 @@
-import { ensureDir, fileExists, findYamlDirectories, findYamlFiles, formatModuleName, getRelativePath, safeReaddir } from "./utils-BypLbD1p.js";
+import { ensureDir, fileExists, findYamlDirectories, findYamlFiles, formatModuleName, getRelativePath, safeReaddir } from "./utils-DGqLkcWK.js";
 
 export { ensureDir, fileExists, findYamlDirectories, findYamlFiles, formatModuleName, getRelativePath, safeReaddir };

package/dist/{vite-BKknryyS.js → vite-7Ak6OVE_.js}

@@ -1,4 +1,4 @@
-import { unpluginFactory } from "./src-DPpaOQvV.js";
+import { unpluginFactory } from "./src-Cs3STwE3.js";
 import { createVitePlugin } from "unplugin";
 
 //#region src/vite.ts

package/dist/vite.d.ts

@@ -1,8 +1,8 @@
-import { Options } from "./types-CpgPraRT.js";
-import * as vite8 from "vite";
+import { Options } from "./types-BJUz_-Xc.js";
+import * as vite3 from "vite";
 
 //#region src/vite.d.ts
-declare const _default: (options?: Options | undefined) => vite8.Plugin<any> | vite8.Plugin<any>[];
+declare const _default: (options?: Options | undefined) => vite3.Plugin<any> | vite3.Plugin<any>[];
 
 //#endregion
 export { _default as default };