smoonb 0.0.59 → 0.0.61

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
@@ -242,6 +242,65 @@ npx smoonb restore
242
242
  - ✅ `.backup.gz` (compactado) - Descompacta automaticamente antes de restaurar
243
243
  - ✅ `.backup` (descompactado) - Restaura diretamente
244
244
 
245
+ ### Importar Backup do Dashboard do Supabase
246
+
247
+ Se você baixou um backup diretamente do Dashboard do Supabase (formato `.backup.gz`), você pode importá-lo para o formato esperado pelo smoonb. O comando também suporta importar arquivos de storage (`.storage.zip`) opcionalmente.
248
+
249
+ **Importar apenas database:**
250
+ ```bash
251
+ npx smoonb import --file "caminho/completo/para/db_cluster-04-03-2024@14-16-59.backup.gz"
252
+ ```
253
+
254
+ **Importar database e storage juntos:**
255
+ ```bash
256
+ npx smoonb import --file "backup.backup.gz" --storage "meu-projeto.storage.zip"
257
+ ```
258
+
259
+ **O que o comando faz:**
260
+ 1. Lê o arquivo `.backup.gz` do Dashboard (obrigatório)
261
+ 2. Se fornecido, lê o arquivo `.storage.zip` do Dashboard (opcional)
262
+ 3. Extrai informações do nome do arquivo de backup (data e hora)
263
+ 4. Cria uma pasta de backup no formato esperado (`backup-YYYY-MM-DD-HH-MM-SS`)
264
+ 5. Copia o arquivo de backup para a pasta criada
265
+ 6. Se fornecido, copia o arquivo de storage para a mesma pasta
266
+ 7. Deixa o backup pronto para ser encontrado pelo comando `restore`
267
+
268
+ **Exemplo completo - Apenas database:**
269
+ ```bash
270
+ # 1. Baixar backup do Dashboard do Supabase
271
+ # Arquivo: db_cluster-04-03-2024@14-16-59.backup.gz
272
+
273
+ # 2. Importar o arquivo
274
+ npx smoonb import --file "C:\Downloads\db_cluster-04-03-2024@14-16-59.backup.gz"
275
+
276
+ # 3. Restaurar o backup importado
277
+ npx smoonb restore
278
+ # O backup importado aparecerá na lista de backups disponíveis
279
+ ```
280
+
281
+ **Exemplo completo - Database e Storage:**
282
+ ```bash
283
+ # 1. Baixar backup e storage do Dashboard do Supabase
284
+ # Arquivos:
285
+ # - db_cluster-04-03-2024@14-16-59.backup.gz
286
+ # - meu-projeto.storage.zip
287
+
288
+ # 2. Importar ambos os arquivos
289
+ npx smoonb import --file "C:\Downloads\db_cluster-04-03-2024@14-16-59.backup.gz" --storage "C:\Downloads\meu-projeto.storage.zip"
290
+
291
+ # 3. Restaurar o backup importado
292
+ npx smoonb restore
293
+ # O backup importado aparecerá na lista de backups disponíveis
294
+ ```
295
+
296
+ **Importante:**
297
+ - O arquivo de backup é **obrigatório** e deve estar no formato do Dashboard: `db_cluster-DD-MM-YYYY@HH-MM-SS.backup.gz`
298
+ - O arquivo de storage é **opcional** e deve estar no formato: `*.storage.zip`
299
+ - O storage depende de um backup, mas o backup não depende do storage
300
+ - Ambos os arquivos serão copiados para a mesma pasta de backup
301
+ - O caminho pode ser absoluto ou relativo
302
+ - O comando criará a estrutura de pastas necessária automaticamente
303
+
245
304
  ### Verificação Pós-Restore
246
305
 
247
306
  ```bash
@@ -263,6 +322,7 @@ npx smoonb check
263
322
  |---------|-----------|
264
323
  | `npx smoonb backup` | Backup completo interativo usando Docker |
265
324
  | `npx smoonb restore` | Restauração interativa usando psql (Docker) |
325
+ | `npx smoonb import --file <path> [--storage <path>]` | Importar arquivo .backup.gz e opcionalmente .storage.zip do Dashboard do Supabase |
266
326
  | `npx smoonb check` | Verificação de integridade pós-restore |
267
327
 
268
328
  ## 🏗️ Arquitetura Técnica
package/bin/smoonb.js CHANGED
@@ -23,11 +23,14 @@ const program = new Command();
23
23
  // Configuração básica do programa
24
24
  program
25
25
  .name('smoonb')
26
- .description('Complete Supabase backup and migration tool - EXPERIMENTAL VERSION - USE AT YOUR OWN RISK')
26
+ .description('Complete Supabase backup and migration tool')
27
27
  .version(packageJson.version, '-v, --version', 'display version number')
28
28
  .addHelpText('before', () => {
29
29
  showBetaBanner();
30
- return '';
30
+ return chalk.yellow.bold('\n⚠️ TERMO DE USO E AVISO DE RISCO\n') +
31
+ chalk.white('Ao prosseguir, você reconhece e concorda que o Supa Moonbase (smoonb) é fornecido "NO ESTADO EM QUE SE ENCONTRA" ("AS IS") e "CONFORME DISPONIBILIDADE", sem garantias de qualquer natureza—expressas, implícitas ou legais—incluindo, sem limitação, garantias de comercialização, adequação a um fim específico e não violação, na máxima extensão permitida pela lei aplicável. Operações de backup e restauração envolvem riscos, os ambientes variam amplamente e não é possível prever ou validar todas as configurações dos usuários. Você é o único responsável por validar seu ambiente, manter cópias independentes e verificar os resultados antes de utilizá-los em produção. O Supa Moonbase (smoonb) é construído com repositórios públicos, auditáveis e software livre, para auxiliar pessoas a simplificar seus fluxos, sem com isso criar qualquer garantia, promessa de suporte ou compromisso de nível de serviço.\n\n') +
32
+ chalk.white('Limitação de responsabilidade (PT-BR) — Na máxima extensão permitida por lei, a Goalmoon, seus contribuidores e licenciadores não serão responsáveis por danos indiretos, incidentais, especiais, consequentes, exemplares ou punitivos (incluindo perda de dados, interrupção de negócios ou lucros cessantes) decorrentes do uso, incapacidade de uso, das operações de backup/restauração realizadas com, ou dos resultados gerados pelo Supa Moonbase (smoonb). Em qualquer hipótese, a responsabilidade total por todas as reivindicações relacionadas ao Supa Moonbase (smoonb) não excederá o valor pago por você pelo Supa Moonbase (smoonb) nos 12 meses anteriores ao evento. Nada neste aviso exclui ou limita responsabilidades onde tais limites sejam proibidos por lei, incluindo (conforme aplicável) dolo ou culpa grave.\n\n') +
33
+ chalk.white('Observação para consumidores no Brasil (PT-BR) — Para consumidores brasileiros, este aviso não afasta direitos irrenunciáveis previstos no Código de Defesa do Consumidor (CDC); qualquer limitação aqui prevista só se aplica nos limites da lei e não impede a indenização obrigatória quando cabível.\n\n');
31
34
  })
32
35
  .addHelpText('after', () => {
33
36
  return chalk.cyan.bold(`
@@ -37,6 +40,37 @@ program
37
40
 
38
41
  🔄 ATUALIZAR PARA ÚLTIMA VERSÃO:
39
42
  npm install smoonb@latest
43
+
44
+ 📚 MANUAL DE USO - EXEMPLOS COMPLETOS:
45
+
46
+ ${chalk.yellow.bold('1. BACKUP - Fazer backup completo do projeto:')}
47
+ ${chalk.white('npx smoonb backup')}
48
+ ${chalk.gray('# Processo interativo que captura todos os componentes do Supabase')}
49
+
50
+ ${chalk.white('npx smoonb backup --skip-realtime')}
51
+ ${chalk.gray('# Pula a captura interativa de Realtime Settings')}
52
+
53
+ ${chalk.yellow.bold('2. RESTORE - Restaurar backup em um projeto:')}
54
+ ${chalk.white('npx smoonb restore')}
55
+ ${chalk.gray('# Processo interativo que lista backups disponíveis e permite escolher')}
56
+
57
+ ${chalk.yellow.bold('3. IMPORT - Importar backup do Dashboard do Supabase:')}
58
+ ${chalk.white('npx smoonb import --file "C:\\Downloads\\db_cluster-04-03-2024@14-16-59.backup.gz"')}
59
+ ${chalk.gray('# Importa apenas o arquivo de database')}
60
+
61
+ ${chalk.white('npx smoonb import --file "backup.backup.gz" --storage "meu-projeto.storage.zip"')}
62
+ ${chalk.gray('# Importa database e storage juntos (storage é opcional)')}
63
+
64
+ ${chalk.yellow.bold('4. CHECK - Verificar integridade após restauração:')}
65
+ ${chalk.white('npx smoonb check')}
66
+ ${chalk.gray('# Verifica conexão, extensões, tabelas, RLS, Realtime e Storage')}
67
+
68
+ ${chalk.yellow.bold('💡 DICAS IMPORTANTES:')}
69
+ ${chalk.white('• O comando import requer um arquivo de backup (.backup.gz), mas o storage (.storage.zip) é opcional')}
70
+ ${chalk.white('• O storage depende de um backup, mas o backup não depende do storage')}
71
+ ${chalk.white('• Use caminhos absolutos ou relativos para os arquivos no comando import')}
72
+ ${chalk.white('• O formato do arquivo de backup deve ser: db_cluster-DD-MM-YYYY@HH-MM-SS.backup.gz')}
73
+ ${chalk.white('• O formato do arquivo de storage deve ser: *.storage.zip')}
40
74
  `);
41
75
  });
42
76
 
@@ -44,22 +78,97 @@ program
44
78
  program
45
79
  .command('backup')
46
80
  .description('Fazer backup completo do projeto Supabase usando Supabase CLI')
47
- .option('-o, --output <dir>', 'Diretório de saída do backup')
48
81
  .option('--skip-realtime', 'Pular captura interativa de Realtime Settings')
82
+ .addHelpText('after', `
83
+ ${chalk.yellow.bold('Exemplos:')}
84
+ ${chalk.white('npx smoonb backup')}
85
+ ${chalk.gray('# Processo interativo completo')}
86
+
87
+ ${chalk.white('npx smoonb backup --skip-realtime')}
88
+ ${chalk.gray('# Pula configuração de Realtime Settings')}
89
+
90
+ ${chalk.yellow.bold('O que é capturado:')}
91
+ • Database PostgreSQL (pg_dumpall + SQL separado)
92
+ • Database Extensions and Settings
93
+ • Custom Roles
94
+ • Edge Functions (download automático)
95
+ • Auth Settings (via Management API)
96
+ • Storage Buckets (metadados via Management API)
97
+ • Realtime Settings (7 parâmetros interativos)
98
+ • Supabase .temp (arquivos temporários)
99
+ • Migrations (todas as migrations do projeto)
100
+ `)
49
101
  .action(commands.backup);
50
102
 
51
103
  program
52
104
  .command('restore')
53
105
  .description('Restaurar backup completo usando psql (modo interativo)')
54
- .option('--db-url <url>', 'URL da database de destino (override)')
106
+ .addHelpText('after', `
107
+ ${chalk.yellow.bold('Exemplos:')}
108
+ ${chalk.white('npx smoonb restore')}
109
+ ${chalk.gray('# Processo interativo que lista backups disponíveis')}
110
+
111
+ ${chalk.yellow.bold('Fluxo do restore:')}
112
+ 1. Validação Docker
113
+ 2. Consentimento para ler/escrever .env.local
114
+ 3. Mapeamento de variáveis de ambiente
115
+ 4. Seleção de backup disponível
116
+ 5. Seleção de componentes para restaurar
117
+ 6. Resumo detalhado e confirmação
118
+ 7. Execução da restauração
119
+
120
+ ${chalk.yellow.bold('Formatos suportados:')}
121
+ • .backup.gz (compactado) - Descompacta automaticamente
122
+ • .backup (descompactado) - Restaura diretamente
123
+ `)
55
124
  .action(commands.restore);
56
125
 
57
126
  program
58
127
  .command('check')
59
128
  .description('Verificar integridade do projeto Supabase após restauração')
60
- .option('-o, --output <file>', 'Arquivo de saída do relatório', 'check-report.json')
129
+ .addHelpText('after', `
130
+ ${chalk.yellow.bold('Exemplos:')}
131
+ ${chalk.white('npx smoonb check')}
132
+ ${chalk.gray('# Verifica integridade e exibe relatório no console')}
133
+
134
+ ${chalk.yellow.bold('O que é verificado:')}
135
+ • Conexão com database
136
+ • Extensões PostgreSQL instaladas
137
+ • Tabelas criadas
138
+ • Políticas RLS (Row Level Security)
139
+ • Publicações Realtime
140
+ • Buckets de Storage
141
+ `)
61
142
  .action(commands.check);
62
143
 
144
+ program
145
+ .command('import')
146
+ .description('Importar arquivo .backup.gz e opcionalmente .storage.zip do Dashboard do Supabase')
147
+ .requiredOption('--file <path>', 'Caminho completo do arquivo .backup.gz a importar')
148
+ .option('--storage <path>', 'Caminho completo do arquivo .storage.zip a importar (opcional)')
149
+ .addHelpText('after', `
150
+ ${chalk.yellow.bold('Exemplos:')}
151
+ ${chalk.white('npx smoonb import --file "C:\\Downloads\\db_cluster-04-03-2024@14-16-59.backup.gz"')}
152
+ ${chalk.gray('# Importa apenas o arquivo de database')}
153
+
154
+ ${chalk.white('npx smoonb import --file "backup.backup.gz" --storage "meu-projeto.storage.zip"')}
155
+ ${chalk.gray('# Importa database e storage juntos')}
156
+
157
+ ${chalk.yellow.bold('Formato dos arquivos:')}
158
+ • Backup: db_cluster-DD-MM-YYYY@HH-MM-SS.backup.gz (obrigatório)
159
+ • Storage: *.storage.zip (opcional)
160
+
161
+ ${chalk.yellow.bold('Importante:')}
162
+ • O arquivo de backup é obrigatório
163
+ • O arquivo de storage é opcional e depende de um backup
164
+ • Ambos os arquivos serão copiados para a mesma pasta de backup
165
+ • O backup importado ficará disponível para o comando restore
166
+ • Use caminhos absolutos ou relativos
167
+ `)
168
+ .action(async (options) => {
169
+ await commands.import({ file: options.file, storage: options.storage });
170
+ });
171
+
63
172
  // Tratamento de erros
64
173
  program.on('command:*', function (operands) {
65
174
  console.error(chalk.red.bold('❌ Comando não reconhecido:'), operands[0]);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "smoonb",
3
- "version": "0.0.59",
3
+ "version": "0.0.61",
4
4
  "description": "Complete Supabase backup and migration tool - EXPERIMENTAL VERSION - USE AT YOUR OWN RISK",
5
5
  "preferGlobal": false,
6
6
  "preventGlobalInstall": true,
@@ -66,8 +66,7 @@ module.exports = async (options) => {
66
66
  const second = String(now.getSeconds()).padStart(2, '0');
67
67
 
68
68
  // Resolver diretório de saída
69
- const defaultOutput = options.output || defaultOutputDir;
70
- const backupDir = path.join(defaultOutput, `backup-${year}-${month}-${day}-${hour}-${minute}-${second}`);
69
+ const backupDir = path.join(defaultOutputDir, `backup-${year}-${month}-${day}-${hour}-${minute}-${second}`);
71
70
  await ensureDir(backupDir);
72
71
 
73
72
  // Backup e mapeamento do .env.local
@@ -98,7 +97,7 @@ module.exports = async (options) => {
98
97
  }
99
98
 
100
99
  // Recalcular outputDir a partir do ENV mapeado
101
- const resolvedOutputDir = options.output || getValue('SMOONB_OUTPUT_DIR') || defaultOutputDir;
100
+ const resolvedOutputDir = getValue('SMOONB_OUTPUT_DIR') || defaultOutputDir;
102
101
 
103
102
  // Se mudou o outputDir, movemos o backupDir inicial para o novo local mantendo timestamp
104
103
  const finalBackupDir = backupDir.startsWith(path.resolve(resolvedOutputDir))
@@ -7,7 +7,7 @@ const { IntrospectionService } = require('../services/introspect');
7
7
  const { showBetaBanner } = require('../utils/banner');
8
8
 
9
9
  // Exportar FUNÇÃO em vez de objeto Command
10
- module.exports = async (options) => {
10
+ module.exports = async () => {
11
11
  showBetaBanner();
12
12
 
13
13
  try {
@@ -37,7 +37,7 @@ module.exports = async (options) => {
37
37
  const report = await performChecks(config, databaseUrl);
38
38
 
39
39
  // Salvar relatório
40
- const reportPath = path.resolve(options.output || 'check-report.json');
40
+ const reportPath = path.resolve('check-report.json');
41
41
  await writeJson(reportPath, report);
42
42
 
43
43
  // Mostrar resumo
@@ -0,0 +1,125 @@
1
+ const chalk = require('chalk');
2
+ const path = require('path');
3
+ const fs = require('fs').promises;
4
+ const { ensureDir } = require('../utils/fsx');
5
+ const { readEnvFile } = require('../utils/env');
6
+ const { showBetaBanner } = require('../utils/banner');
7
+
8
+ /**
9
+ * Comando para importar arquivo .backup.gz e opcionalmente .storage.zip do Dashboard do Supabase
10
+ */
11
+ module.exports = async (options) => {
12
+ showBetaBanner();
13
+
14
+ try {
15
+ // Validar que o arquivo de backup foi fornecido
16
+ if (!options.file) {
17
+ console.error(chalk.red('❌ Arquivo de backup não fornecido'));
18
+ console.log(chalk.yellow('💡 Use: npx smoonb import --file <caminho-do-backup> [--storage <caminho-do-storage>]'));
19
+ console.log(chalk.white(' Exemplo: npx smoonb import --file "C:\\Downloads\\db_cluster-04-03-2024@14-16-59.backup.gz"'));
20
+ console.log(chalk.white(' Exemplo com storage: npx smoonb import --file "backup.backup.gz" --storage "meu-projeto.storage.zip"'));
21
+ process.exit(1);
22
+ }
23
+
24
+ const sourceFile = path.resolve(options.file);
25
+
26
+ // Verificar se o arquivo de backup existe
27
+ try {
28
+ await fs.access(sourceFile);
29
+ } catch {
30
+ console.error(chalk.red(`❌ Arquivo de backup não encontrado: ${sourceFile}`));
31
+ process.exit(1);
32
+ }
33
+
34
+ // Verificar se é um arquivo .backup.gz ou .backup
35
+ if (!sourceFile.endsWith('.backup.gz') && !sourceFile.endsWith('.backup')) {
36
+ console.error(chalk.red('❌ Arquivo de backup deve ser .backup.gz ou .backup'));
37
+ process.exit(1);
38
+ }
39
+
40
+ // Validar arquivo de storage se fornecido
41
+ let sourceStorageFile = null;
42
+ if (options.storage) {
43
+ sourceStorageFile = path.resolve(options.storage);
44
+
45
+ try {
46
+ await fs.access(sourceStorageFile);
47
+ } catch {
48
+ console.error(chalk.red(`❌ Arquivo de storage não encontrado: ${sourceStorageFile}`));
49
+ process.exit(1);
50
+ }
51
+
52
+ // Verificar se é um arquivo .storage.zip
53
+ if (!sourceStorageFile.endsWith('.storage.zip')) {
54
+ console.error(chalk.red('❌ Arquivo de storage deve ser .storage.zip'));
55
+ process.exit(1);
56
+ }
57
+ }
58
+
59
+ // Ler .env.local para obter SMOONB_OUTPUT_DIR
60
+ const envPath = path.join(process.cwd(), '.env.local');
61
+ let outputDir = './backups';
62
+
63
+ try {
64
+ const currentEnv = await readEnvFile(envPath);
65
+ outputDir = currentEnv.SMOONB_OUTPUT_DIR || './backups';
66
+ } catch {
67
+ // Se não conseguir ler .env.local, usar padrão
68
+ console.log(chalk.yellow('⚠️ Não foi possível ler .env.local, usando diretório padrão: ./backups'));
69
+ }
70
+
71
+ // Extrair informações do nome do arquivo de backup
72
+ // Formato esperado: db_cluster-DD-MM-YYYY@HH-MM-SS.backup.gz
73
+ const fileName = path.basename(sourceFile);
74
+ const match = fileName.match(/db_cluster-(\d{2})-(\d{2})-(\d{4})@(\d{2})-(\d{2})-(\d{2})\.backup(\.gz)?/);
75
+
76
+ if (!match) {
77
+ console.error(chalk.red('❌ Nome do arquivo de backup não está no formato esperado do Dashboard'));
78
+ console.log(chalk.yellow('💡 Formato esperado: db_cluster-DD-MM-YYYY@HH-MM-SS.backup.gz'));
79
+ console.log(chalk.white(` Arquivo recebido: ${fileName}`));
80
+ process.exit(1);
81
+ }
82
+
83
+ const [, day, month, year, hour, minute, second] = match;
84
+
85
+ // Criar nome da pasta no formato backup-YYYY-MM-DD-HH-MM-SS
86
+ const backupDirName = `backup-${year}-${month}-${day}-${hour}-${minute}-${second}`;
87
+ const backupDir = path.join(outputDir, backupDirName);
88
+
89
+ // Criar diretório de backup
90
+ await ensureDir(backupDir);
91
+ console.log(chalk.blue(`📁 Criando diretório de backup: ${backupDirName}`));
92
+
93
+ // Copiar arquivo de backup para o diretório de backup
94
+ const destFile = path.join(backupDir, fileName);
95
+ await fs.copyFile(sourceFile, destFile);
96
+
97
+ // Obter tamanho do arquivo de backup
98
+ const stats = await fs.stat(destFile);
99
+ const sizeMB = (stats.size / (1024 * 1024)).toFixed(2);
100
+
101
+ console.log(chalk.green(`✅ Arquivo de backup importado com sucesso!`));
102
+ console.log(chalk.blue(`📦 Backup: ${fileName} (${sizeMB} MB)`));
103
+
104
+ // Copiar arquivo de storage se fornecido
105
+ if (sourceStorageFile) {
106
+ const storageFileName = path.basename(sourceStorageFile);
107
+ const destStorageFile = path.join(backupDir, storageFileName);
108
+ await fs.copyFile(sourceStorageFile, destStorageFile);
109
+
110
+ const storageStats = await fs.stat(destStorageFile);
111
+ const storageSizeMB = (storageStats.size / (1024 * 1024)).toFixed(2);
112
+
113
+ console.log(chalk.green(`✅ Arquivo de storage importado com sucesso!`));
114
+ console.log(chalk.blue(`📦 Storage: ${storageFileName} (${storageSizeMB} MB)`));
115
+ }
116
+
117
+ console.log(chalk.blue(`📁 Localização: ${backupDir}`));
118
+ console.log(chalk.cyan(`\n💡 Próximo passo: Execute 'npx smoonb restore' para restaurar este backup`));
119
+
120
+ } catch (error) {
121
+ console.error(chalk.red(`❌ Erro ao importar arquivo: ${error.message}`));
122
+ process.exit(1);
123
+ }
124
+ };
125
+
package/src/index.js CHANGED
@@ -13,6 +13,7 @@ const { showBetaBanner } = require('./utils/banner');
13
13
  const backupCommand = require('./commands/backup');
14
14
  const restoreCommand = require('./commands/restore');
15
15
  const checkCommand = require('./commands/check');
16
+ const importCommand = require('./commands/import');
16
17
 
17
18
  // Exportar utilitários
18
19
  const supabaseUtils = require('./utils/supabase');
@@ -218,7 +219,8 @@ module.exports = {
218
219
  commands: {
219
220
  backup: backupCommand,
220
221
  restore: restoreCommand,
221
- check: checkCommand
222
+ check: checkCommand,
223
+ import: importCommand
222
224
  },
223
225
 
224
226
  // Utilitários