tirtc-devtools-cli 0.0.10 → 0.0.12

package/dist/{devtools/cli → cli}/src/facade.d.ts

@@ -20,69 +20,24 @@ export declare const CliConfigSchema: z.ZodObject<{
         video_stream_id?: number | undefined;
         audio_stream_id?: number | undefined;
     }>>;
-    connection: z.ZodOptional<z.ZodObject<{
+    client: z.ZodOptional<z.ZodObject<{
         service_entry: z.ZodOptional<z.ZodString>;
         peer_id: z.ZodOptional<z.ZodString>;
-        token: z.ZodOptional<z.ZodString>;
-        auto_token: z.ZodOptional<z.ZodObject<{
-            openapi_entry: z.ZodOptional<z.ZodString>;
-            access_id: z.ZodOptional<z.ZodString>;
-            secret_key: z.ZodOptional<z.ZodString>;
-            local_id: z.ZodOptional<z.ZodString>;
-            user_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-            channel_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }>>;
+        audio_stream_id: z.ZodOptional<z.ZodNumber>;
+        video_stream_id: z.ZodOptional<z.ZodNumber>;
+        consumer: z.ZodOptional<z.ZodEnum<["web_preview"]>>;
     }, "strip", z.ZodTypeAny, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
+        consumer?: "web_preview" | undefined;
     }, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
-    }>>;
-    logging: z.ZodOptional<z.ZodObject<{
-        root_dir: z.ZodOptional<z.ZodString>;
-        console_mirror: z.ZodOptional<z.ZodBoolean>;
-        level: z.ZodOptional<z.ZodEnum<["verbose", "debug", "info", "warn", "error", "fatal"]>>;
-    }, "strip", z.ZodTypeAny, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
-    }, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
+        consumer?: "web_preview" | undefined;
     }>>;
     debug: z.ZodOptional<z.ZodObject<{
         connect_bootstrap: z.ZodOptional<z.ZodObject<{
@@ -137,69 +92,24 @@ export declare const CliConfigSchema: z.ZodObject<{
         video_stream_id?: number | undefined;
         audio_stream_id?: number | undefined;
     }>>;
-    connection: z.ZodOptional<z.ZodObject<{
+    client: z.ZodOptional<z.ZodObject<{
         service_entry: z.ZodOptional<z.ZodString>;
         peer_id: z.ZodOptional<z.ZodString>;
-        token: z.ZodOptional<z.ZodString>;
-        auto_token: z.ZodOptional<z.ZodObject<{
-            openapi_entry: z.ZodOptional<z.ZodString>;
-            access_id: z.ZodOptional<z.ZodString>;
-            secret_key: z.ZodOptional<z.ZodString>;
-            local_id: z.ZodOptional<z.ZodString>;
-            user_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-            channel_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }>>;
+        audio_stream_id: z.ZodOptional<z.ZodNumber>;
+        video_stream_id: z.ZodOptional<z.ZodNumber>;
+        consumer: z.ZodOptional<z.ZodEnum<["web_preview"]>>;
     }, "strip", z.ZodTypeAny, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
+        consumer?: "web_preview" | undefined;
     }, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
-    }>>;
-    logging: z.ZodOptional<z.ZodObject<{
-        root_dir: z.ZodOptional<z.ZodString>;
-        console_mirror: z.ZodOptional<z.ZodBoolean>;
-        level: z.ZodOptional<z.ZodEnum<["verbose", "debug", "info", "warn", "error", "fatal"]>>;
-    }, "strip", z.ZodTypeAny, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
-    }, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
+        consumer?: "web_preview" | undefined;
     }>>;
     debug: z.ZodOptional<z.ZodObject<{
         connect_bootstrap: z.ZodOptional<z.ZodObject<{
@@ -254,69 +164,24 @@ export declare const CliConfigSchema: z.ZodObject<{
         video_stream_id?: number | undefined;
         audio_stream_id?: number | undefined;
     }>>;
-    connection: z.ZodOptional<z.ZodObject<{
+    client: z.ZodOptional<z.ZodObject<{
         service_entry: z.ZodOptional<z.ZodString>;
         peer_id: z.ZodOptional<z.ZodString>;
-        token: z.ZodOptional<z.ZodString>;
-        auto_token: z.ZodOptional<z.ZodObject<{
-            openapi_entry: z.ZodOptional<z.ZodString>;
-            access_id: z.ZodOptional<z.ZodString>;
-            secret_key: z.ZodOptional<z.ZodString>;
-            local_id: z.ZodOptional<z.ZodString>;
-            user_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-            channel_ttl_seconds: z.ZodOptional<z.ZodNumber>;
-        }, "strip", z.ZodTypeAny, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }, {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        }>>;
+        audio_stream_id: z.ZodOptional<z.ZodNumber>;
+        video_stream_id: z.ZodOptional<z.ZodNumber>;
+        consumer: z.ZodOptional<z.ZodEnum<["web_preview"]>>;
     }, "strip", z.ZodTypeAny, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
+        consumer?: "web_preview" | undefined;
     }, {
         service_entry?: string | undefined;
+        video_stream_id?: number | undefined;
+        audio_stream_id?: number | undefined;
         peer_id?: string | undefined;
-        token?: string | undefined;
-        auto_token?: {
-            openapi_entry?: string | undefined;
-            access_id?: string | undefined;
-            secret_key?: string | undefined;
-            local_id?: string | undefined;
-            user_ttl_seconds?: number | undefined;
-            channel_ttl_seconds?: number | undefined;
-        } | undefined;
-    }>>;
-    logging: z.ZodOptional<z.ZodObject<{
-        root_dir: z.ZodOptional<z.ZodString>;
-        console_mirror: z.ZodOptional<z.ZodBoolean>;
-        level: z.ZodOptional<z.ZodEnum<["verbose", "debug", "info", "warn", "error", "fatal"]>>;
-    }, "strip", z.ZodTypeAny, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
-    }, {
-        root_dir?: string | undefined;
-        console_mirror?: boolean | undefined;
-        level?: "verbose" | "debug" | "info" | "warn" | "error" | "fatal" | undefined;
+        consumer?: "web_preview" | undefined;
     }>>;
     debug: z.ZodOptional<z.ZodObject<{
         connect_bootstrap: z.ZodOptional<z.ZodObject<{
@@ -379,82 +244,23 @@ export declare const ServiceStartParamsSchema: z.ZodObject<{
 export declare const ConnectionConnectParamsSchema: z.ZodEffects<z.ZodObject<{
     serviceEntry: z.ZodOptional<z.ZodString>;
     peerId: z.ZodString;
-    token: z.ZodOptional<z.ZodString>;
-    tokenMode: z.ZodOptional<z.ZodEnum<["manual", "auto"]>>;
-    autoToken: z.ZodOptional<z.ZodObject<{
-        openapiEntry: z.ZodOptional<z.ZodString>;
-        accessId: z.ZodString;
-        secretKey: z.ZodString;
-        localId: z.ZodOptional<z.ZodString>;
-        userTtlSeconds: z.ZodOptional<z.ZodNumber>;
-        channelTtlSeconds: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    }, {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    }>>;
+    token: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     peerId: string;
-    token?: string | undefined;
+    token: string;
     serviceEntry?: string | undefined;
-    tokenMode?: "manual" | "auto" | undefined;
-    autoToken?: {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    } | undefined;
 }, {
     peerId: string;
-    token?: string | undefined;
+    token: string;
     serviceEntry?: string | undefined;
-    tokenMode?: "manual" | "auto" | undefined;
-    autoToken?: {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    } | undefined;
 }>, {
     peerId: string;
-    token?: string | undefined;
+    token: string;
     serviceEntry?: string | undefined;
-    tokenMode?: "manual" | "auto" | undefined;
-    autoToken?: {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    } | undefined;
 }, {
     peerId: string;
-    token?: string | undefined;
+    token: string;
     serviceEntry?: string | undefined;
-    tokenMode?: "manual" | "auto" | undefined;
-    autoToken?: {
-        accessId: string;
-        secretKey: string;
-        openapiEntry?: string | undefined;
-        localId?: string | undefined;
-        userTtlSeconds?: number | undefined;
-        channelTtlSeconds?: number | undefined;
-    } | undefined;
 }>;
 export declare const StreamSendStartParamsSchema: z.ZodObject<{
     streamId: z.ZodString;
@@ -498,16 +304,16 @@ export declare const OutputAttachParamsSchema: z.ZodObject<{
     targetPath: z.ZodOptional<z.ZodString>;
     maxFiles: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    streamId: string;
     consumer: string;
+    streamId: string;
     mediaView: string;
     format: string;
     delivery: string;
     targetPath?: string | undefined;
     maxFiles?: number | undefined;
 }, {
-    streamId: string;
     consumer: string;
+    streamId: string;
     mediaView: string;
     format: string;
     delivery: string;
@@ -523,32 +329,32 @@ export declare const OutputAttachCliParamsSchema: z.ZodEffects<z.ZodObject<{
     targetPath: z.ZodOptional<z.ZodString>;
     maxFiles: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    streamId: number;
     consumer: "web_preview" | "file_sink";
+    streamId: number;
     mediaView: "encoded" | "encoded_packet";
     format: "h264" | "g711a" | "jpeg" | "pcm" | "mp4";
     delivery: "artifact_path" | "file";
     targetPath?: string | undefined;
     maxFiles?: number | undefined;
 }, {
-    streamId: number;
     consumer: "web_preview" | "file_sink";
+    streamId: number;
     mediaView: "encoded" | "encoded_packet";
     format: "h264" | "g711a" | "jpeg" | "pcm" | "mp4";
     delivery: "artifact_path" | "file";
     targetPath?: string | undefined;
     maxFiles?: number | undefined;
 }>, {
-    streamId: number;
     consumer: "web_preview" | "file_sink";
+    streamId: number;
     mediaView: "encoded" | "encoded_packet";
     format: "h264" | "g711a" | "jpeg" | "pcm" | "mp4";
     delivery: "artifact_path" | "file";
     targetPath?: string | undefined;
     maxFiles?: number | undefined;
 }, {
-    streamId: number;
     consumer: "web_preview" | "file_sink";
+    streamId: number;
     mediaView: "encoded" | "encoded_packet";
     format: "h264" | "g711a" | "jpeg" | "pcm" | "mp4";
     delivery: "artifact_path" | "file";

package/dist/{devtools/cli → cli}/src/facade.js

@@ -11,23 +11,12 @@ exports.CliConfigSchema = zod_1.z.object({
         video_stream_id: zod_1.z.number().int().nonnegative().optional(),
         audio_stream_id: zod_1.z.number().int().nonnegative().optional(),
     }).optional(),
-    connection: zod_1.z.object({
+    client: 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(),
-    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(),
+        audio_stream_id: zod_1.z.number().int().nonnegative().optional(),
+        video_stream_id: zod_1.z.number().int().nonnegative().optional(),
+        consumer: zod_1.z.enum(['web_preview']).optional(),
     }).optional(),
     debug: zod_1.z.object({
         connect_bootstrap: zod_1.z.object({
@@ -48,6 +37,7 @@ exports.CommandToHostMethodMapping = {
     'host stop': 'host/shutdown',
     'service start': 'service/start',
     'service stop': 'service/stop',
+    'client start': 'connection/connect',
     'connection show': 'connection/get',
     'connection connect': 'connection/connect',
     'connection disconnect': 'connection/disconnect',
@@ -89,18 +79,9 @@ exports.ServiceStartParamsSchema = zod_1.z.object({
 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',
+    token: zod_1.z.string().min(1),
+}).refine((value) => value.token.trim().length > 0, {
+    message: 'token is required',
 });
 exports.StreamSendStartParamsSchema = zod_1.z.object({
     streamId: zod_1.z.string(),

package/dist/cli/src/guide.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printQuickstartGuide = printQuickstartGuide;
+function printQuickstartGuide() {
+    const lines = [
+        'TiRTC CLI 新手快速入口（service start -> client start 本地预览）',
+        '',
+        '前置条件：',
+        '1) 已构建最新 CLI：',
+        '   npm --prefix products/app-server run build',
+        '   npm --prefix products/cli run build',
+        '2) 准备一份 TOML 配置：',
+        '   [server] service_entry = "" license = "<LICENSE>" mp4_path = "./.refers/simple.mp4" video_stream_id = 11 audio_stream_id = 10',
+        '   [client] service_entry = "" peer_id = "<PEER_ID>" audio_stream_id = 10 video_stream_id = 11 consumer = "web_preview"',
+        '',
+        '步骤 1：启动服务（自动创建 session）',
+        '  node products/cli/bin/tirtc-devtools-cli.js --config ./server.toml service start',
+        '  # 记下输出里的 sessionId，后续观测命令显式带 --session',
+        '',
+        '步骤 2：CLI 会自动 prepare MP4 并绑定音视频 stream，不再需要手工 prepare assets_dir',
+        '  # service start 成功后会自动 prepare 并按 AUTO_ON_CONNECTED 进入待发流语义',
+        '',
+        '步骤 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 "<REMOTE_ID>" --endpoint "<ENDPOINT>"',
+        '',
+        '步骤 4：启动 client 本地 web preview',
+        '  node products/cli/bin/tirtc-devtools-cli.js --config ./client.toml client start --token "<TOKEN>"',
+        '  # 返回结果里的 autoApplied.preview.url 就是浏览器预览入口',
+        '',
+        '步骤 5：打开返回的 preview.url，并让页面触发 /preview/start',
+        '  # Host 会在收到 preview/start 后激活对应 receive worker',
+        '',
+        '步骤 6：服务端观测',
+        '  node products/cli/bin/tirtc-devtools-cli.js --session <SESSION_ID> events tail',
+        '  node products/cli/bin/tirtc-devtools-cli.js --session <SESSION_ID> report show',
+        '',
+        '补充：',
+        '- client start 是正式入口；connection connect / stream receive start / output attach 保留为 expert path',
+        '- debug bootstrap qrcode 仅生成连接信息二维码，不签发 token',
+        '- 机器可读输出：在命令后追加 --json',
+        '- 查看全部命令：node products/cli/bin/tirtc-devtools-cli.js --help',
+        '- 查看单命令说明：node products/cli/bin/tirtc-devtools-cli.js <command> --help',
+    ];
+    console.log(lines.join('\n'));
+}