@dbml/connector 5.6.0-alpha.1 → 6.0.0

package/dist/utils/credential-loader.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCredentialFromFile = loadCredentialFromFile;
+exports.parseBigQueryCredential = parseBigQueryCredential;
+const promises_1 = require("fs/promises");
+async function loadCredentialFromFile(filename) {
+    try {
+        const data = await (0, promises_1.readFile)(filename, { encoding: 'utf8' });
+        return data;
+    }
+    catch (error) {
+        if (error.name === 'TypeError' || error.name === 'Error') {
+            throw new Error(`Load credential error: ${error.message}`);
+        }
+        throw error;
+    }
+}
+function parseBigQueryCredential(credentialString) {
+    try {
+        const credentialJson = JSON.parse(credentialString);
+        const { project_id: projectId, client_email: clientEmail, private_key: privateKey, datasets, } = credentialJson;
+        // valid datasets: ['dataset_1', 'dataset_2']
+        const parsedDatasets = !Array.isArray(datasets)
+            ? []
+            : datasets.filter((dataset) => typeof dataset === 'string');
+        const parsedCredentials = {
+            datasets: parsedDatasets,
+        };
+        // Validate and add projectId if provided
+        if (projectId !== undefined) {
+            if (typeof projectId !== 'string' || !projectId || !projectId.trim()) {
+                throw new Error('project_id must be a non-empty string when provided');
+            }
+            parsedCredentials.projectId = projectId;
+        }
+        // Validate and add credentials if provided
+        // Note: If one credential field is provided, both must be provided
+        if (clientEmail !== undefined || privateKey !== undefined) {
+            if (!clientEmail || typeof clientEmail !== 'string' || !clientEmail.trim()) {
+                throw new Error('client_email must be a non-empty string when credentials are provided');
+            }
+            if (!privateKey || typeof privateKey !== 'string' || !privateKey.trim()) {
+                throw new Error('private_key must be a non-empty string when credentials are provided');
+            }
+            parsedCredentials.credentials = {
+                clientEmail,
+                privateKey,
+            };
+        }
+        return parsedCredentials;
+    }
+    catch (error) {
+        if (error instanceof SyntaxError) {
+            throw new Error('Credentials must be in JSON format');
+        }
+        throw error;
+    }
+}

package/dist/utils/helpers.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIntersection = getIntersection;
+exports.getTableSchemaKey = getTableSchemaKey;
+exports.mergeTables = mergeTables;
+exports.mergeFieldDictionary = mergeFieldDictionary;
+exports.mergeIndexDictionary = mergeIndexDictionary;
+exports.mergeTableConstraintDictionary = mergeTableConstraintDictionary;
+exports.mergeCheckConstraintDictionary = mergeCheckConstraintDictionary;
+function getIntersection(firstList, secondList) {
+    return firstList.filter((item) => secondList.includes(item));
+}
+function getTableSchemaKey(schemaName, tableName) {
+    if (!tableName || !tableName.trim()) {
+        throw new Error('Table name must be a non-empty string');
+    }
+    return schemaName ? `${schemaName}.${tableName}` : `${tableName}`;
+}
+function mergeTables(firstTableList, secondTable) {
+    return firstTableList.concat(secondTable);
+}
+function mergeFieldDictionary(firstDict, secondDict) {
+    const result = { ...firstDict };
+    Object.keys(secondDict).forEach((key) => {
+        if (!result[key]) {
+            result[key] = [];
+        }
+        result[key] = result[key].concat(secondDict[key]);
+    });
+    return result;
+}
+function mergeIndexDictionary(firstDict, secondDict) {
+    const result = { ...firstDict };
+    Object.keys(secondDict).forEach((key) => {
+        if (!result[key]) {
+            result[key] = [];
+        }
+        result[key] = result[key].concat(secondDict[key]);
+    });
+    return result;
+}
+function mergeTableConstraintDictionary(firstDict, secondDict) {
+    const result = { ...firstDict };
+    Object.keys(secondDict).forEach((key) => {
+        if (!result[key]) {
+            result[key] = {};
+        }
+        result[key] = secondDict[key];
+    });
+    return result;
+}
+function mergeCheckConstraintDictionary(firstDict, secondDict) {
+    const result = { ...firstDict };
+    Object.keys(secondDict).forEach((key) => {
+        if (!result[key]) {
+            result[key] = [];
+        }
+        result[key] = result[key].concat(secondDict[key]);
+    });
+    return result;
+}

package/dist/utils/parseSchema.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSchemaQuery = exports.parseConnectionString = exports.parseJdbcSchema = exports.parseSchema = void 0;
+// You cannot use the "=" inside database's schema name. It will be treated as a delimiter.
+const SCHEMAS_DELIMITER = 'schemas=';
+const haveSchemas = (str) => {
+    return str.toLowerCase().includes(SCHEMAS_DELIMITER);
+};
+const getSchemasPart = (str) => {
+    return str ? str.toLowerCase().split(SCHEMAS_DELIMITER)[1] : '';
+};
+const noSchemaResult = (connectionString) => ({
+    connectionString,
+    schemas: [],
+});
+// Inputs: schemas string -> Output: schema array string[]
+// schema1, schema2 -> ['schema1', 'schema2']
+// schema3,schema4 -> ['schema3", 'schema4']
+// "schema5,gg", "schema6", schema7 -> ['schema5,gg', 'schema6', 'schema7']
+// schema8 -> ['schema8']
+const parseSchema = (schemas) => {
+    if (!schemas)
+        return [];
+    const schemasWithDoubleQuotes = schemas.split(/,(?=(?:[^"]*(?:"[^"]*")*)*$)/).map((s) => s.trim());
+    return schemasWithDoubleQuotes.map((s) => s.replace(/"/g, ''));
+};
+exports.parseSchema = parseSchema;
+const parseOdbcSchema = (connectionString) => {
+    const connectionParts = connectionString.split(';');
+    const schemasPart = connectionParts.find((part) => haveSchemas(part));
+    return {
+        connectionString: connectionParts.filter((part) => !haveSchemas(part)).join(';'),
+        schemas: (0, exports.parseSchema)(getSchemasPart(schemasPart)),
+    };
+};
+const parseJdbcSchema = (connectionString) => {
+    const connectionParts = connectionString.split('?');
+    const connectionArgs = connectionParts[1].split('&');
+    const schemasPart = connectionArgs.find((part) => haveSchemas(part));
+    return {
+        connectionString: connectionParts[0],
+        schemas: (0, exports.parseSchema)(getSchemasPart(schemasPart)),
+    };
+};
+exports.parseJdbcSchema = parseJdbcSchema;
+const parseConnectionString = (connectionString, connectionStringType) => {
+    if (!haveSchemas(connectionString))
+        return noSchemaResult(connectionString);
+    return connectionStringType === 'jdbc'
+        ? (0, exports.parseJdbcSchema)(connectionString)
+        : parseOdbcSchema(connectionString);
+};
+exports.parseConnectionString = parseConnectionString;
+const buildSchemaQuery = (columnName, schemas, prefix = 'AND') => {
+    if (schemas.length === 0)
+        return '';
+    return `${prefix} ${columnName} IN (${schemas.map((schema) => `'${schema}'`).join(', ')})`;
+};
+exports.buildSchemaQuery = buildSchemaQuery;

package/eslint.config.ts

@@ -19,7 +19,7 @@ export default defineConfig(
         'node_modules/*',
         'dist/*',
         'eslint.config.ts',
-        'vite.config.ts',
+        'jest.config.ts',
         '**/*.test.ts',
         '__tests__/**/*',
       ],
@@ -32,7 +32,6 @@ export default defineConfig(
           sourceType: 'module',
           ecmaVersion: 2020,
           project: './tsconfig.json',
-          tsconfigRootDir: import.meta.dirname,
         },
       },
       plugins: {

package/jest.config.ts

@@ -0,0 +1,18 @@
+import { type Config } from 'jest';
+
+const config: Config = {
+  testMatch: ["**/?(*.)+(spec|test).?([mc])[jt]s?(x)"],
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]sx?$': 'babel-jest',
+  },
+  moduleNameMapper: {
+    '\\.(css|less|scss)$': 'identity-obj-proxy',
+  },
+  collectCoverage: true,
+  coverageReporters: ['json', 'json-summary', 'html', 'text'],
+  coverageDirectory: 'coverage',
+};
+
+export default config;

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/connector",
-  "version": "5.6.0-alpha.1",
+  "version": "6.0.0",
   "description": "This package was created to fetch the schema JSON from many kind of databases.",
   "author": "huy.phung.sw@gmail.com",
   "license": "MIT",
@@ -10,25 +10,42 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
+    "@babel/core": "^7.21.4",
+    "@babel/node": "^7.20.7",
+    "@babel/plugin-transform-runtime": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-typescript": "^7.24.7",
+    "@babel/runtime": "^7.21.0",
+    "@stylistic/eslint-plugin": "^5.5.0",
+    "@types/jest": "^29.5.12",
     "@types/lodash": "^4.17.16",
     "@types/mssql": "^9.1.5",
     "@types/node": "^22.2.0",
     "@types/oracledb": "^6.10.0",
     "@types/pg": "^8.11.6",
-    "ts-node": "^10.9.2"
+    "@typescript-eslint/eslint-plugin": "^8.46.3",
+    "@typescript-eslint/parser": "^8.46.3",
+    "babel-jest": "^29.5.0",
+    "eslint": "^9.39.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.3"
   },
   "scripts": {
-    "build": "rm -rf ./dist && vite build",
-    "dev": "vite build --watch",
+    "build": "tsc",
     "start": "node dist/index.js",
-    "test:watch": "vitest tests",
-    "test": "vitest",
-    "coverage": "vitest --coverage",
+    "test": "jest --coverage=false",
+    "coverage": "jest --coverage",
     "lint": "eslint .",
     "lint:fix": "eslint --fix ."
   },
   "dependencies": {
     "@google-cloud/bigquery": "^7.9.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.3",
+    "@typescript-eslint/parser": "^8.46.3",
+    "eslint": "^9.39.1",
     "lodash": "^4.17.21",
     "mssql": "^11.0.1",
     "mysql2": "^3.11.0",
@@ -39,5 +56,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "2182f84f460f1decde7e5c414dcf6549d23669bf"
+  "gitHead": "75a218687814d8b1c538b26908745e0d0ee8b35a"
 }

package/src/connectors/mysql/index.ts

@@ -1,5 +1,5 @@
 import { createConnection, Connection } from 'mysql2/promise';
-import { flatten } from 'lodash-es';
+import { flatten } from 'lodash';
 import {
   CheckConstraintDictionary, DefaultInfo, DatabaseSchema, DefaultType, Field, IndexColumn, FieldsDictionary, Table, Enum, IndexesDictionary, TableConstraintsDictionary, Index, Ref,
 } from '../types';