@koda-sl/baker-cli 0.515.0-dev.957976bb7 → 0.516.0

package/dist/job-SM2OQ2LO.js

@@ -0,0 +1,202 @@
+import {
+  parseXApiError
+} from "./chunk-FIN4ZXGJ.js";
+import {
+  resolveXAccountId
+} from "./chunk-IDSDJHRS.js";
+import {
+  cacheGet,
+  cacheSet,
+  writeAdsJson
+} from "./chunk-6DPSWLGY.js";
+import {
+  ApiError,
+  apiGet,
+  apiPost
+} from "./chunk-X7VQFLHI.js";
+import "./chunk-LU4HI4KI.js";
+import "./chunk-LGK7UWBN.js";
+import {
+  registerSchema
+} from "./chunk-Q7US4OOA.js";
+import "./chunk-YQSBHWOI.js";
+
+// src/commands/ads/x/stats/job.ts
+import { gunzipSync } from "zlib";
+import { defineCommand } from "citty";
+var POLL_INTERVAL_MS = 1e4;
+var DEADLINE_MS = 12 * 60 * 1e3;
+var RESULT_CACHE_TTL_MS = 6 * 60 * 60 * 1e3;
+registerSchema({
+  command: "ads.x.statsJob",
+  description: "Asynchronous X Ads stats job, fully synchronous from the CLI's perspective. Creates the job, polls every 10s, downloads + decompresses the gzip result, returns inline JSON. Hard deadline 12 min \u2014 must run in the background. Use this for ranges >7 days, segmented stats, or any query that hits sync limits. For fine-grained control, use `stats job-create` + `stats job-status` separately.",
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    entity: { type: "string", description: "CAMPAIGN | LINE_ITEM | PROMOTED_TWEET | ...", required: true },
+    "entity-ids": { type: "string", description: "CSV of entity IDs (max 20)", required: true },
+    "start-time": { type: "string", description: "ISO 8601 hour-aligned start", required: true },
+    "end-time": { type: "string", description: "ISO 8601 hour-aligned end", required: true },
+    granularity: { type: "string", description: "TOTAL | DAY | HOUR", required: false },
+    "metric-groups": { type: "string", description: "CSV of metric groups", required: true },
+    placement: { type: "string", description: "ALL_ON_TWITTER | PUBLISHER_NETWORK", required: false },
+    "segmentation-type": { type: "string", description: "Segmentation (e.g. AGE, GENDER, LOCATIONS)", required: false },
+    country: { type: "string", description: "Country filter", required: false },
+    platform: { type: "string", description: "Platform filter", required: false },
+    "no-cache": { type: "boolean", description: "Skip result cache (still does the live job)", required: false }
+  }
+});
+function parseCsv(v) {
+  if (typeof v !== "string" || v.length === 0) return void 0;
+  const parts = v.split(",").map((s) => s.trim()).filter(Boolean);
+  return parts.length > 0 ? parts : void 0;
+}
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function downloadAndDecompress(url) {
+  const res = await fetch(url, { signal: AbortSignal.timeout(6e4) });
+  if (!res.ok) {
+    throw new ApiError("INTERNAL_ERROR", `Stats job download failed (${res.status})`);
+  }
+  const buf = Buffer.from(await res.arrayBuffer());
+  const decompressed = gunzipSync(buf);
+  return JSON.parse(decompressed.toString("utf-8"));
+}
+async function pollUntilDone(accountId, jobId) {
+  const deadline = Date.now() + DEADLINE_MS;
+  let lastLog = 0;
+  while (Date.now() < deadline) {
+    await sleep(POLL_INTERVAL_MS);
+    const jobs = await apiGet("/api/ads/x/stats/jobs", {
+      "account-id": accountId,
+      "job-id": jobId
+    });
+    const job = jobs[0];
+    if (!job) {
+      throw new ApiError("NOT_FOUND", `Stats job ${jobId} not found`);
+    }
+    if (job.status === "SUCCESS") {
+      return job;
+    }
+    if (job.status === "FAILED" || job.status === "CANCELLED") {
+      throw new ApiError("INTERNAL_ERROR", `Stats job ${jobId} ended in status ${job.status}`);
+    }
+    const elapsed = DEADLINE_MS - (deadline - Date.now());
+    if (elapsed - lastLog > 3e4) {
+      process.stderr.write(`  polling... (${job.status}, ${Math.round(elapsed / 1e3)}s elapsed)
+`);
+      lastLog = elapsed;
+    }
+  }
+  throw new ApiError("TIMEOUT", `Stats job ${jobId} did not complete within ${DEADLINE_MS / 6e4} minutes`);
+}
+function buildCacheKey(body) {
+  return `stats-job:${JSON.stringify(body)}`;
+}
+var statsJobCommand = defineCommand({
+  meta: {
+    name: "job",
+    description: `Async X Ads stats job, sync from the CLI's perspective. Creates \u2192 polls \u2192 downloads \u2192 returns.
+
+Must run in the background (the harness enforces this).
+
+Use this when:
+  \u2022 Date range > 7 days
+  \u2022 Need segmentation (AGE, GENDER, LOCATIONS, ...)
+  \u2022 Sync stats hit a limit
+
+Examples:
+  baker ads x stats job --account-id 18ce53xyz --entity CAMPAIGN \\
+    --entity-ids abc,def --start-time 2026-04-01T00:00:00Z \\
+    --end-time 2026-05-01T00:00:00Z --metric-groups ENGAGEMENT,BILLING
+
+  baker ads x stats job --account-id 18ce53xyz --entity LINE_ITEM \\
+    --entity-ids abc --start-time 2026-04-01T00:00:00Z \\
+    --end-time 2026-05-01T00:00:00Z --metric-groups ENGAGEMENT \\
+    --segmentation-type LOCATIONS
+
+For fine-grained control (don't wait, poll yourself), use:
+  baker ads x stats job-create   \u2014 create + return job ID immediately
+  baker ads x stats job-status   \u2014 poll job status / get download URL`
+  },
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    entity: { type: "string", description: "Entity type", required: true },
+    "entity-ids": { type: "string", description: "CSV of entity IDs", required: true },
+    "start-time": { type: "string", description: "ISO start", required: true },
+    "end-time": { type: "string", description: "ISO end", required: true },
+    granularity: { type: "string", description: "Granularity", required: false },
+    "metric-groups": { type: "string", description: "Metric groups CSV", required: true },
+    placement: { type: "string", description: "Placement", required: false },
+    "segmentation-type": { type: "string", description: "Segmentation type", required: false },
+    country: { type: "string", description: "Country filter", required: false },
+    platform: { type: "string", description: "Platform filter", required: false },
+    "no-cache": { type: "boolean", description: "Skip result cache", required: false }
+  },
+  run: async ({ args }) => {
+    const accountId = await resolveXAccountId(args);
+    const entityIds = parseCsv(args["entity-ids"]);
+    const metricGroups = parseCsv(args["metric-groups"]);
+    if (!entityIds || !metricGroups) {
+      writeAdsJson({
+        ok: false,
+        error: { code: "MISSING_PARAMETER", message: "entity-ids and metric-groups are required" }
+      });
+      process.exit(1);
+    }
+    const body = {
+      accountId,
+      entity: args.entity,
+      entityIds,
+      startTime: args["start-time"],
+      endTime: args["end-time"],
+      granularity: args.granularity ?? "DAY",
+      metricGroups,
+      placement: args.placement ?? "ALL_ON_TWITTER",
+      segmentationType: args["segmentation-type"],
+      country: args.country,
+      platform: args.platform
+    };
+    const useCache = !args["no-cache"];
+    const cacheKey = buildCacheKey(body);
+    if (useCache) {
+      const cached = cacheGet("x-stats", cacheKey);
+      if (cached) {
+        process.stderr.write("Result served from cache.\n");
+        writeAdsJson({ ok: true, data: cached.data, cached: true });
+        return;
+      }
+    }
+    try {
+      process.stderr.write(`Creating X Ads stats job for entity=${body.entity}, ${entityIds.length} IDs...
+`);
+      const job = await apiPost("/api/ads/x/stats/jobs", body);
+      process.stderr.write(`Job ${job.id} queued. Polling every ${POLL_INTERVAL_MS / 1e3}s...
+`);
+      const finished = await pollUntilDone(accountId, job.id);
+      if (!finished.url) {
+        throw new ApiError("INTERNAL_ERROR", `Stats job ${job.id} succeeded but returned no download URL`);
+      }
+      process.stderr.write("Job complete. Downloading + decompressing results...\n");
+      const data = await downloadAndDecompress(finished.url);
+      if (useCache) {
+        cacheSet("x-stats", cacheKey, data, RESULT_CACHE_TTL_MS);
+      }
+      writeAdsJson({ ok: true, data });
+    } catch (err) {
+      if (err instanceof ApiError) {
+        writeAdsJson(parseXApiError(err.message, accountId));
+        process.exit(1);
+      }
+      writeAdsJson({
+        ok: false,
+        error: { code: "NETWORK_ERROR", message: err instanceof Error ? err.message : "Unexpected error" }
+      });
+      process.exit(1);
+    }
+  }
+});
+export {
+  statsJobCommand
+};
+//# sourceMappingURL=job-SM2OQ2LO.js.map

package/dist/job-create-ECZHPVKH.js

@@ -0,0 +1,109 @@
+import {
+  parseXApiError
+} from "./chunk-FIN4ZXGJ.js";
+import {
+  resolveXAccountId
+} from "./chunk-IDSDJHRS.js";
+import {
+  writeAdsJson
+} from "./chunk-6DPSWLGY.js";
+import {
+  ApiError,
+  apiPost
+} from "./chunk-X7VQFLHI.js";
+import "./chunk-LU4HI4KI.js";
+import "./chunk-LGK7UWBN.js";
+import {
+  registerSchema
+} from "./chunk-Q7US4OOA.js";
+import "./chunk-YQSBHWOI.js";
+
+// src/commands/ads/x/stats/job-create.ts
+import { defineCommand } from "citty";
+registerSchema({
+  command: "ads.x.statsJobCreate",
+  description: "Create an asynchronous X Ads stats job (range up to 90 days non-segmented, 45 days segmented). Returns a job id; poll with `stats job-status`. Times must be ISO 8601 hour-aligned.",
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    entity: { type: "string", description: "CAMPAIGN | LINE_ITEM | PROMOTED_TWEET | ...", required: true },
+    "entity-ids": { type: "string", description: "CSV of entity IDs (max 20)", required: true },
+    "start-time": { type: "string", description: "ISO 8601 hour-aligned start", required: true },
+    "end-time": { type: "string", description: "ISO 8601 hour-aligned end", required: true },
+    granularity: { type: "string", description: "TOTAL | DAY | HOUR", required: false },
+    "metric-groups": { type: "string", description: "CSV of metric groups", required: true },
+    placement: { type: "string", description: "ALL_ON_TWITTER | PUBLISHER_NETWORK", required: false },
+    "segmentation-type": { type: "string", description: "Segmentation (e.g. AGE, GENDER, LOCATIONS)", required: false },
+    country: { type: "string", description: "Country filter", required: false },
+    platform: { type: "string", description: "Platform filter", required: false }
+  }
+});
+function parseCsv(v) {
+  if (typeof v !== "string" || v.length === 0) return void 0;
+  const parts = v.split(",").map((s) => s.trim()).filter(Boolean);
+  return parts.length > 0 ? parts : void 0;
+}
+var statsJobCreateCommand = defineCommand({
+  meta: {
+    name: "job-create",
+    description: `Create an async X Ads stats job (up to 90 days, supports segmentation).
+
+Examples:
+  baker ads x stats job-create --account-id 18ce53xyz --entity CAMPAIGN \\
+    --entity-ids abc,def --start-time 2026-04-01T00:00:00Z \\
+    --end-time 2026-05-01T00:00:00Z --metric-groups ENGAGEMENT,BILLING \\
+    --segmentation-type LOCATIONS`
+  },
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    entity: { type: "string", description: "Entity type", required: true },
+    "entity-ids": { type: "string", description: "CSV of entity IDs", required: true },
+    "start-time": { type: "string", description: "ISO start", required: true },
+    "end-time": { type: "string", description: "ISO end", required: true },
+    granularity: { type: "string", description: "Granularity", required: false },
+    "metric-groups": { type: "string", description: "Metric groups CSV", required: true },
+    placement: { type: "string", description: "Placement", required: false },
+    "segmentation-type": { type: "string", description: "Segmentation type", required: false },
+    country: { type: "string", description: "Country filter", required: false },
+    platform: { type: "string", description: "Platform filter", required: false }
+  },
+  run: async ({ args }) => {
+    const accountId = await resolveXAccountId(args);
+    const entityIds = parseCsv(args["entity-ids"]);
+    const metricGroups = parseCsv(args["metric-groups"]);
+    if (!entityIds || !metricGroups) {
+      writeAdsJson({
+        ok: false,
+        error: { code: "MISSING_PARAMETER", message: "entity-ids and metric-groups are required" }
+      });
+      process.exit(1);
+    }
+    const body = {
+      accountId,
+      entity: args.entity,
+      entityIds,
+      startTime: args["start-time"],
+      endTime: args["end-time"],
+      granularity: args.granularity ?? "DAY",
+      metricGroups,
+      placement: args.placement ?? "ALL_ON_TWITTER",
+      segmentationType: args["segmentation-type"],
+      country: args.country,
+      platform: args.platform
+    };
+    try {
+      const data = await apiPost("/api/ads/x/stats/jobs", body);
+      writeAdsJson({ ok: true, data });
+    } catch (err) {
+      if (err instanceof ApiError) {
+        writeAdsJson(parseXApiError(err.message, accountId));
+        process.exit(1);
+      }
+      writeAdsJson({ ok: false, error: { code: "NETWORK_ERROR", message: "Unexpected error" } });
+      process.exit(1);
+    }
+  }
+});
+export {
+  statsJobCreateCommand
+};
+//# sourceMappingURL=job-create-ECZHPVKH.js.map

package/dist/job-status-QSYDKIIV.js

@@ -0,0 +1,74 @@
+import {
+  parseXApiError
+} from "./chunk-FIN4ZXGJ.js";
+import {
+  resolveXAccountId
+} from "./chunk-IDSDJHRS.js";
+import {
+  writeAdsJson
+} from "./chunk-6DPSWLGY.js";
+import {
+  ApiError,
+  apiGet
+} from "./chunk-X7VQFLHI.js";
+import "./chunk-LU4HI4KI.js";
+import "./chunk-LGK7UWBN.js";
+import {
+  registerSchema
+} from "./chunk-Q7US4OOA.js";
+import "./chunk-YQSBHWOI.js";
+
+// src/commands/ads/x/stats/job-status.ts
+import { defineCommand } from "citty";
+registerSchema({
+  command: "ads.x.statsJobStatus",
+  description: "Check the status of one or more X Ads stats jobs. Returns status (PROCESSING|SUCCESS|FAILED) and a downloadable url when SUCCESS. Pass --job-id or --job-ids (CSV).",
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    "job-id": { type: "string", description: "Single job ID", required: false },
+    "job-ids": { type: "string", description: "CSV of job IDs", required: false }
+  }
+});
+var statsJobStatusCommand = defineCommand({
+  meta: {
+    name: "job-status",
+    description: `Poll the status of an async X Ads stats job.
+
+Examples:
+  baker ads x stats job-status --account-id 18ce53xyz --job-id abc
+  baker ads x stats job-status --account-id 18ce53xyz --job-ids abc,def`
+  },
+  args: {
+    "account-id": { type: "string", description: "X Ads account ID", required: false },
+    "job-id": { type: "string", description: "Job ID", required: false },
+    "job-ids": { type: "string", description: "CSV of job IDs", required: false }
+  },
+  run: async ({ args }) => {
+    const accountId = await resolveXAccountId(args);
+    if (!args["job-id"] && !args["job-ids"]) {
+      writeAdsJson({
+        ok: false,
+        error: { code: "MISSING_PARAMETER", message: "Pass --job-id or --job-ids" }
+      });
+      process.exit(1);
+    }
+    try {
+      const params = { "account-id": accountId };
+      if (args["job-id"]) params["job-id"] = args["job-id"];
+      if (args["job-ids"]) params["job-ids"] = args["job-ids"];
+      const data = await apiGet("/api/ads/x/stats/jobs", params);
+      writeAdsJson({ ok: true, data });
+    } catch (err) {
+      if (err instanceof ApiError) {
+        writeAdsJson(parseXApiError(err.message, accountId));
+        process.exit(1);
+      }
+      writeAdsJson({ ok: false, error: { code: "NETWORK_ERROR", message: "Unexpected error" } });
+      process.exit(1);
+    }
+  }
+});
+export {
+  statsJobStatusCommand
+};
+//# sourceMappingURL=job-status-QSYDKIIV.js.map

package/dist/keyword-gap-PUSF7EKY.js

@@ -0,0 +1,130 @@
+import {
+  RESEARCH_DATA_NOTE,
+  handleResearchError,
+  writeResearchHints,
+  writeResearchJson,
+  writeResearchOutput
+} from "./chunk-GSKZ3ZDO.js";
+import {
+  buildResearchQueryContext,
+  warnDefaults
+} from "./chunk-SG2TDQEE.js";
+import "./chunk-44ZRCSR7.js";
+import "./chunk-46YLDIQG.js";
+import {
+  apiPost
+} from "./chunk-X7VQFLHI.js";
+import "./chunk-LU4HI4KI.js";
+import "./chunk-LGK7UWBN.js";
+import {
+  registerSchema
+} from "./chunk-Q7US4OOA.js";
+import "./chunk-YQSBHWOI.js";
+
+// src/commands/research/keyword-gap.ts
+import { defineCommand } from "citty";
+registerSchema({
+  command: "research.keyword-gap",
+  description: "Find keywords a competitor ranks for (organic or paid) that you don't. Discovers expansion opportunities. If --location and --language are omitted, defaults to United States (us) and English (en). The response includes a query_context object showing which location/language were used.",
+  args: {
+    competitor: { type: "string", description: "Competitor domain (positional 1)", required: true },
+    ours: { type: "string", description: "Your domain (positional 2)", required: true },
+    location: {
+      type: "string",
+      description: "Country code (us, uk, es, de...) or DataForSEO location code. Defaults to us (United States); set it for any non-US market.",
+      required: false
+    },
+    language: {
+      type: "string",
+      description: "Language code or name. Defaults to en (English) if omitted \u2014 always set this for non-English markets",
+      required: false
+    },
+    type: { type: "string", description: "Filter: paid, organic, all (default: all)", required: false },
+    limit: { type: "string", description: "Max results per page (default: 50, max: 1000)", required: false },
+    offset: { type: "string", description: "Pagination offset (default: 0)", required: false },
+    "no-cache": { type: "boolean", description: "Skip server cache, hit API directly", required: false }
+  }
+});
+var FIELDS = {
+  keyword: "Keyword in the gap (they rank, you don't)",
+  search_volume: "Monthly search volume",
+  cpc: "Cost per click USD",
+  their_position: "Competitor's ranking position"
+};
+var keywordGapCommand = defineCommand({
+  meta: {
+    name: "keyword-gap",
+    description: `Find keywords a competitor has that you don't. Supports pagination via --offset.
+
+Examples:
+  baker research keyword-gap "competitor.com" "mysite.com"
+  baker research keyword-gap "competitor.com" "mysite.com" --type paid --limit 100
+  baker research keyword-gap "competitor.com" "mysite.com" --offset 50 --limit 50`
+  },
+  args: {
+    competitor: { type: "positional", description: "Competitor domain", required: true },
+    ours: { type: "positional", description: "Your domain", required: true },
+    location: { type: "string", description: "Country code or location code (default: us)", required: false },
+    language: { type: "string", description: "Language code or name (default: en)", required: false },
+    type: { type: "string", description: "Filter: paid, organic, all (default: all)", required: false },
+    limit: { type: "string", description: "Max results per page (default: 50, max: 1000)", required: false },
+    offset: { type: "string", description: "Pagination offset (default: 0)", required: false },
+    output: { type: "string", description: "Format: json|csv|md|jsonl", required: false, default: "json" },
+    "no-cache": { type: "boolean", description: "Skip server cache, hit API directly", required: false }
+  },
+  run: async ({ args }) => {
+    const competitor = args.competitor;
+    const ours = args.ours;
+    const location = args.location || void 0;
+    const language = args.language || void 0;
+    const type = args.type || void 0;
+    const limit = args.limit ? Number(args.limit) : void 0;
+    const offset = args.offset ? Number(args.offset) : void 0;
+    const skipCache = args["no-cache"] ? true : void 0;
+    const queryContext = buildResearchQueryContext(location, language);
+    try {
+      const result = await apiPost("/api/research/keyword-gap", {
+        competitor,
+        ours,
+        location,
+        language,
+        type,
+        limit,
+        offset,
+        skipCache
+      });
+      const currentOffset = offset ?? 0;
+      const currentLimit = limit ?? 50;
+      const hasMore = currentOffset + result.data.length < result.total_count;
+      warnDefaults(queryContext);
+      const format = args.output || "json";
+      if (format !== "json") {
+        writeResearchOutput(result.data, format);
+        writeResearchHints([RESEARCH_DATA_NOTE], format);
+        return;
+      }
+      writeResearchJson({
+        ok: true,
+        your_domain: ours,
+        competitor_domain: competitor,
+        data: result.data,
+        fields: FIELDS,
+        note: RESEARCH_DATA_NOTE,
+        total_count: result.total_count,
+        query_context: queryContext,
+        pagination: {
+          offset: currentOffset,
+          limit: currentLimit,
+          has_more: hasMore,
+          next_offset: hasMore ? currentOffset + currentLimit : void 0
+        }
+      });
+    } catch (err) {
+      handleResearchError(err);
+    }
+  }
+});
+export {
+  keywordGapCommand
+};
+//# sourceMappingURL=keyword-gap-PUSF7EKY.js.map