tirtc-devtools-cli 0.0.1

package/dist/devtools/cli/src/facade.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArtifactExportReportParamsSchema = exports.ArtifactExportLogsParamsSchema = exports.CommandSendJsonParamsSchema = exports.CommandSendParamsSchema = exports.OutputAttachOptionsSchema = exports.OutputAttachCliParamsSchema = exports.OutputAttachParamsSchema = exports.StreamRequestPolicySetParamsSchema = exports.StreamReceiveStartParamsSchema = exports.StreamSendStartParamsSchema = exports.ConnectionConnectParamsSchema = exports.ServiceStartParamsSchema = exports.ErrorReasonCodeMapping = exports.CommandToHostMethodMapping = exports.CliJsonOutputSchema = exports.CliConfigSchema = void 0;
+const zod_1 = require("zod");
+exports.CliConfigSchema = zod_1.z.object({
+    version: zod_1.z.number().int().optional(),
+    service: zod_1.z.object({
+        service_entry: zod_1.z.string().optional(),
+        license: zod_1.z.string().optional(),
+    }).optional(),
+    connection: zod_1.z.object({
+        service_entry: zod_1.z.string().optional(),
+        peer_id: zod_1.z.string().optional(),
+        token: zod_1.z.string().optional(),
+        auto_token: zod_1.z.object({
+            openapi_entry: zod_1.z.string().optional(),
+            access_id: zod_1.z.string().optional(),
+            secret_key: zod_1.z.string().optional(),
+            local_id: zod_1.z.string().optional(),
+            user_ttl_seconds: zod_1.z.number().int().positive().optional(),
+            channel_ttl_seconds: zod_1.z.number().int().positive().optional(),
+        }).optional(),
+    }).optional(),
+    stream: zod_1.z.object({
+        request_policy: zod_1.z.object({
+            mode: zod_1.z.enum(['manual', 'auto-if-bound']).optional(),
+        }).optional(),
+    }).optional(),
+    streams: zod_1.z.object({
+        send: zod_1.z.object({
+            assets_dir: zod_1.z.string().min(1),
+            audio_stream_id: zod_1.z.number().int().nonnegative(),
+            video_stream_id: zod_1.z.number().int().nonnegative(),
+        }).optional(),
+    }).optional(),
+    logging: zod_1.z.object({
+        root_dir: zod_1.z.string().optional(),
+        console_mirror: zod_1.z.boolean().optional(),
+        level: zod_1.z.enum(['verbose', 'debug', 'info', 'warn', 'error', 'fatal']).optional(),
+    }).optional(),
+    debug: zod_1.z.object({
+        connect_bootstrap: zod_1.z.object({
+            access_id: zod_1.z.string().optional(),
+            secret_key: zod_1.z.string().optional(),
+            peer_id: zod_1.z.string().optional(),
+            service_entry: zod_1.z.string().optional(),
+        }).optional(),
+    }).optional(),
+}).passthrough();
+exports.CliJsonOutputSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    message: zod_1.z.string(),
+    data: zod_1.z.any().optional(),
+});
+exports.CommandToHostMethodMapping = {
+    'host status': 'host/status',
+    'host stop': 'host/shutdown',
+    'service start': 'service/start',
+    'service stop': 'service/stop',
+    'connection show': 'connection/get',
+    'connection connect': 'connection/connect',
+    'connection disconnect': 'connection/disconnect',
+    'stream list': 'stream/list',
+    'stream send start': 'stream/sendStart',
+    'stream send stop': 'stream/sendStop',
+    'stream receive start': 'stream/receiveStart',
+    'stream receive stop': 'stream/receiveStop',
+    'stream request-policy get': 'stream/requestPolicy/get',
+    'stream request-policy set': 'stream/requestPolicy/set',
+    'output attach': 'output/attach',
+    'output detach': 'output/detach',
+    'command send': 'command/send',
+    'command tail': 'events/subscribe',
+    'events tail': 'events/subscribe',
+    'logs export': 'artifact/exportLogs',
+    'report show': 'artifact/readReport',
+    'report export': 'artifact/exportReport',
+    'debug bootstrap qrcode': 'debug/token/qrcode',
+};
+exports.ErrorReasonCodeMapping = {
+    protocol_version_mismatch: 2,
+    not_initialized: 3,
+    invalid_request: 4,
+    internal_error: 5,
+    timeout: 6,
+    connection_failed: 7,
+    stream_not_found: 8,
+    protocol_malformed_frame: 9,
+    method_not_found: 10,
+    invalid_initialize_result: 11,
+};
+exports.ServiceStartParamsSchema = zod_1.z.object({
+    serviceEntry: zod_1.z.string().optional(),
+    license: zod_1.z.string().optional(),
+});
+exports.ConnectionConnectParamsSchema = zod_1.z.object({
+    serviceEntry: zod_1.z.string().optional(),
+    peerId: zod_1.z.string(),
+    token: zod_1.z.string().optional(),
+    tokenMode: zod_1.z.enum(['manual', 'auto']).optional(),
+    autoToken: zod_1.z.object({
+        openapiEntry: zod_1.z.string().optional(),
+        accessId: zod_1.z.string(),
+        secretKey: zod_1.z.string(),
+        localId: zod_1.z.string().optional(),
+        userTtlSeconds: zod_1.z.number().int().positive().optional(),
+        channelTtlSeconds: zod_1.z.number().int().positive().optional(),
+    }).optional(),
+}).refine((value) => Boolean(value.token) || Boolean(value.autoToken), {
+    message: 'token or autoToken is required',
+});
+exports.StreamSendStartParamsSchema = zod_1.z.object({
+    streamId: zod_1.z.string(),
+    media: zod_1.z.enum(['audio', 'video']),
+    assetsDir: zod_1.z.string(),
+});
+exports.StreamReceiveStartParamsSchema = zod_1.z.object({
+    streamId: zod_1.z.string(),
+    media: zod_1.z.enum(['audio', 'video']),
+});
+exports.StreamRequestPolicySetParamsSchema = zod_1.z.object({
+    mode: zod_1.z.enum(['manual', 'auto-if-bound']),
+});
+exports.OutputAttachParamsSchema = zod_1.z.object({
+    streamId: zod_1.z.string(),
+    consumer: zod_1.z.string(),
+    mediaView: zod_1.z.string(),
+    format: zod_1.z.string(),
+    delivery: zod_1.z.string(),
+    targetPath: zod_1.z.string().optional(),
+    maxFiles: zod_1.z.number().int().optional(),
+});
+exports.OutputAttachCliParamsSchema = zod_1.z.object({
+    streamId: zod_1.z.number().int().nonnegative(),
+    consumer: zod_1.z.enum(['web_preview', 'file_sink']),
+    mediaView: zod_1.z.enum(['encoded', 'encoded_packet']),
+    format: zod_1.z.enum(['h264', 'g711a', 'jpeg', 'pcm', 'mp4']),
+    delivery: zod_1.z.enum(['artifact_path', 'file']),
+    targetPath: zod_1.z.string().optional(),
+    maxFiles: zod_1.z.number().int().positive().optional(),
+}).superRefine((params, ctx) => {
+    if (params.consumer === 'web_preview') {
+        if (params.delivery !== 'artifact_path') {
+            ctx.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'web_preview requires delivery=artifact_path',
+            });
+        }
+        if (params.format !== 'h264' && params.format !== 'g711a' && params.format !== 'jpeg' && params.format !== 'pcm') {
+            ctx.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'web_preview requires format=h264|g711a|jpeg|pcm',
+            });
+        }
+    }
+    if (params.consumer === 'file_sink') {
+        if (params.delivery !== 'file') {
+            ctx.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'file_sink requires delivery=file',
+            });
+        }
+        if (params.format !== 'mp4') {
+            ctx.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'file_sink requires format=mp4',
+            });
+        }
+    }
+});
+exports.OutputAttachOptionsSchema = zod_1.z.object({
+    streamType: zod_1.z.enum(['audio', 'video']).optional(),
+    stdout: zod_1.z.boolean().optional(),
+    filePath: zod_1.z.string().optional(),
+}).refine((data) => !(data.stdout && data.filePath), {
+    message: 'Cannot specify both stdout and filePath',
+});
+exports.CommandSendParamsSchema = zod_1.z.object({
+    commandId: zod_1.z.string(),
+    kind: zod_1.z.string(),
+    payloadEncoding: zod_1.z.string(),
+    payload: zod_1.z.string(),
+});
+exports.CommandSendJsonParamsSchema = zod_1.z.object({
+    commandId: zod_1.z.number().int().nonnegative(),
+    kind: zod_1.z.string().min(1),
+    payloadJson: zod_1.z.string().min(1),
+});
+exports.ArtifactExportLogsParamsSchema = zod_1.z.object({
+    outputPath: zod_1.z.string(),
+});
+exports.ArtifactExportReportParamsSchema = zod_1.z.object({
+    outputPath: zod_1.z.string(),
+});

package/dist/devtools/cli/src/ffmpeg_tool.d.ts

@@ -0,0 +1,6 @@
+type FfmpegBinaryPair = {
+    ffmpeg: string;
+    ffprobe: string;
+};
+export declare function ensureFfmpegTools(): FfmpegBinaryPair;
+export {};

package/dist/devtools/cli/src/ffmpeg_tool.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureFfmpegTools = ensureFfmpegTools;
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+function resolvePlatform() {
+    const explicit = process.env.TIRTC_RUNTIME_PLATFORM;
+    if (explicit && explicit.trim().length > 0) {
+        return explicit.trim();
+    }
+    if (process.platform === 'darwin' && process.arch === 'arm64') {
+        return 'macos-arm64';
+    }
+    return 'linux-x64';
+}
+function resolveFfmpegCacheRoot() {
+    const explicit = process.env.TIRTC_FFMPEG_CACHE_DIR;
+    if (explicit && explicit.trim().length > 0) {
+        return path_1.default.resolve(explicit.trim());
+    }
+    return path_1.default.join(os_1.default.homedir(), '.tirtc-devtool', 'tools', 'ffmpeg');
+}
+function resolveCachedToolDir(platform) {
+    return path_1.default.join(resolveFfmpegCacheRoot(), platform);
+}
+function isExecutable(filePath) {
+    try {
+        fs_1.default.accessSync(filePath, fs_1.default.constants.X_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function resolveSystemTool(command) {
+    try {
+        const output = (0, child_process_1.execFileSync)('bash', ['-lc', `command -v ${command}`], { encoding: 'utf8' }).trim();
+        return output.length > 0 ? output : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function resolveDownloadSpec(platform) {
+    if (platform === 'macos-arm64') {
+        return {
+            url: 'https://evermeet.cx/ffmpeg/getrelease/zip',
+            archiveName: 'ffmpeg.zip',
+            format: 'zip',
+        };
+    }
+    return {
+        url: 'https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz',
+        archiveName: 'ffmpeg-release-amd64-static.tar.xz',
+        format: 'tar.xz',
+    };
+}
+function ensureDirectory(dirPath) {
+    fs_1.default.mkdirSync(dirPath, { recursive: true });
+}
+function assertToolReady(toolPath, probeArgs) {
+    (0, child_process_1.execFileSync)(toolPath, probeArgs, { stdio: 'ignore' });
+}
+function ensureCommandAvailable(command) {
+    const resolved = resolveSystemTool(command);
+    if (!resolved) {
+        throw new Error(`missing required command: ${command}`);
+    }
+}
+function downloadFile(url, targetPath) {
+    (0, child_process_1.execFileSync)('curl', ['-fL', url, '-o', targetPath], { stdio: 'inherit' });
+}
+function prepareMacosArm64(toolDir) {
+    const ffmpegZip = path_1.default.join(toolDir, 'ffmpeg.zip');
+    const ffprobeZip = path_1.default.join(toolDir, 'ffprobe.zip');
+    const ffmpegBin = path_1.default.join(toolDir, 'ffmpeg');
+    const ffprobeBin = path_1.default.join(toolDir, 'ffprobe');
+    downloadFile('https://evermeet.cx/ffmpeg/getrelease/zip', ffmpegZip);
+    downloadFile('https://evermeet.cx/ffmpeg/getrelease/ffprobe/zip', ffprobeZip);
+    (0, child_process_1.execFileSync)('unzip', ['-o', ffmpegZip, '-d', toolDir], { stdio: 'ignore' });
+    (0, child_process_1.execFileSync)('unzip', ['-o', ffprobeZip, '-d', toolDir], { stdio: 'ignore' });
+    fs_1.default.rmSync(ffmpegZip, { force: true });
+    fs_1.default.rmSync(ffprobeZip, { force: true });
+    fs_1.default.chmodSync(ffmpegBin, 0o755);
+    fs_1.default.chmodSync(ffprobeBin, 0o755);
+}
+function prepareLinuxX64(toolDir, archivePath) {
+    const extractDir = path_1.default.join(toolDir, '.extract');
+    const ffmpegBin = path_1.default.join(toolDir, 'ffmpeg');
+    const ffprobeBin = path_1.default.join(toolDir, 'ffprobe');
+    fs_1.default.rmSync(extractDir, { recursive: true, force: true });
+    ensureDirectory(extractDir);
+    (0, child_process_1.execFileSync)('tar', ['-xf', archivePath, '-C', extractDir], { stdio: 'ignore' });
+    const children = fs_1.default.readdirSync(extractDir).map((entry) => path_1.default.join(extractDir, entry));
+    const sourceDir = children.find((entry) => fs_1.default.statSync(entry).isDirectory());
+    if (!sourceDir) {
+        throw new Error('failed to resolve extracted ffmpeg directory');
+    }
+    fs_1.default.copyFileSync(path_1.default.join(sourceDir, 'ffmpeg'), ffmpegBin);
+    fs_1.default.copyFileSync(path_1.default.join(sourceDir, 'ffprobe'), ffprobeBin);
+    fs_1.default.chmodSync(ffmpegBin, 0o755);
+    fs_1.default.chmodSync(ffprobeBin, 0o755);
+    fs_1.default.rmSync(extractDir, { recursive: true, force: true });
+}
+function prepareCachedTools(platform) {
+    const toolDir = resolveCachedToolDir(platform);
+    const ffmpegBin = path_1.default.join(toolDir, 'ffmpeg');
+    const ffprobeBin = path_1.default.join(toolDir, 'ffprobe');
+    if (isExecutable(ffmpegBin) && isExecutable(ffprobeBin)) {
+        return { ffmpeg: ffmpegBin, ffprobe: ffprobeBin };
+    }
+    ensureDirectory(toolDir);
+    ensureCommandAvailable('curl');
+    const spec = resolveDownloadSpec(platform);
+    const archivePath = path_1.default.join(toolDir, spec.archiveName);
+    downloadFile(spec.url, archivePath);
+    try {
+        if (platform === 'macos-arm64') {
+            ensureCommandAvailable('unzip');
+            prepareMacosArm64(toolDir);
+        }
+        else {
+            ensureCommandAvailable('tar');
+            prepareLinuxX64(toolDir, archivePath);
+        }
+        assertToolReady(ffmpegBin, ['-version']);
+        assertToolReady(ffprobeBin, ['-version']);
+        return { ffmpeg: ffmpegBin, ffprobe: ffprobeBin };
+    }
+    finally {
+        fs_1.default.rmSync(archivePath, { force: true });
+    }
+}
+function ensureFfmpegTools() {
+    const systemFfmpeg = resolveSystemTool('ffmpeg');
+    const systemFfprobe = resolveSystemTool('ffprobe');
+    if (systemFfmpeg && systemFfprobe) {
+        return { ffmpeg: systemFfmpeg, ffprobe: systemFfprobe };
+    }
+    return prepareCachedTools(resolvePlatform());
+}

package/dist/devtools/cli/src/guide.d.ts

@@ -0,0 +1 @@
+export declare function printQuickstartGuide(): void;

package/dist/devtools/cli/src/guide.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printQuickstartGuide = printQuickstartGuide;
+function printQuickstartGuide() {
+    const lines = [
+        'TiRTC CLI 新手快速入口（服务端 -> 安卓扫码）',
+        '',
+        '前置条件：',
+        '1) 已构建最新 CLI：',
+        '   npm --prefix app-server run build',
+        '   npm --prefix devtools/cli run build',
+        '2) 服务端已准备可发送媒体文件（示例：.refers/simple.mp4）',
+        '',
+        '步骤 1：启动服务（自动创建 session）',
+        '  node devtools/cli/bin/tirtc-devtool.js service start "" "<LICENSE>"',
+        '  # 记下输出里的 sessionId，后续命令都显式带 --session',
+        '',
+        '步骤 2：先 prepare local assets，再配置 assets_dir + 显式音视频 stream id 并启动自动按需发流',
+        '  node devtools/cli/bin/tirtc-devtool.js media assets prepare --source .refers/simple.mp4 --output-root ./.tmp/tirtc-devtool/assets',
+        '  [stream.request_policy] mode = "auto-if-bound"',
+        '  [streams.send] assets_dir = "./.tmp/tirtc-devtool/assets/<prepared-assets-id>"  audio_stream_id = 10  video_stream_id = 11',
+        '  # service start 成功后会自动应用上述 request_policy + send 绑定',
+        '',
+        '步骤 3：生成连接 bootstrap 二维码（给安卓扫码）',
+        '  node devtools/cli/bin/tirtc-devtool.js --session <SESSION_ID> debug bootstrap qrcode \\',
+        '    "<ACCESS_ID>" "<SECRET_KEY>" "<PEER_ID>" "<SERVICE_ENTRY>"',
+        '',
+        '步骤 4：安卓扫码后流程（客户端侧）',
+        '  - 解析二维码 JSON（type=tirtc-connect-bootstrap）',
+        '  - 用 access_id + secret_key 在客户端/外部系统签发 token',
+        '  - 持 token + peer_id 连接服务端；连接成功后请求 audio_stream_id/video_stream_id',
+        '',
+        '额外：如果你只想本地直接签发并拿到可扫码 payload，可执行：',
+        '  node devtools/cli/bin/tirtc-devtool.js token issue "<ACCESS_ID>" "<SECRET_KEY>" "<LOCAL_ID>" "<PEER_ID>" \\',
+        '    --service-entry "<SERVICE_ENTRY>"',
+        '  # CLI 会直接打印摘要、payload JSON、token，并生成本地二维码 PNG 路径',
+        '',
+        '步骤 5：服务端观测',
+        '  node devtools/cli/bin/tirtc-devtool.js --session <SESSION_ID> events tail',
+        '  node devtools/cli/bin/tirtc-devtool.js --session <SESSION_ID> report show',
+        '',
+        '补充：',
+        '- debug bootstrap qrcode 仅生成连接信息二维码，不签发 token',
+        '- 机器可读输出：在命令后追加 --json',
+        '- 查看全部命令：node devtools/cli/bin/tirtc-devtool.js --help',
+        '- 查看单命令说明：node devtools/cli/bin/tirtc-devtool.js <command> --help',
+    ];
+    console.log(lines.join('\n'));
+}

package/dist/devtools/cli/src/index.d.ts

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