@stampgis/webrtc 1.0.0 → 1.0.2

package/dist-cli/cli.js

@@ -0,0 +1,220 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * StampAutoAPI CLI 入口
+ *
+ * 用法：
+ *   stamp-autoapi <input-file> [output-dir] [--pkg <packageName>] [--no-stamputil]
+ *
+ * 示例：
+ *   stamp-autoapi ./src/StampUtil.ts ./output
+ *   stamp-autoapi ./src/StampUtil.ts ./output --pkg @stampgis/webrtc
+ *   npx tsx cli/cli.ts src/StampUtil.ts ./output
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const parser_1 = require("./parser");
+const json_generator_1 = require("./json-generator");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/** 默认配置 */
+const DEFAULT_PACKAGE_NAME = '@stampgis/webrtc';
+const DEFAULT_OUTPUT_DIR = './output';
+/**
+ * 解析命令行参数
+ *
+ * 支持的位置参数：
+ *   argv[0] = 输入文件路径
+ *   argv[1] = 输出目录（可选）
+ *
+ * 支持的选项参数：
+ *   --pkg <name>      指定包名（默认 @stampgis/webrtc）
+ *   --no-stamputil    非 StampUtil 模式（使用具名导入）
+ *   --help, -h        显示帮助
+ */
+function parseArgs(argv) {
+    const args = argv.slice(2); // 跳过 node 和脚本路径
+    let input = '';
+    let outputDir = DEFAULT_OUTPUT_DIR;
+    let packageName = DEFAULT_PACKAGE_NAME;
+    let isStampUtil = true;
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        switch (arg) {
+            case '--help':
+            case '-h':
+                printHelp();
+                process.exit(0);
+                break;
+            case '--pkg':
+                packageName = args[++i] ?? DEFAULT_PACKAGE_NAME;
+                break;
+            case '--no-stamputil':
+                isStampUtil = false;
+                break;
+            case '--out':
+                outputDir = args[++i] ?? DEFAULT_OUTPUT_DIR;
+                break;
+            default:
+                if (!input) {
+                    input = arg;
+                }
+                else if (outputDir === DEFAULT_OUTPUT_DIR) {
+                    outputDir = arg;
+                }
+                break;
+        }
+    }
+    if (!input) {
+        console.error('错误：缺少输入文件路径');
+        printHelp();
+        process.exit(1);
+    }
+    return {
+        input: path.resolve(input),
+        outputDir: path.resolve(outputDir),
+        packageName,
+        isStampUtil,
+    };
+}
+/** 打印帮助信息 */
+function printHelp() {
+    console.log(`
+StampAutoAPI - StampGIS SDK 接口自动化文档生成工具
+
+用法：
+  stamp-autoapi <input-file> [output-dir] [options]
+
+参数：
+  input-file        输入的 TypeScript 文件路径（如 src/StampUtil.ts）
+  output-dir        输出目录（默认：./output）
+
+选项：
+  --pkg <name>      指定包名（默认：@stampgis/webrtc）
+  --no-stamputil    非 StampUtil 模式，使用具名导入而非默认导入
+  --out <dir>       指定输出目录（与位置参数二选一）
+  -h, --help        显示帮助信息
+
+示例：
+  stamp-autoapi ./src/StampUtil.ts ./output
+  stamp-autoapi ./src/StampUtil.ts ./output --pkg @stampgis/webrtc
+  npx tsx cli/cli.ts src/StampUtil.ts ./output
+`);
+}
+/**
+ * 主函数
+ */
+function main() {
+    const args = parseArgs(process.argv);
+    // 验证输入文件存在
+    if (!fs.existsSync(args.input)) {
+        console.error(`错误：输入文件不存在 - ${args.input}`);
+        process.exit(1);
+    }
+    // 确保输出目录存在
+    if (!fs.existsSync(args.outputDir)) {
+        fs.mkdirSync(args.outputDir, { recursive: true });
+    }
+    console.log('━'.repeat(60));
+    console.log('  StampAutoAPI - 接口文档自动生成工具');
+    console.log('━'.repeat(60));
+    console.log(`  输入文件：${args.input}`);
+    console.log(`  输出目录：${args.outputDir}`);
+    console.log(`  包名：    ${args.packageName}`);
+    console.log(`  模式：    ${args.isStampUtil ? 'StampUtil（默认导入）' : '具名导入'}`);
+    console.log('━'.repeat(60));
+    console.log('');
+    try {
+        // Step 1: 解析 TypeScript 文件
+        console.log('▶ 正在解析 TypeScript 文件...');
+        const methods = (0, parser_1.parseStampUtil)(args.input, args.packageName, args.isStampUtil);
+        console.log(`  ✓ 共解析到 ${methods.length} 个接口方法`);
+        if (methods.length === 0) {
+            console.warn('  ⚠ 未解析到任何方法，请检查输入文件是否包含类定义');
+            process.exit(0);
+        }
+        // 统计分类
+        const categories = new Set(methods.map((m) => m.category));
+        console.log(`  ✓ 共 ${categories.size} 个分类`);
+        // 统计有描述的方法数
+        const withDesc = methods.filter((m) => m.desc && m.desc !== `${m.name} 方法`).length;
+        console.log(`  ✓ ${withDesc}/${methods.length} 个方法有描述`);
+        console.log('');
+        // Step 2: 生成 JSON 文件
+        console.log('▶ 正在生成 JSON 文件...');
+        const jsonPath = (0, json_generator_1.generateJson)(methods, args.outputDir);
+        // console.log(`  ✓ 已生成：${jsonPath}`);
+        // 同时生成的 JS 文件
+        const jsPath = path.join(args.outputDir, 'jsSdkSchemaStore.js');
+        console.log(`  ✓ 已生成：${jsPath}`);
+        console.log('');
+        // // Step 3: 生成 Markdown 文档
+        // console.log('▶ 正在生成 Markdown 文档...');
+        // const mdPath = generateMarkdown(methods, args.outputDir);
+        // console.log(`  ✓ 已生成：${mdPath}`);
+        // console.log('');
+        // 完成
+        console.log('━'.repeat(60));
+        console.log('  ✅ MCPJSON文件生成完成！');
+        console.log('━'.repeat(60));
+        console.log('');
+        console.log('  生成文件：');
+        // console.log(`    1. ${jsonPath}  (JSON 接口描述)`);
+        console.log(`    1. ${jsPath}    (JS 可直接引用)`);
+        // console.log(`    3. ${mdPath}    (Markdown 文档)`);
+        console.log('');
+    }
+    catch (err) {
+        console.error('');
+        console.error('━'.repeat(60));
+        console.error('  ❌ 生成失败！');
+        console.error('━'.repeat(60));
+        console.error('');
+        if (err instanceof Error) {
+            console.error(`  错误信息：${err.message}`);
+            if (err.stack) {
+                console.error('');
+                console.error('  堆栈信息：');
+                console.error(err.stack);
+            }
+        }
+        else {
+            console.error(`  错误：${String(err)}`);
+        }
+        console.error('');
+        process.exit(1);
+    }
+}
+main();

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@stampgis/webrtc",
-  "version": "1.0.0",
-  "description": "StampGIS 私有地图 SDK，封装 StampUtil 接口库与 core 脚本加载逻辑",
+  "version": "1.0.2",
+  "description": "StampGIS 地图SDK，封装 StampUtil 接口库与 core 脚本加载逻辑",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "stamp-autoapi": "dist-cli/cli.js"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -19,10 +22,21 @@
     "README.md"
   ],
   "sideEffects": false,
+  "//": {
+    "dev": "开发环境，监听文件变化并自动编译",
+    "build": "生产环境，编译代码",
+    "build:cli": "编译 cli 代码",
+    "generate": "生成 jsapi json 文件",
+    "docs": "生成 jsapi HTML静态页面",
+    "docs:serve": "启动 jsapi HTML静态页面服务"
+  },
   "scripts": {
     "dev": "tsup --watch",
     "build": "tsup",
-    "prepublishOnly": "npm run build"
+    "build:cli": "tsc -p tsconfig.cli.json",
+    "generate": "npm run build:cli && node dist-cli/cli.js src/StampUtil.ts ../StampMCPServer/schemaStore",
+    "docs": "jsdoc -c jsdoc.config.json",
+    "docs:serve": "jsdoc -c jsdoc.config.json && npx http-server jsapi-docs -p 8080"
   },
   "keywords": [
     "map",
@@ -37,6 +51,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
+    "axios": "^1.20.0",
     "file-saver": "^2.0.5",
     "jszip": "^3.10.1"
   },
@@ -45,8 +60,17 @@
     "jszip": "^3.10.1"
   },
   "devDependencies": {
+    "@babel/core": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
     "@types/file-saver": "^2.0.7",
-    "typescript": "^5.4.0",
-    "tsup": "^8.0.0"
+    "@types/node": "^20.0.0",
+    "jsdoc": "^4.0.5",
+    "jsdoc-babel": "^0.5.0",
+    "taffydb": "^2.7.3",
+    "tsup": "^8.0.0",
+    "tsx": "^4.0.0",
+    "tui-jsdoc-template": "^1.2.2",
+    "typescript": "^5.4.0"
   }
 }