@gzl10/osx-cli 4.0.0

package/README.md

@@ -0,0 +1,57 @@
+# @gzl10/osx-cli
+
+CLI para extraer esquemas de tablas Oracle y generar JSON compatible con Atlas.
+
+## Instalacion
+
+```bash
+npm install -g @gzl10/osx-cli
+```
+
+## Uso
+
+```bash
+# Una tabla
+osx extract CUSTOMERS --tns PROD_DB -u USER -p PASS
+
+# Multiples tablas
+osx extract CUSTOMERS,ORDERS --tns PROD_DB -u USER -p PASS -o output.json
+
+# Con variables de entorno
+export OSX_USER=USER OSX_PASSWORD=PASS
+osx extract PRODUCTS --tns PROD_DB --pretty
+```
+
+## Opciones
+
+| Opcion | Descripcion |
+| ------ | ----------- |
+| `-t, --tns` | Alias TNS (requerido) |
+| `-s, --schema` | Schema Oracle (default: TNS) |
+| `-u, --user` | Usuario (o env: OSX_USER) |
+| `-p, --password` | Password (o env: OSX_PASSWORD) |
+| `-o, --output` | Fichero salida (default: stdout) |
+| `--pretty` | JSON formateado |
+| `-d, --delay` | Delay entre tablas (ms) |
+
+## Requisitos
+
+- Node.js >= 20
+- Oracle Instant Client
+- Oracle Database 11g, 12c, 18c, 19c, 21c o 23ai
+
+## tnsnames.ora
+
+```text
+PROD_DB =
+  (DESCRIPTION =
+    (ADDRESS = (PROTOCOL = TCP)(HOST = oracle.example.com)(PORT = 1521))
+    (CONNECT_DATA = (SERVICE_NAME = ORCL))
+  )
+```
+
+Variable de entorno: `TNS_ADMIN=/path/to/tnsnames`
+
+## Licencia
+
+MIT

package/dist/chunk-ILUPEXRP.js

@@ -0,0 +1,137 @@
+// src/services/OracleService.ts
+import oracledb from "oracledb";
+var OracleService = class {
+  connection = null;
+  /**
+   * Conecta a Oracle usando TNS
+   */
+  async connect(config) {
+    this.connection = await oracledb.getConnection({
+      user: config.user,
+      password: config.password,
+      connectString: config.tns
+    });
+  }
+  /**
+   * Ejecuta una query con parámetros nombrados
+   */
+  async query(sql, params) {
+    if (!this.connection) {
+      throw new Error(
+        "No hay conexi\xF3n activa a Oracle. Llama a connect() antes de ejecutar queries."
+      );
+    }
+    const result = await this.connection.execute(sql, params, {
+      outFormat: oracledb.OUT_FORMAT_OBJECT
+    });
+    return result.rows || [];
+  }
+  /**
+   * Cierra la conexión
+   */
+  async close() {
+    if (this.connection) {
+      await this.connection.close();
+      this.connection = null;
+    }
+  }
+};
+
+// src/queries/schema.ts
+var TABLE_COMMENT = `
+  SELECT comments
+  FROM ALL_TAB_COMMENTS
+  WHERE owner = :schema AND table_name = :tableName
+`;
+var TABLE_COLUMNS = `
+  SELECT
+    COLS.COLUMN_NAME as "column_name",
+    DESCRIP.COMMENTS as "comment",
+    COLS.DATA_TYPE as "data_type",
+    COLS.DATA_LENGTH as "data_length",
+    COLS.DATA_PRECISION as "data_precision",
+    COLS.NULLABLE as "nullable",
+    CASE WHEN PK.COLUMN_NAME IS NOT NULL THEN 'Y' ELSE 'N' END AS "is_pk"
+  FROM SYS.ALL_TAB_COLUMNS COLS
+  JOIN SYS.ALL_COL_COMMENTS DESCRIP
+    ON DESCRIP.OWNER = COLS.OWNER
+    AND DESCRIP.TABLE_NAME = COLS.TABLE_NAME
+    AND DESCRIP.COLUMN_NAME = COLS.COLUMN_NAME
+  LEFT JOIN (
+    SELECT acc.COLUMN_NAME
+    FROM ALL_CONSTRAINTS ac
+    JOIN ALL_CONS_COLUMNS acc
+      ON ac.OWNER = acc.OWNER
+      AND ac.CONSTRAINT_NAME = acc.CONSTRAINT_NAME
+    WHERE ac.CONSTRAINT_TYPE = 'P'
+      AND ac.OWNER = :schema
+      AND acc.TABLE_NAME = :tableName
+  ) PK ON PK.COLUMN_NAME = COLS.COLUMN_NAME
+  WHERE COLS.OWNER = :schema AND COLS.TABLE_NAME = :tableName
+  ORDER BY COLS.COLUMN_ID
+`;
+var TABLE_CHILDREN = `
+  SELECT DISTINCT ac_child.table_name AS "child_table"
+  FROM all_constraints ac_parent
+  JOIN all_constraints ac_child
+    ON ac_parent.constraint_name = ac_child.r_constraint_name
+    AND ac_parent.owner = ac_child.r_owner
+  WHERE ac_parent.owner = :schema
+    AND ac_parent.table_name = :tableName
+    AND ac_parent.constraint_type = 'P'
+    AND ac_child.constraint_type = 'R'
+    AND ac_child.status = 'ENABLED'
+`;
+
+// src/services/SchemaExtractor.ts
+var SchemaExtractor = class {
+  constructor(oracle) {
+    this.oracle = oracle;
+  }
+  /**
+   * Extrae el esquema completo de una tabla
+   */
+  async extractTable(schema, tableName) {
+    const [commentRow] = await this.oracle.query(TABLE_COMMENT, {
+      schema,
+      tableName
+    });
+    const columns = await this.oracle.query(TABLE_COLUMNS, {
+      schema,
+      tableName
+    });
+    const childrenRows = await this.oracle.query(TABLE_CHILDREN, {
+      schema,
+      tableName
+    });
+    return {
+      schema,
+      name: tableName,
+      comment: commentRow?.COMMENTS || "",
+      columns,
+      children: childrenRows.map((r) => r.child_table)
+    };
+  }
+  /**
+   * Extrae múltiples tablas con delay opcional entre ellas
+   */
+  async extractTables(schema, tableNames, delayMs = 0) {
+    const results = [];
+    for (let i = 0; i < tableNames.length; i++) {
+      const table = await this.extractTable(schema, tableNames[i]);
+      results.push(table);
+      if (delayMs > 0 && i < tableNames.length - 1) {
+        await new Promise((r) => setTimeout(r, delayMs));
+      }
+    }
+    return results;
+  }
+};
+
+export {
+  OracleService,
+  TABLE_COMMENT,
+  TABLE_COLUMNS,
+  TABLE_CHILDREN,
+  SchemaExtractor
+};

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+import {
+  OracleService,
+  SchemaExtractor
+} from "./chunk-ILUPEXRP.js";
+
+// src/cli.ts
+import { program } from "commander";
+
+// src/commands/extract.ts
+import { writeFileSync } from "fs";
+function formatOracleError(message, tns, schema) {
+  if (message.includes("ORA-01017")) {
+    return `
+\u274C Error de autenticaci\xF3n en Oracle
+
+   TNS: ${tns}
+   Schema: ${schema}
+
+   El usuario o password son incorrectos.
+   Verifica las credenciales e intenta de nuevo.
+`;
+  }
+  if (message.includes("ORA-12154") || message.includes("TNS:could not resolve")) {
+    return `
+\u274C Error: No se puede resolver el alias TNS
+
+   TNS especificado: ${tns}
+
+   Posibles causas:
+   \u2022 El alias no existe en tnsnames.ora
+   \u2022 La variable TNS_ADMIN no apunta al directorio correcto
+   \u2022 El archivo tnsnames.ora tiene errores de sintaxis
+
+   Verifica con: cat $TNS_ADMIN/tnsnames.ora | grep -i ` + tns + "\n";
+  }
+  if (message.includes("ORA-12541") || message.includes("TNS:no listener")) {
+    return `
+\u274C Error: No hay listener en el servidor Oracle
+
+   TNS: ${tns}
+
+   El servidor Oracle no est\xE1 escuchando conexiones.
+   Contacta al administrador de base de datos.
+`;
+  }
+  if (message.includes("ORA-12170") || message.includes("TNS:Connect timeout")) {
+    return `
+\u274C Error: Timeout de conexi\xF3n a Oracle
+
+   TNS: ${tns}
+
+   No se pudo establecer conexi\xF3n en el tiempo l\xEDmite.
+   Posibles causas:
+   \u2022 El servidor est\xE1 apagado o inaccesible
+   \u2022 Firewall bloqueando el puerto 1521
+   \u2022 Problemas de red
+`;
+  }
+  if (message.includes("ORA-00942")) {
+    return `
+\u274C Error: Tabla o vista no existe
+
+   Schema: ${schema}
+
+   La tabla especificada no existe o no tienes permisos.
+   Verifica el nombre de la tabla y los permisos del usuario.
+`;
+  }
+  if (message.includes("ORA-01031")) {
+    return `
+\u274C Error: Permisos insuficientes
+
+   Schema: ${schema}
+
+   El usuario no tiene permisos para acceder a las vistas del diccionario.
+   Solicita al DBA: GRANT SELECT ON SYS.ALL_TAB_COLUMNS TO ` + schema + ";\n";
+  }
+  return `
+\u274C Error de Oracle
+
+   ${message}
+`;
+}
+async function extractCommand(tables, options) {
+  const user = options.user || process.env.OSX_USER;
+  const password = options.password || process.env.OSX_PASSWORD;
+  const schema = options.schema || options.tns;
+  if (!user || !password) {
+    console.error(
+      "\n\u274C Error: Credenciales de Oracle no proporcionadas\n\nDebes especificar usuario y password de una de estas formas:\n\n  1. Flags de l\xEDnea de comandos:\n     osx extract D0001 --tns TRON_LD -u USUARIO -p PASSWORD\n\n  2. Variables de entorno:\n     export OSX_USER=USUARIO\n     export OSX_PASSWORD=PASSWORD\n     osx extract D0001 --tns TRON_LD\n"
+    );
+    process.exit(1);
+  }
+  const oracle = new OracleService();
+  try {
+    console.error(`Conectando a ${options.tns}...`);
+    await oracle.connect({ tns: options.tns, user, password });
+    const tableNames = tables.split(",").map((t) => t.trim().toUpperCase()).filter(Boolean);
+    if (tableNames.length === 0) {
+      console.error(
+        "\n\u274C Error: No se especificaron tablas a extraer\n\nUso: osx extract <TABLA> [--tns ALIAS]\n\nEjemplos:\n  osx extract D0001 --tns TRON_LD\n  osx extract D0001,D0002,D0003 --tns TRON_LD\n"
+      );
+      process.exit(1);
+    }
+    console.error(`Extrayendo ${tableNames.length} tabla(s) de ${schema}...`);
+    const extractor = new SchemaExtractor(oracle);
+    const delayMs = options.delay ? parseInt(options.delay, 10) : 0;
+    const results = await extractor.extractTables(schema, tableNames, delayMs);
+    const output = results.length === 1 ? results[0] : results;
+    const json = options.pretty ? JSON.stringify(output, null, 2) : JSON.stringify(output);
+    if (options.output) {
+      writeFileSync(options.output, json, "utf-8");
+      console.error(`Escrito: ${options.output}`);
+    } else {
+      console.log(json);
+    }
+    console.error("Completado.");
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(formatOracleError(message, options.tns, schema));
+    process.exit(1);
+  } finally {
+    await oracle.close();
+  }
+}
+
+// src/cli.ts
+program.name("osx").description("Oracle Schema Extractor - Genera JSON compatible con Atlas OriginType=BBDD").version("1.0.0");
+program.command("extract <tables>").description("Extrae esquema de tabla(s) Oracle. Tablas separadas por coma.").requiredOption("-t, --tns <alias>", "Alias TNS de tnsnames.ora").option("-s, --schema <name>", "Schema Oracle (default: mismo que TNS)").option("-u, --user <user>", "Usuario Oracle (o env: OSX_USER)").option("-p, --password <pass>", "Password Oracle (o env: OSX_PASSWORD)").option("-o, --output <file>", "Fichero de salida (default: stdout)").option("--pretty", "JSON formateado con indentacion").option("-d, --delay <ms>", "Delay entre tablas en ms", "0").action(extractCommand);
+program.parse();

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Representa una columna de Oracle
+ */
+interface OracleColumn {
+    column_name: string;
+    comment: string | null;
+    data_type: string;
+    data_length: number | null;
+    data_precision: number | null;
+    nullable: 'Y' | 'N';
+    is_pk: 'Y' | 'N';
+}
+/**
+ * Esquema de tabla compatible con Atlas OriginType=BBDD
+ */
+interface TableSchema {
+    schema: string;
+    name: string;
+    comment: string;
+    columns: OracleColumn[];
+    children: string[];
+}
+/**
+ * Opciones del comando extract
+ */
+interface ExtractOptions {
+    tns: string;
+    schema?: string;
+    user?: string;
+    password?: string;
+    output?: string;
+    pretty?: boolean;
+    delay?: string;
+}
+/**
+ * Configuración de conexión Oracle
+ */
+interface OracleConfig {
+    tns: string;
+    user: string;
+    password: string;
+}
+
+/**
+ * Servicio de conexión y queries a Oracle
+ */
+declare class OracleService {
+    private connection;
+    /**
+     * Conecta a Oracle usando TNS
+     */
+    connect(config: OracleConfig): Promise<void>;
+    /**
+     * Ejecuta una query con parámetros nombrados
+     */
+    query<T extends object>(sql: string, params: Record<string, unknown>): Promise<T[]>;
+    /**
+     * Cierra la conexión
+     */
+    close(): Promise<void>;
+}
+
+/**
+ * Extractor de esquemas de tablas Oracle
+ */
+declare class SchemaExtractor {
+    private oracle;
+    constructor(oracle: OracleService);
+    /**
+     * Extrae el esquema completo de una tabla
+     */
+    extractTable(schema: string, tableName: string): Promise<TableSchema>;
+    /**
+     * Extrae múltiples tablas con delay opcional entre ellas
+     */
+    extractTables(schema: string, tableNames: string[], delayMs?: number): Promise<TableSchema[]>;
+}
+
+/**
+ * Query para obtener el comentario de una tabla
+ */
+declare const TABLE_COMMENT = "\n  SELECT comments\n  FROM ALL_TAB_COMMENTS\n  WHERE owner = :schema AND table_name = :tableName\n";
+/**
+ * Query para obtener las columnas de una tabla con sus metadatos
+ * Incluye: nombre, comentario, tipo de dato, nullable, si es PK
+ */
+declare const TABLE_COLUMNS = "\n  SELECT\n    COLS.COLUMN_NAME as \"column_name\",\n    DESCRIP.COMMENTS as \"comment\",\n    COLS.DATA_TYPE as \"data_type\",\n    COLS.DATA_LENGTH as \"data_length\",\n    COLS.DATA_PRECISION as \"data_precision\",\n    COLS.NULLABLE as \"nullable\",\n    CASE WHEN PK.COLUMN_NAME IS NOT NULL THEN 'Y' ELSE 'N' END AS \"is_pk\"\n  FROM SYS.ALL_TAB_COLUMNS COLS\n  JOIN SYS.ALL_COL_COMMENTS DESCRIP\n    ON DESCRIP.OWNER = COLS.OWNER\n    AND DESCRIP.TABLE_NAME = COLS.TABLE_NAME\n    AND DESCRIP.COLUMN_NAME = COLS.COLUMN_NAME\n  LEFT JOIN (\n    SELECT acc.COLUMN_NAME\n    FROM ALL_CONSTRAINTS ac\n    JOIN ALL_CONS_COLUMNS acc\n      ON ac.OWNER = acc.OWNER\n      AND ac.CONSTRAINT_NAME = acc.CONSTRAINT_NAME\n    WHERE ac.CONSTRAINT_TYPE = 'P'\n      AND ac.OWNER = :schema\n      AND acc.TABLE_NAME = :tableName\n  ) PK ON PK.COLUMN_NAME = COLS.COLUMN_NAME\n  WHERE COLS.OWNER = :schema AND COLS.TABLE_NAME = :tableName\n  ORDER BY COLS.COLUMN_ID\n";
+/**
+ * Query para obtener las tablas hijas (que tienen FK hacia esta tabla)
+ */
+declare const TABLE_CHILDREN = "\n  SELECT DISTINCT ac_child.table_name AS \"child_table\"\n  FROM all_constraints ac_parent\n  JOIN all_constraints ac_child\n    ON ac_parent.constraint_name = ac_child.r_constraint_name\n    AND ac_parent.owner = ac_child.r_owner\n  WHERE ac_parent.owner = :schema\n    AND ac_parent.table_name = :tableName\n    AND ac_parent.constraint_type = 'P'\n    AND ac_child.constraint_type = 'R'\n    AND ac_child.status = 'ENABLED'\n";
+
+export { type ExtractOptions, type OracleColumn, type OracleConfig, OracleService, SchemaExtractor, TABLE_CHILDREN, TABLE_COLUMNS, TABLE_COMMENT, type TableSchema };

package/dist/index.js

@@ -0,0 +1,14 @@
+import {
+  OracleService,
+  SchemaExtractor,
+  TABLE_CHILDREN,
+  TABLE_COLUMNS,
+  TABLE_COMMENT
+} from "./chunk-ILUPEXRP.js";
+export {
+  OracleService,
+  SchemaExtractor,
+  TABLE_CHILDREN,
+  TABLE_COLUMNS,
+  TABLE_COMMENT
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@gzl10/osx-cli",
+  "version": "4.0.0",
+  "description": "Oracle Schema Extractor CLI - Genera JSON compatible con Atlas OriginType=BBDD",
+  "type": "module",
+  "bin": {
+    "osx": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "oracle",
+    "schema",
+    "extractor",
+    "cli",
+    "atlas",
+    "database"
+  ],
+  "author": "GZL10",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^13.1.0",
+    "oracledb": "^6.7.1",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "@vitest/coverage-v8": "^2.1.8",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsup && node scripts/add-shebang.js",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}