db-modeling-markdown 1.0.6 → 2.0.1

package/dist/services/dbmOptions.d.ts

@@ -1,4 +1,4 @@
-import { DatabaseTypes } from './databaseTypes';
+import { DatabaseTypes } from '../models/databaseTypes';
 /**
  * Options for generation functions
  */
@@ -13,12 +13,16 @@ export declare class DbmOptions {
      */
     mdFileExtension: string;
     /**
-     * The folder path of table definition markdown files()
+     * The markdown file directory of the database model.
      */
     sourceFolder: string;
     /**
-     * The path of the output file
+     * The path of the output file.
      */
     targetPath: string;
+    /**
+     * The markdown file directory of the previous database version.
+     */
+    previousVersionFolder: string;
 }
 export declare const DefaultOptions: DbmOptions;

package/dist/services/dbmOptions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultOptions = exports.DbmOptions = void 0;
-const databaseTypes_1 = require("./databaseTypes");
+const databaseTypes_1 = require("../models/databaseTypes");
 /**
  * Options for generation functions
  */
@@ -17,13 +17,17 @@ class DbmOptions {
          */
         this.mdFileExtension = '.db.md';
         /**
-         * The folder path of table definition markdown files()
+         * The markdown file directory of the database model.
          */
         this.sourceFolder = '';
         /**
-         * The path of the output file
+         * The path of the output file.
          */
         this.targetPath = '';
+        /**
+         * The markdown file directory of the previous database version.
+         */
+        this.previousVersionFolder = '';
     }
 }
 exports.DbmOptions = DbmOptions;

package/dist/services/dbmOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbmOptions.js","sourceRoot":"","sources":["../../src/services/dbmOptions.ts"],"names":[],"mappings":";;;AAAA,mDAAgD;AAEhD;;GAEG;AACH,MAAa,UAAU;IAAvB;QACC;;WAEG;QACH,aAAQ,GAAkB,6BAAa,CAAC,KAAK,CAAC;QAE9C;;;WAGG;QACH,oBAAe,GAAW,QAAQ,CAAC;QAEnC;;WAEG;QACH,iBAAY,GAAW,EAAE,CAAC;QAE1B;;WAEG;QACH,eAAU,GAAW,EAAE,CAAC;IACzB,CAAC;CAAA;AArBD,gCAqBC;AAEY,QAAA,cAAc,GAAG,IAAI,UAAU,EAAE,CAAC"}
+{"version":3,"file":"dbmOptions.js","sourceRoot":"","sources":["../../src/services/dbmOptions.ts"],"names":[],"mappings":";;;AAAA,2DAAuD;AAEvD;;GAEG;AACH,MAAa,UAAU;IAAvB;QACC;;WAEG;QACH,aAAQ,GAAkB,6BAAa,CAAC,KAAK,CAAA;QAE7C;;;WAGG;QACH,oBAAe,GAAW,QAAQ,CAAA;QAElC;;WAEG;QACH,iBAAY,GAAW,EAAE,CAAA;QAEzB;;WAEG;QACH,eAAU,GAAW,EAAE,CAAA;QAEvB;;WAEG;QACH,0BAAqB,GAAW,EAAE,CAAA;IACnC,CAAC;CAAA;AA1BD,gCA0BC;AAEY,QAAA,cAAc,GAAG,IAAI,UAAU,EAAE,CAAA"}

package/dist/services/dbmService.d.ts

@@ -1,5 +1,6 @@
-import { DbModel } from './dbModel';
+import { DbModel } from '../models/dbModel';
 import { DbmOptions } from './dbmOptions';
+import { DbOptions } from './dbOptions';
 /**
  * The database modeling markdown service.
  */
@@ -31,11 +32,30 @@ export declare class DbmService {
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
      */
     static toDropThenCreateTableSql(options: DbmOptions): string;
+    /**
+     * Generate a SQL file with upgrade scripts.
+     * support:
+     * - new tables,
+     * - new columns,
+     * - new primary keys
+     * - new indexes
+     * - new foreign keys
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`, `previousVersionFolder`.
+     */
+    static toUpgradeSql(options: DbmOptions): string;
     /**
      * Generate a JSON file.
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
      */
     static toJson(options: DbmOptions): string;
+    /**
+     * Generate markdown files from a json file
+     * @param jsonFile the json file path
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromJsonFile(jsonFile: string, markdownFolder: string, force?: boolean, fileExtension?: string): void;
     /**
      * Generate markdown files from a model
      * @param model the model object with
@@ -44,9 +64,24 @@ export declare class DbmService {
      * @param fileExtension generated file extension, default: `.db.md`.
      */
     static toMarkdown(model: DbModel, markdownFolder: string, force?: boolean, fileExtension?: string): void;
+    /**
+     * Generate a index file for a model
+     * @param model the model object with
+     * @param markdownFolder the folder to which we will write
+     * @param filename generated file name, default: `index.md`.
+     */
+    static genIndexFile(model: DbModel, markdownFolder: string, filename?: string): void;
     /**
      * Get a model object.
      * @param options the options, required: `database`, `sourceFolder`.
      */
     static toModel(options: DbmOptions): DbModel;
+    /**
+     * Generate markdown files from a database
+     * @param dbOptions the datbase connection configure
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromDatabase(dbOptions: DbOptions, markdownFolder: string, force?: boolean, fileExtension?: string): Promise<void>;
 }

package/dist/services/dbmService.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DbmService = void 0;
 const fs = require("fs");
 const path = require("path");
-const fileHelper_1 = require("../lib/utils/fileHelper");
+const providerFactory_1 = require("../dialects/core/providerFactory");
 const markdownReader_1 = require("../lib/markdown-object/markdownReader");
 const markdownWriter_1 = require("../lib/markdown-object/markdownWriter");
-const providerFactory_1 = require("../dialects/core/providerFactory");
+const fileHelper_1 = require("../lib/utils/fileHelper");
+const databaseTypes_1 = require("../models/databaseTypes");
+const dbmOptions_1 = require("./dbmOptions");
 /**
  * The database modeling markdown service.
  */
@@ -64,9 +66,8 @@ class DbmService {
             ],
         };
         const table = model.tables[0];
-        const content = markdownWriter_1.MarkdownWriter.renderTable(table, options.sourceFolder &&
+        return markdownWriter_1.MarkdownWriter.renderTable(table, options.sourceFolder &&
             path.join(options.sourceFolder, `${table.name}${options.mdFileExtension}`));
-        return content;
     }
     /**
      * Generate a SQL file with create-table-if-not-exists scripts.
@@ -120,6 +121,30 @@ class DbmService {
         }
         return sql;
     }
+    /**
+     * Generate a SQL file with upgrade scripts.
+     * support:
+     * - new tables,
+     * - new columns,
+     * - new primary keys
+     * - new indexes
+     * - new foreign keys
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`, `previousVersionFolder`.
+     */
+    static toUpgradeSql(options) {
+        const fromOptions = new dbmOptions_1.DbmOptions();
+        fromOptions.database = options.database;
+        fromOptions.mdFileExtension = options.mdFileExtension;
+        fromOptions.sourceFolder = options.previousVersionFolder;
+        const fromModel = this.toModel(fromOptions);
+        const model = this.toModel(options);
+        const provider = providerFactory_1.ProviderFactory.getProvider(options.database);
+        const sql = provider.getUpgradeSql(fromModel, model, true);
+        if (options.targetPath) {
+            fileHelper_1.FileHelper.writeFileSync(options.targetPath, sql);
+        }
+        return sql;
+    }
     /**
      * Generate a JSON file.
      * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
@@ -131,6 +156,17 @@ class DbmService {
         }
         return JSON.stringify(model, null, 2);
     }
+    /**
+     * Generate markdown files from a json file
+     * @param jsonFile the json file path
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static fromJsonFile(jsonFile, markdownFolder, force = false, fileExtension = '.db.md') {
+        const model = JSON.parse(fileHelper_1.FileHelper.readJsonFileSync(jsonFile));
+        this.toMarkdown(model, markdownFolder, force, fileExtension);
+    }
     /**
      * Generate markdown files from a model
      * @param model the model object with
@@ -139,20 +175,44 @@ class DbmService {
      * @param fileExtension generated file extension, default: `.db.md`.
      */
     static toMarkdown(model, markdownFolder, force = false, fileExtension = '.db.md') {
-        if (fs.existsSync(markdownFolder)) {
-            if (force) {
-                const files = fileHelper_1.FileHelper.readdirSync(markdownFolder);
-                files.forEach((file) => {
-                    if (file.name.endsWith(fileExtension)) {
-                        fs.unlinkSync(path.join(markdownFolder, file.name));
-                    }
-                });
-            }
+        if (force && fs.existsSync(markdownFolder)) {
+            fileHelper_1.FileHelper.removeAllFilesSync(markdownFolder, fileExtension);
+        }
+        if (!fs.existsSync(markdownFolder)) {
+            fileHelper_1.FileHelper.mkdirSync(markdownFolder);
         }
         model.tables.forEach((table) => {
             markdownWriter_1.MarkdownWriter.renderTable(table, path.join(markdownFolder, `${table.name}${fileExtension}`));
         });
     }
+    /**
+     * Generate a index file for a model
+     * @param model the model object with
+     * @param markdownFolder the folder to which we will write
+     * @param filename generated file name, default: `index.md`.
+     */
+    static genIndexFile(model, markdownFolder, filename = 'index.md') {
+        const file = path.join(markdownFolder, filename);
+        fileHelper_1.FileHelper.removeFileSync(file);
+        let data = '# Database Design\n\n';
+        data += '## Index\n\n';
+        const columnWidths = [5, 6];
+        model.tables.forEach((table) => {
+            if (table.name.length * 2 + 10 > columnWidths[0]) {
+                columnWidths[0] = table.name.length * 2 + 10;
+            }
+            if (table.comment && table.comment.length > columnWidths[1]) {
+                columnWidths[1] = table.comment.length;
+            }
+        });
+        data += `| ${'Table'.padEnd(columnWidths[0], ' ')} | ${'Comment'.padEnd(columnWidths[1], ' ')} |\n`;
+        data += `| ${''.padEnd(columnWidths[0], '-')} | ${''.padEnd(columnWidths[1], '-')} |\n`;
+        model.tables.forEach((table) => {
+            const name = `[${table.name}](${table.name}.db.md)`;
+            data += `| ${name.padEnd(columnWidths[0], ' ')} | ${table.comment?.padEnd(columnWidths[1], ' ')} |\n`;
+        });
+        fileHelper_1.FileHelper.writeFileSync(file, data);
+    }
     /**
      * Get a model object.
      * @param options the options, required: `database`, `sourceFolder`.
@@ -168,6 +228,20 @@ class DbmService {
         });
         return model;
     }
+    /**
+     * Generate markdown files from a database
+     * @param dbOptions the datbase connection configure
+     * @param markdownFolder the folder to which we will write
+     * @param force If true, delete all files whose extension matched, default: `false`.
+     * @param fileExtension generated file extension, default: `.db.md`.
+     */
+    static async fromDatabase(dbOptions, markdownFolder, force = false, fileExtension = '.db.md') {
+        const provider = providerFactory_1.ProviderFactory.getImportProvider(databaseTypes_1.DatabaseTypes.mariadb);
+        const model = await provider.getModel(dbOptions);
+        this.toMarkdown(model, markdownFolder, force, fileExtension);
+        // generate an index.md for the imported model
+        this.genIndexFile(model, markdownFolder);
+    }
 }
 exports.DbmService = DbmService;
 //# sourceMappingURL=dbmService.js.map

package/dist/services/dbmService.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbmService.js","sourceRoot":"","sources":["../../src/services/dbmService.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAK7B,wDAAqD;AACrD,0EAAuE;AACvE,0EAAuE;AACvE,sEAAmE;AAEnE;;GAEG;AACH,MAAa,UAAU;IACtB;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,OAAmB,EAAE,SAAiB;QACtE,MAAM,KAAK,GAAY;YACtB,MAAM,EAAE;gBACP;oBACC,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,uBAAuB;oBAChC,UAAU,EAAE;wBACX,OAAO,EAAE,mBAAmB;wBAC5B,OAAO,EAAE,KAAK;qBACd;oBACD,OAAO,EAAE;wBACR;4BACC,OAAO,EAAE,EAAE;4BACX,MAAM,EAAE,IAAI;4BACZ,OAAO,EAAE,KAAK;yBACd;qBACD;oBACD,WAAW,EAAE;wBACZ;4BACC,OAAO,EAAE,EAAE;4BACX,QAAQ,EAAE,EAAE;4BACZ,UAAU,EAAE,EAAE;4BACd,OAAO,EAAE,EAAE;yBACX;qBACD;oBACD,OAAO,EAAE;wBACR;4BACC,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE,KAAK;4BACX,QAAQ,EAAE,KAAK;4BACf,OAAO,EAAE,EAAE;4BACX,OAAO,EAAE,eAAe;yBACxB;wBACD;4BACC,IAAI,EAAE,WAAW;4BACjB,KAAK,EAAE,YAAY;4BACnB,IAAI,EAAE,cAAc;4BACpB,QAAQ,EAAE,KAAK;4BACf,OAAO,EAAE,IAAI;4BACb,OAAO,EAAE,iBAAiB;yBAC1B;qBACD;iBACD;aACD;SACD,CAAC;QACF,MAAM,KAAK,GAAY,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,+BAAc,CAAC,WAAW,CACzC,KAAK,EACL,OAAO,CAAC,YAAY;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAC3E,CAAC;QACF,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,2BAA2B,CAAC,OAAmB;QAC5D,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,QAAQ,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,OAAmB;QACjD,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAEpD,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,OAAmB;QAC/C,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,QAAQ,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAElD,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB,CAAC,OAAmB;QACzD,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,QAAQ,CAAC,yBAAyB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE5D,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SAClD;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAAmB;QACvC,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACvB,KAAc,EACd,cAAsB,EACtB,QAAiB,KAAK,EACtB,gBAAwB,QAAQ;QAEhC,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YAClC,IAAI,KAAK,EAAE;gBACV,MAAM,KAAK,GAAgB,uBAAU,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;gBAElE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBACtB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;wBACtC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;qBACpD;gBACF,CAAC,CAAC,CAAC;aACH;SACD;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,EAAE;YACvC,+BAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;QAC/F,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,OAAO,CAAC,OAAmB;QACxC,MAAM,KAAK,GAAY,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACtC,MAAM,KAAK,GAAgB,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAExE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACtB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;gBAChD,MAAM,KAAK,GAAG,IAAI,+BAAc,CAAC,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACpF,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACzB;QACF,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAxLD,gCAwLC"}
+{"version":3,"file":"dbmService.js","sourceRoot":"","sources":["../../src/services/dbmService.ts"],"names":[],"mappings":";;;AAAA,yBAAwB;AACxB,6BAA4B;AAG5B,sEAAkE;AAClE,0EAAsE;AACtE,0EAAsE;AACtE,wDAAoD;AACpD,2DAAuD;AAGvD,6CAAyC;AAGzC;;GAEG;AACH,MAAa,UAAU;IACtB;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,OAAmB,EAAE,SAAiB;QACtE,MAAM,KAAK,GAAY;YACtB,MAAM,EAAE;gBACP;oBACC,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,uBAAuB;oBAChC,UAAU,EAAE;wBACX,OAAO,EAAE,mBAAmB;wBAC5B,OAAO,EAAE,KAAK;qBACd;oBACD,OAAO,EAAE;wBACR;4BACC,OAAO,EAAE,EAAE;4BACX,MAAM,EAAE,IAAI;4BACZ,OAAO,EAAE,KAAK;yBACd;qBACD;oBACD,WAAW,EAAE;wBACZ;4BACC,OAAO,EAAE,EAAE;4BACX,QAAQ,EAAE,EAAE;4BACZ,UAAU,EAAE,EAAE;4BACd,OAAO,EAAE,EAAE;yBACX;qBACD;oBACD,OAAO,EAAE;wBACR;4BACC,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE,KAAK;4BACX,QAAQ,EAAE,KAAK;4BACf,OAAO,EAAE,EAAE;4BACX,OAAO,EAAE,eAAe;yBACxB;wBACD;4BACC,IAAI,EAAE,WAAW;4BACjB,KAAK,EAAE,YAAY;4BACnB,IAAI,EAAE,cAAc;4BACpB,QAAQ,EAAE,KAAK;4BACf,OAAO,EAAE,IAAI;4BACb,OAAO,EAAE,iBAAiB;yBAC1B;qBACD;iBACD;aACD;SACD,CAAA;QACD,MAAM,KAAK,GAAY,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACtC,OAAO,+BAAc,CAAC,WAAW,CAChC,KAAK,EACL,OAAO,CAAC,YAAY;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAC3E,CAAA;IACF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,2BAA2B,CAAC,OAAmB;QAC5D,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE5C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAE9D,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;SACjD;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,OAAmB;QACjD,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE5C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAEnD,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;SACjD;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,OAAmB;QAC/C,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE5C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAEjD,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;SACjD;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB,CAAC,OAAmB;QACzD,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE5C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,yBAAyB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAE3D,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;SACjD;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,YAAY,CAAC,OAAmB;QAC7C,MAAM,WAAW,GAAe,IAAI,uBAAU,EAAE,CAAA;QAChD,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACvC,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;QACrD,WAAW,CAAC,YAAY,GAAG,OAAO,CAAC,qBAAqB,CAAA;QACxD,MAAM,SAAS,GAAY,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACpD,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE5C,MAAM,QAAQ,GAAG,iCAAe,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QAE1D,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;SACjD;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,OAAmB;QACvC,MAAM,KAAK,GAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC5C,IAAI,OAAO,CAAC,UAAU,EAAE;YACvB,uBAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;SACvD;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IACtC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CACzB,QAAgB,EAChB,cAAsB,EACtB,QAAiB,KAAK,EACtB,gBAAwB,QAAQ;QAEhC,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC,uBAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,aAAa,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACvB,KAAc,EACd,cAAsB,EACtB,QAAiB,KAAK,EACtB,gBAAwB,QAAQ;QAEhC,IAAI,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YAC3C,uBAAU,CAAC,kBAAkB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAA;SAC5D;QACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YACnC,uBAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA;SACpC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,EAAE;YACvC,+BAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,aAAa,EAAE,CAAC,CAAC,CAAA;QAC9F,CAAC,CAAC,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CACzB,KAAc,EACd,cAAsB,EACtB,WAAmB,UAAU;QAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;QAChD,uBAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAE/B,IAAI,IAAI,GAAG,uBAAuB,CAAA;QAClC,IAAI,IAAI,cAAc,CAAA;QAEtB,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,EAAE;YACvC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE;gBACjD,YAAY,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,CAAA;aAC5C;YACD,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE;gBAC5D,YAAY,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAA;aACtC;QACF,CAAC,CAAC,CAAA;QAEF,IAAI,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,SAAS,CAAC,MAAM,CACtE,YAAY,CAAC,CAAC,CAAC,EACf,GAAG,CACH,MAAM,CAAA;QACP,IAAI,IAAI,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAA;QACvF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAc,EAAE,EAAE;YACvC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAA;YACnD,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,MAAM,CACxE,YAAY,CAAC,CAAC,CAAC,EACf,GAAG,CACH,MAAM,CAAA;QACR,CAAC,CAAC,CAAA;QAEF,uBAAU,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,OAAO,CAAC,OAAmB;QACxC,MAAM,KAAK,GAAY,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;QACrC,MAAM,KAAK,GAAgB,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAEvE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACtB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;gBAChD,MAAM,KAAK,GAAG,IAAI,+BAAc,CAAC,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAEnF,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;aACxB;QACF,CAAC,CAAC,CAAA;QAEF,OAAO,KAAK,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAC/B,SAAoB,EACpB,cAAsB,EACtB,QAAiB,KAAK,EACtB,gBAAwB,QAAQ;QAEhC,MAAM,QAAQ,GAAqB,iCAAe,CAAC,iBAAiB,CAAC,6BAAa,CAAC,OAAO,CAAC,CAAA;QAC3F,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAChD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,aAAa,CAAC,CAAA;QAC5D,8CAA8C;QAC9C,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,CAAA;IACzC,CAAC;CACD;AA9RD,gCA8RC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "db-modeling-markdown",
-	"version": "1.0.6",
+	"version": "2.0.1",
 	"description": "database modeling markdown lib",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -9,10 +9,11 @@
 		"coverage": "jest --coverage",
 		"doc": "npm run gulp doc && npm run gulp docs:copy",
 		"gulp": "gulp",
-		"lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\" --cache --cache-location .eslintcache",
-		"lint:fix": "eslint --fix \"src/**/*.ts\" --cache --cache-location .eslintcache",
+		"lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\"",
+		"lint:fix": "eslint --fix \"src/**/*.ts\" \"tests/**/*.ts\"",
 		"test": "jest",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"pretty": "prettier --write \"src/**/*.ts\" && prettier --write \"tests/**/*.ts\""
 	},
 	"repository": {
 		"type": "git",
@@ -25,7 +26,7 @@
 	],
 	"author": {
 		"name": "Steven Yang",
-		"email": "steven_nyang@outlook.com"
+		"email": "steven_nyang@qq.com"
 	},
 	"license": "MIT",
 	"bugs": {
@@ -33,50 +34,41 @@
 	},
 	"homepage": "https://gitee.com/sn-yang/db-modeling-markdown#readme",
 	"dependencies": {
+		"mariadb": "^3.0.1",
+		"nunjucks": "^3.2.3",
 		"regexp-coder": "2.0.2"
 	},
 	"devDependencies": {
-		"@types/babel__core": "7.1.16",
-		"@types/glob": "^7.2.0",
-		"@types/jest": "27.0.2",
-		"@types/lodash": "^4.14.177",
-		"@types/node": "^16.11.7",
-		"@typescript-eslint/eslint-plugin": "^5.4.0",
-		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.2.0",
+		"@types/babel__core": "7.1.19",
+		"@types/glob": "^8.0.0",
+		"@types/jest": "^29.0.0",
+		"@types/lodash": "^4.14.184",
+		"@types/node": "^18.7.16",
+		"@typescript-eslint/eslint-plugin": "^5.36.2",
+		"@typescript-eslint/parser": "^5.36.2",
+		"dotenv": "^16.0.3",
+		"eslint": "^8.23.0",
 		"eslint-config-airbnb-base": "^15.0.0",
-		"eslint-config-airbnb-typescript": "^15.0.0",
-		"eslint-config-prettier": "^8.3.0",
+		"eslint-config-airbnb-typescript": "^17.0.0",
+		"eslint-config-prettier": "^8.5.0",
 		"eslint-config-tslint": "^0.2.1",
-		"eslint-plugin-import": "^2.25.3",
-		"eslint-plugin-simple-import-sort": "^7.0.0",
-		"eslint-plugin-sort-class-members": "1.12.0",
-		"eslint-plugin-typescript-sort-keys": "2.0.0",
-		"glob": "^7.2.0",
+		"eslint-plugin-import": "^2.26.0",
+		"eslint-plugin-simple-import-sort": "^8.0.0",
+		"eslint-plugin-typescript-sort-keys": "2.1.0",
+		"glob": "^8.0.3",
 		"gulp": "^4.0.2",
 		"gulp-shell": "^0.8.0",
 		"gulp-sourcemaps": "^3.0.0",
 		"gulp-typescript": "^5.0.1",
-		"husky": "^7.0.0",
-		"jest": "27.3.1",
-		"jscodeshift": "0.13.0",
-		"lint-staged": "^12.0.2",
-		"sort-class-members-codemod": "0.5.1",
-		"ts-jest": "27.0.7",
-		"ts-node": "^10.4.0",
-		"typedoc": "^0.22.9",
-		"typescript": "^4.4.4",
+		"husky": "^8.0.0",
+		"jest": "^29.0.3",
+		"jscodeshift": "^0.13.1",
+		"lint-staged": "^13.0.3",
+		"sort-class-members-codemod": "^0.5.1",
+		"ts-jest": "^29.0.0",
+		"ts-node": "^10.9.1",
+		"typedoc": "^0.23.14",
+		"typescript": "^4.8.3",
 		"vscode-test": "^1.6.1"
-	},
-	"husky": {
-		"hooks": {
-			"pre-commit": "tsc --noEmit && lint-staged"
-		}
-	},
-	"lint-staged": {
-		"*.{ts}": [
-			"eslint --fix",
-			"git add"
-		]
 	}
 }

package/dist/services/databaseTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"databaseTypes.js","sourceRoot":"","sources":["../../src/services/databaseTypes.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAmCX;AAnCD,WAAY,aAAa;IACxB;;OAEG;IACH,4BAAW,CAAA;IAEX;;OAEG;IACH,oCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,kCAAiB,CAAA;IAEjB;;OAEG;IACH,0CAAyB,CAAA;IAEzB;;OAEG;IACH,kCAAiB,CAAA;AAClB,CAAC,EAnCW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAmCxB"}

package/dist/services/dbModel.d.ts

@@ -1,135 +0,0 @@
-/**
- * Describe a database model
- */
-export interface DbModel {
-    /**
-     * The model tables
-     */
-    tables: DbTable[];
-}
-/**
- * Describe a table
- */
-export interface DbTable {
-    /**
-     * The table columns
-     */
-    columns: DbColumn[];
-    /**
-     * The table comment
-     */
-    comment?: string;
-    /**
-     * The table foreign keys
-     */
-    foreignKeys: DbForeignKey[];
-    /**
-     * The table indexes
-     */
-    indexes: DbIndex[];
-    /**
-     * The table name
-     */
-    name: string;
-    /**
-     * The table primary key
-     */
-    primaryKey?: DbPrimaryKey;
-}
-/**
- * Describe a table column
- */
-export interface DbColumn {
-    /**
-     * The column comment
-     */
-    comment?: string;
-    /**
-     * The table default value.
-     * <empty> is no default value.
-     * Value `''` for default value empty
-     *
-     */
-    default?: string;
-    /**
-     * The column table
-     */
-    label?: string;
-    /**
-     * The column name
-     */
-    name: string;
-    /**
-     * If the column nullable
-     */
-    nullable?: boolean;
-    /**
-     * The column data type
-     */
-    type: string;
-}
-/**
- * Describe table primary key
- */
-export interface DbPrimaryKey {
-    /**
-     * If the primary key is clusterred
-     */
-    cluster?: boolean;
-    /**
-     * The primary key columns.
-     *
-     * Use comma `,` to split multiple columns.
-     * E.g. `column, column2`
-     */
-    columns: string;
-}
-/**
- * Describe the table index
- */
-export interface DbIndex {
-    /**
-     * If the index is clusterred
-     */
-    cluster?: boolean;
-    /**
-     * The index columns.
-     *
-     * Use comma `,` to split multiple columns.
-     * E.g. `column, column2`
-     */
-    columns: string;
-    /**
-     * If the index is unique
-     */
-    unique?: boolean;
-}
-/**
- * Describe the table foreign key
- */
-export interface DbForeignKey {
-    /**
-     * The foreign key columns.
-     *
-     * Use comma `,` to split multiple columns.
-     * E.g. `column, column2`
-     */
-    columns: string;
-    /**
-     * The foreign key options
-     *
-     * E.g. `ON DELETE CASCADE`
-     */
-    options?: string;
-    /**
-     * The reference columns of the foreign key columns.
-     *
-     * Use comma `,` to split multiple columns.
-     * E.g. `column, column2`
-     */
-    refColumns: string;
-    /**
-     * The reference table of the foreign key
-     */
-    refTable: string;
-}