Regenerate from the customer API contract

Generated from contracts/customer-api.json in the private source repository.
Do not edit these files by hand; they are overwritten on the next contract change.

Author: searchcode bot

.github/workflows/publish.yml

@@ -1,4 +1,9 @@
 # GENERATED. Publishes @searchcode/cli when a version tag is pushed.
+#
+# A tag only reaches this repository from the private source repository, and it only pushes one
+# after the live smoke test has passed against the production API. That smoke test is the gate
+# that proves these clients match the API they describe; the tests below are the offline,
+# structural half. See scripts/smoke-public-clients.mjs in the source repository.
 name: publish
 
 on:

src/index.js

@@ -79,11 +79,21 @@ function commandHelp(command) {
 
 /** Render a response as readable text; --json prints the raw payload instead. */
 function render(payload) {
-  const rows = payload.results ?? payload.rows ?? payload.domains ?? payload.items;
+  // The API names its row array after the thing it returns: "sites" for a technology query,
+  // "domains" for the domain index, "results" for a search, and so on. scripts/smoke-public-
+  // clients.mjs asserts against the live API that every key a command can return is listed here,
+  // because an unlisted key silently degrades this command to raw JSON.
+  const rows = payload.sites ?? payload.domains ?? payload.results ?? payload.rows
+    ?? payload.products ?? payload.shops ?? payload.hits ?? payload.items;
   if (!Array.isArray(rows)) return JSON.stringify(payload, null, 2);
   if (rows.length === 0) return 'No results.';
   const out = [];
-  if (typeof payload.total === 'number') out.push(`${payload.total} total`, '');
+  // Likewise the count: "total_sites" for a technology query, "total" for the domain index.
+  const total = payload.total_sites ?? payload.total ?? payload.sites;
+  if (typeof total === 'number') {
+    const approx = payload.total_is_exact === false ? 'about ' : '';
+    out.push(`${approx}${total.toLocaleString('en-US')} total`, '');
+  }
   for (const row of rows) {
     if (typeof row === 'string') { out.push(row); continue; }
     const primary = row.domain ?? row.name ?? row.host ?? row.title ?? '';

test/commands.test.js

@@ -3,6 +3,7 @@
 
 import { test } from 'node:test';
 import assert from 'node:assert/strict';
+import { readFile } from 'node:fs/promises';
 import { CUSTOMER_API_ROUTES } from '@searchcode/core';
 import { COMMANDS } from '../src/commands.js';
 
@@ -56,3 +57,32 @@ test('every parameter carries a description', () => {
     }
   }
 });
+
+// The renderer picks the row array by name, and the API names it after what it returns:
+// "sites" from a technology query, "domains" from the domain index, "results" from a search.
+// These payloads are the real gateway shapes. If the renderer stops recognising one, output
+// silently degrades to raw JSON — which is exactly the regression these pin down. The live
+// smoke test (scripts/smoke-public-clients.mjs) checks the same thing against production.
+const GATEWAY_SHAPES = [
+  ['technology query', { technology: 'React', total_sites: 1234567, sites: [{ domain: 'a.com', rank: 1 }], offset: 0 }],
+  ['domain index', { total: 42, total_is_exact: true, domains: [{ domain: 'b.com' }], limit: 10 }],
+  ['facet count', { kind: 'tech', signal: 'React', sites: 1234567 }],
+  ['search results', { results: [{ domain: 'c.com', blob_hash: 'x' }], next_cursor: null }],
+];
+
+for (const [name, payload] of GATEWAY_SHAPES) {
+  test(`the renderer reads the ${name} response shape`, async () => {
+    const source = await readFile(new URL('../src/index.js', import.meta.url), 'utf8');
+    const match = source.match(/const rows = ([^;]+);/);
+    assert.ok(match, 'the renderer no longer looks up rows the way this test expects');
+    const known = [...match[1].matchAll(/payload\.([a-z_]+)/g)].map((m) => m[1]);
+    const arrayKey = Object.keys(payload).find((k) => Array.isArray(payload[k]));
+    if (arrayKey) {
+      assert.ok(
+        known.includes(arrayKey),
+        `the renderer would print raw JSON for a ${name}: it returns "${arrayKey}", ` +
+          `and the renderer only knows ${known.join(', ')}`,
+      );
+    }
+  });
+}