@dbml/core 6.3.0 → 6.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@dbml/core",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "description": "> TODO: description",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -19,7 +19,6 @@
     "lib",
     "types"
   ],
-  "type": "module",
   "types": "./types/index.d.ts",
   "main": "./lib/index.cjs",
   "module": "./lib/index.mjs",
@@ -47,7 +46,7 @@
     "lint:fix": "eslint --fix ."
   },
   "dependencies": {
-    "@dbml/parse": "^6.3.0",
+    "@dbml/parse": "^6.4.0",
     "antlr4": "^4.13.1",
     "lodash": "^4.17.15",
     "lodash-es": "^4.17.15",
@@ -58,7 +57,7 @@
   "devDependencies": {
     "bluebird": "^3.5.5"
   },
-  "gitHead": "f9928b19cbf40509c32383b96b7569d8603c8eb0",
+  "gitHead": "e365a1165ce3610f2bc9563b9eefac206d2f5c35",
   "engines": {
     "node": ">=16"
   }

package/types/export/DbmlExporter.d.ts

@@ -0,0 +1,30 @@
+import type { NormalizedModel } from '../model_structure/database';
+import type { NormalizedTable } from '../model_structure/table';
+import type { NormalizedTableGroup } from '../model_structure/tableGroup';
+
+export interface DbmlExporterOptions {
+    /** When false, TableData (Records) blocks are omitted from the output. Defaults to true. */
+    includeRecords: boolean;
+}
+
+declare class DbmlExporter {
+    static hasWhiteSpace(str: string): boolean;
+    static hasSquareBracket(str: string): boolean;
+    static isExpression(str: string): boolean;
+    static escapeNote(str: string | null): string;
+    static exportEnums(enumIds: number[], model: NormalizedModel): string;
+    static getFieldLines(tableId: number, model: NormalizedModel): string[];
+    static getIndexLines(tableId: number, model: NormalizedModel): string[];
+    static getCheckLines(tableId: number, model: NormalizedModel): string[];
+    static getTableSettings(table: NormalizedTable): string;
+    static exportTables(tableIds: number[], model: NormalizedModel): string;
+    static buildFieldName(fieldIds: number[], model: NormalizedModel): string;
+    static exportRefs(refIds: number[], model: NormalizedModel): string;
+    static getTableGroupSettings(tableGroup: NormalizedTableGroup): string;
+    static exportTableGroups(tableGroupIds: number[], model: NormalizedModel): string;
+    static exportStickyNotes(model: NormalizedModel): string;
+    static exportRecords(model: NormalizedModel): string;
+    static export(model: NormalizedModel, options: DbmlExporterOptions): string;
+}
+
+export default DbmlExporter;

package/types/export/JsonExporter.d.ts

@@ -0,0 +1,13 @@
+import type Database from '../model_structure/database';
+import type { NormalizedModel } from '../model_structure/database';
+
+export interface JsonExporterOptions {
+    /** When false, the model is exported via its `.export()` method before stringifying. Defaults to true. */
+    isNormalized: boolean;
+}
+
+declare class JsonExporter {
+    static export(model: Database | NormalizedModel, options: JsonExporterOptions): string;
+}
+
+export default JsonExporter;

package/types/export/ModelExporter.d.ts

@@ -1,7 +1,13 @@
-import Database, { NormalizedModel } from '../model_structure/database';
+import type Database from '../model_structure/database';
+import type { NormalizedModel } from '../model_structure/database';
+import type { ExportFormat, ExportOptions } from './index';
 
-export declare type ExportFormatOption = 'dbml' | 'mysql' | 'postgres' | 'json' | 'mssql' | 'oracle';
 declare class ModelExporter {
-    static export(model: Database | NormalizedModel, format: ExportFormatOption, isNormalized?: boolean): string;
+    /**
+     * @deprecated Passing a boolean as the third argument is deprecated. Use `ExportOptions` instead.
+     */
+    static export(model: Database | NormalizedModel, format: ExportFormat, options: boolean): string;
+    static export(model: Database | NormalizedModel, format: ExportFormat, options?: ExportOptions): string;
 }
+
 export default ModelExporter;

package/types/export/index.d.ts

@@ -1,7 +1,15 @@
-import { ExportFormatOption } from './ModelExporter';
-import { RecordValueType } from '../model_structure/database';
+import type { DbmlExporterOptions } from './DbmlExporter';
+import type { JsonExporterOptions } from './JsonExporter';
+
+export type ExportFormat = 'dbml' | 'mysql' | 'postgres' | 'json' | 'mssql' | 'oracle';
+
+export type ExportOptions =
+  Partial<DbmlExporterOptions> &
+  Partial<JsonExporterOptions>;
+
+declare function _export(str: string, format: ExportFormat, options: boolean): string;
+declare function _export(str: string, format: ExportFormat, options?: ExportOptions): string;
 
-declare function _export(str: string, format: ExportFormatOption): string;
 declare const _default: {
     export: typeof _export;
 };

package/types/import/index.d.ts

@@ -1,11 +1,18 @@
-declare function _import(str: string, format: 'dbml' | 'mysql' | 'postgres' | 'json' | 'mssql' | 'postgresLegacy' | 'mssqlLegacy' | 'oracle'): string;
+import type { DbmlExporterOptions } from '../export/DbmlExporter';
+
+export type ImportFormat = 'dbml' | 'mysql' | 'postgres' | 'json' | 'mssql' | 'postgresLegacy' | 'mssqlLegacy' | 'schemarb' | 'snowflake' | 'oracle';
+
+export type ImportOptions = Partial<DbmlExporterOptions>;
+
+declare function _import(str: string, format: ImportFormat, options?: ImportOptions): string;
 
 /**
- * @param {any} schemaJson
+ * @param schemaJson
  * @description Type of schemaJson is `DatabaseSchema`.
  * The type definition of `DatabaseSchema` object can be found [here](https://github.com/holistics/dbml/blob/a4dcb110f1d79f5d95b0d3db4b919914439e039d/packages/dbml-connector/src/connectors/types.ts#L89)
  */
-declare function generateDbml(schemaJson: any): string;
+declare function generateDbml(schemaJson: unknown): string;
+
 declare const _default: {
     import: typeof _import;
     generateDbml: typeof generateDbml;

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import ModelExporter, { ExportFormatOption } from './export/ModelExporter';
+import ModelExporter from './export/ModelExporter';
 import Parser from './parse/Parser';
 import importer from './import';
 import exporter from './export';
@@ -10,9 +10,12 @@ export {
   importer,
   exporter,
   ModelExporter,
-  ExportFormatOption,
   Parser,
 };
+export type { ExportFormat, ExportOptions } from './export/index';
+export type { DbmlExporterOptions } from './export/DbmlExporter';
+export type { JsonExporterOptions } from './export/JsonExporter';
+export type { ImportFormat, ImportOptions } from './import/index';
 export { CompilerDiagnostic, CompilerError as CompilerDiagnostics, EditorPosition, ErrorCode, WarningLevel } from './parse/error';
 
 export * from './model_structure';