uniky 1.0.18 → 1.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniky",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "description": "uni-app 开发工具库，包含 hooks、http 请求和 vite 插件",
   "type": "module",
   "main": "./src/lib/index.ts",

package/scripts/postinstall.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { copyFileSync, mkdirSync, existsSync, writeFileSync } from 'fs';
+import { copyFileSync, mkdirSync, existsSync, writeFileSync, readdirSync, statSync } from 'fs';
 import { join, dirname } from 'path';
 import { fileURLToPath } from 'url';
 
@@ -28,6 +28,30 @@ function findProjectRoot() {
   return process.cwd();
 }
 
+function copyDirectoryRecursive(source, target) {
+  if (!existsSync(target)) {
+    mkdirSync(target, { recursive: true });
+  }
+
+  const files = readdirSync(source);
+  let count = 0;
+
+  files.forEach(file => {
+    const sourcePath = join(source, file);
+    const targetPath = join(target, file);
+    const stat = statSync(sourcePath);
+
+    if (stat.isDirectory()) {
+      count += copyDirectoryRecursive(sourcePath, targetPath);
+    } else {
+      copyFileSync(sourcePath, targetPath);
+      count++;
+    }
+  });
+
+  return count;
+}
+
 function installPluginFiles() {
   try {
     const projectRoot = findProjectRoot();
@@ -38,28 +62,8 @@ function installPluginFiles() {
       mkdirSync(unikyDir, { recursive: true });
     }
 
-    if (!existsSync(pluginDir)) {
-      mkdirSync(pluginDir, { recursive: true });
-    }
-
     const sourceDir = join(__dirname, '..', 'src', 'plugin');
-    const filesToCopy = [
-      'pages.defined.ts',
-      'global.defined.ts',
-      'lib.defined.ts',
-      'index.ts'
-    ];
-
-    let copiedCount = 0;
-    filesToCopy.forEach(file => {
-      const sourcePath = join(sourceDir, file);
-      const targetPath = join(pluginDir, file);
-
-      if (existsSync(sourcePath)) {
-        copyFileSync(sourcePath, targetPath);
-        copiedCount++;
-      }
-    });
+    const copiedCount = copyDirectoryRecursive(sourceDir, pluginDir);
 
     const indexContent = `// created by zhuxietong on 2026-01-30 16:37
 export * from './plugin/index.js';

package/src/plugin/README.md

@@ -0,0 +1,113 @@
+# UniKy 插件系统
+
+该目录包含 UniKy 框架的自动代码生成插件。
+
+## 插件列表
+
+### 1. global.defined.ts - 全局定义插件
+
+自动收集 `src/_unikey/global` 文件夹下的所有导出内容，生成全局类型定义和安装文件。
+
+### 2. pages.defined.ts - 页面路由插件
+
+自动处理页面路由相关的代码生成。
+
+### 3. http.defined.ts - HTTP 请求代码生成插件
+
+基于 OpenAPI 规范自动生成类型安全的 HTTP 请求函数。
+
+## HTTP 插件使用说明
+
+### 工作原理
+
+1. 插件会读取项目中的 OpenAPI 规范文件（支持多个位置）
+2. 解析所有 API 路径和方法
+3. 自动生成对应的请求函数
+4. 生成的代码保存到 `src/_unikey/global/ky.ts`
+
+### OpenAPI 文件位置
+
+插件会按以下顺序查找 OpenAPI 规范文件：
+
+1. `.uniky/oas/openapi.json`（推荐）
+2. `openapi.json`
+3. `swagger.json`
+4. `api-docs.json`
+
+### 生成规则
+
+**路径命名转换：**
+- `/api/sys.account/login` → `apiSysAccountLogin()`
+- `/api/util.tool/upload` → `apiUtilToolUpload()`
+
+**请求方法：**
+- GET/DELETE 请求：`functionName(params?: any)`
+- POST/PUT/PATCH 请求：`functionName(data?: any, params?: any)`
+
+### 生成的代码结构
+
+```typescript
+// 1. uniKy 实例配置
+export const _ky = uniKy.create({
+  prefixUrl: baseUrl,
+  hooks: { ... },
+  timeout: 30000
+});
+
+// 2. useKyData Hook
+export function useKyData<T, O extends object = {}>(...)
+
+// 3. API 请求函数
+export function apiSysAccountLogin(data?: any, params?: any) {
+  return _ky.post('/api/sys.account/login', { data, params })
+    .then(res => res.data);
+}
+```
+
+### 使用示例
+
+```typescript
+// 直接调用
+import { apiSysAccountLogin } from '@/_unikey/global/ky';
+
+await apiSysAccountLogin({ username: 'admin', password: '123456' });
+
+// 使用 Hook
+import { useKyData, apiPitfallIndexQuery } from '@/_unikey/global/ky';
+
+const { data, run } = useKyData(apiPitfallIndexQuery, []);
+```
+
+### 重新生成代码
+
+插件会在以下情况自动重新生成代码：
+
+1. 项目启动时（如果文件不存在）
+2. OpenAPI 规范文件发生变化时
+
+如果需要手动触发重新生成，删除 `src/_unikey/global/ky.ts` 文件后重启开发服务器。
+
+### 配置选项
+
+在 `vite.config.ts` 中配置插件：
+
+```typescript
+import { unikyPlugin } from './.uniky/index';
+
+export default defineConfig({
+  plugins: [
+    uni(),
+    unikyPlugin({
+      enablePages: true,   // 启用页面插件
+      enableGlobal: true,  // 启用全局定义插件
+      enableHttp: true     // 启用 HTTP 插件（默认启用）
+    })
+  ]
+});
+```
+
+### 注意事项
+
+1. **文件保护**：如果 `ky.ts` 文件已存在，插件不会覆盖，需手动删除后才会重新生成
+2. **路径格式**：OpenAPI 中的路径需要符合 RESTful 规范
+3. **自动导入**：生成的函数可以通过全局定义系统自动导入使用

package/src/plugin/global.defined.ts

@@ -171,11 +171,11 @@ export default function globalDefinedPlugin(): Plugin {
     content += '// 请勿手动修改\n\n';
 
     // 生成 import 语句
-    for (const [filePath, names] of imports) {
+    Array.from(imports.entries()).forEach(([filePath, names]) => {
       if (names.size > 0) {
         content += `import type { ${Array.from(names).join(', ')} } from './${filePath}';\n`;
       }
-    }
+    });
 
     content += '\n';
 
@@ -227,7 +227,7 @@ export default function globalDefinedPlugin(): Plugin {
     content += '// 请勿手动修改\n\n';
 
     // 生成 import 语句
-    for (const [filePath, info] of imports) {
+    Array.from(imports.entries()).forEach(([filePath, info]) => {
       if (info.hasDefault && info.names.size > 0) {
         content += `import ${info.defaultName}, { ${Array.from(info.names).join(', ')} } from '${filePath}';\n`;
       } else if (info.hasDefault) {
@@ -235,7 +235,7 @@ export default function globalDefinedPlugin(): Plugin {
       } else if (info.names.size > 0) {
         content += `import { ${Array.from(info.names).join(', ')} } from '${filePath}';\n`;
       }
-    }
+    });
 
     content += '\n';
     content += '/**\n';

package/src/plugin/http.defined.ts

@@ -0,0 +1,106 @@
+// created by zhuxietong on 2026-01-30 23:22
+// 该插件用于生成基础的 HTTP 请求配置
+// 生成的代码将保存到 src/_unikey/global/ky.ts
+
+import type { Plugin } from 'vite';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+export default function httpDefinedPlugin(): Plugin {
+  const outputPath = 'src/_unikey/global/ky.ts';
+
+  /**
+   * 生成基础请求配置代码
+   */
+  function generateCode(): string {
+    let code = `// created by zhuxietong on 2026-01-30 23:22\n`;
+    code += `import { uniKy, useMountedLoad } from "uniky";\n`;
+    code += `import { ref } from "vue";\n\n`;
+
+    code += `const baseUrl = import.meta.env.VITE_API_BASE_URL;\n\n`;
+
+    code += `export const _ky = uniKy.create({\n`;
+    code += `  prefixUrl: baseUrl,\n`;
+    code += `  hooks: {\n`;
+    code += `    beforeRequest: [\n`;
+    code += `      (request, options) => {\n`;
+    code += `        const headers = options.headers || {};\n`;
+    code += `        try {\n`;
+    code += `          const user = uni.getStorageSync('user') || '{}';\n`;
+    code += `          const { token } = JSON.parse(user);\n`;
+    code += `          if (token) {\n`;
+    code += `            headers['Authorization'] = 'Bearer ' + token;\n`;
+    code += `          }\n`;
+    code += `          options.headers = headers;\n`;
+    code += `        } catch (e) {}\n`;
+    code += `      },\n`;
+    code += `    ],\n`;
+    code += `    afterResponse: [\n`;
+    code += `      (resp: any, request, options) => {},\n`;
+    code += `    ],\n`;
+    code += `  },\n`;
+    code += `  timeout: 30000,\n`;
+    code += `});\n\n`;
+
+    code += `export function useKyData<T, O extends object = {}>(req: (option: O) => Promise<T>, defaultValue?: T) {\n`;
+    code += `  const data = ref<T | undefined>(defaultValue);\n`;
+    code += `  const option = ref<any>({});\n`;
+    code += `  const run = () => {\n`;
+    code += `    return new Promise((resolve, reject) => {\n`;
+    code += `      req(option.value)\n`;
+    code += `        .then((res: any) => {\n`;
+    code += `          data.value = res;\n`;
+    code += `          resolve(res);\n`;
+    code += `        })\n`;
+    code += `        .catch((err) => {\n`;
+    code += `          reject(err);\n`;
+    code += `        });\n`;
+    code += `    });\n`;
+    code += `  };\n\n`;
+    code += `  useMountedLoad(({ option:o, query, json }) => {\n`;
+    code += `    option.value = option;\n`;
+    code += `    run()\n`;
+    code += `      .then(() => {})\n`;
+    code += `      .catch(() => {});\n`;
+    code += `  });\n\n`;
+    code += `  return {\n`;
+    code += `    data,\n`;
+    code += `    run,\n`;
+    code += `  };\n`;
+    code += `}\n`;
+
+    return code;
+  }
+
+  /**
+   * 生成文件
+   */
+  function generate() {
+    try {
+      if (fs.existsSync(outputPath)) {
+        console.log(`[httpDefined] 文件已存在，跳过生成: ${outputPath}`);
+        return;
+      }
+
+      const code = generateCode();
+
+      const dir = path.dirname(outputPath);
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+      }
+
+      fs.writeFileSync(outputPath, code, 'utf-8');
+      console.log(`[httpDefined] 已生成 ${outputPath}`);
+    } catch (error) {
+      console.error('[httpDefined] 生成失败:', error);
+    }
+  }
+
+  return {
+    name: 'vite-plugin-http-defined',
+
+    buildStart() {
+      generate();
+    }
+  };
+}

package/src/plugin/index.ts

@@ -3,30 +3,35 @@ import type { Plugin } from 'vite';
 
 import pagesDefinedPlugin from './pages.defined';
 import globalDefinedPlugin from './global.defined';
+import httpDefinedPlugin from './http.defined';
 
 
 
 export interface UnikyPluginOptions {
   enablePages?: boolean;
   enableGlobal?: boolean;
+  enableHttp?: boolean;
 }
 
 export function unikyPlugin(options: UnikyPluginOptions = {}): Plugin[] {
-  const { enablePages = true, enableGlobal = true } = options;
+  const { enablePages = true, enableGlobal = true, enableHttp = true } = options;
 
   const plugins: Plugin[] = [];
 
   if (enablePages) {
     plugins.push(pagesDefinedPlugin());
   }
-
+  if (enableHttp) {
+    plugins.push(httpDefinedPlugin());
+  }
   if (enableGlobal) {
     plugins.push(globalDefinedPlugin());
   }
 
+
   return plugins;
 }
 
-export { pagesDefinedPlugin, globalDefinedPlugin };
+export { pagesDefinedPlugin, globalDefinedPlugin, httpDefinedPlugin };
 
 export default unikyPlugin;