@brew.new/cli 0.4.0 → 0.5.0

package/dist/bin.js

@@ -215,7 +215,7 @@ function shellQuote(token) {
 
 // src/version.ts
 var CLI_NAME = "brew-cli";
-var CLI_VERSION = "0.4.0" ;
+var CLI_VERSION = "0.5.0" ;
 var CONFIG_KEYS = ["apiKey", "brandId", "apiUrl"];
 function isConfigKey(value) {
   return CONFIG_KEYS.includes(value);
@@ -1038,6 +1038,56 @@ function renderInstances(rows) {
 }
 
 // src/lib/raw-request.ts
+async function rawRequest(ctx, request) {
+  const auth = resolveAuth({
+    globals: ctx.globals,
+    env: ctx.io.env,
+    ...request.allowAnonymous === true ? { allowAnonymous: true } : {}
+  });
+  const hasBody = request.body !== void 0;
+  const idempotencyKey = resolveRawIdempotencyKey(
+    request.method,
+    request.idempotencyKey
+  );
+  const headers = buildRawHeaders({
+    auth,
+    path: request.path,
+    hasJsonBody: hasBody,
+    idempotencyKey
+  });
+  const url = new URL(`${auth.apiUrl}${request.path}`);
+  for (const [key, value] of Object.entries(request.query ?? {})) {
+    if (value !== void 0) {
+      url.searchParams.set(key, value);
+    }
+  }
+  const response = await fetch(url, {
+    method: request.method,
+    headers,
+    ...hasBody ? { body: JSON.stringify(request.body) } : {},
+    ...request.signal === void 0 ? {} : { signal: request.signal }
+  });
+  const text = await response.text();
+  const parsed = tryParseJson(text);
+  if (!response.ok) {
+    throw responseToApiError(response, parsed);
+  }
+  if (parsed === void 0) {
+    throw new CliApiError({
+      status: response.status,
+      code: "UNEXPECTED_RESPONSE",
+      type: "internal_error",
+      message: "The API returned a non-JSON success response."
+    });
+  }
+  return parsed;
+}
+function resolveRawIdempotencyKey(method, provided) {
+  if (provided !== void 0 && provided !== "") {
+    return provided;
+  }
+  return method === "POST" ? crypto.randomUUID() : void 0;
+}
 function buildRawHeaders(input) {
   const headers = new Headers({
     authorization: `Bearer ${input.auth.apiKey}`,
@@ -2033,6 +2083,175 @@ var automationsTestCommand = defineCommand({
   }
 });
 
+// src/commands/automations/triggers/contract.ts
+var FORMAT_FLAG = {
+  flag: "--format <format>",
+  summary: "Rendering: json (default, the contract object) or ts | zod | jsonschema | skill ({format, content})"
+};
+var FORMATS = /* @__PURE__ */ new Set(["json", "ts", "zod", "jsonschema", "skill"]);
+var ENFORCEMENT_MODES = /* @__PURE__ */ new Set(["off", "prune", "strict"]);
+var VALIDATE_ENFORCEMENT_MODES = /* @__PURE__ */ new Set(["prune", "strict"]);
+function formatQuery(value) {
+  const format = flagString(value);
+  if (format === void 0) {
+    return "";
+  }
+  if (!FORMATS.has(format)) {
+    throw new CliUsageError(
+      `Unknown --format '${format}' (expected json | ts | zod | jsonschema | skill).`
+    );
+  }
+  return `?format=${format}`;
+}
+function contentHuman(body) {
+  return typeof body.content === "string" ? { human: body.content } : {};
+}
+var automationsTriggersContractGetCommand = defineCommand({
+  path: ["automations", "triggers", "contract", "get"],
+  summary: "Read a trigger payload contract: stored when declared, derived otherwise; --format renders ts/zod/jsonschema/skill",
+  sdkMethod: null,
+  isRawTransport: true,
+  route: {
+    method: "GET",
+    path: "/v1/automations/triggers/{triggerEventId}/contract"
+  },
+  commandClass: "read",
+  args: [
+    {
+      name: "triggerEventId",
+      summary: "Trigger id (tri_\u2026, or an integration composite id)",
+      isRequired: true
+    }
+  ],
+  flags: [FORMAT_FLAG],
+  examples: [
+    "brew-cli automations triggers contract get tri_signup",
+    "brew-cli automations triggers contract get tri_signup --format ts",
+    "brew-cli automations triggers contract get tri_signup --format skill --json | jq -r .content"
+  ],
+  run: async ({ ctx, args, flags }) => {
+    const body = await rawRequest(ctx, {
+      method: "GET",
+      path: `/v1/automations/triggers/${encodeURIComponent(args.triggerEventId ?? "")}/contract${formatQuery(flags.format)}`
+    });
+    return { data: body, ...contentHuman(body) };
+  }
+});
+var automationsTriggersContractPutCommand = defineCommand({
+  path: ["automations", "triggers", "contract", "put"],
+  summary: "Declare (or replace) the stored payload contract for a trigger \u2014 tree-validated before any write; omitting --enforcement leaves the stored setting unchanged",
+  sdkMethod: null,
+  isRawTransport: true,
+  route: {
+    method: "PUT",
+    path: "/v1/automations/triggers/{triggerEventId}/contract"
+  },
+  commandClass: "write",
+  args: [
+    {
+      name: "triggerEventId",
+      summary: "Trigger id (tri_\u2026)",
+      isRequired: true
+    }
+  ],
+  flags: [
+    INPUT_FLAG,
+    {
+      flag: "--enforcement <mode>",
+      summary: "off (advisory, the default) | prune (drop fields not on the list) | strict (reject a payload carrying them)"
+    }
+  ],
+  examples: [
+    `brew-cli automations triggers contract put tri_signup --input '{"fields":[{"key":"email","type":"string","required":true}]}'`,
+    "brew-cli automations triggers contract put tri_signup --enforcement strict"
+  ],
+  // Trigger contracts must keep a top-level required `email` string;
+  // nested object/array fields need a Liquid-enabled workspace. The
+  // response is the same body a follow-up `contract get` returns.
+  run: async ({ ctx, args, flags }) => {
+    const input = mergeInput(
+      await readJsonFlag(ctx, flags.input, "--input"),
+      {}
+    );
+    if (input.fields !== void 0 && !Array.isArray(input.fields)) {
+      throw new CliUsageError(
+        "--input .fields must be an array of contract field nodes."
+      );
+    }
+    const enforcement = flagString(flags.enforcement);
+    if (enforcement !== void 0 && !ENFORCEMENT_MODES.has(enforcement)) {
+      throw new CliUsageError(
+        `Unknown --enforcement '${enforcement}' (expected off | prune | strict).`
+      );
+    }
+    const requestBody = {
+      ...input,
+      ...enforcement !== void 0 ? { enforcement } : {}
+    };
+    if (Object.keys(requestBody).length === 0) {
+      throw new CliUsageError(
+        "Empty contract body \u2014 pass --input (fields and/or name) or --enforcement <mode>."
+      );
+    }
+    const body = await rawRequest(ctx, {
+      method: "PUT",
+      path: `/v1/automations/triggers/${encodeURIComponent(args.triggerEventId ?? "")}/contract`,
+      body: requestBody
+    });
+    return { data: body };
+  }
+});
+var automationsTriggersContractValidateCommand = defineCommand({
+  path: ["automations", "triggers", "contract", "validate"],
+  summary: "Dry-run a payload against a trigger's contract (the fire path's validator) \u2014 never fires; invalid payloads still exit 0",
+  sdkMethod: null,
+  isRawTransport: true,
+  route: {
+    method: "POST",
+    path: "/v1/automations/triggers/{triggerEventId}/contract/validate"
+  },
+  commandClass: "read",
+  args: [
+    {
+      name: "triggerEventId",
+      summary: "Trigger id (tri_\u2026)",
+      isRequired: true
+    }
+  ],
+  flags: [
+    INPUT_FLAG,
+    {
+      flag: "--enforcement <mode>",
+      summary: "Preview a mode other than the stored one: prune | strict"
+    }
+  ],
+  examples: [
+    `brew-cli automations triggers contract validate tri_signup --input '{"payload":{"email":"jane@example.com"}}'`
+  ],
+  run: async ({ ctx, args, flags }) => {
+    const input = mergeInput(
+      await readJsonFlag(ctx, flags.input, "--input"),
+      {}
+    );
+    const payload = input.payload ?? input;
+    const enforcement = flagString(flags.enforcement);
+    if (enforcement !== void 0 && !VALIDATE_ENFORCEMENT_MODES.has(enforcement)) {
+      throw new CliUsageError(
+        `Unknown --enforcement '${enforcement}' (expected prune | strict).`
+      );
+    }
+    const body = await rawRequest(ctx, {
+      method: "POST",
+      path: `/v1/automations/triggers/${encodeURIComponent(args.triggerEventId ?? "")}/contract/validate`,
+      body: {
+        payload,
+        ...enforcement !== void 0 ? { enforcement } : {}
+      }
+    });
+    return { data: body };
+  }
+});
+
 // src/commands/automations/triggers/create.ts
 var automationsTriggersCreateCommand = defineCommand({
   path: ["automations", "triggers", "create"],
@@ -2116,7 +2335,7 @@ var automationsTriggersFireCommand = defineCommand({
   ],
   flags: [INPUT_FLAG, IDEMPOTENCY_FLAG],
   examples: [
-    `brew-cli automations triggers fire tev_123 --input '{"payload":{"userId":"u_1"}}' --yes`
+    `brew-cli automations triggers fire tri_signup --input '{"payload":{"email":"jane@example.com"}}' --yes`
   ],
   confirmSummary: ({ args }) => `Fire trigger ${args.triggerEventId ?? ""} \u2014 starts REAL runs on every published automation listening to it.`,
   run: async ({ ctx, args, flags }) => {
@@ -3329,6 +3548,40 @@ var contentTransformCommand = defineCommand({
   }
 });
 
+// src/commands/contracts/infer.ts
+var contractsInferCommand = defineCommand({
+  path: ["contracts", "infer"],
+  summary: "Draft a payload contract from a real example payload \u2014 nothing is saved; PUT the draft on a trigger",
+  sdkMethod: null,
+  isRawTransport: true,
+  route: { method: "POST", path: "/v1/payload-contracts/infer" },
+  commandClass: "read",
+  flags: [INPUT_FLAG],
+  examples: [
+    `brew-cli contracts infer --input '{"email":"jane@example.com","order":{"total":9.5}}'`
+  ],
+  // Accepts either the bare example object or `{ example: {...} }`.
+  // Un-inferable spots (nulls, empty arrays) come back under `issues`.
+  run: async ({ ctx, flags }) => {
+    const input = mergeInput(
+      await readJsonFlag(ctx, flags.input, "--input"),
+      {}
+    );
+    const example = input.example ?? input;
+    if (typeof example !== "object" || example === null || Array.isArray(example) || Object.keys(example).length === 0) {
+      throw new CliUsageError(
+        "--input with a non-empty example object is required (the JSON your system sends)."
+      );
+    }
+    const body = await rawRequest(ctx, {
+      method: "POST",
+      path: "/v1/payload-contracts/infer",
+      body: { example }
+    });
+    return { data: body };
+  }
+});
+
 // src/skip-list.ts
 var SDK_SKIP_LIST = [
   {
@@ -4994,36 +5247,6 @@ function renderTemplates(rows) {
     { key: "brand", header: "BRAND" }
   ]);
 }
-
-// src/commands/transactional/get.ts
-var transactionalGetCommand = defineCommand({
-  path: ["transactional", "get"],
-  summary: "Read a transactional email object: locked design/domain/envelope; Liquid workspaces add `variableTree` + a fireable `examplePayload`",
-  sdkMethod: "transactional.get",
-  route: { method: "GET", path: "/v1/transactional/{transactionId}" },
-  commandClass: "read",
-  args: [
-    {
-      name: "transactionId",
-      summary: "Transactional email id (txn_\u2026) from Email Actions \u2192 Transactional Email",
-      isRequired: true
-    }
-  ],
-  examples: ["brew-cli transactional get txn_8fK2mQ4pLx"],
-  // `variables` (legacy merge tags) is always present. `templating.engine`,
-  // `variableTree`, and `examplePayload` only appear on Liquid-enabled
-  // workspaces: variableTree lists every trigger.*/customer.* path the
-  // pinned template references, and examplePayload is a ready-to-send
-  // `payload` body for `emails send` (or `POST /v1/sends { transactionId,
-  // to, payload }`). Nested payload values are Liquid-only — the same
-  // shape sent to a non-Liquid workspace is rejected with 400. A `--test`
-  // send on `emails send` accepts the identical `payload` shape with the
-  // same live-fire rendering parity, so an examplePayload preview matches
-  // what a real fire produces.
-  run: async ({ ctx, args }) => ({
-    data: await ctx.client().transactional.get(args.transactionId ?? "")
-  })
-});
 var HEADER_PREFIX = "// brew:contracts sha256:";
 function pascalCase(value) {
   const cleaned = value.replace(/[^a-zA-Z0-9]+/g, " ").trim();
@@ -5043,77 +5266,56 @@ var IDENTIFIER_RE = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
 function propertyKey(key) {
   return IDENTIFIER_RE.test(key) ? key : JSON.stringify(key);
 }
-function triggerFieldType(type) {
-  if (type === "int") {
-    return "number";
-  }
-  if (type === "boolean") {
-    return "boolean";
+function scalarTsType(type, node) {
+  switch (type) {
+    case "string":
+      return "string";
+    case "int":
+    case "float":
+      return "number";
+    case "boolean":
+      return "boolean";
+    case "date":
+      return "string";
+    case "enum":
+      return node.enumValues && node.enumValues.length > 0 ? node.enumValues.map((value) => JSON.stringify(value)).join(" | ") : "string";
+    default:
+      return "unknown";
   }
-  return "string";
-}
-function emitTriggerType(trigger, name) {
-  const fields = trigger.payloadSchema?.fields ?? [];
-  const lines = fields.map((field) => {
-    const optional = field.required ? "" : "?";
-    return `  ${propertyKey(field.key)}${optional}: ${triggerFieldType(field.type)}`;
-  });
-  const body = fields.length === 0 ? `export type ${name} = Record<string, never>` : [`export type ${name} = {`, ...lines, "}"].join("\n");
-  return [
-    `/** Fire: POST /v1/automations/triggers/${trigger.triggerEventId}/fire \u2014 body { payload: ${name} } */`,
-    body
-  ].join("\n");
 }
-function scalarType(node) {
-  if (node.inferredType === "number" || node.inferredType === "boolean") {
-    return node.inferredType;
+function triggerFieldType(node, indent) {
+  if (node.type === "object") {
+    return triggerObjectLiteral(node.children ?? [], indent);
   }
-  if (node.inferredType === "string") {
-    return "string";
+  if (node.type === "array") {
+    if (node.children && node.children.length > 0) {
+      return `Array<${triggerObjectLiteral(node.children, indent)}>`;
+    }
+    const element = node.itemType ? scalarTsType(node.itemType, node) : "unknown";
+    return `Array<${element}>`;
   }
-  return node.fallback === null ? "unknown" : "string";
-}
-function emitTreeNode(node, indent) {
-  const optional = node.fallback === null ? "" : "?";
-  const key = `${indent}${propertyKey(node.key)}${optional}: `;
-  if (node.kind === "object") {
-    const children = node.children ?? [];
-    return `${key}{
-${children.map((child) => emitTreeNode(child, `${indent}  `)).join("\n")}
-${indent}}`;
-  }
-  if (node.kind === "array") {
-    const children = node.children ?? [];
-    if (children.length === 0) {
-      return `${key}Array<unknown>`;
-    }
-    return `${key}Array<{
-${children.map((child) => emitTreeNode(child, `${indent}  `)).join("\n")}
-${indent}}>`;
-  }
-  return `${key}${scalarType(node)}`;
+  return scalarTsType(node.type, node);
 }
-function emitTransactionalType(row, name) {
-  const roots = row.variableTree ?? [];
-  const payloadNodes = [];
-  for (const root of roots) {
-    if (root.namespace === "customer") {
-      continue;
-    }
-    if (root.key === "trigger" || root.key === "payload") {
-      payloadNodes.push(
-        ...root.children ?? []
-      );
-      continue;
-    }
-    payloadNodes.push(root);
+function triggerObjectLiteral(nodes, indent) {
+  if (nodes.length === 0) {
+    return indent === "" ? "Record<string, never>" : "Record<string, unknown>";
+  }
+  const inner = `${indent}  `;
+  const lines = ["{"];
+  for (const node of nodes) {
+    const optional = node.required ? "" : "?";
+    lines.push(
+      `${inner}${propertyKey(node.key)}${optional}: ${triggerFieldType(node, inner)}`
+    );
   }
-  const body = payloadNodes.length === 0 ? `export type ${name} = Record<string, never>` : `export type ${name} = {
-${payloadNodes.map((node) => emitTreeNode(node, "  ")).join("\n")}
-}`;
+  lines.push(`${indent}}`);
+  return lines.join("\n");
+}
+function emitTriggerType(trigger, name) {
+  const fields = trigger.payloadSchema?.fields ?? [];
   return [
-    `/** Fire: POST /v1/sends \u2014 body { transactionId: ${JSON.stringify(row.transactionId)}, to, payload: ${name} } */`,
-    body
+    `/** Fire: POST /v1/automations/triggers/${trigger.triggerEventId}/fire \u2014 body { payload: ${name} } */`,
+    `export type ${name} = ${triggerObjectLiteral(fields, "")}`
   ].join("\n");
 }
 function byCodepoint(a, b) {
@@ -5143,31 +5345,18 @@ function buildFileText(args) {
   const triggers = [...args.triggers].sort(
     (a, b) => byCodepoint(a.triggerEventId, b.triggerEventId)
   );
-  const transactionals = [...args.transactionals].sort(
-    (a, b) => byCodepoint(a.transactionId, b.transactionId)
+  const names = uniqueNames(
+    triggers.map((t) => ({ id: t.triggerEventId, label: t.title }))
   );
-  const names = uniqueNames([
-    ...triggers.map((t) => ({ id: t.triggerEventId, label: t.title })),
-    ...transactionals.map((t) => ({
-      id: t.transactionId,
-      label: t.subject?.trim() || t.transactionId
-    }))
-  ]);
   const triggerBlocks = triggers.map(
     (t, i) => emitTriggerType(t, names[i] ?? typeName(t.title))
   );
-  const transactionalBlocks = transactionals.map(
-    (t, i) => emitTransactionalType(
-      t,
-      names[triggers.length + i] ?? typeName(t.transactionId)
-    )
-  );
   const body = [
     "// Generated by `brew-cli types` \u2014 do not edit by hand.",
-    "// Re-run `brew-cli types` after changing a trigger schema or a",
-    "// transactional design; gate drift in CI with `brew-cli types --check`.",
+    "// Re-run `brew-cli types` after changing a trigger schema; gate",
+    "// drift in CI with `brew-cli types --check`.",
     "",
-    [...triggerBlocks, ...transactionalBlocks].join("\n\n"),
+    triggerBlocks.join("\n\n"),
     ""
   ].join("\n");
   const hash = createHash("sha256").update(body).digest("hex");
@@ -5176,7 +5365,7 @@ ${body}`;
 }
 var typesCommand = defineCommand({
   path: ["types"],
-  summary: "Generate TypeScript payload contracts (triggers + transactional objects) into your codebase; --check is the CI drift gate (exit 1 on drift). Needs the automations scope; --transaction also needs sends",
+  summary: "Generate TypeScript payload contracts for this workspace's triggers into your codebase; --check is the CI drift gate (exit 1 on drift). Needs the automations scope",
   sdkMethod: null,
   derivedFrom: "automations.triggers.list",
   route: { method: "GET", path: "/v1/automations/triggers" },
@@ -5187,10 +5376,6 @@ var typesCommand = defineCommand({
       summary: "Output file (default brew-contracts.ts)",
       defaultValue: "brew-contracts.ts"
     },
-    {
-      flag: "--transaction <transactionIds...>",
-      summary: "Transactional object ids (txn_\u2026) to include, contract derived from each pinned template"
-    },
     {
       flag: "--check",
       summary: "Verify the output file is up to date instead of writing; exits 1 on drift"
@@ -5198,7 +5383,7 @@ var typesCommand = defineCommand({
   ],
   examples: [
     "brew-cli types",
-    "brew-cli types --out src/brew-contracts.ts --transaction txn_8fK2mQ4pLx",
+    "brew-cli types --out src/brew-contracts.ts",
     "brew-cli types --check"
   ],
   run: async ({ ctx, flags }) => {
@@ -5217,12 +5402,7 @@ var typesCommand = defineCommand({
       }
       cursor = listResponse.pagination.cursor;
     }
-    const transactionIds = Array.isArray(flags.transaction) ? flags.transaction : [];
-    const transactionals = [];
-    for (const transactionId of transactionIds) {
-      transactionals.push(await ctx.client().transactional.get(transactionId));
-    }
-    const text = buildFileText({ transactionals, triggers });
+    const text = buildFileText({ triggers });
     const outPath = typeof flags.out === "string" ? flags.out : "brew-contracts.ts";
     if (flags.check === true) {
       let existing = null;
@@ -5249,10 +5429,9 @@ var typesCommand = defineCommand({
     return {
       data: {
         out: outPath,
-        transactionals: transactionals.length,
         triggers: triggers.length
       },
-      human: `Wrote ${outPath} (${triggers.length} trigger${triggers.length === 1 ? "" : "s"}, ${transactionals.length} transactional).`
+      human: `Wrote ${outPath} (${triggers.length} trigger${triggers.length === 1 ? "" : "s"}).`
     };
   }
 });
@@ -5343,7 +5522,6 @@ var ALL_COMMANDS = [
   sendsCancelCommand,
   sendsPauseCommand,
   sendsResumeCommand,
-  transactionalGetCommand,
   typesCommand,
   audiencesListCommand,
   audiencesGetCommand,
@@ -5363,6 +5541,10 @@ var ALL_COMMANDS = [
   automationsRunCommand,
   automationsTriggersListCommand,
   automationsTriggersReadyCommand,
+  automationsTriggersContractGetCommand,
+  automationsTriggersContractPutCommand,
+  automationsTriggersContractValidateCommand,
+  contractsInferCommand,
   automationsTriggersCreateCommand,
   automationsTriggersUpdateCommand,
   automationsTriggersDeleteCommand,
@@ -5429,7 +5611,8 @@ var GROUP_SUMMARIES = {
   integrations: "Read the connected-integration catalog",
   sends: "Control in-flight or scheduled sends",
   templates: "Browse the template gallery",
-  transactional: "Read reusable transactional email objects",
+  contract: "Stored payload contracts (get, put, validate)",
+  contracts: "Payload-contract helpers",
   triggers: "Manage trigger events",
   runs: "Automation run history",
   "trigger-instances": "Fired trigger instances"