@codemastersolutions/db-utility 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CodeMaster Soluções
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE.es

@@ -0,0 +1,21 @@
+Licencia MIT
+
+Copyright (c) 2024 CodeMaster Soluções
+
+Por la presente se concede permiso, de forma gratuita, a cualquier persona que obtenga una copia
+de este software y de los archivos de documentación asociados (el "Software"), para tratar
+con el Software sin restricciones, incluidos, sin limitación, los derechos
+de uso, copia, modificación, fusión, publicación, distribución, sublicencia y/o venta
+de copias del Software, y para permitir a las personas a las que se les proporcione el Software
+que lo hagan, sujeto a las siguientes condiciones:
+
+El aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas
+las copias o partes sustanciales del Software.
+
+EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O
+IMPLÍCITA, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS DE COMERCIABILIDAD,
+IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS
+AUTORES O TITULARES DE LOS DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN, DAÑOS U OTRA
+RESPONSABILIDAD, YA SEA EN UNA ACCIÓN DE CONTRATO, AGRAVIO O DE OTRO TIPO, QUE SURJA DE,
+FUERA DE O EN CONEXIÓN CON EL SOFTWARE O EL USO U OTRAS NEGOCIACIONES EN EL
+SOFTWARE.

package/LICENSE.pt-BR

@@ -0,0 +1,21 @@
+Licença MIT
+
+Copyright (c) 2024 CodeMaster Soluções
+
+A permissão é concedida, gratuitamente, a qualquer pessoa que obtenha uma cópia
+deste software e dos arquivos de documentação associados (o "Software"), para lidar
+com o Software sem restrições, incluindo, sem limitação, os direitos
+de usar, copiar, modificar, mesclar, publicar, distribuir, sublicenciar e/ou vender
+cópias do Software, e permitir que as pessoas a quem o Software é
+fornecido o façam, sujeito às seguintes condições:
+
+O aviso de direitos autorais acima e este aviso de permissão devem ser incluídos em todas
+as cópias ou partes substanciais do Software.
+
+O SOFTWARE É FORNECIDO "NO ESTADO EM QUE SE ENCONTRA", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU
+IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO,
+ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM NENHUMA HIPÓTESE OS
+AUTORES OU TITULARES DOS DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER REIVINDICAÇÃO, DANOS OU OUTRA
+RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE,
+FORA DE OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO
+SOFTWARE.

package/README.es.md

@@ -0,0 +1,155 @@
+# DbUtility
+
+> La utilidad de base de datos más poderosa.
+
+[![npm version](https://img.shields.io/npm/v/@codemastersolutions/db-utility.svg)](https://www.npmjs.com/package/@codemastersolutions/db-utility)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**[🇺🇸 English](./README.md) | [🇧🇷 Português](./README.pt-BR.md)**
+
+DbUtility es una utilidad poderosa para manipular bases de datos Microsoft SQL Server, MySQL y PostgreSQL. Desarrollada en Node.js y TypeScript, su objetivo es simplificar la conexión a bases de datos, introspección, exportación de modelos y creación de migraciones.
+
+## Características
+
+- **Soporte Multi-Base de Datos**: Conéctese a Microsoft SQL Server, MySQL y PostgreSQL utilizando controladores oficiales (`mssql`, `mysql2`, `pg`).
+- **Configuración Flexible**: Detalles de conexión a través de CLI, `.env`, archivos de configuración JSON.
+- **Introspección**: Analice su base de datos para listar tablas, vistas, procedimientos almacenados, funciones y disparadores.
+- **Exportación de Modelos**: Exporte tablas de base de datos a modelos de Sequelize, TypeORM y Prisma (Próximamente).
+- **Generación de Migraciones**: Cree migraciones a partir de tablas existentes en la base de datos para Sequelize, TypeORM y Prisma (Próximamente).
+
+## Instalación
+
+```bash
+npm install @codemastersolutions/db-utility
+# o globalmente
+npm install -g @codemastersolutions/db-utility
+```
+
+## Configuración
+
+### Inicialización
+
+Puede inicializar un archivo de configuración predeterminado utilizando el comando CLI:
+
+```bash
+dbutility --init
+```
+
+Si el archivo ya existe, puede forzar la recreación con valores predeterminados:
+
+```bash
+dbutility --init -f
+# o
+dbutility --init --force
+```
+
+### Archivo de Configuración (dbutility.config.json)
+
+El archivo de configuración permite definir el idioma de la CLI, directorios de salida y patrones de nombres.
+
+```json
+{
+  "language": "es",
+  "introspection": {
+    "outputDir": "db-utility-introspect"
+  },
+  "migrations": {
+    "outputDir": "db-utility-migrations",
+    "fileNamePattern": "timestamp-prefix"
+  }
+}
+```
+
+### Variables de Entorno (.env)
+
+También puede configurar DbUtility utilizando variables de entorno. Las configuraciones en el archivo JSON tienen prioridad sobre las variables de entorno si ambos están presentes.
+
+```env
+# Idioma (pt-BR, en, es)
+DB_UTILITY_LANG=es
+
+# Directorios de Salida
+DB_UTILITY_INTROSPECTION_OUTPUT_DIR=mi-directorio-introspect
+DB_UTILITY_MIGRATIONS_OUTPUT_DIR=mi-directorio-migrations
+
+# Patrón de Nombre de Archivo de Migración (timestamp-prefix, prefix-timestamp)
+DB_UTILITY_MIGRATIONS_FILE_NAME_PATTERN=prefix-timestamp
+```
+
+## CLI - Interfaz de Línea de Comandos
+
+> **Nota de Seguridad**: Recomendamos encarecidamente utilizar un usuario de base de datos con permisos de **solo lectura** (SELECT) para realizar operaciones de introspección y exportación. Esto minimiza el riesgo de modificaciones accidentales de datos. La biblioteca DbUtility solo ejecuta consultas de metadatos (estructura de la base de datos) y bloquea comandos que puedan modificar datos o leer filas de tablas de negocio.
+
+DbUtility ofrece una CLI robusta para interactuar con sus bases de datos.
+
+### Conectar a la Base de Datos
+
+Pruebe la conexión a su base de datos.
+
+```bash
+dbutility connect -t postgres -H localhost -P 5432 -u usuario -p contraseña -d nombre_base_datos --ssl
+```
+
+### Realizar Introspección
+
+Analice el esquema de la base de datos y genere informes de introspección.
+
+```bash
+dbutility introspect -t mysql -H localhost -P 3306 -u usuario -p contraseña -d nombre_base_datos
+```
+
+### Exportar Modelos
+
+Exporte la estructura de la base de datos a modelos ORM.
+
+```bash
+dbutility export --target sequelize --output ./src/models -t postgres ...
+```
+
+### Generar Migraciones
+
+Genere migraciones a partir de la estructura existente de la base de datos. Este comando limpia el directorio de salida antes de generar nuevos archivos.
+
+```bash
+dbutility migrate --target sequelize --output ./migrations -t postgres ...
+```
+
+Opciones:
+- `--data`: Genera migraciones de datos (seeds) para las tablas especificadas.
+- `--only-data`: Genera SOLO migraciones de datos (seeds).
+- `--tables <tables>`: Lista de tablas separadas por comas para exportar datos.
+
+Al usar `--data`, los archivos de seed se generan inmediatamente después de la migración de creación de la tabla correspondiente.
+
+### Probar Migraciones
+
+Pruebe las migraciones generadas utilizando contenedores Docker.
+
+```bash
+dbutility test --target sequelize --dir ./migrations/sequelize --engines postgres:14
+```
+
+Opciones:
+- `--target <target>`: ORM objetivo (sequelize, typeorm).
+- `--dir <dir>`: Directorio que contiene las migraciones (opcional).
+- `--engines <engines>`: Lista separada por comas de motores de base de datos para probar (ej: postgres:14, mysql:8). Si se omite, intenta leer `database-info.json` generado por el comando migrate.
+
+Requisitos:
+- Docker debe estar instalado y en ejecución.
+
+### Opciones de la CLI
+
+- `-t, --type <type>`: Tipo de base de datos (postgres, mysql, mssql)
+- `-H, --host <host>`: Host de la base de datos
+- `-P, --port <port>`: Puerto de la base de datos
+- `-u, --username <username>`: Usuario de la base de datos
+- `-p, --password <password>`: Contraseña de la base de datos
+- `-d, --database <database>`: Nombre de la base de datos
+- `--ssl`: Habilitar SSL (opcional)
+- `-c, --config <path>`: Ruta a un archivo de configuración específico
+
+## Licencia
+
+MIT © [CodeMaster Soluções](https://github.com/codemastersolutions)
+
+Ver [LICENSE.es](./LICENSE.es) para más información.

package/README.md

@@ -0,0 +1,155 @@
+# DbUtility
+
+> The most powerful database utility.
+
+[![npm version](https://img.shields.io/npm/v/@codemastersolutions/db-utility.svg)](https://www.npmjs.com/package/@codemastersolutions/db-utility)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**[🇧🇷 Português](./README.pt-BR.md) | [🇪🇸 Español](./README.es.md)**
+
+DbUtility is a powerful utility for manipulating Microsoft SQL Server, MySQL, and PostgreSQL databases. Developed in Node.js and TypeScript, it aims to simplify database connection, introspection, model export, and migration creation.
+
+## Features
+
+- **Multi-Database Support**: Connect to Microsoft SQL Server, MySQL, and PostgreSQL using official drivers (`mssql`, `mysql2`, `pg`).
+- **Flexible Configuration**: Connection details via CLI, `.env`, JSON configuration files.
+- **Introspection**: Analyze your database to list tables, views, stored procedures, functions, and triggers.
+- **Model Export**: Export database tables to Sequelize, TypeORM, and Prisma models (Coming soon).
+- **Migration Generation**: Create migrations from existing database tables for Sequelize, TypeORM, and Prisma (Coming soon).
+
+## Installation
+
+```bash
+npm install @codemastersolutions/db-utility
+# or globally
+npm install -g @codemastersolutions/db-utility
+```
+
+## Configuration
+
+### Initialization
+
+You can initialize a default configuration file using the CLI command:
+
+```bash
+dbutility --init
+```
+
+If the file already exists, you can force recreation with default values:
+
+```bash
+dbutility --init -f
+# or
+dbutility --init --force
+```
+
+### Configuration File (dbutility.config.json)
+
+The configuration file allows you to define CLI language, output directories, and naming patterns.
+
+```json
+{
+  "language": "en",
+  "introspection": {
+    "outputDir": "db-utility-introspect"
+  },
+  "migrations": {
+    "outputDir": "db-utility-migrations",
+    "fileNamePattern": "timestamp-prefix"
+  }
+}
+```
+
+### Environment Variables (.env)
+
+You can also configure DbUtility using environment variables. JSON file configurations take precedence over environment variables if both are present.
+
+```env
+# Language (pt-BR, en, es)
+DB_UTILITY_LANG=en
+
+# Output Directories
+DB_UTILITY_INTROSPECTION_OUTPUT_DIR=my-introspect-dir
+DB_UTILITY_MIGRATIONS_OUTPUT_DIR=my-migrations-dir
+
+# Migration File Name Pattern (timestamp-prefix, prefix-timestamp)
+DB_UTILITY_MIGRATIONS_FILE_NAME_PATTERN=prefix-timestamp
+```
+
+## CLI - Command Line Interface
+
+> **Security Note**: We strongly recommend using a database user with **read-only** permissions (SELECT) when performing introspection and export operations. This minimizes the risk of accidental data modifications. The DbUtility library only executes metadata queries (database structure) and blocks commands that could modify data or read business table rows.
+
+DbUtility offers a robust CLI to interact with your databases.
+
+### Connect to Database
+
+Test connection to your database.
+
+```bash
+dbutility connect -t postgres -H localhost -P 5432 -u username -p password -d database_name --ssl
+```
+
+### Perform Introspection
+
+Analyze database schema and generate introspection reports.
+
+```bash
+dbutility introspect -t mysql -H localhost -P 3306 -u username -p password -d database_name
+```
+
+### Export Models
+
+Export database structure to ORM models.
+
+```bash
+dbutility export --target sequelize --output ./src/models -t postgres ...
+```
+
+### Generate Migrations
+
+Generate migrations from existing database structure. This command cleans the output directory before generating new files.
+
+```bash
+dbutility migrate --target sequelize --output ./migrations -t postgres ...
+```
+
+Options:
+- `--data`: Generate data migrations (seeds) for specified tables.
+- `--only-data`: Generate ONLY data migrations (seeds).
+- `--tables <tables>`: Comma-separated list of tables to export data from.
+
+When using `--data`, seed files are generated immediately after their corresponding table creation migration.
+
+### Test Migrations
+
+Test generated migrations using Docker containers.
+
+```bash
+dbutility test --target sequelize --dir ./migrations/sequelize --engines postgres:14
+```
+
+Options:
+- `--target <target>`: Target ORM (sequelize, typeorm).
+- `--dir <dir>`: Directory containing migrations (optional).
+- `--engines <engines>`: Comma-separated list of database engines to test (e.g., postgres:14, mysql:8). If omitted, it tries to read `database-info.json` generated by the migrate command.
+
+Requirements:
+- Docker must be installed and running.
+
+### CLI Options
+
+- `-t, --type <type>`: Database type (postgres, mysql, mssql)
+- `-H, --host <host>`: Database host
+- `-P, --port <port>`: Database port
+- `-u, --username <username>`: Database username
+- `-p, --password <password>`: Database password
+- `-d, --database <database>`: Database name
+- `--ssl`: Enable SSL (optional)
+- `-c, --config <path>`: Path to a specific configuration file
+
+## License
+
+MIT © [CodeMaster Soluções](https://github.com/codemastersolutions)
+
+See [LICENSE](./LICENSE) for more information.

package/README.pt-BR.md

@@ -0,0 +1,155 @@
+# DbUtility
+
+> O mais poderoso utilitário de banco de dados.
+
+[![npm version](https://img.shields.io/npm/v/@codemastersolutions/db-utility.svg)](https://www.npmjs.com/package/@codemastersolutions/db-utility)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**[🇺🇸 English](./README.md) | [🇪🇸 Español](./README.es.md)**
+
+DbUtility é um utilitário poderoso para manipulação de bancos de dados Microsoft SQL Server, MySQL e PostgreSQL. Desenvolvido em Node.js e TypeScript, visa simplificar a conexão com banco de dados, introspecção, exportação de models e criação de migrations.
+
+## Funcionalidades
+
+- **Suporte Multi-Banco**: Conecte-se ao Microsoft SQL Server, MySQL e PostgreSQL usando drivers oficiais (`mssql`, `mysql2`, `pg`).
+- **Configuração Flexível**: Detalhes de conexão via CLI, `.env`, arquivos de configuração JSON.
+- **Introspecção**: Analise seu banco de dados para listar tabelas, views, stored procedures, funções e triggers.
+- **Exportação de Models**: Exporte tabelas do banco de dados para models do Sequelize, TypeORM e Prisma (Em breve).
+- **Geração de Migrations**: Crie migrations a partir de tabelas existentes no banco de dados para Sequelize, TypeORM e Prisma (Em breve).
+
+## Instalação
+
+```bash
+npm install @codemastersolutions/db-utility
+# ou globalmente
+npm install -g @codemastersolutions/db-utility
+```
+
+## Configuração
+
+### Inicialização
+
+Você pode inicializar um arquivo de configuração padrão usando o comando CLI:
+
+```bash
+dbutility --init
+```
+
+Se o arquivo já existir, você pode forçar a recriação com os valores padrão:
+
+```bash
+dbutility --init -f
+# ou
+dbutility --init --force
+```
+
+### Arquivo de Configuração (dbutility.config.json)
+
+O arquivo de configuração permite definir o idioma da CLI, diretórios de saída e padrões de nomenclatura.
+
+```json
+{
+  "language": "pt-BR",
+  "introspection": {
+    "outputDir": "db-utility-introspect"
+  },
+  "migrations": {
+    "outputDir": "db-utility-migrations",
+    "fileNamePattern": "timestamp-prefix"
+  }
+}
+```
+
+### Variáveis de Ambiente (.env)
+
+Você também pode configurar o DbUtility usando variáveis de ambiente. As configurações no arquivo JSON têm prioridade sobre as variáveis de ambiente se ambos estiverem presentes.
+
+```env
+# Idioma (pt-BR, en, es)
+DB_UTILITY_LANG=pt-BR
+
+# Diretórios de Saída
+DB_UTILITY_INTROSPECTION_OUTPUT_DIR=meu-diretorio-introspect
+DB_UTILITY_MIGRATIONS_OUTPUT_DIR=meu-diretorio-migrations
+
+# Padrão de Nome de Arquivo de Migration (timestamp-prefix, prefix-timestamp)
+DB_UTILITY_MIGRATIONS_FILE_NAME_PATTERN=prefix-timestamp
+```
+
+## CLI - Interface de Linha de Comando
+
+> **Nota de Segurança**: Recomendamos fortemente o uso de um usuário de banco de dados com permissões de **somente leitura** (SELECT) para realizar operações de introspecção e exportação. Isso minimiza riscos de alterações acidentais nos dados. A biblioteca DbUtility executa apenas consultas de metadados (estrutura do banco) e bloqueia comandos que possam alterar dados ou ler registros das tabelas de negócio.
+
+O DbUtility oferece uma CLI robusta para interagir com seus bancos de dados.
+
+### Conectar ao Banco de Dados
+
+Teste a conexão com seu banco de dados.
+
+```bash
+dbutility connect -t postgres -H localhost -P 5432 -u usuario -p senha -d banco_dados --ssl
+```
+
+### Realizar Introspecção
+
+Analise o esquema do banco de dados e gere relatórios de introspecção.
+
+```bash
+dbutility introspect -t mysql -H localhost -P 3306 -u usuario -p senha -d banco_dados
+```
+
+### Exportar Models
+
+Exporte a estrutura do banco de dados para models de ORM.
+
+```bash
+dbutility export --target sequelize --output ./src/models -t postgres ...
+```
+
+### Gerar Migrations
+
+Gere migrations a partir da estrutura existente do banco de dados. Este comando limpa o diretório de saída antes de gerar novos arquivos.
+
+```bash
+dbutility migrate --target sequelize --output ./migrations -t postgres ...
+```
+
+Opções:
+- `--data`: Gera migrations de dados (seeds) para as tabelas especificadas.
+- `--only-data`: Gera APENAS migrations de dados (seeds).
+- `--tables <tables>`: Lista de tabelas separadas por vírgula para exportar dados.
+
+Ao usar `--data`, os arquivos de seed são gerados imediatamente após a migration de criação da tabela correspondente.
+
+### Testar Migrations
+
+Teste as migrations geradas usando containers Docker.
+
+```bash
+dbutility test --target sequelize --dir ./migrations/sequelize --engines postgres:14
+```
+
+Opções:
+- `--target <target>`: ORM alvo (sequelize, typeorm).
+- `--dir <dir>`: Diretório contendo as migrations (opcional).
+- `--engines <engines>`: Lista separada por vírgula de engines de banco de dados para testar (ex: postgres:14, mysql:8). Se omitido, tenta ler `database-info.json` gerado pelo comando migrate.
+
+Requisitos:
+- Docker deve estar instalado e em execução.
+
+### Opções da CLI
+
+- `-t, --type <type>`: Tipo de banco de dados (postgres, mysql, mssql)
+- `-H, --host <host>`: Host do banco de dados
+- `-P, --port <port>`: Porta do banco de dados
+- `-u, --username <username>`: Usuário do banco de dados
+- `-p, --password <password>`: Senha do banco de dados
+- `-d, --database <database>`: Nome do banco de dados
+- `--ssl`: Habilitar SSL (opcional)
+- `-c, --config <path>`: Caminho para um arquivo de configuração específico
+
+## Licença
+
+MIT © [CodeMaster Soluções](https://github.com/codemastersolutions)
+
+Veja [LICENSE.pt-BR](./LICENSE.pt-BR) para mais informações.

package/dist/cli/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}