@optima-chat/browser-cli 0.7.0 → 0.9.0

package/dist/index.js

@@ -174,10 +174,9 @@ async function requestBinary(path) {
   return Buffer.from(arrayBuffer);
 }
 var BrowserAPI = class {
-  async createSession(url, profileId, force, connector, ziniaoProfileId, bitbrowserProfileId) {
+  async createSession(url, force, connector, ziniaoProfileId, bitbrowserProfileId) {
     const body = {};
     if (url) body.url = url;
-    if (profileId) body.profile_id = profileId;
     if (force) body.force = true;
     if (connector) body.connector = connector;
     if (ziniaoProfileId) body.ziniao_profile_id = ziniaoProfileId;
@@ -187,14 +186,6 @@ var BrowserAPI = class {
       body: JSON.stringify(body)
     });
   }
-  async listProfiles() {
-    return request("/api/profiles");
-  }
-  async deleteProfile(profileId) {
-    return request("/api/profiles/" + encodeURIComponent(profileId), {
-      method: "DELETE"
-    });
-  }
   async setZiNiaoConfig(company, username, password) {
     return request("/api/user/ziniao-config", {
       method: "PUT",
@@ -258,22 +249,29 @@ var BrowserAPI = class {
   async getScreenshot(sessionId) {
     return requestBinary(`/api/sessions/${sessionId}/screenshot`);
   }
-  async runRecipeScript(name, params, pollMs = 2e3) {
+  async runRecipeScript(name, params, pollMs = 2e3, timeoutMs = 36e4) {
     const started = await request(`/api/scripts/${name}/run`, {
       method: "POST",
       body: JSON.stringify({ params })
     });
+    const deadline = Date.now() + timeoutMs;
     for (; ; ) {
-      const task = await request(
-        `/api/script-tasks/${started.id}`
-      );
+      const task = await request(`/api/script-tasks/${started.id}`);
       if (task.status === "completed") return task.output;
       if (task.status === "failed" || task.status === "needs_fallback") {
-        throw new Error(task.error || `recipe ${task.status}`);
+        throw new Error(task.error || task.output?.error || `recipe ${task.status}`);
+      }
+      if (Date.now() >= deadline) {
+        throw new Error(
+          `recipe ${name} did not finish within ${Math.round(timeoutMs / 1e3)}s (task ${started.id})`
+        );
       }
       await new Promise((r) => setTimeout(r, pollMs));
     }
   }
+  async fetchArtifact(artifactPath) {
+    return requestBinary(artifactPath);
+  }
   async search(sessionId, pattern) {
     return request(`/api/sessions/${sessionId}/search`, {
       method: "POST",
@@ -328,10 +326,10 @@ var BrowserAPI = class {
   async deleteScript(name) {
     await request(`/api/scripts/${encodeURIComponent(name)}`, { method: "DELETE" });
   }
-  async runScript(scriptName, params = {}, profileId, connector, bitbrowserProfileId) {
+  async runScript(scriptName, params = {}, connector, ziniaoProfileId, bitbrowserProfileId) {
     const payload = { params };
-    if (profileId) payload.profile_id = profileId;
     if (connector) payload.connector = connector;
+    if (ziniaoProfileId) payload.ziniao_profile_id = ziniaoProfileId;
     if (bitbrowserProfileId) payload.bitbrowser_profile_id = bitbrowserProfileId;
     return request(`/api/scripts/${encodeURIComponent(scriptName)}/run`, {
       method: "POST",
@@ -446,26 +444,12 @@ function formatError(err) {
 function formatTabsInline(tabs) {
   return tabs.map((t) => `[${t.tab_id}] ${t.title}`).join(", ");
 }
-function formatProfiles(result) {
-  if (result.profiles.length === 0) {
-    return "No browser profiles found.";
-  }
-  const lines = result.profiles.map((p) => {
-    const sizeMb = (p.size_bytes / (1024 * 1024)).toFixed(1);
-    return `  ${p.profile_id} (${sizeMb} MB)`;
-  });
-  return `Browser profiles:
-${lines.join("\n")}`;
-}
-function formatProfileDelete(profileId) {
-  return `Profile '${profileId}' deleted.`;
-}
 
 // src/commands/lifecycle.ts
 function registerLifecycleCommands(program2) {
-  program2.command("launch").description("Launch a browser session").option("--url <url>", "Navigate to URL after launch").option("--profile <id>", "Use a named browser profile").option("--force", "Close existing session before launching").option("--connector <type>", "Browser connector: chrome, ziniao, or bitbrowser").option("--ziniao-profile <id>", "ZiNiao browser profile ID").option("--bitbrowser-profile <id>", "BitBrowser profile ID").action(async (opts) => {
+  program2.command("launch").description("Launch a browser session").option("--url <url>", "Navigate to URL after launch").option("--force", "Close existing session before launching").option("--connector <type>", "Browser connector: chrome, ziniao, or bitbrowser").option("--ziniao-profile <id>", "ZiNiao browser profile ID").option("--bitbrowser-profile <id>", "BitBrowser profile ID").action(async (opts) => {
     try {
-      const state = await api.createSession(opts.url, opts.profile, opts.force, opts.connector, opts.ziniaoProfile, opts.bitbrowserProfile);
+      const state = await api.createSession(opts.url, opts.force, opts.connector, opts.ziniaoProfile, opts.bitbrowserProfile);
       saveSessionId(state.session_id);
       console.log(formatLaunch(state));
     } catch (err) {
@@ -682,15 +666,38 @@ function registerTabCommands(program2) {
 }
 
 // src/commands/script.ts
-import { readFileSync as readFileSync3 } from "fs";
+import { mkdirSync as mkdirSync2, readFileSync as readFileSync3, writeFileSync as writeFileSync3 } from "fs";
+import { basename, dirname, resolve } from "path";
 var POLL_INTERVAL_MS = 2e3;
 var POLL_TIMEOUT_MS = 18e4;
+var REQUIRED_ARG_FLAG = {
+  ziniao_profile_id: "--ziniao-profile <id>",
+  bitbrowser_profile_id: "--bitbrowser-profile <id>"
+};
+function formatRequiredArgs(s) {
+  if (!s.required_args?.length) return null;
+  const flags = s.required_args.map((a) => REQUIRED_ARG_FLAG[a] ?? `--param ${a}=<value>`).join(" ");
+  return `  requires: ${flags}`;
+}
+async function deliverArtifact(task, out) {
+  const output = task.output;
+  if (!output) return null;
+  if (output.path) return output.path;
+  if (!output.artifact_path) return null;
+  const target = resolve(out ?? `./${basename(output.filename ?? "artifact")}`);
+  const content = await api.fetchArtifact(output.artifact_path);
+  mkdirSync2(dirname(target), { recursive: true });
+  writeFileSync3(target, content);
+  return target;
+}
 function formatScriptList(scripts) {
   if (scripts.length === 0) return "No scripts registered.";
   const lines = [];
   for (const s of scripts) {
     const tag = s.source ? ` [${s.source}]` : "";
     lines.push(`${s.name} \u2014 ${s.description}${tag}`);
+    const requires = formatRequiredArgs(s);
+    if (requires) lines.push(requires);
     for (let i = 0; i < s.steps.length; i++) {
       lines.push(`  [${i + 1}] ${s.steps[i].id} \u2014 ${s.steps[i].description}`);
     }
@@ -781,7 +788,7 @@ function registerScriptCommands(program2) {
       process.exit(1);
     }
   });
-  program2.command("runscript").argument("<name>", "Script name").description("Run a script (polls until complete)").option("--param <params...>", "Parameters as key=value").option("--profile <id>", "Use a named browser profile").option("--connector <type>", "Browser connector: chrome, ziniao, or bitbrowser").option("--bitbrowser-profile <id>", "BitBrowser profile ID (with --connector bitbrowser)").option("--no-poll", "Return immediately without polling").action(async (name, opts) => {
+  program2.command("runscript").argument("<name>", "Script name").description("Run a script (polls until complete)").option("--param <params...>", "Parameters as key=value").option("--connector <type>", "Browser connector: chrome, ziniao, or bitbrowser").option("--ziniao-profile <id>", "ZiNiao browser profile ID (with --connector ziniao)").option("--bitbrowser-profile <id>", "BitBrowser profile ID (with --connector bitbrowser)").option("--out <path>", "Where to write the script's exported file (default: ./<filename>)").option("--no-poll", "Return immediately without polling").action(async (name, opts) => {
     try {
       const params = {};
       if (opts.param) {
@@ -790,8 +797,9 @@ function registerScriptCommands(program2) {
           params[k] = rest.join("=");
         }
       }
+      if (opts.out) params.out_path = resolve(opts.out);
       clearSessionId();
-      const task = await api.runScript(name, params, opts.profile, opts.connector, opts.bitbrowserProfile);
+      const task = await api.runScript(name, params, opts.connector, opts.ziniaoProfile, opts.bitbrowserProfile);
       console.log(`Script started (task: ${task.id})`);
       if (!opts.poll) {
         console.log(`Poll with: browser-cli script-task ${task.id}`);
@@ -812,6 +820,18 @@ function registerScriptCommands(program2) {
         saveSessionId(result.session_id);
       }
       console.log(formatScriptTask(result));
+      if (result.status === "completed") {
+        try {
+          const saved = await deliverArtifact(result, opts.out);
+          if (saved) console.log(`Saved -> ${saved}`);
+        } catch (err) {
+          const staged = result.output?.artifact_path;
+          console.error(`${formatError(err)}
+Script completed; only saving the file failed.`);
+          if (staged) console.error(`The artifact is still at ${staged}.`);
+          process.exit(1);
+        }
+      }
     } catch (err) {
       console.error(formatError(err));
       process.exit(1);
@@ -828,29 +848,7 @@ function registerScriptCommands(program2) {
   });
 }
 function sleep(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-
-// src/commands/profile.ts
-function registerProfileCommands(program2) {
-  program2.command("profiles").description("List browser profiles").action(async () => {
-    try {
-      const result = await api.listProfiles();
-      console.log(formatProfiles(result));
-    } catch (err) {
-      console.error(formatError(err));
-      process.exit(1);
-    }
-  });
-  program2.command("delete-profile").description("Delete a named browser profile").argument("<profile-id>", "Profile ID to delete").action(async (profileId) => {
-    try {
-      const result = await api.deleteProfile(profileId);
-      console.log(formatProfileDelete(result.profile_id));
-    } catch (err) {
-      console.error(formatError(err));
-      process.exit(1);
-    }
-  });
+  return new Promise((resolve3) => setTimeout(resolve3, ms));
 }
 
 // src/ziniao-doctor.ts
@@ -999,7 +997,8 @@ function registerZiNiaoCommands(program2) {
       console.log(`ZiNiao profiles (${result.profiles.length}):
 `);
       for (const p of result.profiles) {
-        console.log(`  ${p.id}  ${p.name}`);
+        const site = p.platform_name ? `  [${p.platform_name}]` : "";
+        console.log(`  ${p.id}  ${p.name}${site}`);
       }
       console.log("\nUse: browser-cli launch --connector ziniao --ziniao-profile <id> --url <url>");
     } catch (err) {
@@ -1026,15 +1025,33 @@ function registerZiNiaoCommands(program2) {
 }
 
 // src/commands/recipes.ts
-import { writeFileSync as writeFileSync3 } from "fs";
+import { writeFileSync as writeFileSync4 } from "fs";
+import { resolve as resolve2 } from "path";
+async function runExport(script, params, out, timeoutMs) {
+  const outPath = resolve2(out);
+  const result = await api.runRecipeScript(script, { ...params, out_path: outPath }, 2e3, timeoutMs);
+  if (!result.path) {
+    writeFileSync4(outPath, await api.fetchArtifact(result.artifact_path));
+  }
+  console.log(`Saved ${result.filename} -> ${outPath} (${result.size} bytes)`);
+}
 function registerRecipeCommands(program2) {
-  program2.command("export-ad-report").description("Export TikTok Shop last-7-days video ad data into the session workspace").requiredOption("--ziniao-profile <id>", "ZiNiao browser profile ID").option("--out <path>", "Output CSV path", "./tt_video_ad_7d.csv").action(async (opts) => {
+  program2.command("export-ad-report").description("Export TikTok Shop last-7-days video ad data into the session workspace").requiredOption("--ziniao-profile <id>", "ZiNiao browser profile ID").option("--report-url <url>", "Ad dashboard URL (default: TikTok Shop MY local site)").option("--out <path>", "Output CSV path", "./tt_video_ad_7d.csv").action(async (opts) => {
     try {
-      const out = await api.runRecipeScript("tiktok_video_ad_export", {
-        ziniao_profile_id: opts.ziniaoProfile
-      });
-      writeFileSync3(opts.out, Buffer.from(out.content_b64, "base64"));
-      console.log(`Saved ${out.filename} -> ${opts.out} (${out.size} bytes)`);
+      const params = { ziniao_profile_id: opts.ziniaoProfile };
+      if (opts.reportUrl) params.report_url = opts.reportUrl;
+      await runExport("tiktok_video_ad_export", params, opts.out, 36e4);
+    } catch (err) {
+      console.error(formatError(err));
+      process.exit(1);
+    }
+  });
+  program2.command("export-order-report").description("Export TikTok Shop order data into the session workspace").requiredOption("--ziniao-profile <id>", "ZiNiao browser profile ID").option("--report-url <url>", "Order list URL (default: TikTok Shop MY local site)").option("--days <n>", "Export the last N days (default: 7, max 365)").option("--out <path>", "Output CSV path", "./tt_orders.csv").action(async (opts) => {
+    try {
+      const params = { ziniao_profile_id: opts.ziniaoProfile };
+      if (opts.reportUrl) params.report_url = opts.reportUrl;
+      if (opts.days) params.days = opts.days;
+      await runExport("tiktok_order_export", params, opts.out, 54e4);
     } catch (err) {
       console.error(formatError(err));
       process.exit(1);
@@ -1086,7 +1103,6 @@ registerInteractionCommands(program);
 registerInfoCommands(program);
 registerTabCommands(program);
 registerScriptCommands(program);
-registerProfileCommands(program);
 registerZiNiaoCommands(program);
 registerRecipeCommands(program);
 registerBitBrowserCommands(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optima-chat/browser-cli",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "type": "module",
   "main": "./dist/index.js",
   "bin": {