@dbml/core 3.0.0 → 3.1.1

package/lib/model_structure/database.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _lodash = _interopRequireDefault(require("lodash"));
+var _lodash = _interopRequireWildcard(require("lodash"));
 var _schema = _interopRequireDefault(require("./schema"));
 var _ref2 = _interopRequireDefault(require("./ref"));
 var _enum2 = _interopRequireDefault(require("./enum"));
@@ -15,6 +15,8 @@ var _element = _interopRequireDefault(require("./element"));
 var _config = require("./config");
 var _dbState = _interopRequireDefault(require("./dbState"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -55,8 +57,8 @@ var Database = /*#__PURE__*/function (_Element) {
     _this.generateId();
     _this.hasDefaultSchema = false;
     _this.schemas = [];
-    _this.note = project.note ? project.note.value : null;
-    _this.noteToken = project.note ? project.note.token : null;
+    _this.note = project.note ? (0, _lodash.get)(project, 'note.value', project.note) : null;
+    _this.noteToken = project.note ? (0, _lodash.get)(project, 'note.token', project.noteToken) : null;
     _this.databaseType = project.database_type;
     _this.name = project.name;
     _this.aliases = aliases;

package/lib/model_structure/enum.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+var _lodash = require("lodash");
 var _element = _interopRequireDefault(require("./element"));
 var _enumValue = _interopRequireDefault(require("./enumValue"));
 var _utils = require("./utils");
@@ -34,15 +35,17 @@ var Enum = /*#__PURE__*/function (_Element) {
       token = _ref.token,
       values = _ref.values,
       note = _ref.note,
-      schema = _ref.schema;
+      schema = _ref.schema,
+      _ref$noteToken = _ref.noteToken,
+      noteToken = _ref$noteToken === void 0 ? null : _ref$noteToken;
     _classCallCheck(this, Enum);
     _this = _super.call(this, token);
     if (!name) {
       _this.error('Enum must have a name');
     }
     _this.name = name;
-    _this.note = note ? note.value : null;
-    _this.noteToken = note ? note.token : null;
+    _this.note = note ? (0, _lodash.get)(note, 'value', note) : null;
+    _this.noteToken = note ? (0, _lodash.get)(note, 'token', noteToken) : null;
     _this.values = [];
     _this.fields = [];
     _this.schema = schema;

package/lib/model_structure/enumValue.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+var _lodash = require("lodash");
 var _element = _interopRequireDefault(require("./element"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -31,15 +32,17 @@ var EnumValue = /*#__PURE__*/function (_Element) {
       name = _ref.name,
       token = _ref.token,
       note = _ref.note,
-      _enum = _ref._enum;
+      _enum = _ref._enum,
+      _ref$noteToken = _ref.noteToken,
+      noteToken = _ref$noteToken === void 0 ? null : _ref$noteToken;
     _classCallCheck(this, EnumValue);
     _this = _super.call(this, token);
     if (!name) {
       _this.error('Enum value must have a name');
     }
     _this.name = name;
-    _this.note = note ? note.value : null;
-    _this.noteToken = note ? note.token : null;
+    _this.note = note ? (0, _lodash.get)(note, 'value', note) : null;
+    _this.noteToken = note ? (0, _lodash.get)(note, 'token', noteToken) : null;
     _this._enum = _enum;
     _this.dbState = _this._enum.dbState;
     _this.generateId();

package/lib/model_structure/field.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+var _lodash = require("lodash");
 var _element = _interopRequireDefault(require("./element"));
 var _config = require("./config");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -39,7 +40,9 @@ var Field = /*#__PURE__*/function (_Element) {
       dbdefault = _ref.dbdefault,
       increment = _ref.increment,
       _ref$table = _ref.table,
-      table = _ref$table === void 0 ? {} : _ref$table;
+      table = _ref$table === void 0 ? {} : _ref$table,
+      _ref$noteToken = _ref.noteToken,
+      noteToken = _ref$noteToken === void 0 ? null : _ref$noteToken;
     _classCallCheck(this, Field);
     _this = _super.call(this, token);
     if (!name) {
@@ -54,8 +57,8 @@ var Field = /*#__PURE__*/function (_Element) {
     _this.unique = unique;
     _this.pk = pk;
     _this.not_null = notNull;
-    _this.note = note ? note.value : null;
-    _this.noteToken = note ? note.token : null;
+    _this.note = note ? (0, _lodash.get)(note, 'value', note) : null;
+    _this.noteToken = note ? (0, _lodash.get)(note, 'token', noteToken) : null;
     _this.dbdefault = dbdefault;
     _this.increment = increment;
     _this.endpoints = [];

package/lib/model_structure/schema.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+var _lodash = require("lodash");
 var _table = _interopRequireDefault(require("./table"));
 var _element = _interopRequireDefault(require("./element"));
 var _enum2 = _interopRequireDefault(require("./enum"));
@@ -46,7 +47,9 @@ var Schema = /*#__PURE__*/function (_Element) {
       tableGroups = _ref$tableGroups === void 0 ? [] : _ref$tableGroups,
       token = _ref.token,
       _ref$database = _ref.database,
-      database = _ref$database === void 0 ? {} : _ref$database;
+      database = _ref$database === void 0 ? {} : _ref$database,
+      _ref$noteToken = _ref.noteToken,
+      noteToken = _ref$noteToken === void 0 ? null : _ref$noteToken;
     _classCallCheck(this, Schema);
     _this = _super.call(this, token);
     _this.tables = [];
@@ -54,8 +57,8 @@ var Schema = /*#__PURE__*/function (_Element) {
     _this.tableGroups = [];
     _this.refs = [];
     _this.name = name;
-    _this.note = note ? note.value : null;
-    _this.noteToken = note ? note.token : null;
+    _this.note = note ? (0, _lodash.get)(note, 'value', note) : null;
+    _this.noteToken = note ? (0, _lodash.get)(note, 'token', noteToken) : null;
     _this.alias = alias;
     _this.database = database;
     _this.dbState = _this.database.dbState;

package/lib/model_structure/table.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+var _lodash = require("lodash");
 var _element = _interopRequireDefault(require("./element"));
 var _field = _interopRequireDefault(require("./field"));
 var _indexes = _interopRequireDefault(require("./indexes"));
@@ -42,13 +43,15 @@ var Table = /*#__PURE__*/function (_Element) {
       _ref$schema = _ref.schema,
       schema = _ref$schema === void 0 ? {} : _ref$schema,
       token = _ref.token,
-      headerColor = _ref.headerColor;
+      headerColor = _ref.headerColor,
+      _ref$noteToken = _ref.noteToken,
+      noteToken = _ref$noteToken === void 0 ? null : _ref$noteToken;
     _classCallCheck(this, Table);
     _this = _super.call(this, token);
     _this.name = name;
     _this.alias = alias;
-    _this.note = note ? note.value : null;
-    _this.noteToken = note ? note.token : null;
+    _this.note = note ? (0, _lodash.get)(note, 'value', note) : null;
+    _this.noteToken = note ? (0, _lodash.get)(note, 'token', noteToken) : null;
     _this.headerColor = headerColor;
     _this.fields = [];
     _this.indexes = [];

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

@@ -12,6 +12,15 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 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 () {
+  /**
+   * @param {{
+   *  name: string,
+   *  unique: boolean,
+   *  pk: boolean,
+   *  type: string,
+   *  columns: {value: string, type: 'column' | 'string' | 'expression'}[],
+   * }} param0
+   */
   function Index(_ref) {
     var name = _ref.name,
       unique = _ref.unique,
@@ -31,7 +40,7 @@ var Index = /*#__PURE__*/function () {
     /** @type {boolean} */
     this.pk = pk;
 
-    /** @type {{value: string, type: string}[]} */
+    /** @type {{value: string, type: 'column' | 'string' | 'expression'}[]} */
     this.columns = columns;
   }
   _createClass(Index, [{
@@ -53,6 +62,18 @@ var Field = /*#__PURE__*/function () {
   /** @type {boolean} */
   // fk;
 
+  /**
+   * @param {{
+   *  name: string,
+   *  type: {type_name: string, schemaName: string},
+   *  not_null: boolean,
+   *  increment: boolean,
+   *  dbdefault: {value: string, type: 'string' | 'number' | 'boolean' | 'expression'},
+   *  unique: boolean,
+   *  pk: boolean,
+   *  note: {value: string}
+   * }} param0
+   */
   function Field(_ref2) {
     var name = _ref2.name,
       type = _ref2.type,
@@ -75,7 +96,7 @@ var Field = /*#__PURE__*/function () {
     /** @type {boolean} */
     this.increment = increment;
 
-    /** @type {{value: string, type: 'string'}} */
+    /** @type {{value: string, type: 'string' | 'number' | 'boolean' | 'expression'}} */
     this.dbdefault = dbdefault;
 
     /** @type {boolean} */
@@ -84,7 +105,7 @@ var Field = /*#__PURE__*/function () {
     /** @type {boolean} */
     this.pk = pk;
 
-    /** @type {string} */
+    /** @type {{value: string}} */
     this.note = note;
   }
   _createClass(Field, [{
@@ -106,6 +127,15 @@ var Field = /*#__PURE__*/function () {
 }();
 exports.Field = Field;
 var Table = /*#__PURE__*/function () {
+  /**
+   * @param {{
+   *  name: string,
+   *  schemaName: string,
+   *  fields: Field[],
+   *  indexes: Index[],
+   *  note: {value: string}
+   * }} param0
+   */
   function Table(_ref3) {
     var name = _ref3.name,
       schemaName = _ref3.schemaName,
@@ -119,13 +149,13 @@ var Table = /*#__PURE__*/function () {
     /** @type {string} */
     this.schemaName = schemaName;
 
-    /** @type {Array<Field>} */
+    /** @type {Field[]} */
     this.fields = fields || [];
 
-    /** @type {Array<Index>} */
+    /** @type {Index[]} */
     this.indexes = indexes || [];
 
-    /** @type {string} */
+    /** @type {{value: string}} */
     this.note = note;
   }
   _createClass(Table, [{
@@ -149,6 +179,14 @@ var Table = /*#__PURE__*/function () {
 }();
 exports.Table = Table;
 var Endpoint = /*#__PURE__*/function () {
+  /**
+   * @param {{
+   *  tableName: string,
+   *  schemaName: string,
+   *  fieldNames: string[],
+   *  relation: '*' | '1'
+   * }} param0
+   */
   function Endpoint(_ref4) {
     var tableName = _ref4.tableName,
       schemaName = _ref4.schemaName,
@@ -164,7 +202,7 @@ var Endpoint = /*#__PURE__*/function () {
     /** @type {string[]} */
     this.fieldNames = fieldNames;
 
-    /** @type {string} */
+    /** @type {'*' | '1'} */
     this.relation = relation;
   }
   _createClass(Endpoint, [{
@@ -182,6 +220,14 @@ var Endpoint = /*#__PURE__*/function () {
 }();
 exports.Endpoint = Endpoint;
 var Ref = /*#__PURE__*/function () {
+  /**
+   * @param {{
+   *  name: string,
+   *  endpoints: Endpoint[],
+   *  onDelete: string,
+   *  onUpdate: string
+   * }} param0
+   */
   function Ref(_ref5) {
     var name = _ref5.name,
       endpoints = _ref5.endpoints,
@@ -191,7 +237,7 @@ var Ref = /*#__PURE__*/function () {
     /** @type {string} */
     this.name = name;
 
-    /** @type {Array<Endpoint>} */
+    /** @type {Endpoint[]} */
     this.endpoints = endpoints || [];
 
     /** @type {string} */

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

@@ -23,16 +23,21 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 var ParserErrorListener = /*#__PURE__*/function (_antlr4$error$ErrorLi) {
   _inherits(ParserErrorListener, _antlr4$error$ErrorLi);
   var _super = _createSuper(ParserErrorListener);
-  function ParserErrorListener() {
+  function ParserErrorListener(args) {
+    var _this;
     _classCallCheck(this, ParserErrorListener);
-    return _super.apply(this, arguments);
+    _this = _super.call(this, args);
+
+    /** @type {SyntaxError[]} */
+    _this.errors = [];
+    return _this;
   }
+
+  // eslint-disable-next-line no-unused-vars
   _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);
+    value: function syntaxError(recognizer, offendingSymbol, line, column, msg, err) {
+      this.errors.push(new _SyntaxError["default"](line, column, msg));
     }
   }]);
   return ParserErrorListener;

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

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TABLE_CONSTRAINT_KIND = exports.DATA_TYPE = exports.CONSTRAINT_TYPE = exports.COLUMN_CONSTRAINT_KIND = void 0;
+var TABLE_CONSTRAINT_KIND = {
+  FIELD: 'field',
+  INDEX: 'index',
+  FK: 'fk',
+  UNIQUE: 'unique',
+  PK: 'pk'
+};
+exports.TABLE_CONSTRAINT_KIND = TABLE_CONSTRAINT_KIND;
+var COLUMN_CONSTRAINT_KIND = {
+  NOT_NULL: 'not_null',
+  UNIQUE: 'unique',
+  PK: 'pk',
+  DEFAULT: 'dbdefault',
+  INCREMENT: 'increment',
+  INLINE_REF: 'inline_ref',
+  NOTE: 'note'
+};
+exports.COLUMN_CONSTRAINT_KIND = COLUMN_CONSTRAINT_KIND;
+var DATA_TYPE = {
+  STRING: 'string',
+  NUMBER: 'number',
+  BOOLEAN: 'boolean',
+  EXPRESSION: 'expression'
+};
+
+// legacy - for compatibility with model_structure
+exports.DATA_TYPE = DATA_TYPE;
+var CONSTRAINT_TYPE = {
+  COLUMN: 'column',
+  STRING: 'string',
+  EXPRESSION: 'expression'
+};
+exports.CONSTRAINT_TYPE = CONSTRAINT_TYPE;

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

@@ -8,6 +8,9 @@ var _antlr = _interopRequireDefault(require("antlr4"));
 var _PostgreSQLLexer = _interopRequireDefault(require("../parsers/postgresql/PostgreSQLLexer"));
 var _PostgreSQLParser = _interopRequireDefault(require("../parsers/postgresql/PostgreSQLParser"));
 var _PostgresASTGen = _interopRequireDefault(require("./postgres/PostgresASTGen"));
+var _MySqlLexer = _interopRequireDefault(require("../parsers/mysql/MySqlLexer"));
+var _MySqlParser = _interopRequireDefault(require("../parsers/mysql/MySqlParser"));
+var _MySQLASTGen = _interopRequireDefault(require("./mysql/MySQLASTGen"));
 var _ParserErrorListener = _interopRequireDefault(require("./ParserErrorListener"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 /* eslint-disable import/no-named-as-default-member */
@@ -16,17 +19,36 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 function parse(input, format) {
   var chars = new _antlr["default"].InputStream(input);
   var database = null;
-  if (format === 'postgres') {
-    var lexer = new _PostgreSQLLexer["default"](chars);
-    var tokens = new _antlr["default"].CommonTokenStream(lexer);
-    var parser = new _PostgreSQLParser["default"](tokens);
-    parser.buildParseTrees = true;
-    parser.removeErrorListeners();
-    parser.addErrorListener(new _ParserErrorListener["default"]());
-    var parseTree = parser.root();
-    database = parseTree.accept(new _PostgresASTGen["default"]());
-  } else {
-    throw new Error("Format not supported: ".concat(format));
+  var errorListener = new _ParserErrorListener["default"]();
+  switch (format) {
+    case 'postgres':
+      {
+        var lexer = new _PostgreSQLLexer["default"](chars);
+        var tokens = new _antlr["default"].CommonTokenStream(lexer);
+        var parser = new _PostgreSQLParser["default"](tokens);
+        parser.buildParseTrees = true;
+        parser.removeErrorListeners();
+        parser.addErrorListener(errorListener);
+        var parseTree = parser.root();
+        database = parseTree.accept(new _PostgresASTGen["default"]());
+        if (errorListener.errors.length) throw errorListener.errors;
+        break;
+      }
+    case 'mysql':
+      {
+        var _lexer = new _MySqlLexer["default"](chars);
+        var _tokens = new _antlr["default"].CommonTokenStream(_lexer);
+        var _parser = new _MySqlParser["default"](_tokens);
+        _parser.buildParseTrees = true;
+        _parser.removeErrorListeners();
+        _parser.addErrorListener(errorListener);
+        var _parseTree = _parser.root();
+        database = _parseTree.accept(new _MySQLASTGen["default"]());
+        if (errorListener.errors.length) throw errorListener.errors;
+        break;
+      }
+    default:
+      throw new Error("Format not supported: ".concat(format));
   }
   return database;
 }