@dbml/core 3.9.1 → 3.9.2-alpha.0

package/lib/export/DbmlExporter.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _lodash = _interopRequireDefault(require("lodash"));
+var _lodash = require("lodash");
 var _utils = require("./utils");
 var _config = require("../model_structure/config");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
@@ -186,23 +185,26 @@ var DbmlExporter = /*#__PURE__*/function () {
   }, {
     key: "exportTables",
     value: function exportTables(tableIds, model) {
-      var _this = this;
       var tableContentArr = DbmlExporter.getTableContentArr(tableIds, model);
       var tableStrs = tableContentArr.map(function (tableContent) {
         var table = model.tables[tableContent.tableId];
         var schema = model.schemas[table.schemaId];
-        var tableSettingStr = _this.getTableSettings(table);
+        var tableSettingStr = DbmlExporter.getTableSettings(table);
+        // Include schema name if needed
+        var tableName = "\"".concat(table.name, "\"");
+        if ((0, _utils.shouldPrintSchema)(schema, model)) tableName = "\"".concat(schema.name, "\".\"").concat(table.name, "\"");
+        var fieldStr = tableContent.fieldContents.map(function (field) {
+          return "  ".concat(field, "\n");
+        }).join('');
         var indexStr = '';
-        if (!_lodash["default"].isEmpty(tableContent.indexContents)) {
-          indexStr = "\n  Indexes {\n".concat(tableContent.indexContents.map(function (indexLine) {
-            return "    ".concat(indexLine);
-          }).join('\n'), "\n  }");
+        if (!(0, _lodash.isEmpty)(tableContent.indexContents)) {
+          var indexBody = tableContent.indexContents.map(function (indexLine) {
+            return "    ".concat(indexLine, "\n");
+          }).join('');
+          indexStr = "\n  Indexes {\n".concat(indexBody, "  }\n");
         }
-        var tableNote = table.note ? "  Note: ".concat(DbmlExporter.escapeNote(table.note), "\n") : '';
-        var tableStr = "Table ".concat((0, _utils.shouldPrintSchema)(schema, model) ? "\"".concat(schema.name, "\".") : '', "\"").concat(table.name, "\"").concat(tableSettingStr, " {\n").concat(tableContent.fieldContents.map(function (line) {
-          return "  ".concat(line);
-        }).join('\n'), "\n").concat(indexStr ? "".concat(indexStr, "\n") : '').concat(tableNote, "}\n");
-        return tableStr;
+        var noteStr = table.note ? "  Note: ".concat(DbmlExporter.escapeNote(table.note), "\n") : '';
+        return "Table ".concat(tableName).concat(tableSettingStr, " {\n").concat(fieldStr).concat(indexStr).concat(noteStr, "}\n");
       });
       return tableStrs.length ? tableStrs.join('\n') : '';
     }
@@ -217,7 +219,7 @@ var DbmlExporter = /*#__PURE__*/function () {
   }, {
     key: "exportRefs",
     value: function exportRefs(refIds, model) {
-      var _this2 = this;
+      var _this = this;
       var strArr = refIds.map(function (refId) {
         var ref = model.refs[refId];
         var oneRelationEndpointIndex = ref.endpointIds.findIndex(function (endpointId) {
@@ -233,7 +235,7 @@ var DbmlExporter = /*#__PURE__*/function () {
         var refEndpointField = model.fields[refEndpoint.fieldIds[0]];
         var refEndpointTable = model.tables[refEndpointField.tableId];
         var refEndpointSchema = model.schemas[refEndpointTable.schemaId];
-        var refEndpointFieldName = _this2.buildFieldName(refEndpoint.fieldIds, model, 'dbml');
+        var refEndpointFieldName = _this.buildFieldName(refEndpoint.fieldIds, model, 'dbml');
         if (ref.name) {
           line += " ".concat((0, _utils.shouldPrintSchema)(model.schemas[ref.schemaId], model) ? "\"".concat(model.schemas[ref.schemaId].name, "\".") : '', "\"").concat(ref.name, "\"");
         }
@@ -242,7 +244,7 @@ var DbmlExporter = /*#__PURE__*/function () {
         var foreignEndpointField = model.fields[foreignEndpoint.fieldIds[0]];
         var foreignEndpointTable = model.tables[foreignEndpointField.tableId];
         var foreignEndpointSchema = model.schemas[foreignEndpointTable.schemaId];
-        var foreignEndpointFieldName = _this2.buildFieldName(foreignEndpoint.fieldIds, model, 'dbml');
+        var foreignEndpointFieldName = _this.buildFieldName(foreignEndpoint.fieldIds, model, 'dbml');
         if (isManyToMany) line += '<> ';else if (foreignEndpoint.relation === '1') line += '- ';else line += '< ';
         line += "".concat((0, _utils.shouldPrintSchema)(foreignEndpointSchema, model) ? "\"".concat(foreignEndpointSchema.name, "\".") : '', "\"").concat(foreignEndpointTable.name, "\".").concat(foreignEndpointFieldName);
         var refActions = [];
@@ -260,25 +262,48 @@ var DbmlExporter = /*#__PURE__*/function () {
       });
       return strArr.length ? strArr.join('\n') : '';
     }
+  }, {
+    key: "getTableGroupSettings",
+    value: function getTableGroupSettings(tableGroup) {
+      var settings = [];
+      if (tableGroup.color) settings.push("color: ".concat(tableGroup.color));
+      return settings.length ? " [".concat(settings.join(', '), "]") : '';
+    }
   }, {
     key: "exportTableGroups",
     value: function exportTableGroups(tableGroupIds, model) {
       var tableGroupStrs = tableGroupIds.map(function (groupId) {
         var group = model.tableGroups[groupId];
         var groupSchema = model.schemas[group.schemaId];
-        return "TableGroup ".concat((0, _utils.shouldPrintSchema)(groupSchema, model) ? "\"".concat(groupSchema.name, "\".") : '', "\"").concat(group.name, "\" {\n").concat(group.tableIds.map(function (tableId) {
+        var groupSettingStr = DbmlExporter.getTableGroupSettings(group);
+        var groupNote = group.note ? "  Note: ".concat(DbmlExporter.escapeNote(group.note), "\n") : '';
+        var groupSchemaName = (0, _utils.shouldPrintSchema)(groupSchema, model) ? "\"".concat(groupSchema.name, "\".") : '';
+        var groupName = "".concat(groupSchemaName, "\"").concat(group.name, "\"");
+        var tableNames = group.tableIds.reduce(function (result, tableId) {
           var table = model.tables[tableId];
           var tableSchema = model.schemas[table.schemaId];
-          return "  ".concat((0, _utils.shouldPrintSchema)(tableSchema, model) ? "\"".concat(tableSchema.name, "\".") : '', "\"").concat(table.name, "\"");
-        }).join('\n'), "\n}\n");
+          var tableName = "  ".concat((0, _utils.shouldPrintSchema)(tableSchema, model) ? "\"".concat(tableSchema.name, "\".") : '', "\"").concat(table.name, "\"");
+          return result + "".concat(tableName, "\n");
+        }, '');
+        return "TableGroup ".concat(groupName).concat(groupSettingStr, " {\n").concat(tableNames).concat(groupNote, "}\n");
       });
       return tableGroupStrs.length ? tableGroupStrs.join('\n') : '';
     }
+  }, {
+    key: "exportStickyNotes",
+    value: function exportStickyNotes(model) {
+      return (0, _lodash.reduce)(model.notes, function (result, note) {
+        var escapedContent = "  ".concat(DbmlExporter.escapeNote(note.content));
+        var stickyNote = "Note ".concat(note.name, " {\n").concat(escapedContent, "\n}\n");
+
+        // Add a blank line between note elements
+        return result ? result + '\n' + stickyNote : stickyNote;
+      }, '');
+    }
   }, {
     key: "export",
     value: function _export(model) {
-      var res = '';
-      var hasBlockAbove = false;
+      var elementStrs = [];
       var database = model.database['1'];
       database.schemaIds.forEach(function (schemaId) {
         var _model$schemas$schema = model.schemas[schemaId],
@@ -286,28 +311,15 @@ var DbmlExporter = /*#__PURE__*/function () {
           tableIds = _model$schemas$schema.tableIds,
           tableGroupIds = _model$schemas$schema.tableGroupIds,
           refIds = _model$schemas$schema.refIds;
-        if (!_lodash["default"].isEmpty(enumIds)) {
-          if (hasBlockAbove) res += '\n';
-          res += DbmlExporter.exportEnums(enumIds, model);
-          hasBlockAbove = true;
-        }
-        if (!_lodash["default"].isEmpty(tableIds)) {
-          if (hasBlockAbove) res += '\n';
-          res += DbmlExporter.exportTables(tableIds, model);
-          hasBlockAbove = true;
-        }
-        if (!_lodash["default"].isEmpty(tableGroupIds)) {
-          if (hasBlockAbove) res += '\n';
-          res += DbmlExporter.exportTableGroups(tableGroupIds, model);
-          hasBlockAbove = true;
-        }
-        if (!_lodash["default"].isEmpty(refIds)) {
-          if (hasBlockAbove) res += '\n';
-          res += DbmlExporter.exportRefs(refIds, model);
-          hasBlockAbove = true;
-        }
+        if (!(0, _lodash.isEmpty)(enumIds)) elementStrs.push(DbmlExporter.exportEnums(enumIds, model));
+        if (!(0, _lodash.isEmpty)(tableIds)) elementStrs.push(DbmlExporter.exportTables(tableIds, model));
+        if (!(0, _lodash.isEmpty)(tableGroupIds)) elementStrs.push(DbmlExporter.exportTableGroups(tableGroupIds, model));
+        if (!(0, _lodash.isEmpty)(refIds)) elementStrs.push(DbmlExporter.exportRefs(refIds, model));
       });
-      return res;
+      if (!(0, _lodash.isEmpty)(model.notes)) elementStrs.push(DbmlExporter.exportStickyNotes(model));
+
+      // all elements already end with 1 '\n', so join('\n') to separate them with 1 blank line
+      return elementStrs.join('\n');
     }
   }]);
   return DbmlExporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/core",
-  "version": "3.9.1",
+  "version": "3.9.2-alpha.0",
   "description": "> TODO: description",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
     "prepublish": "npm run build"
   },
   "dependencies": {
-    "@dbml/parse": "^3.9.1",
+    "@dbml/parse": "^3.9.2-alpha.0",
     "antlr4": "^4.13.1",
     "lodash": "^4.17.15",
     "parsimmon": "^1.13.0",
@@ -59,7 +59,7 @@
       "\\.(?!json$)[^.]*$": "@glen/jest-raw-loader"
     }
   },
-  "gitHead": "8494c278b97347945cf3b71d6f75cd658dbae85d",
+  "gitHead": "269532f01f0475328ef08c72ec2ca901a91b0846",
   "engines": {
     "node": ">=16"
   }