@axiosleo/orm-mysql 0.12.2 → 0.13.0

package/bin/orm-mysql.js

@@ -9,7 +9,7 @@ const app = new App({
   name: 'MySQL ORM CLI',
   desc: 'migrate, model, seed, etc.',
   bin: 'orm-mysql',
-  version: '0.12.2',
+  version: '0.13.0',
   commands_dir: path.join(__dirname, '../commands'),
 });
 

package/commands/migrate.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const { Command, debug, Workflow } = require('@axiosleo/cli-tool');
+const { Command, debug } = require('@axiosleo/cli-tool');
+const { migrate } = require('../index');
 const is = require('@axiosleo/cli-tool/src/helper/is');
-const migration = require('../src/migration');
 
 class MigrateCommand extends Command {
   constructor() {
@@ -26,31 +26,19 @@ class MigrateCommand extends Command {
    * @param {*} options 
    */
   async exec(args, options) {
-    const workflow = new Workflow(migration);
     try {
-      await workflow.start({
-        task_key: 'migrate_logs',
-        action: args.action,
-        config: {
-          dir: args.dir
-        },
-        connection: {
-          host: options.host,
-          port: is.number(options.port) ?
-            options.port : parseInt(options.port),
-          user: options.user,
-          password: options.pass,
-          database: options.db
-        },
+      await migrate(args.action, args.dir, {
+        host: options.host,
+        port: is.string(options.port) ?
+          parseInt(options.port) : options.port || 3306,
+        user: options.user,
+        password: options.pass,
+        database: options.db,
         debug: options.debug
       });
       process.exit(0);
     } catch (e) {
-      if (e.curr && e.curr.error) {
-        debug.error(e.curr.error);
-      } else {
-        debug.log(e);
-      }
+      debug.error(e);
       process.exit(1);
     }
   }

package/index.d.ts

@@ -637,9 +637,8 @@ export declare class MigrationInterface {
     spatial?: boolean
   }): void;
 
-  createForeignKey(options: {
+  createForeignKey(table: string, options: {
     foreignKey?: string,
-    tableName: string,
     columnName: string,
     reference: {
       tableName: string,
@@ -649,15 +648,54 @@ export declare class MigrationInterface {
     }
   }): void;
 
+  /**
+   * drop table from database
+   * @param tableName 
+   */
   dropTable(tableName: string): void;
 
-  dropColumn(columnName: string, tableName: string): void;
+  /**
+   * drop column from table
+   * @param columnName 
+   * @param tableName 
+   */
+  dropColumn(tableName: string, columnName: string): void;
+
+  /**
+   * drop index from table
+   * @param indexName 
+   * @param tableName 
+   */
+  dropIndex(tableName: string, columns: string[]): void;
 
-  dropIndex(indexName: string): void;
+  dropIndexWithName(tableName: string, indexName: string): void;
 
-  dropForeignKey(foreign_key: string, tableName: string): void;
+  /**
+   * drop foreign key from table
+   * @param foreign_key 
+   * @param tableName 
+   */
+  dropForeignKey(tableName: string, foreign_key: string): void;
 
   insertData(table: string, data: any[]): void;
 
   raw(sql: string, values: any[]): void;
 }
+
+export type MigrateAction = 'up' | 'down' | 'UP' | 'DOWN';
+export type MigrateOptions = {
+  host?: string,
+  port?: number,
+  user?: string,
+  password?: string,
+  database?: string,
+  debug?: boolean
+};
+
+/**
+ * migrate database
+ * @param action 
+ * @param dir 
+ * @param options 
+ */
+export function migrate(action: MigrateAction, dir: string, options?: MigrateOptions): Promise<void>;

package/index.js

@@ -1,5 +1,10 @@
 'use strict';
 
+const { Workflow } = require('@axiosleo/cli-tool');
+const Hook = require('./src/hook');
+const { Builder } = require('./src/builder');
+const migration = require('./src/migration');
+
 const {
   QueryHandler,
   QueryOperator,
@@ -21,8 +26,32 @@ const {
   MySQLClient
 } = require('./src/client');
 
-const Hook = require('./src/hook');
-const { Builder } = require('./src/builder');
+const _runMigration = async (action, dir, options = {}) => {
+  const workflow = new Workflow(migration);
+  try {
+    await workflow.start({
+      task_key: 'migrate_logs',
+      action: action.toLowerCase(),
+      config: {
+        dir: dir
+      },
+      connection: {
+        host: options.host || 'localhost',
+        port: options.port || 3306,
+        user: options.user || 'root',
+        password: options.password || '',
+        database: options.database || ''
+      },
+      debug: options.debug
+    });
+  } catch (e) {
+    if (e.curr && e.curr.error) {
+      throw e.curr.error;
+    } else {
+      throw e;
+    }
+  }
+};
 
 module.exports = {
   Hook,
@@ -40,5 +69,6 @@ module.exports = {
   getClient,
   createPool,
   createClient,
-  createPromiseClient
+  createPromiseClient,
+  migrate: _runMigration
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axiosleo/orm-mysql",
-  "version": "0.12.2",
+  "version": "0.13.0",
   "description": "MySQL ORM tool",
   "keywords": [
     "mysql",
@@ -18,6 +18,7 @@
     "test": "mocha --reporter spec --timeout 3000 tests/*.tests.js",
     "test-cov": "nyc -r=lcov -r=html -r=text -r=json mocha -t 10000 -R spec tests/*.tests.js",
     "test-one": "mocha --reporter spec --timeout 3000 ",
+    "build": "DEPLOY_ENV=prod bun build ./index.js --compile --outfile dist/orm-mysql",
     "feature-test": "node tests/transaction.ft.js",
     "setup-feature-db": "node tests/setup-feature-db.js",
     "feature-test:local": "docker compose up -d && sleep 10 && npm run setup-feature-db && npm run feature-test && docker compose down",
@@ -48,7 +49,6 @@
     "mocha-sinon": "^2.1.2",
     "nyc": "^15.1.0",
     "pre-commit": "^1.2.2",
-    "sinon": "^17.0.1",
     "typescript": "^5.3.3"
   },
   "pre-commit": {

package/pnpm-workspace.yaml

@@ -0,0 +1,5 @@
+ignoredBuiltDependencies:
+  - pre-commit
+
+onlyBuiltDependencies:
+  - spawn-sync

package/src/builder.js

@@ -622,6 +622,15 @@ class ManageSQLBuilder extends Builder {
   }
 
   dropIndex(options) {
+    _validate(options, {
+      columns: 'required|array',
+      table: 'required|string',
+    });
+    options.name = 'idx_' + options.table + '_' + options.columns.join('_');
+    return _render('DROP INDEX `${name}` ON `${table}`', options);
+  }
+
+  dropIndexWithName(options) {
     _validate(options, {
       name: 'required|string',
       table: 'required|string',

package/src/migration.js

@@ -97,8 +97,7 @@ async function init(context) {
   let res = await _execSQL(conn, builder.sql);
   conn.end();
   if (res.serverStatus !== 2 && res.serverStatus !== 16386) {
-    printer.error('create migration table failed.');
-    process.exit(1);
+    throw new Error('create migration table failed.');
   }
 }
 
@@ -221,12 +220,12 @@ function _initMigration(file, queries = {}) {
   });
 
   Object.defineProperty(migration, 'createForeignKey', {
-    value: function (options = {}) {
+    value: function (table, options = {}) {
       _assign(options, {
         operator: 'create',
         target: 'foreignKey',
-        name: options.foreignKey ? options.foreignKey : 'fk_' + options.tableName + '_' + options.columnName,
-        table: options.tableName,
+        name: options.foreignKey ? options.foreignKey : 'fk_' + table + '_' + options.columnName,
+        table: table,
         column: options.columnName,
         reference: options.reference
       });
@@ -247,7 +246,7 @@ function _initMigration(file, queries = {}) {
   });
 
   Object.defineProperty(migration, 'dropColumn', {
-    value: function (name, table) {
+    value: function (table, name) {
       const builder = new ManageSQLBuilder({
         operator: 'drop',
         target: 'column',
@@ -259,10 +258,22 @@ function _initMigration(file, queries = {}) {
   });
 
   Object.defineProperty(migration, 'dropIndex', {
-    value: function (name, table) {
+    value: function (table, columns) {
       const builder = new ManageSQLBuilder({
         operator: 'drop',
         target: 'index',
+        columns,
+        table
+      });
+      queries[file].push({ sql: builder.sql, values: builder.values });
+    }, ...baseAttr
+  });
+
+  Object.defineProperty(migration, 'dropIndexWithName', {
+    value: function (table, name) {
+      const builder = new ManageSQLBuilder({
+        operator: 'drop',
+        target: 'indexWithName',
         name,
         table
       });
@@ -271,7 +282,7 @@ function _initMigration(file, queries = {}) {
   });
 
   Object.defineProperty(migration, 'dropForeignKey', {
-    value: function (name, table) {
+    value: function (table, name) {
       const builder = new ManageSQLBuilder({
         operator: 'drop',
         target: 'foreignKey',
@@ -319,16 +330,14 @@ async function run(context) {
     switch (context.action) {
       case 'up': {
         if (typeof script.up !== 'function') {
-          printer.error(`Migration file "${file}" must have a function named up.`);
-          process.exit(1);
+          throw new Error(`Migration file "${file}" must have a function named up.`);
         }
         await script.up(migration);
         break;
       }
       case 'down': {
         if (typeof script.down !== 'function') {
-          printer.error(`Migration file "${file}" must have a function named down.`);
-          process.exit(1);
+          throw new Error(`Migration file "${file}" must have a function named down.`);
         }
         await script.down(migration);
         break;