@koda-sl/baker-cli 0.354.0-dev.e6a354971 → 0.354.0-dev.faae9de67

package/README.md

@@ -98,12 +98,7 @@ All commands return a JSON envelope:
 ### Unknown options are refused
 
 An option a command does not declare stops the run with `UNKNOWN_ARGUMENT`, naming the
-real one it was most likely reaching for, with the first sentence of that option's own
-description. A word the command spells differently is matched by meaning (`--from` and
-`--since` → `--start-date`, `--to` and `--until` → `--end-date`, `--path` and `--url` →
-`--landing`, each only where the command has it); otherwise only a near spelling is
-offered, so a short option is never pointed at an unrelated one (`--from` at `--full`).
-Previously such an option was accepted and ignored, so a call that
+closest real one. Previously such an option was accepted and ignored, so a call that
 looked like it had filtered or narrowed a result was in fact answering the unfiltered
 question — and nothing in the output said so. Both spellings of an option work
 (`--run-id` and `--runId`), as they always did. The error's `fix` names the exact call
@@ -1338,7 +1333,7 @@ Shared flags: `--days <n>` (default 30) or `--start-date` / `--end-date` (`YYYY-
 
 `--measure` decides whose activity is measured and defaults to `campaigns` (only visitors a Baker landing brought). `--measure all` measures the client's entire website and is a decision somebody has to ask for. `host` is the client's own landing domain when one shares a domain with the site being measured, so the script and its events stay first-party; `firstParty` in the response says which, and removing that domain from Baker means re-running this command.
 
-**Paging the list reports.** `people`, `submissions` and `delivery` are lists of individual things rather than breakdowns — `delivery` and `submissions` are the ones the CLI exposes, `people` backs the People section of the dashboard's landing Analytics screen over the same wire — and only they take `--page <n>` (1-based) and `--page-size <n>` (up to 200, default 50). The response carries `pageInfo` with `hasMore` — when it is true there **are** more rows, so a total must never be reported from one page. Pass neither flag and a list comes back at the size it always did. A value that is not a whole positive number (`--page /pricing`) is refused before any request, naming `--landing` as the flag that narrows a report to one page of the site.
+**Paging the list reports.** `people`, `submissions` and `delivery` are lists of individual things rather than breakdowns — `delivery` and `submissions` are the ones the CLI exposes, `people` backs the People section of the dashboard's landing Analytics screen over the same wire — and only they take `--page <n>` (1-based) and `--page-size <n>` (up to 200, default 50). The response carries `pageInfo` with `hasMore` — when it is true there **are** more rows, so a total must never be reported from one page. Pass neither flag and a list comes back at the size it always did.
 
 **A conversion is a company-level named event, not a property of a Form.** `baker analytics conversions` is the only place "what counts" is decided, and an empty `definitions` list means every conversion number in every other report is zero — not because nobody converted, but because nothing is named as an outcome and Baker never guesses which event is the point of a page. `--candidates` lists every event these pages actually produced — each Form step and trigger, every `data-baker-*` event, every outbound destination — with volume and whether it is already counted; that list is where an event key comes from, so never invent one. `--event <key> --name "Booked a call"` starts counting it **immediately and retroactively**: the whole stored history is rescored, so naming the right event today also fixes last month. Nothing here is staged and publishing is not involved. Two events given the same `--name` become one row and one number, which is how a call booked on three different Forms reads as one outcome. `--count-mode every_time` is for the outcomes people genuinely repeat (a guide downloaded twice is two downloads); the default counts once per visit.
 
@@ -1426,8 +1421,8 @@ baker experiment plan --landing oferta --variant oferta--1 --goal submit:book-a-
 baker experiment start --landing oferta --variant oferta--1 --because "60% of visitors never scroll past the hero" --change "put the price in the headline"
 baker experiment update --id temp_exp_1 --goal submit:book-a-call # a staged test can still change what it measures
 baker experiment update --id a3f91c2b --because "…"              # a live one can only change its wording
-baker experiment status                                          # the verdict on every test
-baker experiment status --id a3f91c2b --full                     # one test, with the confidence and posteriors behind it
+baker experiment status                                          # the verdict on every test, first; dates as calendar dates
+baker experiment status --id a3f91c2b --full                     # one test, with everything the dashboard reads and the posteriors
 baker experiment history --landing oferta                        # every finished test on a page: claim, numbers, decision, learning
 baker experiment pause --id a3f91c2b                             # everyone sees the original for now
 baker experiment resume --id a3f91c2b                            # the split picks up with the same sides

package/dist/cli.js

@@ -33401,19 +33401,6 @@ function pageOf(args5) {
     ...size ? { pageSize: Number(size) } : {}
   };
 }
-function isWholePositive(raw) {
-  return /^[1-9]\d*$/.test(String(raw));
-}
-function paginationError(args5) {
-  if (args5.page !== void 0 && !isWholePositive(args5.page)) {
-    return `--page takes a page number of a list report (1, 2, \u2026), not "${String(args5.page)}". To narrow a report to one page of the site, pass --landing <internalId> (from \`baker analytics landings\`), or read one path with \`baker analytics page --path /pricing\`.`;
-  }
-  const size = args5["page-size"];
-  if (size !== void 0 && !isWholePositive(size)) {
-    return `--page-size takes a number of rows (1 to 200), not "${String(size)}".`;
-  }
-  return null;
-}
 function requestBody(args5, options) {
   const candidates = {
     preset: options.preset,
@@ -33478,11 +33465,6 @@ async function runPreset(args5, options) {
     });
     process.exit(1);
   }
-  const pagination = paginationError(args5);
-  if (pagination) {
-    writeJsonEnvelope({ ok: false, error: { code: "VALIDATION_ERROR", message: pagination } });
-    process.exit(1);
-  }
   try {
     const response = await apiPost("/api/analytics/query", requestBody(args5, options));
     const requestedPlatform = args5.platform === void 0 ? "" : String(args5.platform);
@@ -47133,6 +47115,80 @@ async function declarationsOf(root, files) {
   return sources.flatMap(eventDeclarationsIn);
 }
 
+// src/commands/experiment/readout.ts
+function isoMoment(ms) {
+  return ms === null ? null : new Date(ms).toISOString();
+}
+function isoDay2(ms) {
+  return ms === null ? null : new Date(ms).toISOString().slice(0, 10);
+}
+function compactArm(arm) {
+  return { visitors: arm.visitors, conversions: arm.conversions, rate: Math.round(arm.rate * 1e4) / 1e4 };
+}
+function compactMetric(metric) {
+  return {
+    name: metric.name,
+    reading: metric.reading,
+    control: metric.control.conversions,
+    variant: metric.variant.conversions
+  };
+}
+function fullArm(arm) {
+  return {
+    ...arm,
+    ...arm.snapshotCapturedAt === void 0 ? {} : { snapshotCapturedAt: isoMoment(arm.snapshotCapturedAt) }
+  };
+}
+function statusReadout(row, { full, now }) {
+  const decisionWhen = {
+    earliestDecisionAt: isoDay2(row.earliestDecisionAt),
+    ...row.earliestDecisionAt === null ? {} : { earliestDecisionIn: describeWait(row.earliestDecisionAt, now) }
+  };
+  const moments = {
+    startedAt: isoMoment(row.startedAt),
+    pausedAt: isoMoment(row.pausedAt),
+    finishedAt: isoMoment(row.finishedAt)
+  };
+  if (full) {
+    return {
+      ...row,
+      ...moments,
+      ...decisionWhen,
+      control: fullArm(row.control),
+      variant: fullArm(row.variant)
+    };
+  }
+  return {
+    experimentId: row.experimentId,
+    landingSlug: row.landingSlug,
+    variantSlug: row.variantSlug,
+    status: row.status,
+    verdict: row.verdict,
+    summary: row.summary,
+    ...row.winner === null ? {} : { winner: row.winner },
+    ...row.invalidReason === null ? {} : { invalidReason: row.invalidReason },
+    stillNeeded: row.stillNeeded,
+    ...decisionWhen,
+    willNotConclude: row.willNotConclude,
+    control: compactArm(row.control),
+    variant: compactArm(row.variant),
+    secondary: row.secondary.map(compactMetric),
+    hypothesisStatement: row.hypothesisStatement,
+    minDetectableRelativeLift: row.minDetectableRelativeLift,
+    goal: row.goal,
+    ...row.variantGoal === null ? {} : { variantGoal: row.variantGoal },
+    goalLabel: row.goalLabel,
+    ...moments,
+    ...row.status === "finished" ? {
+      survivor: row.survivor,
+      hypothesisOutcome: row.hypothesisOutcome,
+      fold: row.fold,
+      learning: row.learning,
+      endReason: row.endReason
+    } : {}
+  };
+}
+
 // src/commands/experiment/update.ts
 function buildUpdateRequest(args5, rawArgs) {
   const expect = args5.expect === void 0 ? void 0 : String(args5.expect);
@@ -47374,18 +47430,26 @@ registerSchema({
   args: {
     id: { type: "string", description: "One test, by its id", required: false },
     landing: LANDING_FILTER_ARG,
-    full: { type: "boolean", description: "Include the posteriors behind the verdict", required: false }
+    full: {
+      type: "boolean",
+      description: "Every field the dashboard reads too \u2014 the hypothesis in parts, what each version owns, the preview pictures and the posteriors behind the verdict",
+      required: false
+    }
   }
 });
 var statusCommand6 = defineCommand124({
   meta: {
     name: "status",
-    description: "The verdict on each test. Read `verdict` and nothing else to decide: keep_running | winner | no_difference | cannot_win | invalid. `cannot_win` means even the best case is under the lift the test was looking for \u2014 end it and keep the original. `stillNeeded` is the data (visitors, conversions) the test still needs; a test is gated on data, never on days. `summary` is one sentence you can show the client, and `secondary` lists every other conversion the company counts on the same two arms \u2014 context, never a second decision. The numbers under `--full` are for printing, never for deciding \u2014 a test that says keep_running has not finished, however good its numbers look."
+    description: "The verdict on each test. Read `verdict` and nothing else to decide: keep_running | winner | no_difference | cannot_win | invalid. `cannot_win` means even the best case is under the lift the test was looking for \u2014 end it and keep the original. `stillNeeded` is the data (visitors, conversions) the test still needs; a test is gated on data, never on days. `earliestDecisionAt` is the day this page's traffic would get it there (YYYY-MM-DD) and `earliestDecisionIn` how far off that is \u2014 say those, never work a date out yourself. `summary` is one sentence you can show the client, and `secondary` lists every other conversion the company counts on the same two arms \u2014 context, never a second decision. The numbers under `--full` are for printing, never for deciding \u2014 a test that says keep_running has not finished, however good its numbers look."
   },
   args: {
     id: { type: "string", description: "One test, by its id", required: false },
     landing: LANDING_FILTER_ARG,
-    full: { type: "boolean", description: "Include the posteriors behind the verdict", required: false }
+    full: {
+      type: "boolean",
+      description: "Every field the dashboard reads too \u2014 the hypothesis in parts, what each version owns, the preview pictures and the posteriors behind the verdict",
+      required: false
+    }
   },
   run: async ({ args: args5 }) => {
     try {
@@ -47394,10 +47458,13 @@ var statusCommand6 = defineCommand124({
         ...args5.landing ? { landingSlug: String(args5.landing) } : {},
         ...args5.full === true ? { full: true } : {}
       });
+      const now = Date.now();
       writeJsonEnvelope({
         ok: true,
-        data: response.data,
-        hints: buildStatusHints(response.data.experiments)
+        data: {
+          experiments: response.data.experiments.map((row) => statusReadout(row, { full: args5.full === true, now }))
+        },
+        hints: buildStatusHints(response.data.experiments, now)
       });
     } catch (error) {
       reportApiError(error);
@@ -68628,36 +68695,19 @@ function findUnknownFlags(root, argv) {
   }
   return unknown;
 }
-var SYNONYMS = {
-  from: ["start-date", "start", "since"],
-  since: ["start-date", "start", "from"],
-  start: ["start-date", "since", "from"],
-  to: ["end-date", "end", "until"],
-  until: ["end-date", "end", "to"],
-  end: ["end-date", "until", "to"],
-  path: ["landing"],
-  url: ["landing"]
-};
 function closestFlag(unknown, command) {
   const accepted = acceptedNames(command);
   if (!accepted) {
     return null;
   }
   const name = unknown.replace(/^--/, "").split("=")[0] ?? "";
-  const synonym = SYNONYMS[name]?.find((candidate) => accepted.has(candidate));
-  if (synonym) {
-    return `--${synonym}`;
-  }
   const scored = [...accepted].filter((candidate) => !ALWAYS_ACCEPTED.has(candidate)).map((candidate) => ({
     candidate,
     prefix: sharedPrefix(name, candidate),
     distance: editDistance(name, candidate)
-  })).filter(({ prefix, distance }) => prefix >= 4 || distance <= typoBudget(name)).sort((a, b) => b.prefix - a.prefix || a.distance - b.distance);
+  })).filter(({ prefix, distance }) => prefix >= 4 || distance <= 3).sort((a, b) => b.prefix - a.prefix || a.distance - b.distance);
   return scored[0] ? `--${scored[0].candidate}` : null;
 }
-function typoBudget(name) {
-  return Math.max(1, Math.floor(name.length / 3));
-}
 function sharedPrefix(a, b) {
   let i = 0;
   while (i < a.length && i < b.length && a[i] === b[i]) {
@@ -68681,24 +68731,6 @@ function commandFor(root, argv) {
   const { command, resolved } = resolveCommand2(root, argv);
   return resolved ? command : null;
 }
-function suggestFlag(unknown, command) {
-  const flag = closestFlag(unknown, command);
-  if (!flag) {
-    return null;
-  }
-  const args5 = argsOf(command) ?? {};
-  const name = flag.slice(2);
-  const def = args5[name] ?? args5[camel(name)];
-  const described = def && typeof def === "object" ? def.description : void 0;
-  const description = typeof described === "string" ? described.split(/\.\s/)[0]?.trim().replace(/\.$/, "") : "";
-  return description ? { flag, description } : { flag };
-}
-function suggestionText(suggestion) {
-  if (!suggestion) {
-    return "";
-  }
-  return suggestion.description ? `Did you mean ${suggestion.flag}? It is described as: ${suggestion.description}. ` : `Did you mean ${suggestion.flag}? `;
-}
 var OUTPUT_EXPLANATION = "This command has no --output option: `--output json` is accepted by every command that prints the JSON envelope, and md or files only where `baker schema` lists `output`. Drop the option and read the default output. ";
 function unknownFlagEnvelope(unknown, commandPath, suggestion, hasSchema) {
   const list = unknown.join(", ");
@@ -68709,7 +68741,7 @@ function unknownFlagEnvelope(unknown, commandPath, suggestion, hasSchema) {
       message: `${list} ${unknown.length > 1 ? "are not options" : "is not an option"} of \`baker ${commandPath}\`.`,
       fix: {
         action: hasSchema ? "check_schema" : "check_help",
-        explanation: (unknown.some((flag) => flag === "--output" || flag.startsWith("--output=")) ? OUTPUT_EXPLANATION : "") + suggestionText(suggestion) + `Run \`${hasSchema ? `baker schema ${commandPath}` : `baker ${commandPath} --help`}\` to see every option this command takes. Do not re-run the same call: until this version an unrecognised option was accepted and ignored, so a command that looked like it had filtered or narrowed the result was in fact answering the unfiltered question.`
+        explanation: (unknown.some((flag) => flag === "--output" || flag.startsWith("--output=")) ? OUTPUT_EXPLANATION : "") + (suggestion ? `Did you mean ${suggestion}? ` : "") + `Run \`${hasSchema ? `baker schema ${commandPath}` : `baker ${commandPath} --help`}\` to see every option this command takes. Do not re-run the same call: until this version an unrecognised option was accepted and ignored, so a command that looked like it had filtered or narrowed the result was in fact answering the unfiltered question.`
       },
       retryable: false
     }
@@ -68739,7 +68771,7 @@ function refuseUnknownFlags(root, argv) {
   }
   const command = commandFor(root, argv);
   const first = unknown[0];
-  const suggestion = command && first ? suggestFlag(first, command) : null;
+  const suggestion = command && first ? closestFlag(first, command) : null;
   const path48 = commandPathOf(root, argv);
   process.stdout.write(
     `${JSON.stringify(unknownFlagEnvelope(unknown, path48, suggestion, findSchema(path48.split(" ")) !== void 0), null, 2)}