kaven-cli 0.4.0-alpha.1 → 0.4.1-alpha.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.
Files changed (54) hide show
  1. package/README.md +147 -84
  2. package/README.pt-BR.md +334 -0
  3. package/dist/EnvManager-GQMEZ6NV.js +158 -0
  4. package/dist/MarketplaceClient-IJGRQRC4.js +7 -0
  5. package/dist/chunk-3RG5ZIWI.js +10 -0
  6. package/dist/chunk-GHZX5OAA.js +455 -0
  7. package/dist/commands/aiox/index.js +20 -0
  8. package/dist/commands/config/features.js +110 -1008
  9. package/dist/commands/config/index.js +1 -34
  10. package/dist/commands/index.js +1 -0
  11. package/dist/commands/init/aiox-bootstrap.js +83 -0
  12. package/dist/commands/init/index.js +20 -40
  13. package/dist/commands/marketplace/browse.js +1 -34
  14. package/dist/commands/module/activate.js +89 -48
  15. package/dist/commands/module/list.js +51 -0
  16. package/dist/commands/module/publish.js +2 -35
  17. package/dist/commands/upgrade/index.js +6 -39
  18. package/dist/core/AuthService.js +2 -34
  19. package/dist/core/CacheManager.js +3 -0
  20. package/dist/core/ConfigManager.js +8 -7
  21. package/dist/core/ErrorRecovery.js +1 -0
  22. package/dist/core/LicenseService.js +3 -38
  23. package/dist/core/ModuleDoctor.js +3 -0
  24. package/dist/core/ModuleInstaller.js +5 -36
  25. package/dist/core/ProjectInitializer.js +43 -5
  26. package/dist/core/RegistryResolver.js +3 -2
  27. package/dist/core/SchemaActivator.js +29 -8
  28. package/dist/core/ScriptRunner.js +3 -2
  29. package/dist/core/index.js +1 -0
  30. package/dist/index.js +30 -9
  31. package/dist/infrastructure/Container.js +2 -4
  32. package/dist/infrastructure/MarketplaceClient.js +31 -3
  33. package/dist/infrastructure/TelemetryBuffer.js +3 -1
  34. package/dist/infrastructure/TransactionalFileSystem.js +4 -1
  35. package/dist/infrastructure/errors.js +2 -0
  36. package/dist/infrastructure/index.js +1 -0
  37. package/dist/lib/capabilities-catalog.js +73 -0
  38. package/dist/lib/module-registry.js +47 -0
  39. package/dist/lib/schema-modifier.js +40 -0
  40. package/dist/tier-table-LAL6PAVW.js +52 -0
  41. package/package.json +11 -3
  42. package/dist/commands/modules/add.js +0 -53
  43. package/dist/commands/modules/list.js +0 -40
  44. package/dist/commands/modules/remove.js +0 -54
  45. package/dist/core/api/KavenApiClient.js +0 -61
  46. package/dist/core/auth/AuthManager.js +0 -91
  47. package/dist/core/modules/Injector.js +0 -86
  48. package/dist/core/modules/ModuleInstaller.js +0 -63
  49. package/dist/core/modules/ModuleManager.js +0 -59
  50. package/dist/core/modules/ModuleRemover.js +0 -60
  51. package/dist/lib/config.js +0 -66
  52. package/dist/lib/errors.js +0 -32
  53. package/dist/lib/logger.js +0 -70
  54. package/dist/types/module.js +0 -49
@@ -0,0 +1,334 @@
1
+ # Kaven CLI
2
+
3
+ > 📖 English version: [README.md](./README.md)
4
+
5
+ [![npm version](https://img.shields.io/npm/v/kaven-cli/alpha.svg)](https://www.npmjs.com/package/kaven-cli)
6
+ [![npm downloads](https://img.shields.io/npm/dm/kaven-cli.svg)](https://www.npmjs.com/package/kaven-cli)
7
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
8
+ [![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org)
9
+ [![CI](https://github.com/kaven-co/kaven-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/kaven-co/kaven-cli/actions/workflows/ci.yml)
10
+
11
+ A CLI oficial do [Kaven](https://kaven.site) — boilerplate enterprise-grade para SaaS.
12
+ Bootstrap de projetos, gerenciamento de módulos e integração com o Kaven Marketplace diretamente pelo terminal.
13
+
14
+ O Kaven é um projeto brasileiro. O boilerplate comprime de 3-6 meses para dias o trabalho de infraestrutura base de um SaaS (auth, multi-tenancy, pagamentos, design system).
15
+
16
+ > **Alpha:** APIs e comandos podem mudar antes da v1.0.0.
17
+
18
+ ---
19
+
20
+ ## Instalação
21
+
22
+ ```bash
23
+ npm install -g kaven-cli@alpha
24
+ # ou
25
+ pnpm add -g kaven-cli@alpha
26
+ ```
27
+
28
+ **Requisitos:** Node.js >= 20, pnpm (necessário para o `kaven init`)
29
+
30
+ ---
31
+
32
+ ## Início Rápido
33
+
34
+ ```bash
35
+ # 1. Bootstrap de um novo projeto
36
+ kaven init meu-saas
37
+
38
+ # 2. Autenticar com o marketplace
39
+ kaven auth login
40
+
41
+ # 3. Explorar módulos disponíveis
42
+ kaven marketplace browse
43
+
44
+ # 4. Instalar um módulo
45
+ kaven marketplace install payments
46
+
47
+ # 5. Verificar saúde do projeto
48
+ kaven module doctor
49
+ ```
50
+
51
+ ---
52
+
53
+ ## Referência de Comandos
54
+
55
+ ### `kaven init [nome-do-projeto]`
56
+
57
+ Cria um novo projeto Kaven a partir do template oficial.
58
+
59
+ ```
60
+ Opções:
61
+ --defaults Pular prompts interativos, usar valores padrão
62
+ --skip-install Pular o pnpm install após o setup
63
+ --skip-git Pular git init e commit inicial
64
+ --force Sobrescrever diretório existente
65
+ --with-squad Inicializar squad AIOX no projeto
66
+
67
+ Exemplos:
68
+ kaven init meu-app
69
+ kaven init meu-app --defaults
70
+ kaven init meu-app --skip-git --skip-install
71
+ ```
72
+
73
+ ---
74
+
75
+ ### `kaven auth`
76
+
77
+ Gerenciar autenticação com o Kaven Marketplace.
78
+
79
+ ```
80
+ Subcomandos:
81
+ login Iniciar fluxo de device code (RFC 8628) — abre o navegador para confirmar
82
+ logout Encerrar a sessão local
83
+ whoami Exibir informações do usuário autenticado
84
+ ```
85
+
86
+ ---
87
+
88
+ ### `kaven marketplace`
89
+
90
+ Explorar e instalar módulos do Kaven Marketplace.
91
+
92
+ ```
93
+ Subcomandos:
94
+ list Listar módulos disponíveis
95
+ install Baixar e aplicar um módulo no projeto atual
96
+ browse Navegador interativo (TUI)
97
+
98
+ Opções (list):
99
+ --category <cat> Filtrar por categoria
100
+ --sort <campo> newest (padrão) | popular | name
101
+ --page <n> Número da página
102
+ --limit <n> Resultados por página (máx 100)
103
+ --json Saída em JSON bruto
104
+
105
+ Opções (install):
106
+ --version <ver> Instalar uma versão específica
107
+ --force Pular confirmação de sobrescrita
108
+ --skip-env Pular injeção no .env
109
+ --env-file <path> Caminho do .env alvo
110
+ ```
111
+
112
+ ---
113
+
114
+ ### `kaven module`
115
+
116
+ Gerenciar módulos instalados no projeto atual.
117
+
118
+ ```
119
+ Subcomandos:
120
+ doctor Executar health checks no projeto e nos módulos instalados
121
+ add Instalar um módulo a partir de um manifest local
122
+ remove Desinstalar um módulo instalado
123
+ publish Publicar um módulo no marketplace
124
+
125
+ Opções (doctor):
126
+ --fix Corrigir problemas automaticamente (pnpm install, prisma generate, env vars)
127
+ --json Saída em JSON legível por máquina
128
+
129
+ Exit codes (doctor):
130
+ 0 Todos os checks passaram
131
+ 1 Um ou mais erros encontrados
132
+ 2 Apenas avisos (sem erros)
133
+
134
+ Opções (publish):
135
+ --dry-run Validar e empacotar sem fazer upload
136
+ --changelog <msg> Notas de release para esta versão
137
+ ```
138
+
139
+ > `kaven doctor` é um alias para `kaven module doctor`.
140
+
141
+ ---
142
+
143
+ ### `kaven upgrade`
144
+
145
+ Fazer upgrade da licença via checkout Paddle.
146
+
147
+ ```
148
+ Opções:
149
+ --no-browser Imprimir URL do checkout em vez de abrir o navegador
150
+
151
+ Comportamento:
152
+ Abre o checkout Paddle no navegador → aguarda confirmação de pagamento (a cada 5s, máx 10 min)
153
+ → atualiza a licença local em caso de sucesso
154
+ ```
155
+
156
+ ---
157
+
158
+ ### `kaven license`
159
+
160
+ ```
161
+ Subcomandos:
162
+ status Exibir tier e validade da licença atual
163
+ ```
164
+
165
+ ---
166
+
167
+ ### `kaven cache`
168
+
169
+ Gerenciar o cache local de respostas da API (`~/.kaven/cache`, máx 50 MB).
170
+
171
+ ```
172
+ Subcomandos:
173
+ status Exibir estatísticas do cache (tamanho, entradas, idade)
174
+ clear Apagar todos os dados em cache
175
+
176
+ TTLs do cache:
177
+ Listagem de módulos 24 horas
178
+ Manifests de módulos 7 dias
179
+ Status da licença 1 hora
180
+ ```
181
+
182
+ ---
183
+
184
+ ### `kaven telemetry`
185
+
186
+ ```
187
+ Subcomandos:
188
+ view Exibir eventos de telemetria locais recentes
189
+ -l, --limit <n> Número de eventos (padrão: 10)
190
+ ```
191
+
192
+ ---
193
+
194
+ ### `kaven config`
195
+
196
+ ```
197
+ Subcomandos:
198
+ set <chave> <valor> Definir um valor de configuração
199
+ get <chave> Ler um valor de configuração
200
+ ```
201
+
202
+ ---
203
+
204
+ ### `kaven init-ci`
205
+
206
+ Inicializa configuração de CI/CD no projeto atual. Gera workflows do GitHub Actions configurados para projetos Kaven.
207
+
208
+ ---
209
+
210
+ ## Configuração
211
+
212
+ Toda a configuração fica em `~/.kaven/`:
213
+
214
+ ```
215
+ ~/.kaven/
216
+ auth.json Tokens de autenticação (chmod 600)
217
+ config.json Configuração da CLI
218
+ license.json Chave e tier da licença
219
+ signing-key.json Chave Ed25519 para módulos (chmod 600)
220
+ cache/ Cache de respostas da API (máx 50 MB)
221
+ telemetry.log Eventos de telemetria locais
222
+ ```
223
+
224
+ ### Variáveis de Ambiente
225
+
226
+ | Variável | Descrição |
227
+ |----------|-----------|
228
+ | `KAVEN_API_URL` | Sobrescrever a URL da API do marketplace |
229
+ | `KAVEN_DEBUG=1` | Ativar saída de debug detalhada |
230
+ | `KAVEN_OFFLINE=1` | Usar apenas dados em cache, sem requisições de rede |
231
+ | `KAVEN_TELEMETRY=0` | Desativar telemetria completamente |
232
+
233
+ ### Sobrescrever a URL da API (config file)
234
+
235
+ ```json
236
+ // ~/.kaven/config.json
237
+ {
238
+ "apiUrl": "https://api.seu-kaven.com"
239
+ }
240
+ ```
241
+
242
+ ### Modo Debug
243
+
244
+ ```bash
245
+ KAVEN_DEBUG=1 kaven marketplace list
246
+ ```
247
+
248
+ ### Modo Offline
249
+
250
+ ```bash
251
+ KAVEN_OFFLINE=1 kaven marketplace list
252
+ ```
253
+
254
+ ---
255
+
256
+ ## Troubleshooting
257
+
258
+ **Erro "Not authenticated"**
259
+ ```bash
260
+ kaven auth login
261
+ ```
262
+
263
+ **"module.json not found" ao publicar**
264
+
265
+ Execute `kaven module publish` de dentro do diretório do módulo (o que contém o `module.json`).
266
+
267
+ **pnpm install falha no `kaven init`**
268
+ ```bash
269
+ npm install -g pnpm # instalar pnpm globalmente
270
+ # ou pular e instalar depois:
271
+ kaven init meu-app --skip-install
272
+ cd meu-app && pnpm install
273
+ ```
274
+
275
+ **Prisma client desatualizado**
276
+ ```bash
277
+ kaven module doctor --fix
278
+ # ou manualmente:
279
+ npx prisma generate
280
+ ```
281
+
282
+ **Problemas de cache**
283
+ ```bash
284
+ kaven cache clear
285
+ ```
286
+
287
+ **Permission denied em `~/.kaven/`**
288
+ ```bash
289
+ chmod 700 ~/.kaven
290
+ chmod 600 ~/.kaven/auth.json ~/.kaven/signing-key.json
291
+ ```
292
+
293
+ ---
294
+
295
+ ## Contribuindo
296
+
297
+ ```bash
298
+ git clone https://github.com/kaven-co/kaven-cli
299
+ cd kaven-cli
300
+ pnpm install
301
+ pnpm test # 310 testes
302
+ pnpm run typecheck
303
+ pnpm run lint
304
+ ```
305
+
306
+ **Convenção de commits:** este repositório usa [Conventional Commits](https://www.conventionalcommits.org/).
307
+
308
+ ```bash
309
+ feat: adicionar flag --with-squad ao kaven init
310
+ fix: corrigir corrupção de cache em escritas concorrentes
311
+ docs: atualizar seção de troubleshooting
312
+ ```
313
+
314
+ **Fluxo de release:**
315
+ 1. Abrir um PR contra `main`
316
+ 2. CI deve estar verde (lint + typecheck + testes + build)
317
+ 3. Merge → Semantic Release faz o bump de versão automaticamente e publica no npm (tag `@alpha`)
318
+
319
+ Tipos que disparam release: `feat` (minor), `fix` / `perf` / `refactor` (patch), `BREAKING CHANGE` (major).
320
+ Tipos que **não** disparam release: `chore`, `docs`, `test`, `style`, `ci`.
321
+
322
+ Consulte [`docs/releasing.md`](./docs/releasing.md) para a documentação completa do pipeline de release.
323
+
324
+ ---
325
+
326
+ ## Licença
327
+
328
+ Apache 2.0 — veja [LICENSE](LICENSE)
329
+
330
+ ---
331
+
332
+ Documentação: https://docs.kaven.site/cli
333
+ GitHub: https://github.com/kaven-co/kaven-cli
334
+ npm: https://www.npmjs.com/package/kaven-cli
@@ -0,0 +1,158 @@
1
+ import "./chunk-3RG5ZIWI.js";
2
+
3
+ // src/core/EnvManager.ts
4
+ import * as fs from "fs";
5
+ import * as path from "path";
6
+ import * as readline from "readline";
7
+ import chalk from "chalk";
8
+ var EnvManager = class {
9
+ async injectEnvVars(moduleSlug, envVars, options) {
10
+ if (options.skipEnv || !envVars || envVars.length === 0) {
11
+ return { added: 0, skipped: 0 };
12
+ }
13
+ const envFilePath = path.join(options.projectDir, options.envFile ?? ".env");
14
+ const existingContent = this.readEnvFile(envFilePath);
15
+ const existingVars = this.parseEnvFile(existingContent);
16
+ const newVars = [];
17
+ let skipped = 0;
18
+ console.log(chalk.bold(`
19
+ Environment variables for '${moduleSlug}':
20
+ `));
21
+ for (const envDef of envVars) {
22
+ if (existingVars.has(envDef.name)) {
23
+ console.log(chalk.dim(` ${envDef.name} \u2014 already set, skipping`));
24
+ skipped++;
25
+ continue;
26
+ }
27
+ let value;
28
+ if (envDef.sensitive) {
29
+ value = await this.promptPassword(
30
+ ` ${envDef.name} (${envDef.description})${envDef.default ? " [****]" : ""}: `
31
+ );
32
+ if (!value && envDef.default) value = envDef.default;
33
+ } else {
34
+ const defaultHint = envDef.default ? ` [${envDef.default}]` : "";
35
+ value = await this.promptInput(
36
+ ` ${envDef.name} (${envDef.description})${defaultHint}: `,
37
+ envDef.default
38
+ );
39
+ }
40
+ if (envDef.required && !value) {
41
+ console.log(chalk.yellow(` ${envDef.name} is required.`));
42
+ value = envDef.sensitive ? await this.promptPassword(` ${envDef.name}: `) : await this.promptInput(` ${envDef.name}: `);
43
+ if (!value) {
44
+ console.log(chalk.yellow(` Skipping ${envDef.name} \u2014 set it manually in .env`));
45
+ skipped++;
46
+ continue;
47
+ }
48
+ }
49
+ newVars.push({ name: envDef.name, value });
50
+ }
51
+ if (newVars.length === 0) {
52
+ console.log(chalk.dim(" No new environment variables to add."));
53
+ return { added: 0, skipped };
54
+ }
55
+ const markerBlock = this.buildMarkerBlock(moduleSlug, newVars);
56
+ this.appendToEnvFile(envFilePath, existingContent, markerBlock);
57
+ console.log(
58
+ chalk.green(`
59
+ Added ${newVars.length} environment variable(s) to ${options.envFile ?? ".env"}`)
60
+ );
61
+ return { added: newVars.length, skipped };
62
+ }
63
+ removeEnvVars(moduleSlug, options) {
64
+ const envFiles = [".env", ".env.local", ".env.development", ".env.production"];
65
+ if (options.envFile) envFiles.unshift(options.envFile);
66
+ let totalRemoved = 0;
67
+ for (const envFile of envFiles) {
68
+ const envFilePath = path.join(options.projectDir, envFile);
69
+ if (!fs.existsSync(envFilePath)) continue;
70
+ const content = fs.readFileSync(envFilePath, "utf-8");
71
+ const beginMarker = `# [KAVEN_MODULE:${moduleSlug} BEGIN]`;
72
+ const endMarker = `# [KAVEN_MODULE:${moduleSlug} END]`;
73
+ const beginIdx = content.indexOf(beginMarker);
74
+ const endIdx = content.indexOf(endMarker);
75
+ if (beginIdx === -1 || endIdx === -1) continue;
76
+ const block = content.substring(beginIdx, endIdx + endMarker.length);
77
+ const varCount = block.split("\n").filter((l) => /^[A-Z_]+=/.test(l)).length;
78
+ const before = content.substring(0, beginIdx).replace(/\n+$/, "\n");
79
+ const after = content.substring(endIdx + endMarker.length + 1);
80
+ fs.writeFileSync(envFilePath, before + after);
81
+ totalRemoved += varCount;
82
+ if (varCount > 0) {
83
+ console.log(chalk.dim(` Removed ${varCount} env var(s) from ${envFile}`));
84
+ }
85
+ }
86
+ return totalRemoved;
87
+ }
88
+ readEnvFile(filePath) {
89
+ try {
90
+ return fs.readFileSync(filePath, "utf-8");
91
+ } catch {
92
+ return "";
93
+ }
94
+ }
95
+ parseEnvFile(content) {
96
+ const vars = /* @__PURE__ */ new Map();
97
+ for (const line of content.split("\n")) {
98
+ const match = line.match(/^([A-Z_][A-Z0-9_]*)=(.*)$/);
99
+ if (match) vars.set(match[1], match[2]);
100
+ }
101
+ return vars;
102
+ }
103
+ buildMarkerBlock(moduleSlug, vars) {
104
+ return [
105
+ `# [KAVEN_MODULE:${moduleSlug} BEGIN]`,
106
+ ...vars.map((v) => `${v.name}=${v.value}`),
107
+ `# [KAVEN_MODULE:${moduleSlug} END]`
108
+ ].join("\n");
109
+ }
110
+ appendToEnvFile(filePath, existingContent, block) {
111
+ fs.mkdirSync(path.dirname(filePath), { recursive: true });
112
+ const separator = existingContent.endsWith("\n") || existingContent === "" ? "\n" : "\n\n";
113
+ fs.writeFileSync(filePath, existingContent + separator + block + "\n");
114
+ }
115
+ promptInput(message, defaultValue) {
116
+ return new Promise((resolve) => {
117
+ const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
118
+ rl.question(message, (answer) => {
119
+ rl.close();
120
+ resolve(answer || defaultValue || "");
121
+ });
122
+ });
123
+ }
124
+ promptPassword(message) {
125
+ return new Promise((resolve) => {
126
+ const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
127
+ process.stdout.write(message);
128
+ process.stdin.setRawMode?.(true);
129
+ process.stdin.resume();
130
+ let password = "";
131
+ const handler = (key) => {
132
+ const char = key.toString();
133
+ if (char === "\r" || char === "\n") {
134
+ process.stdin.setRawMode?.(false);
135
+ process.stdin.pause();
136
+ process.stdin.removeListener("data", handler);
137
+ process.stdout.write("\n");
138
+ rl.close();
139
+ resolve(password);
140
+ } else if (char === "") {
141
+ process.exit();
142
+ } else if (char === "\x7F") {
143
+ password = password.slice(0, -1);
144
+ process.stdout.clearLine(0);
145
+ process.stdout.cursorTo(0);
146
+ process.stdout.write(message + "*".repeat(password.length));
147
+ } else {
148
+ password += char;
149
+ process.stdout.write("*");
150
+ }
151
+ };
152
+ process.stdin.on("data", handler);
153
+ });
154
+ }
155
+ };
156
+ export {
157
+ EnvManager
158
+ };
@@ -0,0 +1,7 @@
1
+ import {
2
+ MarketplaceClient
3
+ } from "./chunk-GHZX5OAA.js";
4
+ import "./chunk-3RG5ZIWI.js";
5
+ export {
6
+ MarketplaceClient
7
+ };
@@ -0,0 +1,10 @@
1
+ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
2
+ get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
3
+ }) : x)(function(x) {
4
+ if (typeof require !== "undefined") return require.apply(this, arguments);
5
+ throw Error('Dynamic require of "' + x + '" is not supported');
6
+ });
7
+
8
+ export {
9
+ __require
10
+ };