uniky 1.0.17 → 1.0.19

package/package.json

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

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

@@ -1,5 +1,5 @@
 // 该插件用于作为 vite.config.ts 中 作为插件；
-// 该插件用于收集 src/.uniky/global文件夹下的ts文件 所有export 导出的内容， 并将其合并为一个全局定义文件 src/.uniky/global.d.ts 文件 同时，生成一个 /src/.uniky/global.install.ts 文件.
+// 该插件用于收集 src/_unikey/global文件夹下的ts文件 所有export 导出的内容， 并将其合并为一个全局定义文件 src/_unikey/global.d.ts 文件 同时，生成一个 /src/_unikey/global.install.ts 文件.
 // 以便在项目中全局使用这些类型定义，避免了手动维护全局类型定义文件的麻烦。
 
 import type { Plugin } from 'vite';
@@ -14,9 +14,9 @@ interface ExportInfo {
 }
 
 export default function globalDefinedPlugin(): Plugin {
-  const globalDir = 'src/.uniky/global';
-  const globalDtsPath = 'src/.uniky/global.d.ts';
-  const installTsPath = 'src/.uniky/global.install.ts';
+  const globalDir = 'src/_unikey/global';
+  const globalDtsPath = 'src/_unikey/global.d.ts';
+  const installTsPath = 'src/_unikey/global.install.ts';
 
   /**
    * 递归获取目录下所有 .ts 文件（排除 .d.ts 和 install.ts）
@@ -158,7 +158,7 @@ export default function globalDefinedPlugin(): Plugin {
 
     // 按文件分组导出
     for (const exp of allExports) {
-      const relativePath = path.relative('src/.uniky', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '');
+      const relativePath = path.relative('src/_unikey', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '');
       if (!imports.has(relativePath)) {
         imports.set(relativePath, new Set());
       }
@@ -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';
 
@@ -187,11 +187,11 @@ export default function globalDefinedPlugin(): Plugin {
     if (globalItems.length > 0) {
       for (const exp of globalItems) {
         if (exp.type === 'function') {
-          content += `  const ${exp.name}: typeof import('./${path.relative('src/.uniky', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
+          content += `  const ${exp.name}: typeof import('./${path.relative('src/_unikey', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
         } else if (exp.type === 'const') {
-          content += `  const ${exp.name}: typeof import('./${path.relative('src/.uniky', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
+          content += `  const ${exp.name}: typeof import('./${path.relative('src/_unikey', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
         } else if (exp.type === 'class') {
-          content += `  const ${exp.name}: typeof import('./${path.relative('src/.uniky', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
+          content += `  const ${exp.name}: typeof import('./${path.relative('src/_unikey', exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '')}').${exp.name};\n`;
         }
       }
     }
@@ -210,7 +210,7 @@ export default function globalDefinedPlugin(): Plugin {
 
     // 按文件分组导出
     for (const exp of allExports) {
-      const relativePath = './global/' + path.relative(path.join('src', '.uniky', 'global'), exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '');
+      const relativePath = './global/' + path.relative(path.join('src', '_unikey', 'global'), exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, '');
       if (!imports.has(relativePath)) {
         imports.set(relativePath, { names: new Set(), hasDefault: false });
       }
@@ -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';
@@ -247,7 +247,7 @@ export default function globalDefinedPlugin(): Plugin {
     // 将导出的内容挂载到 globalThis
     const globalItems = allExports.filter(exp => exp.type !== 'interface' && exp.type !== 'type');
     for (const exp of globalItems) {
-      const name = exp.isDefault ? (imports.get('./global/' + path.relative(path.join('src', '.uniky', 'global'), exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, ''))?.defaultName || exp.name) : exp.name;
+      const name = exp.isDefault ? (imports.get('./global/' + path.relative(path.join('src', '_unikey', 'global'), exp.filePath).replace(/\\/g, '/').replace(/\.ts$/, ''))?.defaultName || exp.name) : exp.name;
       content += `  (globalThis as any).${exp.name} = ${name};\n`;
     }
 
@@ -305,25 +305,25 @@ export default function globalDefinedPlugin(): Plugin {
     },
 
     configureServer(server) {
-      // 监听 src/.uniky/global 目录下的文件变化
+      // 监听 src/_unikey/global 目录下的文件变化
       server.watcher.add(globalDir);
 
       server.watcher.on('change', (file) => {
-        if (file.includes('src/.uniky/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
+        if (file.includes('src/_unikey/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
           console.log(`[globalDefined] 检测到文件变化: ${file}`);
           generate();
         }
       });
 
       server.watcher.on('add', (file) => {
-        if (file.includes('src/.uniky/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
+        if (file.includes('src/_unikey/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
           console.log(`[globalDefined] 检测到新文件: ${file}`);
           generate();
         }
       });
 
       server.watcher.on('unlink', (file) => {
-        if (file.includes('src/.uniky/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
+        if (file.includes('src/_unikey/global') && file.endsWith('.ts') && !file.endsWith('.d.ts') && !file.includes('global.install.ts')) {
           console.log(`[globalDefined] 检测到文件删除: ${file}`);
           generate();
         }

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;

package/src/plugin/pages.defined.ts

@@ -248,7 +248,7 @@ export default function pagesDefinedPlugin(): Plugin {
     configResolved(config) {
       // 确定 src 目录和输出路径
       srcDir = path.resolve(config.root, 'src');
-      outputPath = path.resolve(srcDir, '.uniky/global/pages.ts');
+      outputPath = path.resolve(srcDir, '_unikey/global/pages.ts');
     },
 
     buildStart() {