@customyai/cli 0.1.1 → 0.6.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 +42 -0
- package/README.md +50 -4
- package/dist/bin.cjs +14 -4
- package/dist/bin.mjs +13 -3
- package/dist/chunk-6S5U7ZKO.cjs +1102 -0
- package/dist/chunk-L2FCAP2K.mjs +1087 -0
- package/dist/index.cjs +23 -7
- package/dist/index.d.cts +78 -6
- package/dist/index.d.ts +78 -6
- package/dist/index.mjs +1 -1
- package/package.json +7 -4
- package/dist/chunk-JQGTXI6C.cjs +0 -389
- package/dist/chunk-RAIHVQ4J.mjs +0 -378
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,47 @@
|
|
|
1
1
|
# @customyai/cli
|
|
2
2
|
|
|
3
|
+
## 0.6.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Typed roles and permissions from the manifest: `customy apps codegen` also writes `CustomyPermission`, `CustomyRole`, `CUSTOMY_ROLE_PERMISSIONS` and `CustomyAppTypes` (and `CustomyEventProperties` is now a type alias so it satisfies the event map); `createAccess<Capability, Role, Permission>()` types `permissions.effective`, `appRoles.*`, `me()` and `AccessMeSnapshot<Role, Permission>`; `createCustomy<CustomyAppTypes>()` carries `roles` and `permissions` into `customy.access`. A misspelled role or permission fails to compile.
|
|
8
|
+
|
|
9
|
+
## 0.5.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- Dependencias actualizadas:
|
|
14
|
+
- @customyai/provisioning@0.1.1
|
|
15
|
+
|
|
16
|
+
## 0.5.0
|
|
17
|
+
|
|
18
|
+
### Minor Changes
|
|
19
|
+
|
|
20
|
+
- `customy apps validate | sync` ahora aceptan los campos opcionales `permissions` y `roles` del manifiesto `app/v1` y los scopes de Access `app-roles:read` / `app-roles:write`. La validación es la misma que aplica el servidor (claves en el espacio de nombres `<clave-de-la-app>.`, sin comodines, permisos de rol declarados, topes de cantidad); `validate` y `sync` imprimen los conteos de permisos y roles y la reconciliación del servidor. Los manifiestos existentes siguen validando igual.
|
|
21
|
+
|
|
22
|
+
## 0.4.0
|
|
23
|
+
|
|
24
|
+
### Minor Changes
|
|
25
|
+
|
|
26
|
+
- `customy flags | segments | experiments`: control de Customy Experiments desde la terminal (listar, leer, crear y actualizar desde JSON, archivar, restaurar, borrar, kill switch, miembros de segmentos, arrancar, pausar y concluir experimentos). Origen en `--base-url` o `CUSTOMY_EXPERIMENTS_URL`, credencial en `CUSTOMY_EXPERIMENTS_TOKEN`, `--reason` obligatorio en escrituras y `--dry-run`. Exporta `runExperimentsCli` y `EXPERIMENTS_EXIT_CODES`.
|
|
27
|
+
|
|
28
|
+
## 0.3.0
|
|
29
|
+
|
|
30
|
+
### Minor Changes
|
|
31
|
+
|
|
32
|
+
- Informe de API al día: el esquema de acciones de agente incluye `request_operator_approval`.
|
|
33
|
+
|
|
34
|
+
## 0.2.0
|
|
35
|
+
|
|
36
|
+
### Minor Changes
|
|
37
|
+
|
|
38
|
+
- Customy Provisioning para usuarios de PRUEBA: `@customyai/provisioning` (cliente sobre `@customyai/core` con token de máquina en memoria, `Customy-Environment` en cada petición, `Idempotency-Key` estable en reintentos, errores tipados y redacción de secretos), `createProvisioning`, el namespace `provisioning` y `@customyai/sdk/testing` (`withEphemeralUsers`) en `@customyai/sdk`, y los comandos `customy users | audit | policy | whoami | login` en `@customyai/cli`.
|
|
39
|
+
|
|
40
|
+
### Patch Changes
|
|
41
|
+
|
|
42
|
+
- Dependencias actualizadas:
|
|
43
|
+
- @customyai/provisioning@0.1.0
|
|
44
|
+
|
|
3
45
|
## 0.1.1
|
|
4
46
|
|
|
5
47
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @customyai/cli
|
|
2
2
|
|
|
3
|
-
La CLI de Customy para apps: valida, tipa y sincroniza el `customy.app.json` de una app (manifiesto `app/v1`: productos y scopes, recursos, eventos con schema y propósitos de consentimiento, capabilities, planes y meters).
|
|
3
|
+
La CLI de Customy para apps: valida, tipa y sincroniza el `customy.app.json` de una app, y provisiona usuarios de prueba (manifiesto `app/v1`: productos y scopes, recursos, eventos con schema y propósitos de consentimiento, capabilities, planes y meters; opcionalmente `permissions` y `roles` de la app).
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
6
|
npm install --save-dev @customyai/cli
|
|
@@ -11,8 +11,54 @@ CUSTOMY_ACCESS_URL=https://access-api.customy.ai CUSTOMY_ACCESS_TOKEN=… \
|
|
|
11
11
|
npx customy apps sync --workspace-env <envId> # --reason "…"
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
- **validate**: sale 1 y enseña cada problema con su ruta (`plans.0.capabilities.missing: CAPABILITY_UNDECLARED`).
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
14
|
+
- **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.
|
|
15
|
+
- **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`.
|
|
16
|
+
- **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>()`.
|
|
17
|
+
- **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.
|
|
18
|
+
|
|
19
|
+
## Provisioning de usuarios de PRUEBA
|
|
20
|
+
|
|
21
|
+
Sobre [`@customyai/provisioning`](../sdk-provisioning). Todo comando que habla con el servidor exige `--env staging|production` (no hay entorno por defecto) y envía `Customy-Environment`.
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
export CUSTOMY_ACCESS_URL=https://<access-origin> # o --base-url
|
|
25
|
+
export CUSTOMY_CLIENT_ID=… CUSTOMY_CLIENT_SECRET=… # llave de API de Access de UN entorno (o CUSTOMY_TOKEN)
|
|
26
|
+
|
|
27
|
+
customy users test create --env staging --count 5 --email-domain qa.example.com --currency USD --country US --locale es-CO --expires-in-days 7 --reason "e2e checkout"
|
|
28
|
+
customy users test cleanup --env staging --batch <id> --reason "fin de la corrida" # o --mine
|
|
29
|
+
customy users get <externalKey> --env staging
|
|
30
|
+
customy users list --env staging --kind test --batch <id> --all
|
|
31
|
+
customy users upsert qa-ana --env staging --email ana@qa.example.com --attr tier=pro --reason "cuenta de QA" # --password generate por defecto en test
|
|
32
|
+
customy users delete <externalKey> --env staging --reason "..."
|
|
33
|
+
customy users signin-link <externalKey> --env staging --reason "..."
|
|
34
|
+
customy audit list --env staging --subject <externalKey> | audit export --format csv --out audit.csv | audit verify
|
|
35
|
+
customy policy get --env staging
|
|
36
|
+
customy whoami --env staging
|
|
37
|
+
customy login # device flow: aún no disponible (sale 2)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- `--json`: un solo documento JSON en stdout y nada más; los diagnósticos van a stderr.
|
|
41
|
+
- `--dry-run` (toda escritura): no envía nada; imprime método, ruta, cuerpo y entorno, y sale 0.
|
|
42
|
+
- **Producción**: una escritura pide teclear `production` (terminal) o `--yes-i-am-sure production` (sin terminal); si no, sale 4.
|
|
43
|
+
- Las contraseñas generadas y los enlaces de acceso se muestran **una sola vez** (stdout y `--json`); nunca se escriben a archivos, a stderr ni a argv (`--password` solo acepta `generate` o `none`).
|
|
44
|
+
- Códigos de salida: `0` ok, `1` error de servidor o de uso, `2` no soportado, `3` credenciales o scope, `4` entorno distinto o confirmación rechazada.
|
|
17
45
|
|
|
18
46
|
También se puede usar como biblioteca: `validateManifest`, `generateAppTypes`, `syncApp` y `runCli`.
|
|
47
|
+
|
|
48
|
+
## Customy Experiments: flags, segmentos y experimentos
|
|
49
|
+
|
|
50
|
+
Control de Customy Experiments desde la terminal o un pipeline. El origen sale de `--base-url` o `CUSTOMY_EXPERIMENTS_URL` y la credencial de `CUSTOMY_EXPERIMENTS_TOKEN` (nunca por la línea de comandos); el inquilino y el entorno los decide el servidor por la credencial. Toda escritura exige `--reason` (la auditoría pide el porqué) y admite `--dry-run`, que imprime la petición y no envía nada.
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
customy flags list --q checkout --json
|
|
54
|
+
customy flags create --file flag.json --reason "alta del flag de checkout" # el JSON es el cuerpo de POST /v1/experiments/flags
|
|
55
|
+
customy flags kill checkout.v2 --environment env_prod --reason "incidente 42"
|
|
56
|
+
customy flags archive|restore|delete <key> --reason "..."
|
|
57
|
+
customy segments create --file segment.json --reason "segmento Pro"
|
|
58
|
+
customy segments members add beta --unit-keys u1,u2,u3 --reason "alta de la beta"
|
|
59
|
+
customy experiments create --file experiment.json --reason "hipótesis del hero"
|
|
60
|
+
customy experiments start <key> --reason "arranque"
|
|
61
|
+
customy experiments conclude <key> --decision ship --reason "ganó la variante B"
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Códigos de salida: 0 ok, 1 error del servidor o de uso, 3 credencial rechazada (401/403), 4 conflicto o solicitud de cambio pendiente (409/412).
|
package/dist/bin.cjs
CHANGED
|
@@ -1,14 +1,24 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
'use strict';
|
|
3
3
|
|
|
4
|
-
var
|
|
4
|
+
var chunk6S5U7ZKO_cjs = require('./chunk-6S5U7ZKO.cjs');
|
|
5
|
+
var promises = require('readline/promises');
|
|
5
6
|
|
|
6
|
-
|
|
7
|
-
|
|
7
|
+
async function prompt(question) {
|
|
8
|
+
const rl = promises.createInterface({ input: process.stdin, output: process.stderr });
|
|
9
|
+
try {
|
|
10
|
+
return await rl.question(question);
|
|
11
|
+
} finally {
|
|
12
|
+
rl.close();
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
chunk6S5U7ZKO_cjs.runCli(process.argv.slice(2), {
|
|
8
16
|
cwd: process.cwd(),
|
|
9
17
|
env: process.env,
|
|
10
18
|
out: (line) => console.log(line),
|
|
11
|
-
err: (line) => console.error(line)
|
|
19
|
+
err: (line) => console.error(line),
|
|
20
|
+
isTTY: Boolean(process.stdin.isTTY),
|
|
21
|
+
prompt
|
|
12
22
|
}).then((code) => {
|
|
13
23
|
process.exitCode = code;
|
|
14
24
|
});
|
package/dist/bin.mjs
CHANGED
|
@@ -1,12 +1,22 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { runCli } from './chunk-
|
|
2
|
+
import { runCli } from './chunk-L2FCAP2K.mjs';
|
|
3
|
+
import { createInterface } from 'readline/promises';
|
|
3
4
|
|
|
4
|
-
|
|
5
|
+
async function prompt(question) {
|
|
6
|
+
const rl = createInterface({ input: process.stdin, output: process.stderr });
|
|
7
|
+
try {
|
|
8
|
+
return await rl.question(question);
|
|
9
|
+
} finally {
|
|
10
|
+
rl.close();
|
|
11
|
+
}
|
|
12
|
+
}
|
|
5
13
|
runCli(process.argv.slice(2), {
|
|
6
14
|
cwd: process.cwd(),
|
|
7
15
|
env: process.env,
|
|
8
16
|
out: (line) => console.log(line),
|
|
9
|
-
err: (line) => console.error(line)
|
|
17
|
+
err: (line) => console.error(line),
|
|
18
|
+
isTTY: Boolean(process.stdin.isTTY),
|
|
19
|
+
prompt
|
|
10
20
|
}).then((code) => {
|
|
11
21
|
process.exitCode = code;
|
|
12
22
|
});
|