tirtc-devtools-cli 0.0.11 → 0.0.12

package/README.md

@@ -20,7 +20,7 @@
 - **产品级 Observability**：将底层的运行时事件和状态翻译为结构化输出 (JSON) 或友好的终端日志输出；对长耗时命令补轻量进度提示。
 - **调试期工具内聚**：承接调试期必要工具（如 token bootstrap、二维码与媒体预处理）的产品化入口，避免把调试流程散落在 runtime 或外部手工步骤中。
 - **本地 token 工具**：提供直接签发 token、打印组合 JSON、单独 token 与本地二维码 PNG 路径的公开 CLI 能力，服务本地联调与体验验证。
-- **本地 license 二维码工具**：提供 server 扫码用的 license JSON 二维码生成能力，支持可选 `service_entry`。
+- **本地 license 二维码工具**：提供 server 扫码用的 license JSON 二维码生成能力，支持可选 `endpoint`。
 
 ## 不负责什么
 

package/USAGE.md

@@ -70,6 +70,7 @@ node products/cli/bin/tirtc-devtools-cli.js service --help
 node products/cli/bin/tirtc-devtools-cli.js stream --help
 node products/cli/bin/tirtc-devtools-cli.js command --help
 node products/cli/bin/tirtc-devtools-cli.js token issue --help
+node products/cli/bin/tirtc-devtools-cli.js license qrcode --help
 ```
 
 当前关键子菜单快照：
@@ -96,20 +97,21 @@ Commands:
   tail                                                             持续监听命令相关事件
 
 $ node ... token issue --help
+Usage: tirtc-devtools-cli token issue [options] <remote_id>
+
 Options:
   --access-id <accessId>
   --secret-key <secretKey>
-  --local-id <localId>
-  --openapi-entry <url>
-  --service-entry <entry>
-  --user-ttl-seconds <seconds>
-  --channel-ttl-seconds <seconds>
+  --openapi-endpoint <url>
+  --endpoint <entry>
   --qr-error-correction-level <level>
   --ascii-max-columns <columns>
 
 $ node ... license qrcode --help
+Usage: tirtc-devtools-cli license qrcode [options] <license>
+
 Options:
-  --service-entry <entry>
+  --endpoint <entry>
   --qr-error-correction-level <level>
   --ascii-max-columns <columns>
 ```
@@ -143,7 +145,6 @@ license = "runtime-license"
 mp4_path = "/Users/allenfeng/Development/Repositories/tirtc-nexus/tirtc-matrix/.refers/simple.mp4"
 video_stream_id = 11
 audio_stream_id = 10
-
 ```
 
 说明：
@@ -250,10 +251,77 @@ CLI 仍会在本地收紧最小组合矩阵：
 
 `command request` 是 canonical 主语，`command send` 只保留为兼容别名。若要发 JSON，请把 JSON 文本作为 `payload` 传入。`command pending list` 用于恢复或轮询当前积压，`command reply` 基于 `remoteRequestId` 显式回复待处理请求。
 
-## 十、token / debug / report
+## 十、token / license / debug / report
+
+### token issue
+
+命令形态：
+
+```bash
+export TIRTC_CONN_ACCESS_ID="<ACCESS_ID>"
+export TIRTC_CONN_SECRET_KEY="<SECRET_KEY>"
+node products/cli/bin/tirtc-devtools-cli.js --json token issue <REMOTE_ID>
+```
+
+如果要覆盖默认 endpoint，并显式透传给底层签发路径：
+
+```bash
+node products/cli/bin/tirtc-devtools-cli.js --json token issue <REMOTE_ID> \
+  --endpoint <ENDPOINT> \
+  --openapi-endpoint <OPENAPI_ENDPOINT>
+```
+
+当前 CLI 合同：
+
+- 位置参数改为 `<remote_id>`。
+- `--endpoint` 取代旧 `--service-entry`。
+- `--openapi-endpoint` 取代旧 `--openapi-entry`。
+- 不再接收 `local_id`。
+- 显式传入的 `endpoint` / `openapi_endpoint` 会透传给 C 层签发路径，并同时进入二维码 payload。
+- 若未显式传入 `endpoint` / `openapi_endpoint`，则 payload 中不再补默认字段。
+
+`--json` 输出保持外层 envelope 不变：
+
+```json
+{
+  "code": 0,
+  "message": "OK",
+  "data": {
+    "payload": {
+      "remote_id": "TESTFENGJUN4",
+      "token": "<TOKEN>",
+      "endpoint": "http://ep-test-tirtc.tange365.com",
+      "openapi_endpoint": "http://api-test-tirtc.tange365.com"
+    },
+    "payloadJson": "{\"remote_id\":\"TESTFENGJUN4\",\"token\":\"<TOKEN>\",\"endpoint\":\"http://ep-test-tirtc.tange365.com\",\"openapi_endpoint\":\"http://api-test-tirtc.tange365.com\"}",
+    "token": "<TOKEN>",
+    "qrCodePngPath": "/absolute/path/to/token-*.png"
+  }
+}
+```
+
+说明：
+
+- payload 只保留 `remote_id`、`token`、可选 `endpoint`、可选 `openapi_endpoint`。
+- 已删除字段不再出现：`version`、`type`、`local_id`、`peer_id`、`openapi_entry`、`service_entry`、`user_ttl_seconds`、`channel_ttl_seconds`、`generated_at`。
+
+### license qrcode
+
+命令形态：
+
+```bash
+node products/cli/bin/tirtc-devtools-cli.js --json license qrcode <LICENSE>
+node products/cli/bin/tirtc-devtools-cli.js --json license qrcode <LICENSE> --endpoint <ENDPOINT>
+```
+
+当前 CLI 合同：
+
+- 只保留 `license` 和可选 `endpoint`。
+- `--endpoint` 取代旧 `--service-entry`。
+- 若未显式传入 `endpoint`，payload 中不再补默认字段。
+
+### 其他命令
 
-- `token issue <peerId>`：本地签发 token。
-- `license qrcode <license>`：本地生成 server 扫码二维码。
 - `debug bootstrap qrcode ...` / `debug bootstrap qrcode-from-config`：生成联调用二维码。
 - `events tail`：实时查看事件流。
 - `logs export <outputPath>`：导出日志。
@@ -267,7 +335,7 @@ CLI 仍会在本地收紧最小组合矩阵：
 - `client.local.toml` 字段：`[client]` + `[debug.token_issue]`
 - CLI server-only E2E 不再要求先手工 `media assets prepare` 再回填 `assetsDir`
 
-## 十一、Android 人工闭环脚本
+## 十二、Android 人工闭环脚本
 
 如果需要把 CLI 侧闭环常驻起来，再手工去操作 Android example，使用：
 

package/dist/cli/src/guide.js

@@ -23,7 +23,7 @@ function printQuickstartGuide() {
         '步骤 3：显式签发 client token（可本地执行，也可由外部系统提供）',
         '  export TIRTC_CONN_ACCESS_ID="<ACCESS_ID>"',
         '  export TIRTC_CONN_SECRET_KEY="<SECRET_KEY>"',
-        '  node products/cli/bin/tirtc-devtools-cli.js --json token issue "<PEER_ID>" --service-entry "<SERVICE_ENTRY>"',
+        '  node products/cli/bin/tirtc-devtools-cli.js --json token issue "<REMOTE_ID>" --endpoint "<ENDPOINT>"',
         '',
         '步骤 4：启动 client 本地 web preview',
         '  node products/cli/bin/tirtc-devtools-cli.js --config ./client.toml client start --token "<TOKEN>"',

package/dist/cli/src/index.js

@@ -11,7 +11,7 @@ const media_assets_1 = require("./media_assets");
 const token_command_1 = require("./token_command");
 const transport_1 = require("./transport");
 const progress_1 = require("./progress");
-const CLI_VERSION = '0.0.10';
+const CLI_VERSION = '0.0.12';
 const HOST_VERSION = '1.0.0';
 const PROTOCOL_VERSION = '1.0.0';
 if (process.argv.includes('--version') || process.argv.includes('-V')) {
@@ -585,15 +585,15 @@ const debugBootstrap = debug.command('bootstrap').description('连接 bootstrap
 debugBootstrap.command('qrcode <access_id> <secret_key> <peer_id> [service_entry]')
     .description('生成客户端连接 bootstrap 二维码（payload 包含 access_id/secret_key/peer_id）')
     .action((accessId, secretKey, peerId, serviceEntry) => {
-    const payload = JSON.stringify({
-        version: 1,
-        type: 'tirtc-connect-bootstrap',
+    const payloadObject = {
         access_id: accessId,
         secret_key: secretKey,
         peer_id: peerId,
-        service_entry: serviceEntry ?? '',
-        generated_at: new Date().toISOString(),
-    });
+    };
+    if (serviceEntry && serviceEntry.length > 0) {
+        payloadObject.service_entry = serviceEntry;
+    }
+    const payload = JSON.stringify(payloadObject);
     runAndExit(runCommand('debug bootstrap qrcode', { payload, outputStem: 'connect-bootstrap' }, getCliOptions()));
 });
 debugBootstrap.command('qrcode-from-config')
@@ -607,15 +607,15 @@ debugBootstrap.command('qrcode-from-config')
     if (!bootstrap.access_id || !bootstrap.secret_key || !bootstrap.peer_id) {
         throw new Error('debug.connect_bootstrap requires access_id + secret_key + peer_id');
     }
-    const payload = JSON.stringify({
-        version: 1,
-        type: 'tirtc-connect-bootstrap',
+    const payloadObject = {
         access_id: bootstrap.access_id,
         secret_key: bootstrap.secret_key,
         peer_id: bootstrap.peer_id,
-        service_entry: bootstrap.service_entry ?? '',
-        generated_at: new Date().toISOString(),
-    });
+    };
+    if (bootstrap.service_entry && bootstrap.service_entry.length > 0) {
+        payloadObject.service_entry = bootstrap.service_entry;
+    }
+    const payload = JSON.stringify(payloadObject);
     runAndExit(runCommand('debug bootstrap qrcode', { payload, outputStem: 'connect-bootstrap' }, getCliOptions()));
 });
 const events = program.command('events').description('事件订阅：实时观察 Host 事件');

package/dist/cli/src/token_command.js

@@ -102,7 +102,7 @@ function resolveTokenIssueCredential(explicitValue, envVarName, optionName) {
     throw new Error('missing credential: set environment variable ' + envVarName +
         ' or pass ' + optionName + ' explicitly');
 }
-async function runTokenIssueFromCli(peerId, commandOptions, options) {
+async function runTokenIssueFromCli(remoteId, commandOptions, options) {
     const parsePositiveInt = (name, raw) => {
         if (raw === undefined) {
             return undefined;
@@ -129,12 +129,9 @@ async function runTokenIssueFromCli(peerId, commandOptions, options) {
         return await runTokenIssue({
             accessId,
             secretKey,
-            localId: commandOptions.localId?.trim() || peerId,
-            peerId,
-            openapiEntry: commandOptions.openapiEntry,
-            serviceEntry: commandOptions.serviceEntry,
-            userTtlSeconds: parsePositiveInt('user-ttl-seconds', commandOptions.userTtlSeconds),
-            channelTtlSeconds: parsePositiveInt('channel-ttl-seconds', commandOptions.channelTtlSeconds),
+            remoteId,
+            openapiEndpoint: commandOptions.openapiEndpoint,
+            endpoint: commandOptions.endpoint,
             qrErrorCorrectionLevel: parseQrErrorCorrectionLevel(commandOptions.qrErrorCorrectionLevel),
             asciiMaxColumns: parsePositiveInt('ascii-max-columns', commandOptions.asciiMaxColumns),
         }, options);
@@ -169,11 +166,12 @@ async function runLicenseQrcodeFromCli(license, commandOptions, options) {
         if (normalizedLicense.length === 0) {
             throw new Error('license must not be empty');
         }
+        const asciiMaxColumns = commandOptions.asciiMaxColumns === undefined ? undefined : parsePositiveInt('ascii-max-columns', commandOptions.asciiMaxColumns);
         return await runLicenseQrcode({
             license: normalizedLicense,
-            serviceEntry: commandOptions.serviceEntry,
+            endpoint: commandOptions.endpoint,
             qrErrorCorrectionLevel: parseQrErrorCorrectionLevel(commandOptions.qrErrorCorrectionLevel),
-            asciiMaxColumns: parsePositiveInt('ascii-max-columns', commandOptions.asciiMaxColumns),
+            asciiMaxColumns,
         }, options);
     }
     catch (error) {
@@ -182,24 +180,21 @@ async function runLicenseQrcodeFromCli(license, commandOptions, options) {
 }
 function registerTokenCommands(program, getCliOptions, runAndExit) {
     const token = program.command('token').description('Token 工具：签发 token，并输出可直接使用的 JSON 与本地二维码 PNG');
-    token.command('issue <peer_id>')
-        .description('默认从环境变量读取 access/secret，并以 peer_id 作为默认 local_id 来签发 token')
+    token.command('issue <remote_id>')
+        .description('默认从环境变量读取 access/secret，并基于 remote_id 签发 token')
         .option('--access-id <accessId>', '显式 access id；不传时读取 ' + kTokenIssueAccessIdEnvVar)
         .option('--secret-key <secretKey>', '显式 secret key；不传时读取 ' + kTokenIssueSecretKeyEnvVar)
-        .option('--local-id <localId>', '显式 local id；不传时默认使用 peer_id')
-        .option('--openapi-entry <url>', '可选 openapi entry；留空时走 runtime 默认值')
-        .option('--service-entry <entry>', '可选 service entry；用于组合连接 payload 与二维码 PNG')
-        .option('--user-ttl-seconds <seconds>', '可选 user token ttl（秒）')
-        .option('--channel-ttl-seconds <seconds>', '可选 channel token ttl（秒）')
+        .option('--openapi-endpoint <url>', '可选 openapi endpoint；传了就透传到底层签发')
+        .option('--endpoint <entry>', '可选 endpoint；传了就写入 payload 与二维码')
         .option('--qr-error-correction-level <level>', '二维码纠错级别：L/M/Q/H；默认 M')
         .option('--ascii-max-columns <columns>', 'ASCII 二维码最大宽度；不传时优先读取当前终端宽度或 COLUMNS')
-        .action((peerId, commandOptions) => {
-        runAndExit(runTokenIssueFromCli(peerId, commandOptions, getCliOptions()));
+        .action((remoteId, commandOptions) => {
+        runAndExit(runTokenIssueFromCli(remoteId, commandOptions, getCliOptions()));
     });
     const license = program.command('license').description('License 工具：生成 server 扫码 JSON 与本地二维码 PNG');
     license.command('qrcode <license>')
-        .description('生成包含 license 与可选 service_entry 的本地二维码')
-        .option('--service-entry <entry>', '可选 service entry；留空时消费端走默认值')
+        .description('生成包含 license 与可选 endpoint 的本地二维码')
+        .option('--endpoint <entry>', '可选 endpoint；传了就写入 payload 与二维码')
         .option('--qr-error-correction-level <level>', '二维码纠错级别：L/M/Q/H；默认 M')
         .option('--ascii-max-columns <columns>', 'ASCII 二维码最大宽度；不传时优先读取当前终端宽度或 COLUMNS')
         .action((licenseValue, commandOptions) => {

package/dist/cli/src/token_tool.d.ts

@@ -1,26 +1,17 @@
 export type TokenIssueInput = {
     accessId: string;
     secretKey: string;
-    localId: string;
-    peerId: string;
-    openapiEntry?: string;
-    serviceEntry?: string;
-    userTtlSeconds?: number;
-    channelTtlSeconds?: number;
+    remoteId: string;
+    openapiEndpoint?: string;
+    endpoint?: string;
     qrErrorCorrectionLevel?: 'L' | 'M' | 'Q' | 'H';
     asciiMaxColumns?: number;
 };
 export type IssuedTokenPayload = {
-    version: 1;
-    type: 'tirtc-connect-token';
-    peer_id: string;
-    local_id: string;
-    service_entry: string;
+    remote_id: string;
     token: string;
-    openapi_entry: string;
-    user_ttl_seconds: number;
-    channel_ttl_seconds: number;
-    generated_at: string;
+    endpoint?: string;
+    openapi_endpoint?: string;
 };
 export type TokenIssueOutput = {
     payload: IssuedTokenPayload;
@@ -32,13 +23,13 @@ export type TokenIssueOutput = {
 };
 export type LicenseQrcodeInput = {
     license: string;
-    serviceEntry?: string;
+    endpoint?: string;
     qrErrorCorrectionLevel?: 'L' | 'M' | 'Q' | 'H';
     asciiMaxColumns?: number;
 };
 export type LicenseQrcodePayload = {
     license: string;
-    service_entry: string;
+    endpoint?: string;
 };
 export type LicenseQrcodeOutput = {
     payload: LicenseQrcodePayload;

package/dist/cli/src/token_tool.js

@@ -51,9 +51,6 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const qrcode_1 = __importDefault(require("qrcode"));
 const embedded_paths_1 = require("./embedded_paths");
-const kDefaultOpenapiEntry = 'http://api-test-tirtc.tange365.com';
-const kDefaultUserTtlSeconds = 86400;
-const kDefaultChannelTtlSeconds = 300;
 const kAsciiQrQuietZoneModules = 2;
 function pathExists(filePath) {
     return fs_1.default.existsSync(filePath);
@@ -76,7 +73,7 @@ function buildQrCodePngPath(prefix, ...parts) {
     return path_1.default.join(resolveQrCodeOutputDir(), fileName);
 }
 function buildTokenQrCodePngPath(payload) {
-    return buildQrCodePngPath('token', payload.local_id, payload.peer_id);
+    return buildQrCodePngPath('token', payload.remote_id);
 }
 function buildLicenseQrCodePngPath(payload) {
     return buildQrCodePngPath('license', payload.license);
@@ -206,13 +203,10 @@ function buildIssueTokenHelperSource() {
         '});',
         'try {',
         '  const token = addon.issueToken({',
-        '    openapiEntry: input.openapiEntry,',
+        '    openapiEndpoint: input.openapiEndpoint,',
         '    accessId: input.accessId,',
         '    secretKey: input.secretKey,',
-        '    localId: input.localId,',
-        '    peerId: input.peerId,',
-        '    userTtlSeconds: input.userTtlSeconds,',
-        '    channelTtlSeconds: input.channelTtlSeconds,',
+        '    remoteId: input.remoteId,',
         '  });',
         '  process.stdout.write(String(token).trim());',
         '} finally {',
@@ -305,24 +299,29 @@ async function issueToken(input) {
     }
 }
 function buildIssuedTokenPayload(input, token) {
-    return {
-        version: 1,
-        type: 'tirtc-connect-token',
-        peer_id: input.peerId,
-        local_id: input.localId,
-        service_entry: input.serviceEntry ?? '',
+    const payload = {
+        remote_id: input.remoteId,
         token,
-        openapi_entry: input.openapiEntry?.trim() || kDefaultOpenapiEntry,
-        user_ttl_seconds: input.userTtlSeconds ?? kDefaultUserTtlSeconds,
-        channel_ttl_seconds: input.channelTtlSeconds ?? kDefaultChannelTtlSeconds,
-        generated_at: new Date().toISOString(),
     };
+    const normalizedEndpoint = input.endpoint?.trim();
+    if (normalizedEndpoint) {
+        payload.endpoint = normalizedEndpoint;
+    }
+    const normalizedOpenapiEndpoint = input.openapiEndpoint?.trim();
+    if (normalizedOpenapiEndpoint) {
+        payload.openapi_endpoint = normalizedOpenapiEndpoint;
+    }
+    return payload;
 }
 function buildLicenseQrcodePayload(input) {
-    return {
+    const payload = {
         license: input.license.trim(),
-        service_entry: input.serviceEntry?.trim() ?? '',
     };
+    const normalizedEndpoint = input.endpoint?.trim();
+    if (normalizedEndpoint) {
+        payload.endpoint = normalizedEndpoint;
+    }
+    return payload;
 }
 async function writePngQrcode(payloadJson, outputPath, errorCorrectionLevel) {
     const resolvedPath = path_1.default.resolve(outputPath);
@@ -382,13 +381,9 @@ async function buildLicenseQrcode(input) {
 function formatTokenIssueConsoleOutput(output) {
     const summaryLines = [
         'Issued Token Summary:',
-        '  local_id: ' + output.payload.local_id,
-        '  peer_id: ' + output.payload.peer_id,
-        '  service_entry: ' + (output.payload.service_entry || '(empty)'),
-        '  openapi_entry: ' + output.payload.openapi_entry,
-        '  user_ttl_seconds: ' + output.payload.user_ttl_seconds,
-        '  channel_ttl_seconds: ' + output.payload.channel_ttl_seconds,
-        '  generated_at: ' + output.payload.generated_at,
+        '  remote_id: ' + output.payload.remote_id,
+        '  endpoint: ' + (output.payload.endpoint ?? '(omitted)'),
+        '  openapi_endpoint: ' + (output.payload.openapi_endpoint ?? '(omitted)'),
         '',
         'Token:',
         output.token,
@@ -408,7 +403,7 @@ function formatLicenseQrcodeConsoleOutput(output) {
     const summaryLines = [
         'License QR Code Summary:',
         '  license: ' + output.payload.license,
-        '  service_entry: ' + (output.payload.service_entry || '(empty)'),
+        '  endpoint: ' + (output.payload.endpoint ?? '(omitted)'),
         '',
         'Payload JSON:',
         JSON.stringify(output.payload, null, 2),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tirtc-devtools-cli",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "private": false,
   "main": "dist/cli/src/index.js",
   "types": "dist/cli/src/index.d.ts",

package/vendor/app-server/bin/runtime/linux-x64/manifest.txt

@@ -1,4 +1,4 @@
 platform=linux-x64
 profile=credential
-staged_at_utc=2026-04-21T05:02:38Z
+staged_at_utc=2026-04-21T13:44:44Z
 source_sdk=/workspace/.build/sdk/linux-x64