db-modeling-markdown 2.0.1 → 2.1.0

package/dist/services/dbOptions.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DbOptions = void 0;
-const databaseTypes_1 = require("../models/databaseTypes");
-/**
- * Options for database connection
- */
-class DbOptions {
-    constructor() {
-        /**
-         * The database type
-         * Default is `mariadb`
-         */
-        this.databaseType = databaseTypes_1.DatabaseTypes.mariadb;
-    }
-}
-exports.DbOptions = DbOptions;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DbOptions = void 0;
+const databaseTypes_1 = require("../models/databaseTypes");
+/**
+ * Options for database connection
+ */
+class DbOptions {
+    constructor() {
+        /**
+         * The database type
+         * Default is `mariadb`
+         */
+        this.databaseType = databaseTypes_1.DatabaseTypes.mariadb;
+    }
+}
+exports.DbOptions = DbOptions;
 //# sourceMappingURL=dbOptions.js.map

package/dist/services/dbmOptions.d.ts

@@ -1,28 +1,28 @@
-import { DatabaseTypes } from '../models/databaseTypes';
-/**
- * Options for generation functions
- */
-export declare class DbmOptions {
-    /**
-     * The database type
-     */
-    database: DatabaseTypes;
-    /**
-     * The extension of table definition markdown files.
-     * Default is `.db.md`
-     */
-    mdFileExtension: string;
-    /**
-     * The markdown file directory of the database model.
-     */
-    sourceFolder: string;
-    /**
-     * The path of the output file.
-     */
-    targetPath: string;
-    /**
-     * The markdown file directory of the previous database version.
-     */
-    previousVersionFolder: string;
-}
-export declare const DefaultOptions: DbmOptions;
+import { DatabaseTypes } from '../models/databaseTypes';
+/**
+ * Options for generation functions
+ */
+export declare class DbmOptions {
+    /**
+     * The database type
+     */
+    database: DatabaseTypes;
+    /**
+     * The extension of table definition markdown files.
+     * Default is `.db.md`
+     */
+    mdFileExtension: string;
+    /**
+     * The markdown file directory of the database model.
+     */
+    sourceFolder: string;
+    /**
+     * 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,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultOptions = exports.DbmOptions = void 0;
-const databaseTypes_1 = require("../models/databaseTypes");
-/**
- * Options for generation functions
- */
-class DbmOptions {
-    constructor() {
-        /**
-         * The database type
-         */
-        this.database = databaseTypes_1.DatabaseTypes.mysql;
-        /**
-         * The extension of table definition markdown files.
-         * Default is `.db.md`
-         */
-        this.mdFileExtension = '.db.md';
-        /**
-         * The markdown file directory of the database model.
-         */
-        this.sourceFolder = '';
-        /**
-         * The path of the output file.
-         */
-        this.targetPath = '';
-        /**
-         * The markdown file directory of the previous database version.
-         */
-        this.previousVersionFolder = '';
-    }
-}
-exports.DbmOptions = DbmOptions;
-exports.DefaultOptions = new DbmOptions();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultOptions = exports.DbmOptions = void 0;
+const databaseTypes_1 = require("../models/databaseTypes");
+/**
+ * Options for generation functions
+ */
+class DbmOptions {
+    constructor() {
+        /**
+         * The database type
+         */
+        this.database = databaseTypes_1.DatabaseTypes.mysql;
+        /**
+         * The extension of table definition markdown files.
+         * Default is `.db.md`
+         */
+        this.mdFileExtension = '.db.md';
+        /**
+         * The markdown file directory of the database model.
+         */
+        this.sourceFolder = '';
+        /**
+         * The path of the output file.
+         */
+        this.targetPath = '';
+        /**
+         * The markdown file directory of the previous database version.
+         */
+        this.previousVersionFolder = '';
+    }
+}
+exports.DbmOptions = DbmOptions;
+exports.DefaultOptions = new DbmOptions();
 //# sourceMappingURL=dbmOptions.js.map

package/dist/services/dbmService.d.ts

@@ -1,87 +1,87 @@
-import { DbModel } from '../models/dbModel';
-import { DbmOptions } from './dbmOptions';
-import { DbOptions } from './dbOptions';
-/**
- * The database modeling markdown service.
- */
-export declare class DbmService {
-    /**
-     * New a markdown file (.db.md) that defines a table.
-     * The file will be located at `options.sourceFolder` with name `<tableName>.db.md`.
-     * @param options the options (required: `sourceFolder`)
-     * @param tableName The table name
-     */
-    static newDbmMarkdownFile(options: DbmOptions, tableName: string): string;
-    /**
-     * Generate a SQL file with create-table-if-not-exists scripts.
-     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
-     */
-    static toCreateTableIfNotExistsSql(options: DbmOptions): string;
-    /**
-     * Generate a SQL file with create-table scripts.
-     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
-     */
-    static toCreateTableSql(options: DbmOptions): string;
-    /**
-     * Generate a SQL file with drop-table scripts.
-     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
-     */
-    static toDropTableSql(options: DbmOptions): string;
-    /**
-     * Generate a SQL file with drop-then-create-table scripts.
-     * @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
-     * @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 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>;
-}
+import { DbModel } from '../models/dbModel';
+import { DbmOptions } from './dbmOptions';
+import { DbOptions } from './dbOptions';
+/**
+ * The database modeling markdown service.
+ */
+export declare class DbmService {
+    /**
+     * New a markdown file (.db.md) that defines a table.
+     * The file will be located at `options.sourceFolder` with name `<tableName>.db.md`.
+     * @param options the options (required: `sourceFolder`)
+     * @param tableName The table name
+     */
+    static newDbmMarkdownFile(options: DbmOptions, tableName: string): string;
+    /**
+     * Generate a SQL file with create-table-if-not-exists scripts.
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
+     */
+    static toCreateTableIfNotExistsSql(options: DbmOptions): string;
+    /**
+     * Generate a SQL file with create-table scripts.
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
+     */
+    static toCreateTableSql(options: DbmOptions): string;
+    /**
+     * Generate a SQL file with drop-table scripts.
+     * @param options the options, required: `database`, `sourceFolder`, `targetPath`.
+     */
+    static toDropTableSql(options: DbmOptions): string;
+    /**
+     * Generate a SQL file with drop-then-create-table scripts.
+     * @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
+     * @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 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>;
+}