dbdiagram 0.4.0 → 0.5.0

package/README.md

@@ -55,6 +55,21 @@ dbdiagram init --entry schema.dbml --workspace-url myteam --project-url myteam/m
 
 ---
 
+### Validate
+
+Validate a local DBML file and report errors, warnings, and infos.
+
+**Options:**
+
+- `--json` — Output result as JSON
+
+```sh
+dbdiagram validate schema.dbml                         # validate a local DBML file
+dbdiagram validate schema.dbml --json                  # output the result as JSON
+```
+
+---
+
 ### Push
 
 Push a local DBML file to create or update a diagram on dbdiagram.io.

package/dist/constants/dot-dbdiagram-dir.constant.js

@@ -6,5 +6,7 @@ export const DIAGRAM_VIZ_EXTENSION = '.dbdiagram';
 export const DIAGRAM_VIZ_FILE_VERSIONS = {
     v1: '1.0.0',
     v2: '2.0.0',
+    v3: '3.0.0',
 };
+export const LATEST_DIAGRAM_VIZ_FILE_VERSION = DIAGRAM_VIZ_FILE_VERSIONS.v3;
 export const TELEMETRY_FILE_NAME = 'telemetry.json';

package/dist/services/viz/diagram-viz-converter.service.js

@@ -1,4 +1,5 @@
 import { DIAGRAM_VIZ_FILE_VERSIONS } from '../../constants/dot-dbdiagram-dir.constant.js';
+import { DEFAULT_DETAIL_LEVEL, DEFAULT_RELATIONSHIP_MODE, DetailLevel, RelationshipMode, } from '../../types/diagram-viz.type.js';
 export const migrateDiagramVizV1ToV2 = (v1) => {
     return {
         version: DIAGRAM_VIZ_FILE_VERSIONS.v2,
@@ -15,6 +16,38 @@ export const migrateDiagramVizV1ToV2 = (v1) => {
         views: {},
     };
 };
+export const migrateDiagramVizV2ToV3 = (v2) => {
+    const withRelationshipMode = (view) => ({
+        ...view,
+        relationshipMode: DEFAULT_RELATIONSHIP_MODE,
+    });
+    return {
+        ...v2,
+        version: DIAGRAM_VIZ_FILE_VERSIONS.v3,
+        defaultView: withRelationshipMode(v2.defaultView),
+        views: Object.fromEntries(Object.entries(v2.views).map(([name, view]) => [name, withRelationshipMode(view)])),
+    };
+};
+const DIAGRAM_VIZ_MIGRATIONS = [
+    { from: DIAGRAM_VIZ_FILE_VERSIONS.v1, run: (d) => migrateDiagramVizV1ToV2(d) },
+    { from: DIAGRAM_VIZ_FILE_VERSIONS.v2, run: (d) => migrateDiagramVizV2ToV3(d) },
+];
+export const migrateDiagramVizToLatest = (vizDataFromFile, fileVersion) => {
+    const startIndex = DIAGRAM_VIZ_MIGRATIONS.findIndex((migration) => migration.from === fileVersion);
+    if (startIndex === -1)
+        return null;
+    let vizData = vizDataFromFile;
+    for (const migration of DIAGRAM_VIZ_MIGRATIONS.slice(startIndex)) {
+        vizData = migration.run(vizData);
+    }
+    return vizData;
+};
+const toDetailLevel = (value) => (Object.values(DetailLevel).includes(value)
+    ? value
+    : DEFAULT_DETAIL_LEVEL);
+const toRelationshipMode = (value) => (Object.values(RelationshipMode).includes(value)
+    ? value
+    : DEFAULT_RELATIONSHIP_MODE);
 export const toServerFormat = (state, diagramViews) => {
     const { defaultView, views } = state;
     const viewEntitiesMap = new Map(diagramViews?.map((v) => [v.name, v.visibleEntities]));
@@ -23,11 +56,13 @@ export const toServerFormat = (state, diagramViews) => {
         referencePaths: defaultView.referencePaths,
         stickyNoteLayouts: defaultView.stickyNoteLayouts,
         tableGroups: defaultView.tableGroupCollapseStates,
-        detailLevel: defaultView.detailLevel,
+        detailLevel: toDetailLevel(defaultView.detailLevel),
+        relationshipMode: toRelationshipMode(defaultView.relationshipMode),
         visibleEntities: viewEntitiesMap.get('Default'),
         views: Object.entries(views).map(([name, view]) => ({
             name,
-            detailLevel: view.detailLevel,
+            detailLevel: toDetailLevel(view.detailLevel),
+            relationshipMode: toRelationshipMode(view.relationshipMode),
             tablePositions: view.tablePositions,
             tableGroupCollapsedStates: view.tableGroupCollapseStates,
             stickyNoteLayouts: view.stickyNoteLayouts,
@@ -38,7 +73,8 @@ export const toServerFormat = (state, diagramViews) => {
 };
 const viewFromServer = (view) => {
     return {
-        detailLevel: (view.detailLevel ?? ''),
+        detailLevel: toDetailLevel(view.detailLevel),
+        relationshipMode: toRelationshipMode(view.relationshipMode),
         tablePositions: view.tablePositions ?? [],
         tableGroupCollapseStates: view.tableGroupCollapsedStates ?? [],
         stickyNoteLayouts: view.stickyNoteLayouts ?? [],
@@ -51,12 +87,13 @@ export const fromServerFormat = (serverData, existing) => {
         views[view.name] = viewFromServer(view);
     }
     return {
-        version: DIAGRAM_VIZ_FILE_VERSIONS.v2,
+        version: DIAGRAM_VIZ_FILE_VERSIONS.v3,
         darkMode: existing?.darkMode ?? true,
         gridEnabling: existing?.gridEnabling ?? false,
         currentViewName: existing?.currentViewName ?? null,
         defaultView: {
-            detailLevel: serverData.detailLevel,
+            detailLevel: toDetailLevel(serverData.detailLevel),
+            relationshipMode: toRelationshipMode(serverData.relationshipMode),
             tablePositions: serverData.diagram.tables,
             tableGroupCollapseStates: serverData.tableGroups,
             stickyNoteLayouts: serverData.stickyNoteLayouts,

package/dist/services/viz/diagram-viz-file.service.js

@@ -1,8 +1,8 @@
 import { readFile } from 'node:fs/promises';
 import { writeFileWithDir } from '../file.service.js';
-import { DBML_EXTENSION, DIAGRAM_VIZ_EXTENSION, DIAGRAM_VIZ_FILE_VERSIONS, } from '../../constants/dot-dbdiagram-dir.constant.js';
+import { DBML_EXTENSION, DIAGRAM_VIZ_EXTENSION, DIAGRAM_VIZ_FILE_VERSIONS, LATEST_DIAGRAM_VIZ_FILE_VERSION, } from '../../constants/dot-dbdiagram-dir.constant.js';
 import { DIAGRAM_VIZ_READ_ERROR } from '../../constants/viz-read-error.constant.js';
-import { migrateDiagramVizV1ToV2 } from './diagram-viz-converter.service.js';
+import { migrateDiagramVizToLatest } from './diagram-viz-converter.service.js';
 export const deriveDiagramVizPathFromDBML = (dbmlFilePath) => {
     const base = dbmlFilePath.endsWith(DBML_EXTENSION)
         ? dbmlFilePath.slice(0, -DBML_EXTENSION.length)
@@ -28,15 +28,16 @@ export const readDiagramVizFile = async (vizPath) => {
         return { ok: false, errorCode: DIAGRAM_VIZ_READ_ERROR.invalid_json };
     }
     const { version } = parsed;
-    if (version === DIAGRAM_VIZ_FILE_VERSIONS.v2) {
+    const fileVersion = version ?? DIAGRAM_VIZ_FILE_VERSIONS.v1;
+    if (fileVersion === LATEST_DIAGRAM_VIZ_FILE_VERSION) {
         return { ok: true, state: parsed };
     }
-    if (version === undefined || version === DIAGRAM_VIZ_FILE_VERSIONS.v1) {
-        const migrated = migrateDiagramVizV1ToV2(parsed);
-        await writeDiagramVizFile(vizPath, migrated);
-        return { ok: true, state: migrated };
+    const migrated = migrateDiagramVizToLatest(parsed, fileVersion);
+    if (!migrated) {
+        return { ok: false, errorCode: DIAGRAM_VIZ_READ_ERROR.unknown_version };
     }
-    return { ok: false, errorCode: DIAGRAM_VIZ_READ_ERROR.unknown_version };
+    await writeDiagramVizFile(vizPath, migrated);
+    return { ok: true, state: migrated };
 };
 export const writeDiagramVizFile = async (vizPath, state) => {
     await writeFileWithDir(vizPath, JSON.stringify(state, null, 2));

package/dist/types/diagram-viz.type.js

@@ -4,3 +4,11 @@ export var DetailLevel;
     DetailLevel["Keys"] = "Keys";
     DetailLevel["All"] = "All";
 })(DetailLevel || (DetailLevel = {}));
+export const DEFAULT_DETAIL_LEVEL = DetailLevel.All;
+export var RelationshipMode;
+(function (RelationshipMode) {
+    RelationshipMode["Relationship"] = "Relationship";
+    RelationshipMode["Dependency"] = "Dependency";
+    RelationshipMode["All"] = "All";
+})(RelationshipMode || (RelationshipMode = {}));
+export const DEFAULT_RELATIONSHIP_MODE = RelationshipMode.All;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdiagram",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "dist/index.js",
   "bin": {
     "dbdiagram": "dist/index.js"
@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.4.0",
-    "@dbml/core": "9.1.0",
+    "@dbml/core": "10.1.1",
     "@snowplow/node-tracker": "^4.9.0",
     "axios": "^1.19.0",
     "ci-info": "^4.4.0",
@@ -60,6 +60,6 @@
     "vitest": "^4.1.0"
   },
   "resolutions": {
-    "undici": "6.27.0"
+    "undici": "6.28.0"
   }
 }