@customyai/cli 0.10.1 → 0.14.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/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # @customyai/cli
2
2
 
3
+ ## 0.14.0
4
+
5
+ ### Minor Changes
6
+
7
+ - `customy experience env [--channel staging] [--format env|json]` imprime los valores NO secretos `EXPERIENCE_*` del entorno del token (origen de entrega, ámbito, id del entorno, canal, anclas si el token puede verlas, nombre de la marca, espacio de textos y componentes servidos), con una nota por cada valor que no se puede dar. Las claves de catálogo mal formadas se rechazan con la causa, el patrón permitido y el arreglo (p. ej. `checkout_title` → `checkoutTitle`). Un GET con `kind` conserva el filtro también con un token de máquina.
8
+
9
+ ## 0.13.0
10
+
11
+ ### Minor Changes
12
+
13
+ - `customy experience` habla con la puerta pública de autoría (`<origen>/public/author/v1/*`) cuando el token es un token de máquina `cxw_…` (o con `--api public`), así un cliente externo publica sin llaves internas. Nuevos: `publish [--channel staging] [--note …] [--dry-run]` (release con la última revisión de cada artefacto y mueve el canal) y `locale put <bcp47>… [--status] [--direction] [--fallback]` (abre idiomas como `pt-BR`). Reintenta un `429` con `Retry-After` corto (hasta 3 veces). Un token que no empieza por `cxw_` sigue yendo al BFF, sin cambios.
14
+
15
+ ## 0.12.0
16
+
17
+ ### Minor Changes
18
+
19
+ - `customy experience` para integradores: `add <componente|token|texto>` trae un artefacto del backend con tipos y un lock, `diff <releaseA> <releaseB>` resume qué cambia por tipo (con `--html` genera la vista de revisión previa y `--fail-on removed,contrast` para CI), `pin <app> <release>` fija una app a un release y `status --app` muestra qué release y fuente ve. Todos con `--json`, `--dry-run` y errores accionables. Lectura con `CUSTOMY_EXPERIENCE_READ_KEY` (o el token); `pin` exige el token de escritura.
20
+
21
+ ## 0.11.0
22
+
23
+ ### Minor Changes
24
+
25
+ - `customy apps sync` admite `CUSTOMY_ADMIN_SECRET` (cabecera `x-admin-secret`), el 401 dice qué credencial espera Access, `SyncResult` devuelve `publishableKey` y la CLI imprime `CUSTOMY_PUBLISHABLE_KEY` y `CUSTOMY_ENVIRONMENT_ID`.
26
+
3
27
  ## 0.10.1
4
28
 
5
29
  ### Patch Changes
package/README.md CHANGED
@@ -7,16 +7,18 @@ También opera Customy WhatsApp (`customy whatsapp …`) y los catálogos de tra
7
7
  ```bash
8
8
  npm install --save-dev @customyai/cli
9
9
 
10
- npx customy apps validate # --file customy.app.json
11
- npx customy apps codegen --out src/customy.generated.ts
12
- CUSTOMY_ACCESS_URL=https://access-api.customy.ai CUSTOMY_ACCESS_TOKEN=… \
13
- npx customy apps sync --workspace-env <envId> # --reason "…"
10
+ # Fuera del monorepo el paquete se invoca por su nombre completo: `npx customy` NO es este paquete.
11
+ npx @customyai/cli apps validate # --file customy.app.json
12
+ npx @customyai/cli apps codegen --out src/customy.generated.ts
13
+ CUSTOMY_ACCESS_URL=https://access-api.customy.ai CUSTOMY_ADMIN_SECRET=… \
14
+ npx @customyai/cli apps sync --workspace-env <envId> # --reason "…"
15
+ # o, con el token de un administrador del Workspace: CUSTOMY_ACCESS_TOKEN=… (Bearer)
14
16
  ```
15
17
 
16
18
  - **validate**: sale 1 y enseña cada problema con su ruta (`plans.0.capabilities.missing: CAPABILITY_UNDECLARED`) e imprime cuántos eventos, capabilities, permisos y roles declara.
17
19
  - **permisos y roles** (opcionales): `permissions: [{ key, description }]` y `roles: [{ key, name, description?, permissions }]`. Las claves van en el espacio de nombres de la app (`<clave>.…`, en minúsculas y sin comodines), todo permiso de un rol debe estar declarado en `permissions[]` y hay topes (128 permisos, 32 roles, 128 permisos por rol). Para que la app asigne esos roles a sus miembros, pide los scopes `app-roles:read` / `app-roles:write` en el producto `customy-access`. Los errores salen como `permissions.0.key: PERMISSION_NAMESPACE_VIOLATION`, `roles.0.permissions.1: PERMISSION_UNDECLARED`.
18
20
  - **codegen**: escribe los tipos de la app — `CustomyEventName`, `CustomyEventProperties` (de los JSON Schema de sus eventos), `CustomyCapability`, `CustomyPlan`, `CustomyMeter`, `CustomyPermission` y `CustomyRole` (de `permissions[]` y `roles[]`), `CUSTOMY_ROLE_PERMISSIONS` (lo que da cada rol), `CustomyAppTypes` (todos juntos) y los propósitos por evento — para `createCustomy<CustomyAppTypes>()` y `createAccess<CustomyCapability, CustomyRole, CustomyPermission>()` de `@customyai/sdk` (con ellos `permissions.effective`, `appRoles.assignments.assign` y `me()` salen tipados y un nombre de rol mal escrito no compila), `createData<CustomyEventProperties>()` y `createBilling<CustomyMeter>()`.
19
- - **sync**: idempotente. Instala la app en el Workspace si no existe y publica una versión nueva del manifiesto sobre la revisión actual; Access lo lleva a cada producto y la CLI enseña cómo quedó cada uno (sale 1 si alguno falló; repetir `sync` lo repara). Si el manifiesto declara permisos o roles, enseña también cuántos quedaron reconciliados (y los huérfanos). Lee `CUSTOMY_ACCESS_URL` y `CUSTOMY_ACCESS_TOKEN` (el de un administrador del Workspace) del entorno, nunca de la línea de comandos, y nunca crea credenciales.
21
+ - **sync**: idempotente. Instala la app en el Workspace si no existe y publica una versión nueva del manifiesto sobre la revisión actual; Access lo lleva a cada producto y la CLI enseña cómo quedó cada uno (sale 1 si alguno falló; repetir `sync` lo repara). Si el manifiesto declara permisos o roles, enseña también cuántos quedaron reconciliados (y los huérfanos). Lee `CUSTOMY_ACCESS_URL` y una credencial del entorno, nunca de la línea de comandos: `CUSTOMY_ADMIN_SECRET` (cabecera `x-admin-secret`, la que acepta Access de producción; manda si están las dos) o `CUSTOMY_ACCESS_TOKEN` (`Authorization: Bearer` de un administrador del Workspace). Con `ADMIN_SECRET_MODE=require-actor` Access exige además quién y por qué: la CLI manda `x-reason` (el `--reason`, de 8+ caracteres) y `x-actor` si defines `CUSTOMY_ADMIN_ACTOR`. Un 401 dice qué credencial mandó la CLI y cuál espera Access. Al terminar imprime `CUSTOMY_PUBLISHABLE_KEY=pk_…` (no es secreta) y `CUSTOMY_ENVIRONMENT_ID=env_…` para pegarlos en el `.env` de la app; `syncApp` los devuelve como `publishableKey` y `environmentId`. Nunca crea credenciales. Desde un checkout del monorepo hace falta compilar antes (`pnpm --filter @customyai/cli... build`); `npm pack` se niega si falta `dist/bin.mjs`.
20
22
 
21
23
  ## Provisioning de usuarios de PRUEBA
22
24
 
package/dist/bin.cjs CHANGED
@@ -1,8 +1,8 @@
1
1
  #!/usr/bin/env node
2
2
  'use strict';
3
3
 
4
- var chunk6X3AX6PB_cjs = require('./chunk-6X3AX6PB.cjs');
5
- require('./chunk-2A6WFLXS.cjs');
4
+ var chunkF7DBJYTA_cjs = require('./chunk-F7DBJYTA.cjs');
5
+ require('./chunk-VUQSQ5YY.cjs');
6
6
  var promises = require('readline/promises');
7
7
 
8
8
  async function prompt(question) {
@@ -15,7 +15,7 @@ async function prompt(question) {
15
15
  }
16
16
  var interrupt = new AbortController();
17
17
  process.once("SIGINT", () => interrupt.abort());
18
- chunk6X3AX6PB_cjs.runCli(process.argv.slice(2), {
18
+ chunkF7DBJYTA_cjs.runCli(process.argv.slice(2), {
19
19
  signal: interrupt.signal,
20
20
  cwd: process.cwd(),
21
21
  env: process.env,
package/dist/bin.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
- import { runCli } from './chunk-57NNDUEX.mjs';
3
- import './chunk-QKIF4C5R.mjs';
2
+ import { runCli } from './chunk-GD2FZPDE.mjs';
3
+ import './chunk-CCF7M44T.mjs';
4
4
  import { createInterface } from 'readline/promises';
5
5
 
6
6
  async function prompt(question) {
@@ -29,6 +29,20 @@ var CATALOG_DOC_VERSION = "catalog@1";
29
29
  var CATALOG_RESERVED_KEYS = ["constructor", "toString", "valueOf", "hasOwnProperty", "isPrototypeOf", "propertyIsEnumerable", "toLocaleString", "__proto__", "__defineGetter__", "__defineSetter__", "__lookupGetter__", "__lookupSetter__"];
30
30
  var isReservedCatalogKey = (key) => CATALOG_RESERVED_KEYS.includes(key);
31
31
  var CATALOG_KEY = /^(?!(?:constructor|toString|valueOf|hasOwnProperty|isPrototypeOf|propertyIsEnumerable|toLocaleString)$)[a-z][A-Za-z0-9]*(\.[a-z][A-Za-z0-9-]*)*$/;
32
+ function catalogKeyHint(key) {
33
+ const pattern = "patr\xF3n: segmentos separados por puntos; el primero [a-z][A-Za-z0-9]*, los dem\xE1s [a-z][A-Za-z0-9-]*, m\xE1x. 120 caracteres (ej. \xABcheckout.title\xBB, \xABplan.freeTrial\xBB, \xABnav.sign-in\xBB)";
34
+ let why = "no cumple la forma de una clave";
35
+ if (key.length === 0) why = "est\xE1 vac\xEDa";
36
+ else if (key.length > 120) why = `mide ${key.length} caracteres (m\xE1x. 120)`;
37
+ else if (key.includes("_")) why = `no admite el guion bajo \xAB_\xBB: separa con puntos y usa camelCase (p. ej. \xAB${key.replace(/_+([a-zA-Z0-9])/g, (_m, c) => c.toUpperCase()).replace(/_/g, "")}\xBB)`;
38
+ else if (/\s/.test(key)) why = "no admite espacios";
39
+ else if (/^[A-Z]/.test(key) || /\.[A-Z]/.test(key)) why = "cada segmento empieza por min\xFAscula (p. ej. \xABcheckout.title\xBB, no \xABCheckout.Title\xBB)";
40
+ else if (/^\d/.test(key) || /\.\d/.test(key)) why = "cada segmento empieza por una letra, no por una cifra";
41
+ else if (/^\.|\.$|\.\./.test(key)) why = "no admite puntos al principio, al final ni dos seguidos";
42
+ else if (/^[a-z][A-Za-z0-9]*-/.test(key.split(".")[0] ?? "")) why = "el primer segmento no admite guion (los siguientes s\xED)";
43
+ else if (/[^A-Za-z0-9.-]/.test(key)) why = "solo admite letras, cifras, puntos y guiones";
44
+ return `${why}; ${pattern}`;
45
+ }
32
46
  var CATALOG_NAMESPACE = /^[a-z][a-z0-9-]{1,31}$/;
33
47
  var CATALOG_LOCALE = /^[a-z]{2,3}(-[A-Za-z0-9]{2,8}){0,2}$/;
34
48
  var CATALOG_SYNTAXES = ["icu1", "mf2"];
@@ -191,7 +205,7 @@ function validateCatalogUnsafe(input, options) {
191
205
  continue;
192
206
  }
193
207
  if (key.length > CATALOG_MAX_KEY_LENGTH || !CATALOG_KEY.test(key)) {
194
- issues.push({ path: `messages.${key}`, code: "invalid-key", message: "clave no v\xE1lida (min\xFAscula inicial, segmentos con puntos, sin espacios)" });
208
+ issues.push({ path: `messages.${key}`, code: "invalid-key", message: `clave no v\xE1lida \xAB${key.slice(0, 60)}\xBB: ${catalogKeyHint(key)}` });
195
209
  continue;
196
210
  }
197
211
  const a = analyzeMessage(doc.messages[key]);
@@ -223,4 +237,4 @@ function parityReport(byLocale, required, base = required[0] ?? "en") {
223
237
  return { ok: Object.keys(missing).length === 0 && placeholderMismatch.length === 0, missing, placeholderMismatch };
224
238
  }
225
239
 
226
- export { CATALOG_DOC_VERSION, CATALOG_KEY, CATALOG_LOCALE, CATALOG_NAMESPACE, TRANSLATION_PLAN_LIMITS, analyzeMessage, parityReport, validateCatalog };
240
+ export { CATALOG_DOC_VERSION, CATALOG_KEY, CATALOG_LOCALE, CATALOG_NAMESPACE, TRANSLATION_PLAN_LIMITS, analyzeMessage, catalogKeyHint, parityReport, validateCatalog };