@fire-spark/cli 0.0.0-stage → 0.13.3

package/src/commands/doctor/client/copy.ts

@@ -0,0 +1,248 @@
+import type { Copy } from "../../../core/i18n";
+
+const text = (es: string, en: string, pt: string): Copy => {
+  return { "es-EC": es, "en-US": en, "pt-BR": pt };
+};
+
+export const DOCS_PAGE: Copy = {
+  "es-EC": "https://firespark.cloud/docs/es/guides/doctor",
+  "en-US": "https://firespark.cloud/docs/guides/doctor",
+  "pt-BR": "https://firespark.cloud/docs/guides/doctor"
+};
+
+export const SUMMARY = text(
+  "Revisa el FireSpark ya desplegado de un merchant.",
+  "Checks a merchant's already deployed FireSpark.",
+  "Verifica o FireSpark já implantado de um merchant."
+);
+
+const usage = "firespark doctor <run|list|show|init|docs> [ID ...] [options]";
+export const USAGE = usage;
+
+const detailsEs = [
+  "Comandos: run [ID ...], list, show <ID>, init [--config <archivo>], docs.",
+  "run ejecuta los checks contra el FireSpark ya desplegado. Sin --fix solo informa.",
+  "Si falta el YAML, se crea aquí con init y se pregunta solo lo que falte.",
+  "Un canal que nunca se desplegó puede quedar solo con su identidad.",
+  "ORD-01 crea una orden de prueba solo si lo nombras y el pago es cash o sandbox. Antes de place se une al canal realtime y espera a que el checkout se libere.",
+  `La documentación está aquí: ${DOCS_PAGE["es-EC"]}`
+].join("\n");
+
+const detailsEn = [
+  "Commands: run [ID ...], list, show <ID>, init [--config <file>], docs.",
+  "run checks an already deployed FireSpark. Without --fix it only reports.",
+  "If the YAML is missing, init creates it here and asks only for what is missing.",
+  "A channel that was never deployed can keep identity only.",
+  "ORD-01 places a test order only when you name it and payment is cash or sandbox. It joins the realtime channel before place and waits until checkout is released.",
+  `Documentation: ${DOCS_PAGE["en-US"]}`
+].join("\n");
+
+const detailsPt = [
+  "Comandos: run [ID ...], list, show <ID>, init [--config <arquivo>], docs.",
+  "run verifica o FireSpark já implantado. Sem --fix, só informa.",
+  "Se o YAML não existe, o init cria o arquivo aqui e pergunta só o que falta.",
+  "Um canal que nunca foi implantado pode ficar só com a identidade.",
+  "ORD-01 cria um pedido de teste só se você o nomear e o pagamento for cash ou sandbox. Ele entra no canal realtime antes do place e espera o checkout ser liberado.",
+  `A documentação está aqui: ${DOCS_PAGE["pt-BR"]}`
+].join("\n");
+
+export const DETAILS: Copy = {
+  "es-EC": detailsEs,
+  "en-US": detailsEn,
+  "pt-BR": detailsPt
+};
+
+export const COPY = {
+  unknownCommand: text(
+    "Comando desconocido: {name}. Usa run, list, show, init o docs.",
+    "Unknown command: {name}. Use run, list, show, init, or docs.",
+    "Comando desconhecido: {name}. Use run, list, show, init ou docs."
+  ),
+  unknownCheck: text(
+    "Check desconocido: {id}",
+    "Unknown check: {id}",
+    "Check desconhecido: {id}"
+  ),
+  none: text(
+    "Ningún check coincide con esos filtros.",
+    "No check matches those filters.",
+    "Nenhum check corresponde a esses filtros."
+  ),
+  showOne: text(
+    "show necesita un solo ID.",
+    "show needs exactly one ID.",
+    "show precisa de um único ID."
+  ),
+  manyConfigs: text(
+    "Hay varios YAML ({files}). Pasa --config con el archivo que quieres.",
+    "Several YAML files ({files}). Pass --config with the one you want.",
+    "Há vários YAML ({files}). Passe --config com o arquivo que você quer."
+  ),
+  ambiguous: text(
+    "Hay varios canales. Pasa --channel-id para aplicar esas flags.",
+    "There are several channels. Pass --channel-id to apply those flags.",
+    "Há vários canais. Passe --channel-id para aplicar essas flags."
+  ),
+  unknownChannel: text(
+    "No existe un canal con channel_id {id} en el YAML.",
+    "No channel with channel_id {id} exists in the YAML.",
+    "Não existe um canal com channel_id {id} no YAML."
+  ),
+  badPayment: text(
+    "--payment solo acepta cash o sandbox.",
+    "--payment only accepts cash or sandbox.",
+    "--payment só aceita cash ou sandbox."
+  ),
+  badFormat: text(
+    "--format solo acepta text o json.",
+    "--format only accepts text or json.",
+    "--format só aceita text ou json."
+  ),
+  badUrl: text(
+    "--{flag} tiene que ser una URL http o https.",
+    "--{flag} must be an http or https URL.",
+    "--{flag} tem que ser uma URL http ou https."
+  ),
+  badYaml: text(
+    "No pude leer {path}: {detail}",
+    "Could not read {path}: {detail}",
+    "Não consegui ler {path}: {detail}"
+  ),
+  preflight: text(
+    "El canal {channel} está desplegado y le falta {field}. No se ejecutó ningún check.",
+    "Channel {channel} is deployed and is missing {field}. No checks ran.",
+    "O canal {channel} está implantado e falta {field}. Nenhum check rodou."
+  ),
+  wrote: text(
+    "Configuración lista: {path}",
+    "Configuration ready: {path}",
+    "Configuração pronta: {path}"
+  ),
+  deployedAsk: text(
+    "¿El canal {channel} está desplegado? (sí/no) ",
+    "Is channel {channel} deployed? (yes/no) ",
+    "O canal {channel} está implantado? (sim/não) "
+  ),
+  answerYesNo: text(
+    "Responde sí o no para el canal {channel}. No adivino si está desplegado.",
+    "Answer yes or no for channel {channel}. I will not guess if it is deployed.",
+    "Responda sim ou não para o canal {channel}. Não adivinho se está implantado."
+  ),
+  askUrl: text(
+    "URL pública de {channel}: ",
+    "Public URL of {channel}: ",
+    "URL pública de {channel}: "
+  ),
+  askDashboard: text(
+    "URL del dashboard de {channel}: ",
+    "Dashboard URL of {channel}: ",
+    "URL do dashboard de {channel}: "
+  ),
+  askApi: text(
+    "URL de la API de {channel}: ",
+    "API URL of {channel}: ",
+    "URL da API de {channel}: "
+  ),
+  askStore: text(
+    "store-id de {channel}: ",
+    "store-id of {channel}: ",
+    "store-id de {channel}: "
+  ),
+  askFulfillment: text(
+    "fulfillment-id de {channel}: ",
+    "fulfillment-id of {channel}: ",
+    "fulfillment-id de {channel}: "
+  ),
+  askPayment: text(
+    "Pago de {channel} (cash o sandbox): ",
+    "Payment of {channel} (cash or sandbox): ",
+    "Pagamento de {channel} (cash ou sandbox): "
+  ),
+  askReceiver: text(
+    "URL del receptor de webhooks de {channel}: ",
+    "Webhook receiver URL of {channel}: ",
+    "URL do receptor de webhooks de {channel}: "
+  ),
+  askEvidence: text(
+    "Ruta de evidencia de {channel}: ",
+    "Evidence path of {channel}: ",
+    "Caminho de evidência de {channel}: "
+  ),
+  badAnswerPayment: text(
+    "El pago tiene que ser cash o sandbox.",
+    "Payment has to be cash or sandbox.",
+    "O pagamento tem que ser cash ou sandbox."
+  ),
+  docsLine: text(
+    "La documentación está aquí: {url}",
+    "Documentation: {url}",
+    "A documentação está aqui: {url}"
+  ),
+  orderMissing: text(
+    "El canal {channel} le falta {field}. No se creó ninguna orden.",
+    "Channel {channel} is missing {field}. No order was created.",
+    "O canal {channel} falta {field}. Nenhum pedido foi criado."
+  ),
+  orderNoChannel: text(
+    "Falta channel_id para elegir el canal. No se creó ninguna orden.",
+    "channel_id is missing, so no channel was chosen. No order was created.",
+    "Falta channel_id para escolher o canal. Nenhum pedido foi criado."
+  ),
+  orderSkipped: text(
+    "ORD-01 solo corre cuando lo nombras. No se creó ninguna orden.",
+    "ORD-01 runs only when you name it. No order was created.",
+    "ORD-01 só roda quando você o nomeia. Nenhum pedido foi criado."
+  ),
+  orderNoFix: text(
+    "No hay un arreglo automático para ORD-01. No se creó ninguna orden.",
+    "There is no automatic repair for ORD-01. No order was created.",
+    "Não há um reparo automático para ORD-01. Nenhum pedido foi criado."
+  ),
+  unbound: text(
+    "Este check todavía no tiene flujo en esta versión.",
+    "This check has no flow in this version yet.",
+    "Este check ainda não tem fluxo nesta versão."
+  ),
+  noManifests: text(
+    "Este repo no tiene apps/*/src/channel-manifest.json.",
+    "This repo has no apps/*/src/channel-manifest.json.",
+    "Este repo não tem apps/*/src/channel-manifest.json."
+  ),
+  duplicateId: text(
+    "channel_id {id} está en {left} y en {right}.",
+    "channel_id {id} is in {left} and in {right}.",
+    "channel_id {id} está em {left} e em {right}."
+  ),
+  noSafeFix: text(
+    "No hay un arreglo automático que no invente un channel_id. No cambié ningún archivo.",
+    "There is no automatic repair that does not invent a channel_id. No file was changed.",
+    "Não há um reparo automático que não invente um channel_id. Nenhum arquivo mudou."
+  ),
+  flowMissing: text(
+    "El canal {channel} le falta {field}.",
+    "Channel {channel} is missing {field}.",
+    "O canal {channel} falta {field}."
+  ),
+  flowNoChannel: text(
+    "Falta channel_id para elegir el canal.",
+    "channel_id is missing, so no channel was chosen.",
+    "Falta channel_id para escolher o canal."
+  ),
+  noSafeChange: text(
+    "No hay un arreglo automático que no invente datos. No cambié nada.",
+    "There is no automatic repair that does not invent data. Nothing was changed.",
+    "Não há um reparo automático que não invente dados. Nada foi alterado."
+  ),
+  namedOrder: text(
+    "{id} solo corre cuando lo nombras. No se creó ninguna orden.",
+    "{id} runs only when you name it. No order was created.",
+    "{id} só roda quando você o nomeia. Nenhum pedido foi criado."
+  ),
+  strictSkipped: text(
+    "Modo estricto: hay checks omitidos.",
+    "Strict mode: some checks were skipped.",
+    "Modo estrito: há checks omitidos."
+  ),
+  yes: text("sí", "yes", "sim"),
+  no: text("no", "no", "não")
+} as const;

package/src/commands/doctor/client/flow.ts

@@ -0,0 +1,182 @@
+import type { Copy, Locale } from "../../../core/i18n";
+import { translate } from "../../../core/i18n";
+import type { LiveSession } from "../live/live.session";
+import { createLiveSession } from "../live/live.session";
+import type { CheckFail, CheckSkip } from "../live/result";
+import { channelLabel, paymentOf } from "./config";
+import { COPY } from "./copy";
+import { liveConfigOf } from "./order";
+import type { CheckBinding, Outcome, RunCtx } from "./runner";
+import type { YamlChannel } from "./yaml";
+
+export const textOf = (value: string | null | undefined) => {
+  return value?.trim() ?? "";
+};
+
+export const isRecord = (value: unknown): value is Record<string, unknown> => {
+  return !!value && typeof value === "object" && !Array.isArray(value);
+};
+
+export const isOutcome = (value: unknown): value is Outcome => {
+  if (!isRecord(value)) return false;
+  const status = value.status;
+  if (status !== "pass" && status !== "fail" && status !== "skip") return false;
+  return true;
+};
+
+export const say = (
+  locale: Locale,
+  status: Outcome["status"],
+  copy: Copy,
+  vars?: Record<string, string | number>
+): Outcome => {
+  return { status, detail: translate(locale, copy, vars) };
+};
+
+export const chooseChannel = (ctx: RunCtx): YamlChannel | Outcome => {
+  const { channels, channelId, locale } = ctx;
+  if (channelId) {
+    const found = channels.find(item => item.channel_id === channelId);
+    if (found) return found;
+    const detail = translate(locale, COPY.unknownChannel, { id: channelId });
+    return { status: "fail", detail };
+  }
+  if (channels.length !== 1) {
+    return say(locale, "fail", COPY.flowNoChannel);
+  }
+  const only = channels[0];
+  if (!only) return say(locale, "fail", COPY.flowNoChannel);
+  return only;
+};
+
+export const fieldGap = (
+  channel: YamlChannel,
+  env: NodeJS.ProcessEnv,
+  fields: readonly string[]
+) => {
+  for (const field of fields) {
+    if (field.startsWith("FIRESPARK_")) {
+      if (!textOf(env[field])) return field;
+      continue;
+    }
+    if (field === "payment") {
+      const payment = channel.payment ? paymentOf(channel.payment) : null;
+      if (!payment) return "payment";
+      continue;
+    }
+    const bag = channel as unknown as Record<string, unknown>;
+    const value = bag[field];
+    if (typeof value !== "string" || !value.trim()) return field;
+  }
+  return "";
+};
+
+export const prepare = (ctx: RunCtx, fields: readonly string[]) => {
+  const chosen = chooseChannel(ctx);
+  if (isOutcome(chosen)) return chosen;
+  const field = fieldGap(chosen, ctx.env, fields);
+  if (!field) return chosen;
+  const channel = channelLabel(chosen);
+  const vars = { channel, field };
+  return say(ctx.locale, "fail", COPY.flowMissing, vars);
+};
+
+export const fromLive = (
+  locale: Locale,
+  result: CheckFail | CheckSkip
+): Outcome => {
+  const detail = translate(locale, result.reason.copy, result.reason.vars);
+  if (result.status === "skip") return { status: "skip", detail };
+  return { status: "fail", detail: `${result.hop}: ${detail}` };
+};
+
+export const openLive = (ctx: RunCtx, channel: YamlChannel): LiveSession => {
+  const config = liveConfigOf(channel, ctx.env);
+  return createLiveSession(config, { fetch }, ctx.redactor);
+};
+
+export const rowsOf = (value: unknown) => {
+  if (!Array.isArray(value)) return [];
+  return value.filter(isRecord);
+};
+
+export const queryOf = (path: string, pairs: Record<string, string>) => {
+  const params = new URLSearchParams();
+  for (const [key, value] of Object.entries(pairs)) {
+    if (value) params.set(key, value);
+  }
+  const query = params.toString();
+  if (!query) return path;
+  return `${path}?${query}`;
+};
+
+export const isLocalHost = (value: string) => {
+  try {
+    const host = new URL(value).hostname.toLowerCase();
+    if (host === "localhost" || host === "0.0.0.0") return true;
+    if (host === "127.0.0.1" || host === "::1") return true;
+    return host.endsWith(".local");
+  } catch {
+    return true;
+  }
+};
+
+export const withQuery = (url: string, key: string, value: string) => {
+  const parsed = new URL(url);
+  parsed.searchParams.set(key, value);
+  return parsed.toString();
+};
+
+export const readPage = async (url: string) => {
+  const signal = AbortSignal.timeout(15000);
+  const response = await fetch(url, { signal });
+  const body = await response.text();
+  return { status: response.status, body };
+};
+
+export const namedOrderSkip = (ctx: RunCtx, id: string): Outcome | null => {
+  if (ctx.named.has(id)) return null;
+  return say(ctx.locale, "skip", COPY.namedOrder, { id });
+};
+
+export const trpcCall = async (
+  base: string,
+  cookie: string,
+  procedure: string,
+  input: unknown
+) => {
+  const root = base.replace(/\/$/, "");
+  const url = `${root}/api/trpc/${procedure}`;
+  const headers = { "content-type": "application/json", cookie };
+  const signal = AbortSignal.timeout(15000);
+  const body = JSON.stringify({ json: input });
+  const init = { method: "POST", headers, body, signal };
+  try {
+    const response = await fetch(url, init);
+    const text = await response.text();
+    return { status: response.status, text };
+  } catch {
+    return { status: 0, text: "" };
+  }
+};
+
+export const withSafeFix = (
+  run: (ctx: RunCtx) => Promise<Outcome>
+): CheckBinding => {
+  const fix = async (ctx: RunCtx): Promise<Outcome> => {
+    const result = await run(ctx);
+    if (result.status !== "fail") return result;
+    const note = translate(ctx.locale, COPY.noSafeChange);
+    const detail = result.detail ? `${note} ${result.detail}` : note;
+    const failed: Outcome = { status: "fail", detail };
+    return failed;
+  };
+  return { kind: "script", run, fix };
+};
+
+export const ACTIVE = "ACTIVE";
+
+export const isActive = (row: Record<string, unknown>) => {
+  if (!("status" in row)) return true;
+  return row.status === ACTIVE;
+};