@dbml/core 2.5.3 → 2.6.0

package/README.md

@@ -1,6 +1,6 @@
 # @dbml/core
 
-See our website [@dbml/core](https://www.dbml.org/js-module/#core) for more information
+See our website [@dbml/core](https://dbml.dbdiagram.io/js-module/#core) for more information
 
 ## Installation
 ```shell

package/lib/model_structure/field.js

@@ -78,7 +78,9 @@ var Field = /*#__PURE__*/function (_Element) {
       if (this.type.schemaName) {
         var _enum = this.table.schema.database.findEnum(typeSchemaName, typeName);
         if (!_enum) {
-          this.error("Cannot find type ".concat(typeSchemaName, " in schema ").concat(typeSchemaName));
+          // SQL allow definition of non-enum type to be used as column type, which we don't have equivalent dbml counterpart.
+          // So instead of throwing errors on those type, we can view the type as plain text for the purpose of importing to dbml.
+          this.type.type_name = "".concat(typeSchemaName, ".").concat(typeName);
           return;
         }
         this._enum = _enum;

package/lib/parse/ANTLR/ASTGeneration/AST.js

@@ -0,0 +1,246 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Table = exports.Ref = exports.Index = exports.Field = exports.Enum = exports.Endpoint = void 0;
+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); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+/* eslint-disable max-classes-per-file */
+var Index = /*#__PURE__*/function () {
+  function Index(_ref) {
+    var name = _ref.name,
+      unique = _ref.unique,
+      pk = _ref.pk,
+      type = _ref.type,
+      columns = _ref.columns;
+    _classCallCheck(this, Index);
+    /** @type {string} */
+    this.name = name;
+
+    /** @type {string} */
+    this.type = type;
+
+    /** @type {boolean} */
+    this.unique = unique;
+
+    /** @type {boolean} */
+    this.pk = pk;
+
+    /** @type {{value: string, type: string}[]} */
+    this.columns = columns;
+  }
+  _createClass(Index, [{
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        name: this.name,
+        type: this.type,
+        unique: this.unique,
+        pk: this.pk,
+        columns: this.columns
+      };
+    }
+  }]);
+  return Index;
+}();
+exports.Index = Index;
+var Field = /*#__PURE__*/function () {
+  /** @type {boolean} */
+  // fk;
+
+  function Field(_ref2) {
+    var name = _ref2.name,
+      type = _ref2.type,
+      not_null = _ref2.not_null,
+      increment = _ref2.increment,
+      dbdefault = _ref2.dbdefault,
+      unique = _ref2.unique,
+      pk = _ref2.pk,
+      note = _ref2.note;
+    _classCallCheck(this, Field);
+    /** @type {string} */
+    this.name = name;
+
+    /** @type {{type_name: string, schemaName: string}} */
+    this.type = type;
+
+    /** @type {boolean} */
+    this.not_null = not_null;
+
+    /** @type {boolean} */
+    this.increment = increment;
+
+    /** @type {{value: string, type: 'string'}} */
+    this.dbdefault = dbdefault;
+
+    /** @type {boolean} */
+    this.unique = unique;
+
+    /** @type {boolean} */
+    this.pk = pk;
+
+    /** @type {string} */
+    this.note = note;
+  }
+  _createClass(Field, [{
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        name: this.name,
+        type: this.type,
+        not_null: this.not_null,
+        increment: this.increment,
+        dbdefault: this.dbdefault,
+        unique: this.unique,
+        pk: this.pk,
+        note: this.note
+      };
+    }
+  }]);
+  return Field;
+}();
+exports.Field = Field;
+var Table = /*#__PURE__*/function () {
+  function Table(_ref3) {
+    var name = _ref3.name,
+      schemaName = _ref3.schemaName,
+      fields = _ref3.fields,
+      indexes = _ref3.indexes,
+      note = _ref3.note;
+    _classCallCheck(this, Table);
+    /** @type {string} */
+    this.name = name;
+
+    /** @type {string} */
+    this.schemaName = schemaName;
+
+    /** @type {Array<Field>} */
+    this.fields = fields || [];
+
+    /** @type {Array<Index>} */
+    this.indexes = indexes || [];
+
+    /** @type {string} */
+    this.note = note;
+  }
+  _createClass(Table, [{
+    key: "toJSON",
+    value: function toJSON() {
+      var _this$fields, _this$indexes;
+      return {
+        name: this.name,
+        schemaName: this.schemaName,
+        fields: (_this$fields = this.fields) === null || _this$fields === void 0 ? void 0 : _this$fields.map(function (f) {
+          return f.toJSON();
+        }),
+        indexes: (_this$indexes = this.indexes) === null || _this$indexes === void 0 ? void 0 : _this$indexes.map(function (i) {
+          return i.toJSON();
+        }),
+        note: this.note
+      };
+    }
+  }]);
+  return Table;
+}();
+exports.Table = Table;
+var Endpoint = /*#__PURE__*/function () {
+  function Endpoint(_ref4) {
+    var tableName = _ref4.tableName,
+      schemaName = _ref4.schemaName,
+      fieldNames = _ref4.fieldNames,
+      relation = _ref4.relation;
+    _classCallCheck(this, Endpoint);
+    /** @type {string} */
+    this.tableName = tableName;
+
+    /** @type {string} */
+    this.schemaName = schemaName;
+
+    /** @type {string[]} */
+    this.fieldNames = fieldNames;
+
+    /** @type {string} */
+    this.relation = relation;
+  }
+  _createClass(Endpoint, [{
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        tableName: this.tableName,
+        schemaName: this.schemaName,
+        fieldNames: this.fieldNames,
+        relation: this.relation
+      };
+    }
+  }]);
+  return Endpoint;
+}();
+exports.Endpoint = Endpoint;
+var Ref = /*#__PURE__*/function () {
+  function Ref(_ref5) {
+    var name = _ref5.name,
+      endpoints = _ref5.endpoints,
+      onDelete = _ref5.onDelete,
+      onUpdate = _ref5.onUpdate;
+    _classCallCheck(this, Ref);
+    /** @type {string} */
+    this.name = name;
+
+    /** @type {Array<Endpoint>} */
+    this.endpoints = endpoints || [];
+
+    /** @type {string} */
+    this.onDelete = onDelete;
+
+    /** @type {string} */
+    this.onUpdate = onUpdate;
+  }
+  _createClass(Ref, [{
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        name: this.name,
+        onDelete: this.onDelete,
+        onUpdate: this.onUpdate,
+        endpoints: this.endpoints.map(function (e) {
+          return e.toJSON();
+        })
+      };
+    }
+  }]);
+  return Ref;
+}();
+exports.Ref = Ref;
+var Enum = /*#__PURE__*/function () {
+  function Enum(_ref6) {
+    var name = _ref6.name,
+      schemaName = _ref6.schemaName,
+      values = _ref6.values;
+    _classCallCheck(this, Enum);
+    /** @type {string} */
+    this.name = name;
+
+    /** @type {string} */
+    this.schemaName = schemaName;
+
+    /** @type {{name: string}[]} */
+    this.values = values;
+  }
+  _createClass(Enum, [{
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        name: this.name,
+        schemaName: this.schemaName,
+        values: this.values
+      };
+    }
+  }]);
+  return Enum;
+}();
+exports.Enum = Enum;

package/lib/parse/ANTLR/ASTGeneration/ParserErrorListener.js

@@ -0,0 +1,40 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _antlr = _interopRequireDefault(require("antlr4"));
+var _SyntaxError = _interopRequireDefault(require("./SyntaxError"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": 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); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+var ParserErrorListener = /*#__PURE__*/function (_antlr4$error$ErrorLi) {
+  _inherits(ParserErrorListener, _antlr4$error$ErrorLi);
+  var _super = _createSuper(ParserErrorListener);
+  function ParserErrorListener() {
+    _classCallCheck(this, ParserErrorListener);
+    return _super.apply(this, arguments);
+  }
+  _createClass(ParserErrorListener, [{
+    key: "syntaxError",
+    value:
+    // eslint-disable-next-line class-methods-use-this, no-unused-vars
+    function syntaxError(recognizer, offendingSymbol, line, column, msg, err) {
+      throw new _SyntaxError["default"](line, column, msg);
+    }
+  }]);
+  return ParserErrorListener;
+}(_antlr["default"].error.ErrorListener);
+exports["default"] = ParserErrorListener;