@socialseal/cli 0.1.6 → 0.1.7

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.1.7 - 2026-03-20
+- Add `socialseal data export-search-results` for CLI-first enriched ranked-search exports, including direct CSV download handling.
+- Add `search_results_enriched` as an alias on `socialseal data export-report` to map to the ranked-search export template.
+- Add `socialseal data export-options` to make available export workflows discoverable from the CLI.
+- Improve export ergonomics with local report-type validation and instructive failure guidance for processing, failed, and expired-download states.
+
 ## 0.1.6 - 2026-03-19
 - Fix runtime version reporting so `socialseal --version` reads from package metadata instead of a hardcoded source string.
 - Fix `tracking` create request translation so `--workspace-id` is sent on the REST query path the backend uses for workspace binding.

package/README.md

@@ -56,12 +56,19 @@ Optional config file:
   - `socialseal video extract --body @payload.json --out-dir ./video-assets`
 
 - Data exports (provisional):
+  - `socialseal data export-options`
   - `socialseal data export-tracking --group-id 123 --time-period 30d --workspace-id <uuid> --out out.csv`
+  - `socialseal data export-search-results --group-ids 123,124 --workspace-id <uuid> --out ranked.csv`
+  - `socialseal data export-report --report-type search_results_enriched --format csv --payload @payload.json --workspace-id <uuid> --out ranked.csv`
   - `socialseal data export-report --report-type keyword_universe --format csv --payload @payload.json --out out.csv`
 
 ## Notes
-- `export-report` and `export_tracking_data` are provisional until CLI export specs are finalized.
+- `export-report`, `export_tracking_data`, and `export-data`-backed exports are provisional until CLI export specs are finalized.
 - `tools list` ships a stable built-in registry of supported direct-call function targets. It is not live backend enumeration.
+- `data export-search-results` maps to `export-data` template `tracking_ranked_videos_raw` and returns enriched ranked-search rows (search fields + video metadata + latest metrics + analysis). It downloads the signed CSV artifact when available.
+- `data export-report --report-type search_results_enriched` is a compatibility alias to the same `export-data` template flow.
+- `data export-report` now validates report types locally and shows the allowed list immediately; run `socialseal data export-options` when choosing between export flows.
+- If an export returns metadata without a file URL (for example status `processing`), the CLI prints an explicit retry hint and returns the metadata JSON so automation can branch on status.
 - `--timeout <ms>` controls HTTP request timeouts. Agent runs default to a 5-minute WebSocket inactivity timeout unless you set `--idle-timeout <ms>` (or the matching env/config value).
 - `search-journey-run` supports CLI-managed async polling: `--async` starts backend async mode, polling is on by default, `--no-poll` returns the initial `runId`, and `--poll-interval <ms>` controls the status polling cadence.
 - `video queue-analysis` wraps the tracked-video extraction backend in queue-only mode so you can queue one or many tracked videos without downloading assets first.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socialseal/cli",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "private": false,
   "type": "module",
   "description": "SocialSeal CLI (non-interactive)",

package/src/index.js

@@ -27,6 +27,44 @@ const EXIT_CODES = {
   SERVER: 5,
 };
 const HTTP_METHODS = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']);
+const REPORT_TYPE_SEARCH_RESULTS_ENRICHED = 'search_results_enriched';
+const EXPORT_DATA_TEMPLATE_TRACKING_RANKED_VIDEOS_RAW = 'tracking_ranked_videos_raw';
+const SUPPORTED_EXPORT_REPORT_TYPES = [
+  'keyword_universe',
+  'cluster_insights',
+  'creator_signatures',
+  'post_publish',
+  'quick_audit',
+  REPORT_TYPE_SEARCH_RESULTS_ENRICHED,
+];
+const EXPORT_OPTIONS = [
+  {
+    id: 'tracking_csv',
+    command: 'socialseal data export-tracking --group-id <id> --time-period <window>',
+    summary: 'Legacy tracking CSV export for a group or tracking item.',
+    formats: ['csv'],
+    required: ['workspace id', '--group-id or --item-id', '--time-period'],
+    bestFor: 'Quick tracking-table exports and backwards-compatible pipelines.',
+  },
+  {
+    id: 'search_results_enriched',
+    command: 'socialseal data export-search-results --group-ids <id,id,...>',
+    summary: 'Enriched ranked search rows (search results + video + latest metrics + analysis).',
+    formats: ['csv'],
+    required: ['workspace id', '--group-ids'],
+    bestFor: 'SQL-like ranked-search datasets without using psql.',
+    alias: 'socialseal data export-report --report-type search_results_enriched --format csv --payload @payload.json',
+  },
+  {
+    id: 'report_templates',
+    command: 'socialseal data export-report --report-type <type> --format <format> --payload @payload.json',
+    summary: 'Report-template exports via export-report.',
+    formats: ['csv', 'json', 'markdown', 'html', 'excel_data'],
+    required: ['payload JSON'],
+    bestFor: 'Keyword universe, clusters, creators, post-publish timeline, and quick-audit exports.',
+    reportTypes: SUPPORTED_EXPORT_REPORT_TYPES,
+  },
+];
 const KNOWN_TOOLS = [
   { name: 'agent-tool-jobs', category: 'agent', description: 'Poll queued agent-backed tool jobs and fetch their results.' },
   { name: 'deep-exploration-runs', category: 'agent', description: 'Read or persist deep exploration render runs.' },
@@ -54,6 +92,16 @@ const KNOWN_TOOLS = [
     notes: 'Refreshes brand metrics for brands/workspaces. It does not refresh a tracking group by UUID.',
   },
   { name: 'export-report', category: 'export', description: 'Generate report exports (csv/json/markdown/html/excel_data).' },
+  {
+    name: 'export-data',
+    category: 'export',
+    description: 'Run raw workspace-scoped export templates with signed-URL artifacts.',
+    objectType: 'workspace_export',
+    transport: 'post_edge_function',
+    workspaceScoped: true,
+    knownLocalDevState: 'disabled_by_default',
+    notes: 'Includes template `tracking_ranked_videos_raw` for ranked search results with video + metrics + analysis enrichment.',
+  },
   {
     name: 'export_tracking_data',
     category: 'export',
@@ -691,6 +739,88 @@ function coercePositiveInteger(value, label) {
   });
 }
 
+function normalizePositiveIntegerList(value, label, { max } = {}) {
+  if (value === undefined || value === null || value === '') return [];
+  const entries = Array.isArray(value)
+    ? value
+    : String(value)
+      .split(',')
+      .map((entry) => entry.trim())
+      .filter(Boolean);
+  const parsed = entries.map((entry, index) => {
+    const normalized = coercePositiveInteger(entry, `${label}[${index}]`);
+    if (!normalized) {
+      throw new CliError(`Invalid ${label}[${index}] value.`, {
+        code: 'INVALID_ARGUMENT',
+        exitCode: EXIT_CODES.USAGE,
+      });
+    }
+    return normalized;
+  });
+  const deduped = Array.from(new Set(parsed));
+  if (max && deduped.length > max) {
+    throw new CliError(`Too many ${label} values: received ${deduped.length}, max is ${max}.`, {
+      code: 'INVALID_ARGUMENT',
+      exitCode: EXIT_CODES.USAGE,
+    });
+  }
+  return deduped;
+}
+
+function normalizeIsoDateTime(value, label) {
+  if (value === undefined || value === null || value === '') return undefined;
+  if (typeof value !== 'string') {
+    throw new CliError(`Invalid ${label}: expected an ISO datetime string.`, {
+      code: 'INVALID_ARGUMENT',
+      exitCode: EXIT_CODES.USAGE,
+    });
+  }
+  const trimmed = value.trim();
+  const epoch = Date.parse(trimmed);
+  if (Number.isNaN(epoch)) {
+    throw new CliError(`Invalid ${label}: expected an ISO datetime string.`, {
+      code: 'INVALID_ARGUMENT',
+      exitCode: EXIT_CODES.USAGE,
+      details: value,
+    });
+  }
+  return new Date(epoch).toISOString();
+}
+
+function buildSearchResultsEnrichedExportPayload(rawPayload, workspaceId) {
+  const payload = isJsonObject(rawPayload) ? rawPayload : {};
+  const groupIds = normalizePositiveIntegerList(
+    firstDefined(payload, ['groupIds', 'group_ids']),
+    'groupIds',
+    { max: 100 },
+  );
+  if (groupIds.length === 0) {
+    throw new CliError('search_results_enriched export requires at least one group id.', {
+      code: 'MISSING_ARGUMENT',
+      exitCode: EXIT_CODES.USAGE,
+      hint: 'Provide --group-ids for `data export-search-results`, or include groupIds in --payload for `data export-report`.',
+    });
+  }
+
+  const trackingItemIds = normalizePositiveIntegerList(
+    firstDefined(payload, ['trackingItemIds', 'tracking_item_ids']),
+    'trackingItemIds',
+    { max: 1000 },
+  );
+  const dateFrom = normalizeIsoDateTime(firstDefined(payload, ['dateFrom', 'date_from']), 'dateFrom');
+  const dateTo = normalizeIsoDateTime(firstDefined(payload, ['dateTo', 'date_to']), 'dateTo');
+  const filename = trimString(firstDefined(payload, ['filename'])) || undefined;
+
+  return stripUndefinedEntries({
+    workspaceId,
+    groupIds,
+    trackingItemIds: trackingItemIds.length > 0 ? trackingItemIds : undefined,
+    dateFrom,
+    dateTo,
+    filename,
+  });
+}
+
 function buildPathWithQuery(basePath, query) {
   const params = new URLSearchParams();
   for (const [key, rawValue] of Object.entries(query || {})) {
@@ -1695,7 +1825,9 @@ function mapStatusToExitCode(status) {
 }
 
 function isLocallyDisabledByDefaultFunction(functionName) {
-  return functionName === 'group-management' || functionName === 'export_tracking_data';
+  return functionName === 'group-management'
+    || functionName === 'export_tracking_data'
+    || functionName === 'export-data';
 }
 
 function buildStatusHint(status, context = {}) {
@@ -1812,6 +1944,18 @@ function requireApiKey(opts, config) {
   return apiKey;
 }
 
+function assertSupportedReportType(reportType) {
+  const normalized = trimString(reportType);
+  if (SUPPORTED_EXPORT_REPORT_TYPES.includes(normalized)) {
+    return normalized;
+  }
+  throw new CliError(`Unsupported report type: ${reportType}`, {
+    code: 'INVALID_ARGUMENT',
+    exitCode: EXIT_CODES.USAGE,
+    hint: `Use one of: ${SUPPORTED_EXPORT_REPORT_TYPES.join(', ')}. Run \`socialseal data export-options\` to choose the right export flow.`,
+  });
+}
+
 function resolveApiTarget({ apiBase, legacyUrl }) {
   const resolvedApiBase = apiBase || (!legacyUrl ? DEFAULT_API_BASE : null);
   if (!resolvedApiBase && !legacyUrl) {
@@ -2509,6 +2653,24 @@ async function handleDataExportTracking(opts) {
 }
 
 async function handleDataExportReport(opts) {
+  const reportType = assertSupportedReportType(opts.reportType);
+
+  if (reportType === REPORT_TYPE_SEARCH_RESULTS_ENRICHED) {
+    if (opts.format !== 'csv') {
+      throw new CliError('search_results_enriched supports only csv format.', {
+        code: 'INVALID_ARGUMENT',
+        exitCode: EXIT_CODES.USAGE,
+        hint: 'Use --format csv.',
+      });
+    }
+    const payload = ensureJsonObject(parseJsonInput(opts.payload, { label: 'payload' }), 'payload');
+    await handleDataExportSearchResults({
+      ...opts,
+      __rawPayload: payload,
+    });
+    return;
+  }
+
   const config = loadConfig();
   const apiKey = requireApiKey(opts, config);
   const apiBase = resolveApiBase(opts, config);
@@ -2525,7 +2687,7 @@ async function handleDataExportReport(opts) {
     path: useGateway ? '/cli/tools/export-report' : '/functions/v1/export-report',
     method: 'POST',
     body: {
-      reportType: opts.reportType,
+      reportType,
       format: opts.format,
       payload,
     },
@@ -2571,6 +2733,142 @@ async function handleDataExportReport(opts) {
   process.stdout.write(JSON.stringify(json, null, opts.pretty ? 2 : 0) + '\n');
 }
 
+async function handleDataExportSearchResults(opts) {
+  const config = loadConfig();
+  const apiKey = requireApiKey(opts, config);
+  const apiBase = resolveApiBase(opts, config);
+  const supabaseUrl = resolveLegacyUrl(resolveSupabaseUrl(opts, config), 'SOCIALSEAL_SUPABASE_URL');
+  const { resolvedApiBase, legacyUrl, useGateway } = resolveApiTarget({ apiBase, legacyUrl: supabaseUrl });
+  const timeoutMs = resolveTimeoutMs(opts, config);
+  const { workspaceId: resolvedWorkspaceId, source: workspaceSource } = resolveWorkspaceSelection(opts, config);
+
+  const rawPayload = opts.__rawPayload ?? stripUndefinedEntries({
+    groupIds: normalizePositiveIntegerList(opts.groupIds, 'groupIds', { max: 100 }),
+    trackingItemIds: normalizePositiveIntegerList(opts.trackingItemIds, 'trackingItemIds', { max: 1000 }),
+    dateFrom: opts.dateFrom,
+    dateTo: opts.dateTo,
+    filename: opts.filename,
+  });
+
+  const payloadWorkspaceId = resolvePayloadWorkspaceId(rawPayload, null);
+  const effectiveWorkspaceId = requireWorkspaceSelection(payloadWorkspaceId || resolvedWorkspaceId, {
+    label: 'Search results enriched export',
+    hint: 'Pass --workspace-id, set SOCIALSEAL_WORKSPACE_ID, or configure a default workspace before exporting.',
+  });
+  const effectiveWorkspaceSource = payloadWorkspaceId ? 'body' : workspaceSource;
+  emitWorkspaceSelectionNotice(opts, {
+    workspaceId: effectiveWorkspaceId,
+    source: effectiveWorkspaceSource,
+    label: 'search_results_enriched export',
+  });
+
+  const normalizedPayload = buildSearchResultsEnrichedExportPayload(rawPayload, effectiveWorkspaceId);
+  const requestedFilename = trimString(normalizedPayload.filename) || undefined;
+  delete normalizedPayload.filename;
+
+  const exportResponse = await callApi({
+    apiBase: useGateway ? resolvedApiBase : legacyUrl,
+    apiKey,
+    path: useGateway ? '/cli/tools/export-data' : '/functions/v1/export-data',
+    method: 'POST',
+    body: {
+      template: EXPORT_DATA_TEMPLATE_TRACKING_RANKED_VIDEOS_RAW,
+      format: 'csv',
+      payload: normalizedPayload,
+      filename: requestedFilename,
+    },
+    workspaceId: effectiveWorkspaceId,
+    timeoutMs,
+  });
+
+  if (!exportResponse.ok) {
+    throw await buildHttpError(exportResponse, {
+      label: 'Search results enriched export',
+      functionName: 'export-data',
+      method: 'POST',
+    });
+  }
+
+  const responseJson = await exportResponse.json();
+  const metadata = isJsonObject(responseJson) && isJsonObject(responseJson.metadata)
+    ? responseJson.metadata
+    : null;
+  const fileUrl = trimString(metadata?.file_url || '');
+  const status = trimString(metadata?.status || '').toLowerCase();
+
+  if (!fileUrl) {
+    if (status === 'processing') {
+      process.stderr.write('[socialseal] Export is still processing. Re-run the same command shortly; the backend dedupes and returns the finished artifact when ready.\n');
+    } else if (status === 'failed') {
+      process.stderr.write('[socialseal] Export status is failed. Inspect the JSON metadata for details, then retry with corrected filters.\n');
+    } else {
+      process.stderr.write('[socialseal] Export did not include a file URL yet. Inspect the JSON metadata and retry if needed.\n');
+    }
+    emitJsonOutput(responseJson, opts.pretty);
+    return;
+  }
+
+  const artifactResponse = await fetchWithTimeout(fileUrl, {
+    method: 'GET',
+    headers: { Accept: '*/*' },
+  }, timeoutMs);
+
+  if (!artifactResponse.ok) {
+    throw await buildHttpError(artifactResponse, {
+      label: 'Search results enriched artifact download',
+      method: 'GET',
+      hint: 'The signed file URL may be expired or inaccessible. Re-run the export command to mint a fresh URL.',
+    });
+  }
+
+  if (!artifactResponse.body) {
+    throw new CliError('Export artifact response contained no body.', {
+      code: 'EMPTY_RESPONSE',
+      exitCode: EXIT_CODES.SERVER,
+    });
+  }
+
+  const outPath = opts.stdout
+    ? null
+    : (opts.out || trimString(metadata?.filename || '') || 'tracking-ranked-videos.csv');
+  if (outPath) {
+    await pipeline(artifactResponse.body, fs.createWriteStream(outPath));
+    process.stderr.write(`[socialseal] Export written to ${outPath}\n`);
+  } else {
+    await pipeline(artifactResponse.body, process.stdout);
+  }
+}
+
+function handleDataExportOptions(opts) {
+  const payload = {
+    exports: EXPORT_OPTIONS,
+    supportedReportTypes: SUPPORTED_EXPORT_REPORT_TYPES,
+    note: 'Use this list to choose the right export surface before running data export commands.',
+  };
+
+  if (opts.json) {
+    emitJsonOutput(payload, opts.pretty);
+    return;
+  }
+
+  process.stdout.write('[socialseal] Available export options\n');
+  process.stdout.write('[socialseal] Choose a flow based on dataset shape, not endpoint name.\n\n');
+  for (const option of EXPORT_OPTIONS) {
+    process.stdout.write(`- ${option.id}: ${option.summary}\n`);
+    process.stdout.write(`  command: ${option.command}\n`);
+    process.stdout.write(`  formats: ${option.formats.join(', ')}\n`);
+    process.stdout.write(`  required: ${option.required.join(', ')}\n`);
+    process.stdout.write(`  best for: ${option.bestFor}\n`);
+    if (option.alias) {
+      process.stdout.write(`  alias: ${option.alias}\n`);
+    }
+    if (Array.isArray(option.reportTypes)) {
+      process.stdout.write(`  report types: ${option.reportTypes.join(', ')}\n`);
+    }
+    process.stdout.write('\n');
+  }
+}
+
 async function handleVideoExtract(opts) {
   const config = loadConfig();
   const apiKey = requireApiKey(opts, config);
@@ -2902,7 +3200,7 @@ if (typeof program.showHelpAfterError === 'function') {
 if (typeof program.showSuggestionAfterError === 'function') {
   program.showSuggestionAfterError(true);
 }
-program.addHelpText('after', `\nExamples:\n  socialseal workspace list\n  socialseal workspace use <workspace-id>\n  socialseal agent run --message \"ping\"\n  socialseal tools list\n  socialseal tools call --function <tool> --body @payload.json\n  socialseal tools call --function search-journey-run --body @payload.json --async --workspace-id <uuid>\n  socialseal video queue-analysis --video-id 734829384 --workspace-id <uuid>\n  socialseal video extract --video-id 734829384 --wait --out-dir ./video-assets\n  socialseal data export-tracking --group-id 123 --time-period 30d\n`);
+program.addHelpText('after', `\nExamples:\n  socialseal workspace list\n  socialseal workspace use <workspace-id>\n  socialseal agent run --message \"ping\"\n  socialseal tools list\n  socialseal tools call --function <tool> --body @payload.json\n  socialseal tools call --function search-journey-run --body @payload.json --async --workspace-id <uuid>\n  socialseal video queue-analysis --video-id 734829384 --workspace-id <uuid>\n  socialseal video extract --video-id 734829384 --wait --out-dir ./video-assets\n  socialseal data export-options\n  socialseal data export-tracking --group-id 123 --time-period 30d\n  socialseal data export-search-results --group-ids 123,124 --workspace-id <uuid> --out ranked.csv\n`);
 
 program
   .command('agent')
@@ -2994,6 +3292,14 @@ tools
 
 const data = program.command('data').description('Data exports (provisional)');
 
+data
+  .command('export-options')
+  .description('List export flows, when to use each, and required inputs')
+  .option('--json', 'Emit machine-readable output')
+  .option('--pretty', 'Pretty-print JSON')
+  .option('--verbose', 'Show error details')
+  .action((opts) => runCommand(handleDataExportOptions, opts));
+
 data
   .command('export-tracking')
   .description('Export tracking data as CSV')
@@ -3010,10 +3316,29 @@ data
   .option('--verbose', 'Show error details')
   .action((opts) => runCommand(handleDataExportTracking, opts));
 
+data
+  .command('export-search-results')
+  .description('Export enriched ranked search results (search_results + videos + latest metrics + analysis) as CSV')
+  .requiredOption('--group-ids <ids>', 'Comma-separated tracking group ids (for example: 123,124,125)')
+  .option('--tracking-item-ids <ids>', 'Optional comma-separated tracking item ids')
+  .option('--date-from <iso>', 'Optional ISO datetime lower bound (inclusive)')
+  .option('--date-to <iso>', 'Optional ISO datetime upper bound (inclusive)')
+  .option('--filename <name>', 'Optional export filename stem (without extension)')
+  .option('--out <path>', 'Output file path')
+  .option('--stdout', 'Write to stdout')
+  .option('--api-base <url>', 'API base URL (default https://api.socialseal.co)')
+  .option('--api-key <key>', 'CLI API key')
+  .option('--workspace-id <id>', 'Workspace id (for scoped keys)')
+  .option('--pretty', 'Pretty-print JSON metadata when no file is ready')
+  .option('--json', 'Emit machine-readable errors')
+  .option('--timeout <ms>', 'Request timeout in milliseconds')
+  .option('--verbose', 'Show error details')
+  .action((opts) => runCommand(handleDataExportSearchResults, opts));
+
 data
   .command('export-report')
   .description('Export report data via export-report (provisional)')
-  .requiredOption('--report-type <type>', 'keyword_universe|cluster_insights|creator_signatures|post_publish|quick_audit')
+  .requiredOption('--report-type <type>', 'keyword_universe|cluster_insights|creator_signatures|post_publish|quick_audit|search_results_enriched')
   .option('--format <format>', 'csv|json|markdown|html|excel_data', 'csv')
   .requiredOption('--payload <jsonOrFile>', 'Payload JSON or @file.json')
   .option('--out <path>', 'Output file path')