fx-spec-hub 0.0.1

package/README.md

@@ -0,0 +1,66 @@
+# swagger-admin
+
+把本仓库作为一个可复用的依赖包使用：提供 OpenAPI -> TS Client 生成，以及 Strapi 枚举生成。
+
+## 安装（示例）
+
+在你的其它项目里（推荐开发依赖）：
+
+```bash
+pnpm add -D file:../swagger-admin
+```
+
+或从 git 安装（按你自己的仓库地址调整）：
+
+```bash
+pnpm add -D git+ssh://git@your-host/your-org/swagger-admin.git
+```
+
+## CLI
+
+### 1) 生成 Swagger 客户端
+
+```bash
+swagger-admin swagger --input ./openapi.json --output ./src/api --baseURL https://api.example.com
+```
+
+也可以输入 URL：
+
+```bash
+swagger-admin swagger --input https://example.com/openapi.json --output ./src/api --baseURL https://api.example.com
+```
+
+常用可选参数：
+
+- `--baseURL`：index.ts 里的 baseURL 字符串（必填）
+- `--httpClientPath`：HttpClient import 路径（默认 `@/utils/request`）
+- `--templateDir`：自定义模板目录（默认使用本包 `swagger-template`）
+- `--httpClientType axios|fetch`：默认 `axios`
+
+### 2) 生成 Strapi 枚举
+
+```bash
+swagger-admin strapi-enums --input https://cms.example.com/api/options --output ./src/api/enum.ts
+```
+
+当 `--input` 不包含 `?` 时，会自动拼接默认 query（`pageSize/locale/populate`）。如果你想完全自定义 query，直接把完整 URL（带 `?`）传进去即可。
+
+也可以不传 `--input`，默认使用本包内置的 `data/strapi-enum-options.json` 进行离线生成。
+
+## 作为库使用（可选）
+
+```ts
+import { generateSwaggerApi, generateStrapiEnums } from 'swagger-admin';
+
+await generateSwaggerApi({
+  input: 'https://example.com/openapi.json',
+  output: './src/api',
+  baseURL: 'https://api.example.com',
+  onSuccess(result) {
+    console.log('生成完成：', result.outputDir);
+  },
+});
+
+// 不传 input 时，会读取包内默认 OpenAPI JSON；第二个参数 isStrapi 默认为 false
+// await generateSwaggerApi({ output: './src/api', baseURL: 'https://api.example.com' }, true);
+```

package/bin/swagger-admin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+'use strict';
+
+require('../dist/cli.js');
+

package/dist/bootstrap.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bootstrap.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const dotenv_1 = __importDefault(require("dotenv"));
+const targetEnv = process.env.TARGET_ENV;
+const clientType = process.env.CLIENT_TYPE;
+if (!targetEnv) {
+    throw new Error('bootstrap 需要环境变量 TARGET_ENV（例如 dev / uat / prod / test）');
+}
+const envDir = node_path_1.default.resolve(__dirname, `env/${clientType}`);
+const commonEnvPath = node_path_1.default.join(envDir, '.env.common');
+const targetEnvPath = node_path_1.default.join(envDir, `.env.${targetEnv}`);
+if (!node_fs_1.default.existsSync(commonEnvPath)) {
+    throw new Error(`未找到 env 文件：${commonEnvPath}`);
+}
+if (!node_fs_1.default.existsSync(targetEnvPath)) {
+    throw new Error(`未找到 env 文件：${targetEnvPath}`);
+}
+dotenv_1.default.config({ path: [commonEnvPath, targetEnvPath] });
+//# sourceMappingURL=bootstrap.js.map

package/dist/bootstrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":";;;;;AAAA,sDAAyB;AACzB,0DAA6B;AAC7B,oDAA4B;AAE5B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;AACzC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;AAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;IACf,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,UAAU,EAAE,CAAC,CAAC;AAC5D,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACvD,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,SAAS,EAAE,CAAC,CAAC;AAE7D,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;IAClC,MAAM,IAAI,KAAK,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC;AACjD,CAAC;AACD,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;IAClC,MAAM,IAAI,KAAK,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC"}

package/dist/bootstrap.mjs

@@ -0,0 +1 @@
+import './bootstrap.js';

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const minimist_1 = __importDefault(require("minimist"));
+const logger_1 = require("./logger");
+const strapi_enums_1 = require("./strapi-enums");
+const swagger_1 = require("./swagger");
+function printHelp() {
+    const text = `
+swagger-admin
+
+用法：
+  swagger-admin swagger --input <url|file> --output <dir> [options]
+  swagger-admin strapi-enums --input <url|file> --output <file> [options]
+
+swagger 选项：
+  --input            OpenAPI URL 或本地文件路径（必填）
+  --output           输出目录（必填）
+  --templateDir      自定义模板目录（可选，默认使用本包 swagger-template）
+  --baseURL          index.ts 里的 baseURL 字符串（必填）
+  --httpClientPath   HttpClient import 路径（默认：@/utils/request）
+  --httpClientType   axios | fetch（默认：axios）
+
+strapi-enums 选项：
+  --input            URL 或本地 JSON 文件路径（可选，默认使用本包 data/strapi-enum-options.json）
+  --output           输出文件路径（必填）
+  --pageSize         默认 1000（仅当 input 不含 ? 时自动拼 query）
+  --locale           默认 zh-CN（仅当 input 不含 ? 时自动拼 query）
+  --prettierConfig   prettier 配置文件路径（可选）
+`.trim();
+    // eslint-disable-next-line no-console
+    console.log(text);
+}
+function asHttpClientType(value) {
+    if (value === 'axios' || value === 'fetch')
+        return value;
+    throw new Error(`--httpClientType 仅支持 axios|fetch，收到：${String(value)}`);
+}
+async function runSwagger(argv) {
+    const args = (0, minimist_1.default)(argv, {
+        string: ['input', 'output', 'templateDir', 'baseURL', 'httpClientPath', 'httpClientType'],
+        default: {
+            httpClientPath: '@/utils/request',
+            httpClientType: 'axios',
+        },
+    });
+    const input = args.input;
+    const output = args.output;
+    const baseURL = args.baseURL;
+    if (!input || !output || !baseURL) {
+        throw new Error('swagger 命令需要 --input、--output、--baseURL');
+    }
+    await (0, swagger_1.generateSwaggerApi)({
+        input,
+        output,
+        templateDir: args.templateDir,
+        baseURL,
+        httpClientPath: args.httpClientPath,
+        httpClientType: asHttpClientType(args.httpClientType),
+    });
+    (0, logger_1.log)(`swagger 生成完成：${output}`);
+}
+async function runStrapiEnums(argv) {
+    const args = (0, minimist_1.default)(argv, {
+        string: ['input', 'output', 'locale', 'prettierConfig'],
+        default: {
+            pageSize: 1000,
+            locale: 'zh-CN',
+        },
+    });
+    const input = args.input;
+    const output = args.output;
+    if (!output) {
+        throw new Error('strapi-enums 命令需要 --output');
+    }
+    const pageSize = typeof args.pageSize === 'number'
+        ? args.pageSize
+        : Number.isFinite(Number(args.pageSize))
+            ? Number(args.pageSize)
+            : 1000;
+    await (0, strapi_enums_1.generateStrapiEnums)({
+        input,
+        output,
+        pageSize,
+        locale: args.locale,
+        prettierConfig: args.prettierConfig,
+    });
+    (0, logger_1.log)(`Strapi 枚举生成完成：${output}`);
+}
+async function main() {
+    const [command, ...rest] = process.argv.slice(2);
+    if (!command || command === 'help' || command === '--help' || command === '-h') {
+        printHelp();
+        return;
+    }
+    if (command === 'swagger')
+        return runSwagger(rest);
+    if (command === 'strapi-enums')
+        return runStrapiEnums(rest);
+    throw new Error(`未知命令：${command}`);
+}
+main().catch((e) => {
+    (0, logger_1.logError)(e);
+    printHelp();
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAChC,qCAAyC;AACzC,iDAAqD;AACrD,uCAA2E;AAE3E,SAAS,SAAS;IAChB,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;CAqBd,CAAC,IAAI,EAAE,CAAC;IAEP,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IACzD,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,IAAc;IACtC,MAAM,IAAI,GAAG,IAAA,kBAAQ,EAAC,IAAI,EAAE;QAC1B,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,CAAC;QACzF,OAAO,EAAE;YACP,cAAc,EAAE,iBAAiB;YACjC,cAAc,EAAE,OAAO;SACxB;KACF,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,IAAA,4BAAkB,EAAC;QACvB,KAAK;QACL,MAAM;QACN,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,OAAO;QACP,cAAc,EAAE,IAAI,CAAC,cAAc;QACnC,cAAc,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC;KACtD,CAAC,CAAC;IAEH,IAAA,YAAG,EAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,IAAc;IAC1C,MAAM,IAAI,GAAG,IAAA,kBAAQ,EAAC,IAAI,EAAE;QAC1B,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,CAAC;QACvD,OAAO,EAAE;YACP,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,OAAO;SAChB;KACF,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,QAAQ,GACZ,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;QAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ;QACf,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvB,CAAC,CAAC,IAAI,CAAC;IAEb,MAAM,IAAA,kCAAmB,EAAC;QACxB,KAAK;QACL,MAAM;QACN,QAAQ;QACR,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,cAAc,EAAE,IAAI,CAAC,cAAc;KACpC,CAAC,CAAC;IAEH,IAAA,YAAG,EAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;AACjC,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjD,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,MAAM,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QAC/E,SAAS,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;IACnD,IAAI,OAAO,KAAK,cAAc;QAAE,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;IAE5D,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,EAAE,CAAC,CAAC;AACrC,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC;IACZ,SAAS,EAAE,CAAC;IACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}