supcoflow 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,6 +26,10 @@ npx supcoflow login
26
26
  | `supcoflow repo conectar` | Conecta el repo de esta carpeta con la App de GitHub: te da un enlace, lo confirmás en la consola. Sin terminal, `--start` y después `--wait`, como `login`. |
27
27
  | `supcoflow proyecto crear` | Crea (o reusa) el proyecto del repo ya conectado y lo anota en `.supcoflow/proyecto.json`. Si el motor no deduce los comandos, `--install "…" --test "…"`. |
28
28
  | `supcoflow proyecto ver` | El proyecto del repo: rama, comandos y el estado de la App de GitHub. |
29
+ | `supcoflow guia revisar` | Revisa `.supcoflow/guia.md` contra el motor sin publicar nada. |
30
+ | `supcoflow guia publicar` | Sube `.supcoflow/guia.md` directo (con el commit y la rama que declara tu clon, no verificados en GitHub). `--desde-github` verifica contra la rama principal en vez de subir el archivo. |
31
+ | `supcoflow guia ver` | Muestra la guía activa, de dónde viene y si la rama sigue al día. |
32
+ | `supcoflow guia usar --origen repo\|agente` | Elige cuál guía queda activa. |
29
33
  | `supcoflow describir --json` | Todo el contrato (comandos, flags, facultades de la clave, códigos) en una línea de JSON. |
30
34
 
31
35
  `supcoflow --help` (o `supcoflow <comando> --help`) muestra la ayuda con ejemplos. Los comandos de
@@ -68,7 +72,7 @@ los que escriben aceptan `--dry-run`.
68
72
  |---|---|
69
73
  | `supcoflow catalogo` | Qué se puede configurar y con qué valores. |
70
74
  | `supcoflow configuracion` | Chat, sitios, marca y acuerdo de datos del proyecto. |
71
- | `supcoflow chat prender` / `chat apagar` | Prende o apaga el chat (sin skill aprobada, prender sale 4). |
75
+ | `supcoflow chat prender` / `chat apagar` | Prende o apaga el chat (hace falta una guía: publicá la del repo con `supcoflow guia publicar` o generá y aprobá la de nuestro agente en Brain). |
72
76
  | `supcoflow chat marca --titulo "Ayuda" --tema acento=#0a7` | Título, saludo y colores; lo no nombrado queda igual. |
73
77
  | `supcoflow chat logo --archivo logo.png` | Sube el logo (.png, .jpg o .webp, hasta 200 KB). |
74
78
  | `supcoflow sitios agregar\|quitar --sitio https://app.ejemplo.com` | Sitios desde los que carga el chat. |
@@ -77,6 +81,42 @@ los que escriben aceptan `--dry-run`.
77
81
  | `supcoflow claves crear --nombre ci --guardar-en ~/ci.key` | Clave de consulta para CI: el secreto queda sólo en ese archivo (0600, fuera de un repo), nunca en la salida. |
78
82
  | `supcoflow claves listar` / `claves revocar --id cla_…` | Ver y revocar claves de consulta. |
79
83
 
84
+ ## La guía
85
+
86
+ La guía le cuenta al chat qué hace cada pantalla de tu producto. Vive en el repo, en
87
+ `.supcoflow/guia.md` (en la raíz). El flujo, en este orden:
88
+
89
+ 1. `supcoflow guia revisar`: la revisa contra el motor sin publicar nada (si está mal armada, sale 3 con la línea de cada error).
90
+ 2. `supcoflow guia publicar`: sube el archivo directo y queda como guía activa. Manda también el commit y la rama de tu
91
+ clon (`git rev-parse HEAD`, si hay git y commits; si no, va sin commit): son declarados por la terminal, no
92
+ verificados en GitHub, y así se muestran. Repetir con el mismo archivo no duplica.
93
+ 3. Opcional, `supcoflow guia publicar --desde-github`: no sube el archivo; manda su huella y el motor la compara con la
94
+ de la rama principal de GitHub (commit verificado). Si todavía no está subida (o la rama tiene otra), sale 5:
95
+ subí la guía a la rama principal y volvé a correr.
96
+
97
+ `supcoflow guia ver` muestra la guía activa y si la rama sigue al día (`al_dia` en el JSON);
98
+ `supcoflow guia usar --origen repo|agente` elige cuál queda activa cuando hay una del repo y otra de nuestro agente.
99
+ Todos toman el repo del `origin`, o `--repo owner/repo` (con `revisar` y `publicar`, sin clon local de ese repo sale 3 `falta_guia`: la guía se lee del archivo); `revisar`, `publicar` y `usar` aceptan `--dry-run`; `--desde-github` es sólo de `publicar`.
100
+
101
+ El formato de `.supcoflow/guia.md`:
102
+
103
+ ```markdown
104
+ # Guía de Mi App ← opcional; se ignora
105
+
106
+ ## Facturas ← una sección por pantalla o función (1 a 60). Nombre: 1–120 caracteres
107
+ Para qué sirve: Ver y pagar las facturas del mes. ← obligatorio, 1–600
108
+ Qué puede hacer el usuario: Descargar el PDF, pagar con ← obligatorio, 1–600; puede seguir
109
+ tarjeta y ver el historial. en las líneas de abajo
110
+ Problemas comunes: ← opcional; hasta 10, cada uno 1–300
111
+ - El botón Pagar no responde con tarjetas de débito.
112
+ - El PDF sale en blanco en Safari.
113
+ ```
114
+
115
+ - Las etiquetas se reconocen al principio de la línea, sin distinguir mayúsculas y con o sin tildes
116
+ («Para que sirve:» vale). Una línea que no es etiqueta continúa el campo anterior (se une con un espacio).
117
+ - Texto antes del primer `## ` que no sea el `# ` del título → error. Una etiqueta repetida en una sección →
118
+ error. Una línea con `<` o `>` → error. Más de 64 KB → `guia_muy_grande`.
119
+
80
120
  ## El contrato
81
121
 
82
122
  Pensado para que lo lea un programa, no sólo una persona:
@@ -86,7 +126,7 @@ Pensado para que lo lea un programa, no sólo una persona:
86
126
  - **Sin preguntas sin terminal interactiva** (o con `--json`): si falta un dato, sale 3 diciendo qué
87
127
  flag usar. `supcoflow login` sin terminal sale 3 y te indica el camino en dos pasos.
88
128
  - **`--dry-run`** donde se puede simular (`login`, `login --start`, `logout`, `repo conectar --start`,
89
- `proyecto crear`). `login --wait
129
+ `proyecto crear`, `guia revisar`, `guia publicar`, `guia usar`). `login --wait
90
130
  --dry-run` sale 3: sondear consume el código y no hay cómo simularlo.
91
131
 
92
132
  | Código | Quiere decir |
package/dist/api.js CHANGED
@@ -21,9 +21,9 @@ export function urlDeLaApi(env) {
21
21
  return new URL(u.origin);
22
22
  throw invalida();
23
23
  }
24
- // A mano a propósito: tiene que coincidir con package.json (0.3.0); sólo identifica a la terminal
24
+ // A mano a propósito: tiene que coincidir con package.json (0.5.0); sólo identifica a la terminal
25
25
  // en los logs del motor, no decide nada.
26
- const VERSION = "0.3.0";
26
+ const VERSION = "0.5.0";
27
27
  const PLAZO_POR_DEFECTO_MS = 15_000;
28
28
  // Los dos POST que crean algo: detrás, el motor acuña con Vercel Connect y le pregunta a GitHub varias
29
29
  // veces (instalación, repos, comandos, rama). Con 15 s una respuesta lenta pero buena se cortaba y
@@ -293,3 +293,22 @@ export async function esClaveDeConsultaDelProyecto(api, clave, proyectoId, f) {
293
293
  throw inesperada(r.status);
294
294
  return r.cuerpo.via === "clave_de_consulta" && r.cuerpo.proyecto === proyectoId;
295
295
  }
296
+ // ---- La guía (bloque 5) ----
297
+ // Devuelven la respuesta entera: qué significa cada 409/422 lo decide el comando (`guia_no_subida` es
298
+ // un código de salida propio; `guia_mal_armada` lleva la lista de errores por línea).
299
+ const rutaDeLaGuia = (proyectoId) => `/api/proyectos/${encodeURIComponent(proyectoId)}/guia`;
300
+ export function revisarGuia(api, clave, proyectoId, contenido, f) {
301
+ return conClave(api, clave, `${rutaDeLaGuia(proyectoId)}/revisar`, { method: "POST", headers: JSON_BODY, body: JSON.stringify({ contenido }) }, f);
302
+ }
303
+ export function publicarGuia(api, clave, proyectoId, cuerpo, f) {
304
+ // La vía de GitHub acuña con Connect y le pregunta a GitHub por la rama: el mismo plazo que las altas (la directa no
305
+ // llama a GitHub, pero comparte el plazo para no tener dos reglas).
306
+ return conClave(api, clave, `${rutaDeLaGuia(proyectoId)}/publicar`, { method: "POST", headers: JSON_BODY, body: JSON.stringify(cuerpo) }, f, PLAZO_DE_ALTA_MS);
307
+ }
308
+ // Siempre con `comprobar=1`: `guia ver` quiere el `al_dia` de la rama; el motor lo ignora si el origen no es el repo.
309
+ export function leerGuia(api, clave, proyectoId, f) {
310
+ return conClave(api, clave, `${rutaDeLaGuia(proyectoId)}?comprobar=1`, { method: "GET" }, f, PLAZO_DE_ALTA_MS);
311
+ }
312
+ export function elegirOrigen(api, clave, proyectoId, origen, f) {
313
+ return conClave(api, clave, `${rutaDeLaGuia(proyectoId)}/origen`, { method: "POST", headers: JSON_BODY, body: JSON.stringify({ origen }) }, f);
314
+ }
@@ -4,11 +4,12 @@ export const COMANDOS_COMPUESTOS = [
4
4
  "repo conectar", "proyecto crear", "proyecto ver",
5
5
  "chat prender", "chat apagar", "chat marca", "chat logo", "sitios agregar", "sitios quitar",
6
6
  "datos fijar", "politica fijar", "claves crear", "claves listar", "claves revocar",
7
+ "guia revisar", "guia publicar", "guia ver", "guia usar",
7
8
  ];
8
9
  // Sólo estas primeras palabras admiten una segunda: cualquier otro par sigue siendo «de más».
9
10
  const PRIMERAS_PALABRAS = new Set(COMANDOS_COMPUESTOS.map((c) => c.split(" ")[0]));
10
11
  const FLAGS_CON_VALOR = [
11
- "repo", "install", "test", "sitio", "titulo", "saludo", "archivo", "permitir", "modo", "nombre", "guardar-en", "id",
12
+ "repo", "install", "test", "sitio", "titulo", "saludo", "archivo", "permitir", "modo", "nombre", "guardar-en", "id", "origen",
12
13
  ];
13
14
  // strict: un flag mal escrito (`--estart`) no se ignora en silencio: un asistente creería que
14
15
  // pidió algo que no pidió.
@@ -37,6 +38,8 @@ export function leerArgumentos(argv) {
37
38
  nombre: { type: "string" },
38
39
  "guardar-en": { type: "string" },
39
40
  id: { type: "string" },
41
+ origen: { type: "string" },
42
+ "desde-github": { type: "boolean" },
40
43
  tema: { type: "string", multiple: true },
41
44
  },
42
45
  tokens: true,
@@ -92,6 +95,8 @@ export function leerArgumentos(argv) {
92
95
  nombre: v.nombre ?? null,
93
96
  guardarEn: v["guardar-en"] ?? null,
94
97
  id: v.id ?? null,
98
+ origen: v.origen ?? null,
99
+ desdeGithub: v["desde-github"] === true,
95
100
  tema: v.tema ?? [],
96
101
  },
97
102
  };
package/dist/cli.js CHANGED
@@ -6,6 +6,7 @@ import { revocarPropia } from "./api.js";
6
6
  import { leerArgumentos } from "./argumentos.js";
7
7
  import { clavesCrear, clavesListar, clavesRevocar } from "./comandos/claves.js";
8
8
  import { chatLogo, chatMarca, chatPrenderApagar, comandoConfiguracion, sitios } from "./comandos/configurar.js";
9
+ import { guiaPublicar, guiaRevisar, guiaUsar, guiaVer } from "./comandos/guia.js";
9
10
  import { comandoCatalogo, datosFijar, politicaFijar } from "./comandos/datos-y-politica.js";
10
11
  import { ayuda, comandoDescribir, DESCRIPCION } from "./comandos/describir.js";
11
12
  import { loginInteractivo, loginStart, loginWait } from "./comandos/login.js";
@@ -36,7 +37,7 @@ async function correr(argv) {
36
37
  start: flags.start, wait: flags.wait, repo: flags.repo !== null, install: flags.install !== null, test: flags.test !== null,
37
38
  sitio: flags.sitio !== null, titulo: flags.titulo !== null, saludo: flags.saludo !== null, tema: flags.tema.length > 0,
38
39
  archivo: flags.archivo !== null, permitir: flags.permitir !== null, modo: flags.modo !== null,
39
- nombre: flags.nombre !== null, guardarEn: flags.guardarEn !== null, id: flags.id !== null,
40
+ nombre: flags.nombre !== null, guardarEn: flags.guardarEn !== null, id: flags.id !== null, origen: flags.origen !== null, desdeGithub: flags.desdeGithub,
40
41
  };
41
42
  const noAplica = flagQueNoAplica(comando, Object.keys(presentes).filter((k) => presentes[k]));
42
43
  if (noAplica !== null)
@@ -114,6 +115,14 @@ async function correr(argv) {
114
115
  return { r: await clavesListar(e.claves, flags), json };
115
116
  case "claves revocar":
116
117
  return { r: await clavesRevocar(e.claves, flags), json };
118
+ case "guia revisar":
119
+ return { r: await guiaRevisar(e.guia, flags), json };
120
+ case "guia publicar":
121
+ return { r: await guiaPublicar(e.guia, flags), json };
122
+ case "guia ver":
123
+ return { r: await guiaVer(e.guia, flags), json };
124
+ case "guia usar":
125
+ return { r: await guiaUsar(e.guia, flags), json };
117
126
  }
118
127
  throw new Error(`comando sin despacho: ${comando}`);
119
128
  }
@@ -3,7 +3,7 @@
3
3
  // ayuda pensada para personas. La ayuda se arma desde acá: una sola fuente, así no se desfasan.
4
4
  import { SALIDA } from "../contrato.js";
5
5
  // A mano a propósito, como en api.ts: tiene que coincidir con package.json (lo pinza un test).
6
- const VERSION = "0.3.0";
6
+ const VERSION = "0.5.0";
7
7
  export const DESCRIPCION = {
8
8
  version: VERSION,
9
9
  comandos: [
@@ -89,7 +89,7 @@ export const DESCRIPCION = {
89
89
  },
90
90
  {
91
91
  nombre: "chat prender",
92
- resumen: "Prende el chat de soporte del proyecto. Sin skill aprobada hace falta una persona (sale 4).",
92
+ resumen: "Prende el chat de soporte del proyecto. Hace falta una guía vigente (la publicada del repo o la aprobada de nuestro agente); si no, sale 4 (skill_no_aprobada).",
93
93
  flags: ["--repo owner/repo: el repo, si no es el «origin» de esta carpeta", "--dry-run: dice qué haría sin hacerlo", "--json"],
94
94
  ejemplos: ["supcoflow chat prender --json"],
95
95
  codigos: [0, 1, 2, 3, 4],
@@ -182,17 +182,45 @@ export const DESCRIPCION = {
182
182
  ejemplos: ["supcoflow claves revocar --id cla_0123456789abcdef --json"],
183
183
  codigos: [0, 1, 2, 3, 4],
184
184
  },
185
+ {
186
+ nombre: "guia revisar",
187
+ resumen: "Revisa .supcoflow/guia.md (la raíz de este clon) contra el motor, sin publicar nada: dice si está bien armada y cuántas secciones tiene. Es el paso antes del commit.",
188
+ flags: ["--repo owner/repo: el repo, si no es el «origin» de esta carpeta (sin clon local sale 3 falta_guia: la guía se lee del archivo)", "--dry-run: dice qué mandaría sin mandarlo", "--json"],
189
+ ejemplos: ["supcoflow guia revisar --json"],
190
+ codigos: [0, 1, 2, 3, 4],
191
+ },
192
+ {
193
+ nombre: "guia publicar",
194
+ resumen: "Sube .supcoflow/guia.md directo: manda el contenido y el commit y la rama que declara este clon (si hay git y commits; si no, sin commit). El motor la revisa y la deja como guía activa; el commit queda como «declarado por la terminal, no verificado en GitHub». Con --desde-github conserva la vía anterior: manda la huella y el motor la compara con la de la rama principal; si todavía no está subida a esa rama (o es otra), sale 5.",
195
+ flags: ["--desde-github: no sube el archivo; verifica contra la rama principal de GitHub (sale 5 guia_no_subida / guia_distinta si no coincide)", "--repo owner/repo: el repo, si no es el «origin» de esta carpeta (sin clon local sale 3 falta_guia: la guía se lee del archivo)", "--dry-run: dice qué mandaría (o la huella con --desde-github), sin pedir nada", "--json"],
196
+ ejemplos: ["supcoflow guia publicar --json"],
197
+ codigos: [0, 1, 2, 3, 4, 5],
198
+ },
199
+ {
200
+ nombre: "guia ver",
201
+ resumen: "Muestra la guía activa del proyecto, de dónde viene y si la rama principal sigue teniendo esa versión (`al_dia` en el JSON).",
202
+ flags: ["--repo owner/repo: el repo, si no es el «origin» de esta carpeta", "--json"],
203
+ ejemplos: ["supcoflow guia ver --json"],
204
+ codigos: [0, 1, 2, 3, 4],
205
+ },
206
+ {
207
+ nombre: "guia usar",
208
+ resumen: "Elige cuál guía queda activa cuando hay dos: la del repo o la de nuestro agente.",
209
+ flags: ["--origen repo|agente: cuál queda activa (obligatorio)", "--repo owner/repo: el repo, si no es el «origin» de esta carpeta", "--dry-run: dice qué haría sin hacerlo", "--json"],
210
+ ejemplos: ["supcoflow guia usar --origen repo --json"],
211
+ codigos: [0, 1, 2, 3, 4],
212
+ },
185
213
  ],
186
214
  flags_globales: ["--json: el resultado en una línea de JSON por stdout; los avisos van por stderr", "--help, -h: la ayuda con ejemplos"],
187
215
  facultades: [
188
216
  {
189
217
  nombre: "consultar",
190
- incluye: "Identidad y equipo, proyectos, configuración, casos, issues, runs, costos, estado de la instalación",
218
+ incluye: "Identidad y equipo, proyectos, configuración, casos, issues, runs, costos, estado de la instalación, leer y revisar la guía (guia revisar, guia ver)",
191
219
  con_api_key: true,
192
220
  },
193
221
  {
194
222
  nombre: "configurar",
195
- incluye: "Crear/reusar proyecto, conectar o desconectar el repo, configurar y prender el chat, sitios permitidos, acuerdo de datos, política de problemas, publicar la guía, crear y revocar claves de consulta, perfiles de los agentes",
223
+ incluye: "Crear/reusar proyecto, conectar o desconectar el repo, configurar y prender el chat, sitios permitidos, acuerdo de datos, política de problemas, publicar la guía, elegir la guía activa (guia usar), crear y revocar claves de consulta, perfiles de los agentes",
196
224
  con_api_key: true,
197
225
  },
198
226
  { nombre: "probar", incluye: "La prueba hasta el issue (gasta, dentro de los topes)", con_api_key: true },
@@ -0,0 +1,244 @@
1
+ // src/comandos/guia.ts
2
+ // `guia revisar|publicar|ver|usar` (bloque 5): la guía del producto que vive en el repo del cliente
3
+ // (`.supcoflow/guia.md`). La terminal NO decide qué es una guía buena —eso lo decide el parser del motor—;
4
+ // lee el archivo, manda UN pedido y traduce la respuesta a los códigos de salida del contrato.
5
+ import path from "node:path";
6
+ import { resultadoDeFallo, SALIDA, taparSecretos } from "../contrato.js";
7
+ import { huellaDeGuia, MAX_BYTES_DE_LA_GUIA, RUTA_DE_LA_GUIA } from "../guia.js";
8
+ import { repoPedido } from "../repo-local.js";
9
+ import { desenlace, fallo, rutaDe } from "./configurar.js";
10
+ import { proyectoDelRepo } from "./proyecto-del-repo.js";
11
+ // Texto que viene del motor (o del repo, vía el motor) y sale a la terminal de una persona: sin secretos y sin
12
+ // caracteres de control (C0, DEL, C1), que un ESC movería el cursor. Texto y JSON salen del mismo texto ya limpio.
13
+ // Primero se quita el control y recién después se tapan los secretos: al revés, una clave partida por un
14
+ // control (U+0085, por ejemplo) quedaba entera al quitarlo y se imprimía sin tapar.
15
+ const limpio = (t) => taparSecretos(t.replace(/[\u0000-\u001f\u007f-\u009f]/g, ""));
16
+ const cadena = (v) => (typeof v === "string" ? limpio(v) : "");
17
+ const corto = (commit) => cadena(commit).slice(0, 7);
18
+ const secciones = (n) => (typeof n === "number" ? `${n} ${n === 1 ? "sección" : "secciones"}` : "secciones sin contar");
19
+ const NOMBRE_DEL_ORIGEN = { repo: "la del repo", agente: "la de nuestro agente" };
20
+ // ─── El archivo local ───
21
+ // Se busca en la raíz de ESTE clon, nunca en el cwd: parado en una subcarpeta sigue siendo la guía del repo.
22
+ // Con `--repo` y sin clon de ese repo no hay dónde leerla (publicar lee la rama, pero la huella sale del archivo).
23
+ async function leerLaGuia(d, flags) {
24
+ let raiz;
25
+ try {
26
+ raiz = (await repoPedido({ flagRepo: flags.repo, git: d.git, cwd: d.cwd })).raiz;
27
+ }
28
+ catch (e) {
29
+ return { ok: false, resultado: resultadoDeFallo(e) };
30
+ }
31
+ if (raiz === null) {
32
+ return { ok: false, resultado: fallo(SALIDA.entradaInvalida, "falta_guia", `No tengo el clon de ese repo acá, y la guía se lee de ${RUTA_DE_LA_GUIA}: parate en el clon del repo.`) };
33
+ }
34
+ const leido = d.leerArchivoChico(path.join(raiz, RUTA_DE_LA_GUIA), MAX_BYTES_DE_LA_GUIA);
35
+ if ("error" in leido) {
36
+ if (leido.error === "no existe")
37
+ return { ok: false, resultado: fallo(SALIDA.entradaInvalida, "falta_guia", `Falta ${RUTA_DE_LA_GUIA} en el repo: escribila (una sección por pantalla) y volvé a correr.`) };
38
+ if (leido.error === "es demasiado grande")
39
+ return { ok: false, resultado: fallo(SALIDA.entradaInvalida, "guia_muy_grande", `${RUTA_DE_LA_GUIA} pasa los ${MAX_BYTES_DE_LA_GUIA / 1024} KB: acortala.`) };
40
+ return { ok: false, resultado: fallo(SALIDA.entradaInvalida, "guia_ilegible", `No leo ${RUTA_DE_LA_GUIA}: ${limpio(leido.error)}.`) };
41
+ }
42
+ try {
43
+ // ignoreBOM: el BOM se CONSERVA en el texto; quitarlo es regla de la huella (`huellaDeGuia`), no de la lectura.
44
+ // fatal: un byte inválido no se reemplaza en silencio, porque la huella de GitHub no coincidiría nunca.
45
+ return { ok: true, raiz, texto: new TextDecoder("utf-8", { fatal: true, ignoreBOM: true }).decode(leido.bytes) };
46
+ }
47
+ catch {
48
+ return { ok: false, resultado: fallo(SALIDA.entradaInvalida, "guia_ilegible", `${RUTA_DE_LA_GUIA} no es UTF-8 válido.`) };
49
+ }
50
+ }
51
+ // ─── El desenlace propio de la guía, encima del de configurar ───
52
+ function desenlaceDeGuia(r, ok) {
53
+ const c = r.cuerpo;
54
+ // 2xx, 401, 5xx y cuerpos raros los resuelve el de configurar. Ojo: la terminal no distingue 500
55
+ // connect_no_disponible de 502 github_no_disponible (ambos llegan como falla del servicio): los dos son 1.
56
+ if (r.status < 400 || r.status === 401 || r.status >= 500 || typeof c !== "object" || c === null)
57
+ return desenlace(r, ok);
58
+ const error = typeof c.error === "string" ? c.error : "rechazado";
59
+ const message = limpio(typeof c.message === "string" ? c.message : `El motor rechazó el pedido (${r.status}).`);
60
+ const con = (codigo, extra = {}, texto = message) => ({ codigo, json: { ok: false, error, message: taparSecretos(message), ...extra }, texto });
61
+ switch (error) {
62
+ case "guia_no_subida":
63
+ case "guia_distinta": {
64
+ const rama = cadena(c.rama), commit = cadena(c.commit);
65
+ const donde = rama !== "" ? ` (rama ${rama}${commit !== "" ? `, commit ${corto(commit)}` : ""})` : "";
66
+ const que = error === "guia_no_subida" ? "La guía no está en la rama principal del repo" : "La guía de la rama principal es otra, no la de tu archivo";
67
+ return con(SALIDA.esperandoAUnaPersona, { rama: c.rama ?? null, commit: c.commit ?? null }, `${que}${donde}: subí la guía a la rama principal y volvé a correr.`);
68
+ }
69
+ case "instalacion_ausente":
70
+ case "repo_fuera_de_alcance":
71
+ case "sin_guia_del_agente":
72
+ return con(SALIDA.haceFaltaUnaPersona);
73
+ case "guia_mal_armada": {
74
+ const errores = Array.isArray(c.errores) ? c.errores : [];
75
+ const lineas = errores.map((e) => {
76
+ const x = (e ?? {});
77
+ return `línea ${typeof x.linea === "number" ? x.linea : "?"}: ${cadena(x.motivo)}`;
78
+ });
79
+ return con(SALIDA.entradaInvalida, { errores: errores.map((e) => { const x = (e ?? {}); return { linea: x.linea ?? null, motivo: taparSecretos(typeof x.motivo === "string" ? x.motivo : "") }; }) }, [`${RUTA_DE_LA_GUIA} está mal armada:`, ...lineas].join("\n"));
80
+ }
81
+ default:
82
+ return desenlace(r, ok);
83
+ }
84
+ }
85
+ export async function guiaRevisar(d, flags) {
86
+ const g = await leerLaGuia(d, flags);
87
+ if (!g.ok)
88
+ return g.resultado;
89
+ const p = await proyectoDelRepo(d, flags);
90
+ if (!p.ok)
91
+ return p.resultado;
92
+ if (flags.dryRun) {
93
+ const haria = `POST ${rutaDe(p.proyecto, "/guia/revisar")} (${new TextEncoder().encode(g.texto).length} bytes)`;
94
+ return { codigo: SALIDA.ok, json: { ok: true, dry_run: true, haria }, texto: `Con --dry-run no hago nada; sin él: ${haria}.` };
95
+ }
96
+ try {
97
+ return desenlaceDeGuia(await d.revisar(d.api, p.clave, p.proyecto.id, g.texto, d.fetch), (c) => ({
98
+ codigo: SALIDA.ok, json: { ok: true, secciones: c.secciones ?? null }, texto: `La guía está bien armada: ${secciones(c.secciones)}.`,
99
+ }));
100
+ }
101
+ catch (e) {
102
+ return resultadoDeFallo(e);
103
+ }
104
+ }
105
+ // Commit y rama que la terminal DECLARA: son del clon donde está el archivo, no verificados contra GitHub. Cualquier
106
+ // falla (sin git, sin commits, HEAD suelto, plazo vencido) devuelve vacío: declarar es un extra que nunca bloquea la
107
+ // subida ni pregunta nada, y lo que git imprima no sale a la terminal.
108
+ async function declarado(d, raiz) {
109
+ const leer = async (args) => {
110
+ try {
111
+ const r = await d.gitDeclarado(args, raiz);
112
+ return r.codigo === 0 ? r.stdout.trim() : null;
113
+ }
114
+ catch {
115
+ return null;
116
+ }
117
+ };
118
+ const commit = await leer(["rev-parse", "HEAD"]);
119
+ // Sin un commit de 40 hex no se manda ni la rama: una rama sin commit no dice de dónde salió la guía.
120
+ if (commit === null || !/^[0-9a-f]{40}$/.test(commit))
121
+ return {};
122
+ const rama = await leer(["rev-parse", "--abbrev-ref", "HEAD"]);
123
+ // «HEAD» a secas es la cabeza suelta: no es una rama.
124
+ return rama !== null && rama !== "" && rama !== "HEAD" ? { commit, rama } : { commit };
125
+ }
126
+ export async function guiaPublicar(d, flags) {
127
+ const g = await leerLaGuia(d, flags);
128
+ if (!g.ok)
129
+ return g.resultado;
130
+ const p = await proyectoDelRepo(d, flags);
131
+ if (!p.ok)
132
+ return p.resultado;
133
+ const github = flags.desdeGithub === true;
134
+ // La vía de GitHub manda la huella del archivo local TAL CUAL (con BOM y \r\n: normalizarla es regla de
135
+ // `huellaDeGuia`). La directa manda el contenido crudo y el motor calcula la huella: la terminal no la necesita.
136
+ const huella = github ? huellaDeGuia(g.texto) : null;
137
+ const decl = github ? {} : await declarado(d, g.raiz);
138
+ const cuerpo = huella !== null ? { huella } : { contenido: g.texto, ...decl };
139
+ const cuando = decl.commit ? `commit ${decl.commit.slice(0, 7)}${decl.rama ? ` de ${cadena(decl.rama)}` : ""} declarado` : "sin commit";
140
+ // El JSON del dry-run pasa por la misma limpieza que el texto (control primero, secretos después): la rama la
141
+ // decide quien escribió el clon, y un ESC en ella no debe llegar a la terminal por ninguna de las dos salidas.
142
+ if (flags.dryRun) {
143
+ const haria = huella !== null
144
+ ? `POST ${rutaDe(p.proyecto, "/guia/publicar")} con la huella ${huella.slice(0, 12)}…`
145
+ : `POST ${rutaDe(p.proyecto, "/guia/publicar")} con el contenido (${new TextEncoder().encode(g.texto).length} bytes), ${cuando}`;
146
+ const json = huella !== null ? { ok: true, dry_run: true, huella, haria } : { ok: true, dry_run: true, commit: decl.commit ? cadena(decl.commit) : null, rama: decl.rama ? cadena(decl.rama) : null, haria };
147
+ return { codigo: SALIDA.ok, json, texto: `Con --dry-run no hago nada; sin él: ${haria}.` };
148
+ }
149
+ try {
150
+ return desenlaceDeGuia(await d.publicar(d.api, p.clave, p.proyecto.id, cuerpo, d.fetch), (c) => {
151
+ const guia = (c.guia ?? {});
152
+ const ya = c.ya_publicada === true;
153
+ const rem = c.reemplaza;
154
+ const reemplaza = !ya && rem && rem.origen === "agente" && typeof rem.version === "number" ? ` (reemplaza a la de nuestro agente v${rem.version})` : "";
155
+ const json = { ok: true, guia: c.guia ?? null, ya_publicada: ya, reemplaza: c.reemplaza ?? null };
156
+ if (github) {
157
+ const base = `commit ${corto(guia.commit)} de ${cadena(guia.rama)}, ${secciones(guia.secciones)}`;
158
+ // Republicar re-activa la guía del repo aunque antes rigiera la de nuestro agente: «sigue siendo» mentiría en ese caso.
159
+ const texto = ya ? `Ya estaba publicada: ${base}. Quedó como guía activa.` : `Guía publicada: ${base}. Es la guía activa${reemplaza}.`;
160
+ return { codigo: SALIDA.ok, json, texto };
161
+ }
162
+ // El commit se muestra como lo que es: lo que la terminal dijo, no lo que GitHub confirmó.
163
+ const origen = decl.commit ? `commit ${decl.commit.slice(0, 7)} declarado por la terminal (no verificado en GitHub)` : "sin commit";
164
+ const texto = ya
165
+ ? `Ya estaba subida: ${secciones(guia.secciones)}. Quedó como guía activa; ${origen}.`
166
+ : `Guía subida: ${secciones(guia.secciones)}. Es la guía activa${reemplaza}; ${origen}.`;
167
+ return { codigo: SALIDA.ok, json: { ...json, commit_declarado: decl.commit ?? null }, texto };
168
+ });
169
+ }
170
+ catch (e) {
171
+ return resultadoDeFallo(e);
172
+ }
173
+ }
174
+ export async function guiaVer(d, flags) {
175
+ const p = await proyectoDelRepo(d, flags);
176
+ if (!p.ok)
177
+ return p.resultado;
178
+ try {
179
+ return desenlaceDeGuia(await d.ver(d.api, p.clave, p.proyecto.id, d.fetch), (c) => {
180
+ const guia = c.guia;
181
+ const otra = c.otra;
182
+ const rama = c.rama;
183
+ const alDia = rama && typeof rama.al_dia === "boolean" ? rama.al_dia : null;
184
+ const json = { ok: true, guia: guia ?? null, otra: otra ?? null, al_dia: alDia, rama: rama ?? null };
185
+ if (!guia)
186
+ return { codigo: SALIDA.ok, json, texto: "Este proyecto no tiene guía activa: `supcoflow guia publicar` sube la del repo." };
187
+ const lineas = [];
188
+ if (guia.origen === "repo") {
189
+ lineas.push(`Guía activa: ${NOMBRE_DEL_ORIGEN.repo} (versión ${guia.version}, ${secciones(guia.secciones)}).`);
190
+ if (guia.procedencia === "terminal") {
191
+ // Subida desde la terminal: el motor NO comparó nada contra GitHub a propósito (al_dia null), así que "no pude
192
+ // comprobar la rama" sería falso. Commit y rama son lo que declaró quien subió; el id crudo de quien publicó
193
+ // (usr_…) no le dice nada a una persona y la terminal no resuelve nombres: queda sólo en el JSON.
194
+ const commit = cadena(guia.commit), rama = cadena(guia.rama);
195
+ const partes = [cadena(guia.repo), rama !== "" ? `rama ${rama}` : "", commit !== "" ? `commit ${corto(commit)} (declarado)` : "sin commit declarado"].filter((x) => x !== "");
196
+ lineas.push(`Procedencia: ${partes.join(", ")}.`);
197
+ lineas.push("Subida desde la terminal; el commit es declarado, no verificado en GitHub.");
198
+ }
199
+ else {
200
+ lineas.push(`Procedencia: ${cadena(guia.repo)}, rama ${cadena(guia.rama)}, commit ${corto(guia.commit)}, publicada por ${cadena(guia.publicada_por)}.`);
201
+ if (alDia === true)
202
+ lineas.push("Está al día con la rama.");
203
+ else if (alDia === false)
204
+ lineas.push("En la rama hay otra versión: corré `supcoflow guia publicar`.");
205
+ else
206
+ lineas.push("No pude comprobar la rama ahora.");
207
+ }
208
+ }
209
+ else {
210
+ lineas.push(`Guía activa: ${NOMBRE_DEL_ORIGEN.agente} (v${guia.version}, ${secciones(guia.secciones)}).`);
211
+ lineas.push("Procedencia: la escribió nuestro agente y la aprobó una persona.");
212
+ }
213
+ if (otra && (otra.origen === "repo" || otra.origen === "agente")) {
214
+ lineas.push(`También hay ${NOMBRE_DEL_ORIGEN[otra.origen]} (v${typeof otra.version === "number" ? otra.version : "?"}): \`supcoflow guia usar --origen ${otra.origen}\` la activa.`);
215
+ }
216
+ return { codigo: SALIDA.ok, json, texto: lineas.join("\n") };
217
+ });
218
+ }
219
+ catch (e) {
220
+ return resultadoDeFallo(e);
221
+ }
222
+ }
223
+ export async function guiaUsar(d, flags) {
224
+ const origen = flags.origen ?? null;
225
+ if (origen === null)
226
+ return fallo(SALIDA.entradaInvalida, "falta_origen", "Decí cuál: `supcoflow guia usar --origen repo` o `--origen agente`.");
227
+ if (origen !== "repo" && origen !== "agente")
228
+ return fallo(SALIDA.entradaInvalida, "origen_invalido", "--origen es `repo` o `agente`.");
229
+ const p = await proyectoDelRepo(d, flags);
230
+ if (!p.ok)
231
+ return p.resultado;
232
+ if (flags.dryRun) {
233
+ const haria = `POST ${rutaDe(p.proyecto, "/guia/origen")} {origen: ${origen}}`;
234
+ return { codigo: SALIDA.ok, json: { ok: true, dry_run: true, haria }, texto: `Con --dry-run no hago nada; sin él: ${haria}.` };
235
+ }
236
+ try {
237
+ return desenlaceDeGuia(await d.elegir(d.api, p.clave, p.proyecto.id, origen, d.fetch), (c) => ({
238
+ codigo: SALIDA.ok, json: { ok: true, guia: c.guia ?? null }, texto: `Ahora la guía activa es ${NOMBRE_DEL_ORIGEN[origen]}.`,
239
+ }));
240
+ }
241
+ catch (e) {
242
+ return resultadoDeFallo(e);
243
+ }
244
+ }
package/dist/entorno.js CHANGED
@@ -5,7 +5,7 @@ import { randomUUID } from "node:crypto";
5
5
  import { chmodSync, closeSync, constants, fchmodSync, fstatSync, linkSync, lstatSync, mkdirSync, openSync, readFileSync, readSync, realpathSync, renameSync, rmSync, writeSync, } from "node:fs";
6
6
  import { homedir, hostname } from "node:os";
7
7
  import { basename, dirname, join } from "node:path";
8
- import { buscarProyecto, canjear, configurar, crearConexion, crearProyecto, esClaveDeConsultaDelProyecto, leerCatalogo, leerConfiguracion, leerProyecto, listarClaves, pedirCodigo, quienSoy, revocarPropia, subirLogo, ultimaConexion, urlDeLaApi, } from "./api.js";
8
+ import { buscarProyecto, canjear, configurar, crearConexion, crearProyecto, elegirOrigen, esClaveDeConsultaDelProyecto, leerCatalogo, leerConfiguracion, leerGuia, leerProyecto, listarClaves, pedirCodigo, quienSoy, revocarPropia, subirLogo, ultimaConexion, urlDeLaApi, publicarGuia, revisarGuia, } from "./api.js";
9
9
  import { crearCandados } from "./candado.js";
10
10
  import { almacenDeArchivo } from "./guardado/archivo.js";
11
11
  import { crearGuardado } from "./guardado/index.js";
@@ -228,15 +228,20 @@ export const correrReal = (bin, args, stdin, techoMs) => new Promise((resolve) =
228
228
  hijo.stdin.end(stdin ?? undefined);
229
229
  });
230
230
  // `git` con entorno mínimo (sólo PATH): ni GIT_DIR ni GIT_CONFIG del shell desvían la lectura, y
231
- // SUPCOFLOW_TOKEN no le llega. Un git ausente (ENOENT) es «sin git», no un fallo.
232
- export const gitReal = (args, cwd) => new Promise((resolve) => {
233
- execFile("git", args, { cwd, timeout: 5_000, env: { PATH: process.env.PATH ?? "" } }, (e, stdout) => {
231
+ // SUPCOFLOW_TOKEN no le llega. Un git ausente (ENOENT) es «sin git», no un fallo. El plazo es parámetro para no
232
+ // duplicar la función: lo que git imprima nunca sale a la terminal, sólo el código y el stdout.
233
+ const gitConPlazo = (plazoMs) => (args, cwd) => new Promise((resolve) => {
234
+ execFile("git", args, { cwd, timeout: plazoMs, env: { PATH: process.env.PATH ?? "" } }, (e, stdout) => {
234
235
  if (!e)
235
236
  return resolve({ codigo: 0, stdout: String(stdout) });
236
237
  const codigo = e.code;
237
238
  resolve({ codigo: typeof codigo === "number" ? codigo : null, stdout: "" });
238
239
  });
239
240
  });
241
+ export const gitReal = gitConPlazo(5_000);
242
+ // El commit y la rama que la terminal DECLARA al subir la guía: 3 segundos (no 5) porque esto es un extra que nunca
243
+ // debe hacer esperar a nadie.
244
+ export const gitRapido = gitConPlazo(3_000);
240
245
  // `.supcoflow/proyecto.json` vive DENTRO del repo, y el repo puede ser un clon ajeno: su contenido lo
241
246
  // decide quien lo escribió. Por eso ni la carpeta ni el archivo se siguen si son enlaces (uno hacia
242
247
  // `~/.ssh/…` haría que la terminal leyera, o escribiera, lo que el repo quiera), y se lee con tope.
@@ -450,6 +455,11 @@ export function entornoReal(env = process.env) {
450
455
  leerArchivoChico,
451
456
  leerCatalogo: (a, clave) => leerCatalogo(a, clave, fetch),
452
457
  },
458
+ guia: {
459
+ ...configurarEnElMotor,
460
+ leerArchivoChico, fetch, gitDeclarado: gitRapido,
461
+ revisar: revisarGuia, publicar: publicarGuia, ver: leerGuia, elegir: elegirOrigen,
462
+ },
453
463
  claves: {
454
464
  ...configurarEnElMotor,
455
465
  listarClaves: (a, clave, id) => listarClaves(a, clave, id, fetch),
@@ -4,6 +4,7 @@
4
4
  const DE_CONFIGURAR_CON_REPO = [
5
5
  "configuracion", "chat prender", "chat apagar", "chat marca", "chat logo", "sitios agregar", "sitios quitar",
6
6
  "datos fijar", "politica fijar", "claves crear", "claves listar", "claves revocar",
7
+ "guia revisar", "guia publicar", "guia ver", "guia usar",
7
8
  ];
8
9
  export const FLAGS_POR_COMANDO = [
9
10
  { flags: ["start", "wait"], comandos: ["login", "repo conectar"], texto: "--start y --wait son de `supcoflow login` y `supcoflow repo conectar`." },
@@ -18,6 +19,8 @@ export const FLAGS_POR_COMANDO = [
18
19
  { flags: ["permitir"], comandos: ["datos fijar"], texto: "--permitir es de `supcoflow datos fijar`." },
19
20
  { flags: ["modo"], comandos: ["politica fijar"], texto: "--modo es de `supcoflow politica fijar`." },
20
21
  { flags: ["nombre", "guardarEn"], comandos: ["claves crear"], texto: "--nombre y --guardar-en son de `supcoflow claves crear`." },
22
+ { flags: ["origen"], comandos: ["guia usar"], texto: "--origen es de `supcoflow guia usar`." },
23
+ { flags: ["desdeGithub"], comandos: ["guia publicar"], texto: "--desde-github es de `supcoflow guia publicar`." },
21
24
  { flags: ["id"], comandos: ["claves revocar"], texto: "--id es de `supcoflow claves revocar`." },
22
25
  ];
23
26
  /** El mensaje del primer flag presente que el comando no acepta, o null si todo aplica. */
package/dist/guia.js ADDED
@@ -0,0 +1,11 @@
1
+ // La guía del producto que vive en el repo del cliente. Sin dependencias: sólo `node:crypto`.
2
+ import { createHash } from "node:crypto";
3
+ export const RUTA_DE_LA_GUIA = ".supcoflow/guia.md";
4
+ export const MAX_BYTES_DE_LA_GUIA = 64 * 1024;
5
+ // La misma regla que el motor (`src/guia/formato.ts`), copiada a propósito y clavada con los vectores
6
+ // de `test/vectores/huella.json` (idénticos en los dos repos). Se normaliza antes de hashear porque un
7
+ // editor de Windows pone BOM o \r\n, y si las dos puntas hashearan distinto, `guia_distinta` sería eterno.
8
+ export function huellaDeGuia(texto) {
9
+ const normalizado = texto.replace(/^/, "").replace(/\r\n?/g, "\n");
10
+ return createHash("sha256").update(normalizado, "utf8").digest("hex");
11
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "supcoflow",
3
- "version": "0.3.0",
3
+ "version": "0.5.0",
4
4
  "description": "La terminal de Supcoflow: iniciar sesión y manejar el chat de soporte desde la consola o un asistente.",
5
5
  "type": "module",
6
6
  "bin": { "supcoflow": "dist/cli.js" },