@nasl/cli 0.1.17 → 0.1.18

package/README.md

@@ -7,12 +7,12 @@ NASL 语言的命令行工具，提供编译、检查、开发服务等功能。
 ## 安装
 
 ```bash
-pnpm install -g @nasl/cli
+npm install -g @nasl/cli
 ```
 
 ## 使用
 
-### 初始化配置
+### 初始化配置（nasl init）
 
 ```bash
 nasl init
@@ -22,16 +22,15 @@ nasl init
 
 ```json
 {
-  "serverBaseURL": "https://nasl.lcap.163yun.com/api/v1/nasl", // NASL 编译服务的基础 URL
+  "serverBaseURL": "https://nasl.lcap.163yun.com", // NASL 编译服务的基础 URL
   "representation": "NaturalTS", // NASL 语言的表示
   "namespaceResolution": "filename-as-namespace", // 命名空间解析策略
-  "ideVersion": "4.1", // IDE 版本
+  "ideVersion": "4.4", // IDE 版本
   "srcDir": "src", // 源代码目录
   "outDir": "out" // 输出目录
 }
 ```
 
-
 ### 入口文件说明
 
 下面的命令中均支持 [entry] 参数，表示入口文件：
@@ -47,7 +46,7 @@ nasl init
 - 会自动进行依赖分析，收集所有依赖的文件
 - 依赖的页面文件（.tsx）不会继续进行依赖分析，而是直接提取签名，以提高性能
 
-### 编译 NASL 代码
+### 编译 NASL 代码（nasl compile 或 naslc）
 
 ```bash
 # 编译整个 src 目录
@@ -63,7 +62,7 @@ naslc "src/app.logics.*.ts"
 naslc "src/*.tsx"
 ```
 
-### 检查 NASL 代码
+### 检查 NASL 代码（nasl check）
 
 ```bash
 # 检查整个 src 目录
@@ -77,7 +76,7 @@ nasl check "src/app.logics.*.ts"
 nasl check "src/*.tsx"
 ```
 
-### 依赖分析
+### 依赖分析（nasl dep）
 
 建议指定入口文件，否则会扫描整个 src 目录，输出量较大。
 
@@ -89,13 +88,19 @@ nasl dep "src/*.tsx"
 nasl dep
 ```
 
-### 启动开发服务
+### 启动开发服务（nasl dev）
 
 ```bash
 nasl dev
 ```
 
-启动开发服务后，默认可以访问 http://localhost:3100 查看预览效果。
+启动开发服务后，默认访问 http://localhost:3100 查看预览效果。
+
+可以用 --port 和 --host 更换端口号和主机名。
+
+```bash
+nasl dev --port 4900 --host 0.0.0.0
+```
 
 dev 进程始终保持运行，规则如下：
 
@@ -109,7 +114,104 @@ dev 进程始终保持运行，规则如下：
   2. src 被创建：自动编译生成 out 目录
   3. src 被删除: 使用缓存的 out 目录
 
-## 开发 CLI 工具
+### 构建项目（nasl build）
+
+与 nasl dev 对应，构建成最终用于浏览器的 dist 产物。
+
+```bash
+# 使用生产模式构建（默认）
+nasl build
+
+# 使用开发模式构建
+nasl build --mode development
+
+# 构建指定入口文件及其依赖
+nasl build src/app.frontendTypes.pc.frontends.pc.views.dashboard.tsx
+```
+
+### 转换文件格式（nasl transform）
+
+```bash
+# files2full: 将 src 中的文件组合成 fullNaturalTS
+nasl transform files2full [entry] --output [outputPath]
+# 默认输出到 ./full-natural.ts
+
+# json2files: 将 JSON 文件转换成 src 的 files
+nasl transform json2files [jsonFile] --output [outputPath]
+# 如果不指定 jsonFile，将按照默认 IDE 版本的基础模板转换
+
+# files2json: 将 src 中的文件转换成一个 JSON（待实现）
+nasl transform files2json [entry] --output [outputPath]
+# 默认输出到 ./files.json
+```
+
+### 在 IDE 中直接创建应用（nasl create-app-in-ide）
+
+**注意**：目前该命令不支持 useOPENAPI 模式，只在测试环境使用。
+
+```bash
+# 会询问确认（默认）
+nasl create-app-in-ide [entry]
+
+# 跳过确认，直接执行
+nasl create-app-in-ide [entry] --quiet
+
+# 显示详细信息
+nasl create-app-in-ide [entry] --verbose
+```
+
+此命令会将当前项目的 NASL 代码上传到远程服务，在 IDE 中创建新的应用。默认会询问用户确认，使用 `--quiet` 选项可以跳过确认。
+
+## 环境变量配置
+
+除了在 `nasl.config.json` 中配置外，也可以通过环境变量来配置部分选项。环境变量的优先级低于配置文件。
+
+### 支持的环境变量
+
+- `NASL_IDE_VERSION`: IDE 版本号，对应配置`ideVersion`字段
+  ```bash
+  export NASL_IDE_VERSION=4.4
+  ```
+
+- `NASL_SERVER_BASE_URL`: NASL 编译服务的基础 URL，对应配置`serverBaseURL`字段
+  ```bash
+  export NASL_SERVER_BASE_URL=https://nasl.lcap.163yun.com
+  ```
+
+- `USE_LCAP_OPENAPI`: 是否使用 OpenAPI 方式调用（值为 `'true'` 时启用），对应配置`useOPENAPI`字段
+  ```bash
+  export USE_LCAP_OPENAPI=true
+  ```
+
+- `LCAP_OPENAPI_AK`: LCAP OpenAPI Access Key（使用 OpenAPI 时必需），对应配置`OPENAPI_AK`字段
+  ```bash
+  export LCAP_OPENAPI_AK=your_access_key
+  ```
+
+- `LCAP_OPENAPI_SK`: LCAP OpenAPI Secret Key（使用 OpenAPI 时必需），对应配置`OPENAPI_SK`字段
+  ```bash
+  export LCAP_OPENAPI_SK=your_secret_key
+  ```
+
+### 配置文件示例（包含 OpenAPI 配置）
+
+```json
+{
+  "serverBaseURL": "https://sometenant.codewave.163.com",
+  "representation": "NaturalTS",
+  "namespaceResolution": "filename-as-namespace",
+  "ideVersion": "4.4",
+  "srcDir": "src",
+  "outDir": "out",
+  "useOPENAPI": true,
+  "OPENAPI_AK": "your_access_key",
+  "OPENAPI_SK": "your_secret_key"
+}
+```
+
+注意：如果配置了 `useOPENAPI: true`，则必须同时配置 `OPENAPI_AK` 和 `OPENAPI_SK`（可在配置文件中配置，或通过环境变量 `LCAP_OPENAPI_AK` 和 `LCAP_OPENAPI_SK` 配置）。
+
+## DEVELOPMENT
 
 ```bash
 # 安装依赖

package/dist/bin/nasl.mjs

@@ -3,8 +3,8 @@
 import require$$0$1, { EventEmitter } from 'events';
 import require$$1, { spawn, spawnSync } from 'child_process';
 import * as sysPath from 'path';
-import sysPath__default from 'path';
-import require$$0$2, { unwatchFile, watchFile, watch as watch$1, stat as stat$3 } from 'fs';
+import sysPath__default, { join } from 'path';
+import require$$0$2, { promises, unwatchFile, watchFile, watch as watch$1, stat as stat$3 } from 'fs';
 import require$$4 from 'process';
 import require$$0$3 from 'constants';
 import stream$4, { Readable } from 'stream';
@@ -15,14 +15,14 @@ import require$$1$1 from 'tty';
 import require$$3 from 'http';
 import require$$4$1 from 'https';
 import require$$0$6 from 'url';
-import crypto$1 from 'crypto';
+import crypto$1, { createHash } from 'crypto';
 import http2 from 'http2';
 import zlib from 'zlib';
 import * as readline from 'readline';
 import { realpath as realpath$1, stat as stat$2, lstat as lstat$1, open, readdir as readdir$1 } from 'fs/promises';
 import { lstat, stat as stat$1, readdir, realpath } from 'node:fs/promises';
 import { Readable as Readable$1 } from 'node:stream';
-import { resolve, join, relative, sep } from 'node:path';
+import { resolve, join as join$1, relative, sep } from 'node:path';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -8338,10 +8338,39 @@ function loadConfig(configDir) {
         const content = libExports.readFileSync(configPath, 'utf-8');
         const config = JSON.parse(content);
         // 验证必需字段
-        if (!config.serverBaseURL || !config.ideVersion || !config.srcDir || !config.outDir) {
-            defaultLogger.error('配置文件格式不正确，缺少必需字段');
+        if (!config.srcDir || !config.outDir) {
+            defaultLogger.error('配置文件格式不正确，缺少必需的 srcDir 或 outDir 字段');
             return defaultLogger.exit(1);
         }
+        if (!config.ideVersion) {
+            config.ideVersion = process.env.NASL_IDE_VERSION || '';
+            if (!config.ideVersion) {
+                defaultLogger.error('缺少配置 ideVersion，请在配置文件中添加，或在环境变量中配置 NASL_IDE_VERSION');
+                return defaultLogger.exit(1);
+            }
+        }
+        if (!config.serverBaseURL) {
+            config.serverBaseURL = process.env.NASL_SERVER_BASE_URL || '';
+            if (!config.serverBaseURL) {
+                defaultLogger.error('缺少配置 serverBaseURL，请在配置文件中添加，或在环境变量中配置 NASL_SERVER_BASE_URL');
+                return defaultLogger.exit(1);
+            }
+        }
+        if (!config.useOPENAPI)
+            config.useOPENAPI = process.env.USE_LCAP_OPENAPI === 'true';
+        if (!config.OPENAPI_AK)
+            config.OPENAPI_AK = process.env.LCAP_OPENAPI_AK;
+        if (!config.OPENAPI_SK)
+            config.OPENAPI_SK = process.env.LCAP_OPENAPI_SK;
+        if (config.useOPENAPI) {
+            if (!config.OPENAPI_AK || !config.OPENAPI_SK) {
+                defaultLogger.error(`配置了 useOPENAPI，但缺少配置 OPENAPI_AK 和 OPENAPI_SK:
+- 在 nasl.config.json 中配置 OPENAPI_AK 和 OPENAPI_SK，或者在环境变量中配置 LCAP_OPENAPI_AK 和 LCAP_OPENAPI_SK
+- 或将 useOPENAPI 配置为 false
+`);
+                return defaultLogger.exit(1);
+            }
+        }
         return config;
     }
     catch (error) {
@@ -28895,18 +28924,99 @@ function v4(options, buf, offset) {
   return unsafeStringify(rnds);
 }
 
+function generateHash(params) {
+    const hash = createHash('sha256');
+    hash.update(JSON.stringify(params));
+    return hash.digest('hex');
+}
+async function getCachePathWithTimestamp(hash) {
+    const cacheDir = join(process.cwd(), '.cache');
+    await promises.mkdir(cacheDir, { recursive: true });
+    return join(cacheDir, `${hash}_${Date.now()}.json`);
+}
 /**
- * 构建签名字符串
+ * 查找指定 hash 的有效缓存文件
+ * @param hash 缓存标识
+ * @param ttl 缓存有效期（毫秒）
+ * @returns 缓存文件路径和缓存内容，如果没有有效缓存则返回 null
  */
-function buildStringToSign(appKey, nonce, timestamp, secretKey) {
-    return `${appKey}&${nonce}&${timestamp}&${secretKey}`;
+async function findValidCache(hash, ttl) {
+    const cacheDir = join(process.cwd(), '.cache');
+    try {
+        await promises.mkdir(cacheDir, { recursive: true });
+        const files = await promises.readdir(cacheDir);
+        const now = Date.now();
+        // 查找所有匹配的缓存文件
+        const matchingFiles = files
+            .filter((file) => file.startsWith(`${hash}_`) && file.endsWith('.json'))
+            .map((file) => {
+            const match = file.match(/_(\d+)\.json$/);
+            if (!match)
+                return null;
+            const timestamp = parseInt(match[1], 10);
+            return {
+                path: join(cacheDir, file),
+                timestamp,
+                isExpired: now - timestamp > ttl,
+            };
+        })
+            .filter((item) => item !== null);
+        // 删除过期的缓存文件
+        const expiredFiles = matchingFiles.filter((item) => item.isExpired);
+        await Promise.all(expiredFiles.map((item) => promises.unlink(item.path).catch(() => { })));
+        // 查找有效的缓存文件（按时间戳降序排序，获取最新的）
+        const validFiles = matchingFiles.filter((item) => !item.isExpired).sort((a, b) => b.timestamp - a.timestamp);
+        if (validFiles.length > 0) {
+            const cacheFile = validFiles[0];
+            const cacheContent = await promises.readFile(cacheFile.path, 'utf-8');
+            const cachedResult = JSON.parse(cacheContent);
+            return { path: cacheFile.path, data: cachedResult };
+        }
+        return null;
+    }
+    catch (error) {
+        return null;
+    }
 }
 /**
- * 生成 MD5 签名
+ * 高阶函数，为异步函数添加带时间戳的缓存功能
+ * @param fn 需要添加缓存的函数
+ * @param ttl 缓存有效期（毫秒），默认 1 小时
+ * @param getCacheKey 可选的自定义缓存 key 生成函数，如果不提供则使用整个 params
+ * @returns 带缓存的函数版本
  */
-function generateSignature(plainText) {
-    return crypto$1.createHash('md5').update(plainText).digest('hex');
+function cachableWithTTL(fn, ttl = 3600 * 1000, // 默认 1 小时
+getCacheKey) {
+    return async (params, extraParams) => {
+        const functionName = fn.name;
+        const logPrefix = functionName ? `[${functionName}]` : '[cachableWithTTL]';
+        // 检查是否启用缓存
+        if (process.env.NO_AI_CACHE) {
+            return fn(params, extraParams);
+        }
+        // 使用自定义的 getCacheKey 或默认使用整个 params
+        const cacheKey = getCacheKey ? getCacheKey(params) : params;
+        const hash = generateHash(cacheKey);
+        // 查找有效的缓存
+        const validCache = await findValidCache(hash, ttl);
+        if (validCache) {
+            console.log(`${logPrefix} ✓ 使用缓存`);
+            return validCache.data;
+        }
+        // 调用原函数
+        const result = await fn(params, extraParams);
+        // 保存结果到缓存（带时间戳）
+        try {
+            const cachePath = await getCachePathWithTimestamp(hash);
+            await promises.writeFile(cachePath, JSON.stringify(result, null, 2), 'utf-8');
+        }
+        catch (error) {
+            // 缓存写入失败，但不影响返回结果
+        }
+        return result;
+    };
 }
+
 /**
  * 生成客户端签名信息
  * @param appKey AppKey
@@ -28916,8 +29026,8 @@ function generateSignature(plainText) {
 function generateClientSignature(appKey, secretKey) {
     const timestamp = Math.floor(Date.now() / 1000).toString();
     const nonce = v4();
-    const plainText = buildStringToSign(appKey, nonce, timestamp, secretKey);
-    const signature = generateSignature(plainText);
+    const plainText = `${appKey}&${nonce}&${timestamp}&${secretKey}`;
+    const signature = crypto$1.createHash('md5').update(plainText).digest('hex');
     return {
         appKey,
         timestamp,
@@ -28942,12 +29052,12 @@ function generateBaseHeaders(ak, sk) {
     };
 }
 /**
- * 获取租户的 signInfo
+ * 获取租户的 signInfo（内部实现）
  * @param options 服务器选项
  * @param baseHeaders 基础认证头
  * @returns x-signInfo 值
  */
-async function fetchSignInfo(options, baseHeaders) {
+async function _fetchSignInfo({ options, baseHeaders }) {
     const tenantName = options.tenantName || 'defaulttenant';
     const userName = tenantName === 'defaulttenant' ? 'admin' : `${tenantName}-admin`;
     const data = {
@@ -28969,6 +29079,14 @@ async function fetchSignInfo(options, baseHeaders) {
         return null;
     }
 }
+/**
+ * 获取租户的 signInfo（带缓存，1 小时过期）
+ * @param options 服务器选项
+ * @param baseHeaders 基础认证头
+ * @returns x-signInfo 值
+ */
+const fetchSignInfo = cachableWithTTL(_fetchSignInfo, 3600 * 1000, // 1 小时
+(params) => params.options);
 /**
  * 生成完整的认证头（包含 x-signInfo）
  * @param options 服务器选项
@@ -28978,19 +29096,18 @@ async function generateCompleteHeaders(options) {
     const headers = {
         'Content-Type': 'application/json',
     };
-    const OPENAPI_AK = options.OPENAPI_AK || process.env.LCAP_OPENAPI_AK;
-    const OPENAPI_SK = options.OPENAPI_SK || process.env.LCAP_OPENAPI_SK;
     // 如果没有提供 ak 和 sk，返回基础 headers
-    if (!OPENAPI_AK || !OPENAPI_SK) {
-        throw new Error(`配置了 useOPENAPI，但没有提供 OPENAPI_AK 和 OPENAPI_SK:
-- 可取消配置 useOPENAPI
-- 在 nasl.config.json 中配置 OPENAPI_AK 和 OPENAPI_SK，或者在环境变量中配置 LCAP_OPENAPI_AK 和 LCAP_OPENAPI_SK`);
+    if (!options.OPENAPI_AK || !options.OPENAPI_SK) {
+        throw new Error(`配置了 useOPENAPI，但缺少配置 OPENAPI_AK 和 OPENAPI_SK:
+- 在 nasl.config.json 中配置 OPENAPI_AK 和 OPENAPI_SK，或者在环境变量中配置 LCAP_OPENAPI_AK 和 LCAP_OPENAPI_SK
+- 或将 useOPENAPI 配置为 false
+`);
     }
     // 生成基础认证头
-    const baseHeaders = generateBaseHeaders(OPENAPI_AK, OPENAPI_SK);
+    const baseHeaders = generateBaseHeaders(options.OPENAPI_AK, options.OPENAPI_SK);
     Object.assign(headers, baseHeaders);
     // 获取 signInfo
-    const signInfo = await fetchSignInfo(options, headers);
+    const signInfo = await fetchSignInfo({ options, baseHeaders: headers });
     if (signInfo) {
         headers['x-signInfo'] = signInfo;
     }
@@ -29005,10 +29122,9 @@ async function generateCompleteHeaders(options) {
 async function createAxios(options) {
     // 如果需要鉴权，拼接 /openapi/v3/nasl；否则使用原始 URL
     const serverBaseURL = new URL(options.serverBaseURL).origin;
-    const useOPENAPI = options.useOPENAPI || process.env.USE_LCAP_OPENAPI === 'true';
-    const baseURL = useOPENAPI ? `${serverBaseURL}/openapi/v3/nasl` : `${serverBaseURL}/api/v1/nasl`;
+    const baseURL = options.useOPENAPI ? `${serverBaseURL}/openapi/v3/nasl` : `${serverBaseURL}/api/v1/nasl`;
     // 如果需要鉴权，生成完整的认证头；否则只使用基础 headers
-    const headers = useOPENAPI ? await generateCompleteHeaders(options) : { 'Content-Type': 'application/json' };
+    const headers = options.useOPENAPI ? await generateCompleteHeaders(options) : { 'Content-Type': 'application/json' };
     console.log('本次服务调用方为:', baseURL);
     const instance = axios.create({
         baseURL,
@@ -29096,7 +29212,7 @@ async function checkApi(fullNaturalTS, options) {
 async function createAppSyncApi(fullNaturalTS, options) {
     const url = new URL(options.serverBaseURL);
     const origin = url.origin + '/app-ai-creator';
-    const axios = await createAxios({ serverBaseURL: origin});
+    const axios = await createAxios({ serverBaseURL: origin, ideVersion: options.ideVersion });
     try {
         const res = await axios.post('/api/createAppSync', {
             fullNaturalTS,
@@ -38305,6 +38421,10 @@ async function createAppInIde(entry, options) {
     logger.info('开始创建应用在 IDE 中...');
     // 收集需要处理的文件
     const { collectedFiles, config } = await resolveNASLFiles(entry, logger, false, options?.verbose);
+    if (config.useOPENAPI) {
+        logger.error('create-app-in-ide 暂不支持 useOPENAPI 模式');
+        logger.exit(1);
+    }
     // 生成 fullNaturalTS
     logger.newLine();
     logger.info('正在生成 NaturalTS 代码...');
@@ -38424,10 +38544,7 @@ const transformFns = {
             jsonContent = libExports.readFileSync(entry, 'utf-8');
             logger.info(`读取到 JSON 文件: ${entry}`);
         }
-        const files = await transformJson2FilesApi(jsonContent ? JSON.parse(jsonContent) : {}, {
-            serverBaseURL: config.serverBaseURL,
-            ideVersion: config.ideVersion,
-        });
+        const files = await transformJson2FilesApi(jsonContent ? JSON.parse(jsonContent) : {}, config);
         await Promise.all(files.map(async (file) => {
             const outputPath = sysPath.join(projectRoot, config.srcDir, file.path);
             await libExports.writeFile(outputPath, file.content);
@@ -38456,7 +38573,7 @@ async function transform(transformType, entry, options) {
     await transformFn(entry, options);
 }
 
-var version = "0.1.17";
+var version = "0.1.18";
 var pkg = {
 	version: version};
 
@@ -38760,7 +38877,7 @@ class ReaddirpStream extends Readable$1 {
         let entry;
         const basename = this._isDirent ? dirent.name : dirent;
         try {
-            const fullPath = resolve(join(path, basename));
+            const fullPath = resolve(join$1(path, basename));
             entry = { path: relative(this._root, fullPath), fullPath, basename };
             entry[this._statsProp] = this._isDirent ? dirent : await this._stat(fullPath);
         }