@dbml/core 4.0.0 → 5.0.0

package/lib/model_structure/table.js

@@ -11,7 +11,7 @@ var _field = _interopRequireDefault(require("./field"));
 var _indexes = _interopRequireDefault(require("./indexes"));
 var _config = require("./config");
 var _utils = require("./utils");
-var _constraint = _interopRequireDefault(require("./constraint"));
+var _check = _interopRequireDefault(require("./check"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -45,8 +45,8 @@ var Table = /*#__PURE__*/function (_Element) {
       fields = _ref$fields === void 0 ? [] : _ref$fields,
       _ref$indexes = _ref.indexes,
       indexes = _ref$indexes === void 0 ? [] : _ref$indexes,
-      _ref$constraints = _ref.constraints,
-      constraints = _ref$constraints === void 0 ? [] : _ref$constraints,
+      _ref$checks = _ref.checks,
+      checks = _ref$checks === void 0 ? [] : _ref$checks,
       _ref$schema = _ref.schema,
       schema = _ref$schema === void 0 ? {} : _ref$schema,
       token = _ref.token,
@@ -64,7 +64,7 @@ var Table = /*#__PURE__*/function (_Element) {
     _this.headerColor = headerColor;
     _this.fields = [];
     _this.indexes = [];
-    _this.constraints = [];
+    _this.checks = [];
     _this.schema = schema;
     _this.partials = partials;
     _this.dbState = _this.schema.dbState;
@@ -75,7 +75,7 @@ var Table = /*#__PURE__*/function (_Element) {
     _this.processPartials();
     _this.checkFieldCount();
     _this.processIndexes(indexes);
-    _this.processConstraints(constraints);
+    _this.processChecks(checks);
     return _this;
   }
   _inherits(Table, _Element);
@@ -143,19 +143,19 @@ var Table = /*#__PURE__*/function (_Element) {
       });
     }
   }, {
-    key: "processConstraints",
-    value: function processConstraints(constraints) {
+    key: "processChecks",
+    value: function processChecks(checks) {
       var _this5 = this;
-      constraints.forEach(function (constraint) {
-        _this5.pushConstraint(new _constraint["default"](_objectSpread(_objectSpread({}, constraint), {}, {
+      checks.forEach(function (check) {
+        _this5.pushCheck(new _check["default"](_objectSpread(_objectSpread({}, check), {}, {
           table: _this5
         })));
       });
     }
   }, {
-    key: "pushConstraint",
-    value: function pushConstraint(constraint) {
-      this.constraints.push(constraint);
+    key: "pushCheck",
+    value: function pushCheck(check) {
+      this.checks.push(check);
     }
   }, {
     key: "findField",
@@ -272,10 +272,10 @@ var Table = /*#__PURE__*/function (_Element) {
             injectedPartial: tablePartial
           })));
         });
-        tablePartial.constraints.forEach(function (constraint) {
-          _this6.constraints.push(new _constraint["default"](_objectSpread(_objectSpread({}, constraint), {}, {
-            name: constraint.name && "".concat(_this6.name, ".").concat(constraint.name),
-            // deduplicate constraint names when instantiated to tables
+        tablePartial.checks.forEach(function (check) {
+          _this6.checks.push(new _check["default"](_objectSpread(_objectSpread({}, check), {}, {
+            name: check.name && "".concat(_this6.name, ".").concat(check.name),
+            // deduplicate check names when instantiated to tables
             table: _this6,
             injectedPartial: tablePartial
           })));
@@ -309,7 +309,7 @@ var Table = /*#__PURE__*/function (_Element) {
         indexIds: this.indexes.map(function (i) {
           return i.id;
         }),
-        constraintIds: this.constraints.map(function (c) {
+        checkIds: this.checks.map(function (c) {
           return c.id;
         })
       };
@@ -345,8 +345,8 @@ var Table = /*#__PURE__*/function (_Element) {
       this.indexes.forEach(function (index) {
         return index.normalize(model);
       });
-      this.constraints.forEach(function (constraint) {
-        return constraint.normalize(model);
+      this.checks.forEach(function (check) {
+        return check.normalize(model);
       });
     }
   }]);

package/lib/model_structure/tablePartial.js

@@ -33,8 +33,8 @@ var TablePartial = /*#__PURE__*/function (_Element) {
       fields = _ref$fields === void 0 ? [] : _ref$fields,
       _ref$indexes = _ref.indexes,
       indexes = _ref$indexes === void 0 ? [] : _ref$indexes,
-      _ref$constraints = _ref.constraints,
-      constraints = _ref$constraints === void 0 ? [] : _ref$constraints,
+      _ref$checks = _ref.checks,
+      checks = _ref$checks === void 0 ? [] : _ref$checks,
       token = _ref.token,
       headerColor = _ref.headerColor,
       _ref$noteToken = _ref.noteToken,
@@ -48,7 +48,7 @@ var TablePartial = /*#__PURE__*/function (_Element) {
     _this.headerColor = headerColor;
     _this.fields = fields;
     _this.indexes = indexes;
-    _this.constraints = constraints;
+    _this.checks = checks;
     _this.dbState = dbState;
     _this.generateId();
     return _this;

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

@@ -71,7 +71,7 @@ var Field = exports.Field = /*#__PURE__*/function () {
    *  unique: boolean,
    *  pk: boolean,
    *  note: {value: string},
-   *  constraints: {expression: string, name?: string}[]
+   *  checks: {expression: string, name?: string}[]
    * }} param0
    */
   function Field(_ref2) {
@@ -83,7 +83,7 @@ var Field = exports.Field = /*#__PURE__*/function () {
       unique = _ref2.unique,
       pk = _ref2.pk,
       note = _ref2.note,
-      constraints = _ref2.constraints;
+      checks = _ref2.checks;
     _classCallCheck(this, Field);
     /** @type {string} */
     this.name = name;
@@ -110,7 +110,7 @@ var Field = exports.Field = /*#__PURE__*/function () {
     this.note = note;
 
     /** @type {{expression: string, name?: string}[]} */
-    this.constraints = constraints;
+    this.checks = checks;
   }
   return _createClass(Field, [{
     key: "toJSON",
@@ -124,7 +124,7 @@ var Field = exports.Field = /*#__PURE__*/function () {
         unique: this.unique,
         pk: this.pk,
         note: this.note,
-        constraints: this.constraints
+        checks: this.checks
       };
     }
   }]);
@@ -137,7 +137,7 @@ var Table = exports.Table = /*#__PURE__*/function () {
    *  fields: Field[],
    *  indexes: Index[],
    *  note: {value: string},
-   *  constraints: {expression: string, name?: string}[]
+   *  checks: {expression: string, name?: string}[]
    * }} param0
    */
   function Table(_ref3) {
@@ -146,7 +146,7 @@ var Table = exports.Table = /*#__PURE__*/function () {
       fields = _ref3.fields,
       indexes = _ref3.indexes,
       note = _ref3.note,
-      constraints = _ref3.constraints;
+      checks = _ref3.checks;
     _classCallCheck(this, Table);
     /** @type {string} */
     this.name = name;
@@ -164,7 +164,7 @@ var Table = exports.Table = /*#__PURE__*/function () {
     this.note = note;
 
     /** @type {{expression: string, name?: string}[]} */
-    this.constraints = constraints || [];
+    this.checks = checks || [];
   }
   return _createClass(Table, [{
     key: "toJSON",
@@ -180,7 +180,7 @@ var Table = exports.Table = /*#__PURE__*/function () {
           return i.toJSON();
         }),
         note: this.note,
-        constraints: this.constraints
+        checks: this.checks
       };
     }
   }]);

package/lib/parse/ANTLR/ASTGeneration/mssql/MssqlASTGen.js

@@ -609,7 +609,7 @@ var MssqlASTGen = exports["default"] = /*#__PURE__*/function (_TSqlParserVisitor
         schemaName: schemaName,
         fields: fields,
         indexes: tableIndices.concat(indexes),
-        constraints: tableCheckConstraints
+        checks: tableCheckConstraints
       });
       this.data.tables.push(table);
     }
@@ -728,16 +728,16 @@ var MssqlASTGen = exports["default"] = /*#__PURE__*/function (_TSqlParserVisitor
               var _columnDef$value = columnDef.value,
                 _expression = _columnDef$value.expression,
                 name = _columnDef$value.name;
-              if (!field.constraints) {
-                field.constraints = [];
+              if (!field.checks) {
+                field.checks = [];
               }
-              var constraintObj = {
+              var checkObj = {
                 expression: _expression
               };
               if (name) {
-                constraintObj.name = name;
+                checkObj.name = name;
               }
-              field.constraints.push(constraintObj);
+              field.checks.push(checkObj);
               break;
             }
           default:
@@ -1183,13 +1183,13 @@ var MssqlASTGen = exports["default"] = /*#__PURE__*/function (_TSqlParserVisitor
         field.dbdefault = columnDefault.defaultValue;
       });
       checkConstraints.forEach(function (checkConstraint) {
-        var constraintObj = {
+        var checkObj = {
           expression: checkConstraint.expression
         };
         if (checkConstraint.name) {
-          constraintObj.name = checkConstraint.name;
+          checkObj.name = checkConstraint.name;
         }
-        table.constraints.push(constraintObj);
+        table.checks.push(checkObj);
       });
     }
 

package/lib/parse/ANTLR/ASTGeneration/mysql/MySQLASTGen.js

@@ -157,7 +157,7 @@ var MySQLASTGen = exports["default"] = /*#__PURE__*/function (_MySQLParserVisito
           indexes = _definitions$reduce2[1],
           tableRefs = _definitions$reduce2[2],
           singlePkIndex = _definitions$reduce2[3],
-          tableConstraints = _definitions$reduce2[4];
+          tableChecks = _definitions$reduce2[4];
         var inlineRefsOfFields = fieldsData.map(function (fieldData) {
           var _field$type$type_name;
           var field = fieldData.field,
@@ -202,7 +202,7 @@ var MySQLASTGen = exports["default"] = /*#__PURE__*/function (_MySQLParserVisito
             return fd.field;
           }),
           indexes: indexes,
-          constraints: tableConstraints
+          checks: tableChecks
         }, tableOptions));
         if (singlePkIndex) {
           var field = table.fields.find(function (f) {
@@ -413,7 +413,7 @@ var MySQLASTGen = exports["default"] = /*#__PURE__*/function (_MySQLParserVisito
       var type = ctx.dataType().accept(this);
       var constraints = {
         inlineRefs: [],
-        constraints: []
+        checks: []
       };
       ctx.columnConstraint().forEach(function (c) {
         var constraint = c.accept(_this9);
@@ -423,7 +423,7 @@ var MySQLASTGen = exports["default"] = /*#__PURE__*/function (_MySQLParserVisito
           return;
         }
         if (constraint.kind === _constants.COLUMN_CONSTRAINT_KIND.CHECK) {
-          constraints.constraints.push(constraint.value);
+          constraints.checks.push(constraint.value);
           return;
         }
         constraints[constraint.kind] = constraint.value;
@@ -1091,7 +1091,7 @@ var MySQLASTGen = exports["default"] = /*#__PURE__*/function (_MySQLParserVisito
           ref.endpoints[0].tableName = tableName;
           _this13.data.refs.push(ref);
         } else if (alter.kind === ALTER_KIND.ADD_CHECK) {
-          table.constraints.push(alter.value);
+          table.checks.push(alter.value);
         }
         return null;
       });

package/lib/parse/ANTLR/ASTGeneration/postgres/PostgresASTGen.js

@@ -165,7 +165,7 @@ var PostgresASTGen = exports["default"] = /*#__PURE__*/function (_PostgreSQLPars
         fieldsData = _tableElements$reduce2[0],
         indexes = _tableElements$reduce2[1],
         tableRefs = _tableElements$reduce2[2],
-        tableConstraints = _tableElements$reduce2[3];
+        tableChecks = _tableElements$reduce2[3];
       (_this$data$refs = this.data.refs).push.apply(_this$data$refs, _toConsumableArray((0, _lodash.flatten)(fieldsData.map(function (fieldData) {
         return fieldData.inline_refs.map(function (inlineRef) {
           inlineRef.endpoints[0].tableName = tableName;
@@ -186,7 +186,7 @@ var PostgresASTGen = exports["default"] = /*#__PURE__*/function (_PostgreSQLPars
           return fd.field;
         }),
         indexes: indexes,
-        constraints: tableConstraints
+        checks: tableChecks
       });
     }
 
@@ -359,7 +359,7 @@ var PostgresASTGen = exports["default"] = /*#__PURE__*/function (_PostgreSQLPars
       var _this5 = this;
       var r = {
         inline_refs: [],
-        constraints: []
+        checks: []
       };
       ctx.colconstraint().forEach(function (c) {
         var constraint = c.accept(_this5);
@@ -369,7 +369,7 @@ var PostgresASTGen = exports["default"] = /*#__PURE__*/function (_PostgreSQLPars
           return;
         }
         if (constraint.kind === _constants.COLUMN_CONSTRAINT_KIND.CHECK) {
-          r.constraints.push(constraint.value);
+          r.checks.push(constraint.value);
           return;
         }
         r[constraint.kind] = constraint.value;
@@ -972,8 +972,8 @@ var PostgresASTGen = exports["default"] = /*#__PURE__*/function (_PostgreSQLPars
               {
                 var table = findTable(_this8.data.tables, schemaName, tableName);
                 if (!table) break;
-                if (!table.constraints) table.constraints = [];
-                table.constraints.push(cmd.value);
+                if (!table.checks) table.checks = [];
+                table.checks.push(cmd.value);
                 break;
               }
             case _constants.TABLE_CONSTRAINT_KIND.UNIQUE:

package/lib/parse/schemarb/parser.pegjs

@@ -27,14 +27,14 @@
     if (!table) {
       error("Table ${tableName} not found");
     }
-    if (!table.constraints) {
-      table.constraints = [];
+    if (!table.checks) {
+      table.checks = [];
     }
-    const constraint = { expression };
+    const check = { expression };
     if (name) {
-      constraint.name = name;
+      check.name = name;
     }
-    table.constraints.push(constraint);
+    table.checks.push(check);
   }
 
   function addPrimaryKey(fields = [], props = []) {
@@ -284,8 +284,8 @@ rule = tableData:create_table_syntax {
 
 add_check_constraint_syntax
   = sp* add_check_constraint sp* tableName:(symbol / name) "," sp* expression:name props:check_constraint_props* {
-    const constraintName = props.find(p => p.name)?.name;
-    addCheckConstraintToTable(tableName, expression, constraintName);
+    const checkName = props.find(p => p.name)?.name;
+    addCheckConstraintToTable(tableName, expression, checkName);
   }
 
 add_foreign_key_syntax
@@ -319,8 +319,8 @@ create_table_syntax
       fields: addPrimaryKey(body.fields),
       // index: _.union(...body.index)
     })
-    if (body.constraints && body.constraints.length > 0) {
-      table.constraints = body.constraints;
+    if (body.checks && body.checks.length > 0) {
+      table.checks = body.checks;
     }
     return {
       table,
@@ -333,7 +333,7 @@ table_body = fields:field* {
       fields: fields.filter(field => field.isField).map(field => field.field),
       index: fields.filter(field => field.isIndex).map(field => field.index),
       references: fields.filter(field => field.isReferences).map(field => field.reference),
-      constraints: fields.filter(field => field.isConstraint).map(field => field.constraint),
+      checks: fields.filter(field => field.isCheck).map(field => field.check),
     });
   }
 
@@ -342,7 +342,7 @@ field = whitespace* field:table_field_syntax whatever* endline { return field }
 table_field_syntax
   = field_index_syntax
   / reference: field_reference_syntax { return ({ reference, isReferences: true })}
-  / constraint: field_check_constraint_syntax { return ({ constraint, isConstraint: true })}
+  / check: field_check_constraint_syntax { return ({ check, isCheck: true })}
   / field:field_type_syntax { return ({ field, isField: true }) }
 
 field_index_syntax = index sp+ whateters
@@ -350,13 +350,13 @@ field_reference_syntax = references sp+ reference:reference_value {
     return reference;
   }
 field_check_constraint_syntax = check_constraint sp+ expression:name props:check_constraint_props* {
-    const constraint = { expression };
+    const check = { expression };
     for (let i = 0; i < props.length; i++) {
       if (props[i].name) {
-        constraint.name = props[i].name;
+        check.name = props[i].name;
       }
     }
-    return constraint;
+    return check;
   }
 field_type_syntax = type:field_type sp+ name:name {
     return ({

package/lib/parse/schemarbParser.js

@@ -129,10 +129,10 @@ function peg$parse(input, options) {
     peg$c4 = peg$literalExpectation(",", false),
     peg$c5 = function peg$c5(tableName, expression, props) {
       var _props$find;
-      var constraintName = (_props$find = props.find(function (p) {
+      var checkName = (_props$find = props.find(function (p) {
         return p.name;
       })) === null || _props$find === void 0 ? void 0 : _props$find.name;
-      addCheckConstraintToTable(tableName, expression, constraintName);
+      addCheckConstraintToTable(tableName, expression, checkName);
     },
     peg$c6 = function peg$c6(fromTable, toTable, props) {
       var foreign = refactorForeign(createForeign(fromTable, toTable, props));
@@ -168,8 +168,8 @@ function peg$parse(input, options) {
         fields: addPrimaryKey(body.fields)
         // index: _.union(...body.index)
       };
-      if (body.constraints && body.constraints.length > 0) {
-        table.constraints = body.constraints;
+      if (body.checks && body.checks.length > 0) {
+        table.checks = body.checks;
       }
       return {
         table: table,
@@ -193,10 +193,10 @@ function peg$parse(input, options) {
         }).map(function (field) {
           return field.reference;
         }),
-        constraints: fields.filter(function (field) {
-          return field.isConstraint;
+        checks: fields.filter(function (field) {
+          return field.isCheck;
         }).map(function (field) {
-          return field.constraint;
+          return field.check;
         })
       };
     },
@@ -209,10 +209,10 @@ function peg$parse(input, options) {
         isReferences: true
       };
     },
-    peg$c16 = function peg$c16(constraint) {
+    peg$c16 = function peg$c16(check) {
       return {
-        constraint: constraint,
-        isConstraint: true
+        check: check,
+        isCheck: true
       };
     },
     peg$c17 = function peg$c17(field) {
@@ -225,15 +225,15 @@ function peg$parse(input, options) {
       return reference;
     },
     peg$c19 = function peg$c19(expression, props) {
-      var constraint = {
+      var check = {
         expression: expression
       };
       for (var i = 0; i < props.length; i++) {
         if (props[i].name) {
-          constraint.name = props[i].name;
+          check.name = props[i].name;
         }
       }
-      return constraint;
+      return check;
     },
     peg$c20 = function peg$c20(type, name) {
       return {
@@ -2466,16 +2466,16 @@ function peg$parse(input, options) {
     if (!table) {
       error("Table ${tableName} not found");
     }
-    if (!table.constraints) {
-      table.constraints = [];
+    if (!table.checks) {
+      table.checks = [];
     }
-    var constraint = {
+    var check = {
       expression: expression
     };
     if (name) {
-      constraint.name = name;
+      check.name = name;
     }
-    table.constraints.push(constraint);
+    table.checks.push(check);
   }
   function addPrimaryKey() {
     var fields = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/core",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "> TODO: description",
   "author": "Holistics <dev@holistics.io>",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
     "prepublish": "npm run build"
   },
   "dependencies": {
-    "@dbml/parse": "^4.0.0",
+    "@dbml/parse": "^5.0.0",
     "antlr4": "^4.13.1",
     "lodash": "^4.17.15",
     "parsimmon": "^1.13.0",
@@ -62,7 +62,7 @@
       "^lodash-es$": "lodash"
     }
   },
-  "gitHead": "defacb4ec78893de46225948499feea5bf2932e2",
+  "gitHead": "a2d029e9c3c78ab0956312495165ec3115b5bc00",
   "engines": {
     "node": ">=16"
   }

package/types/model_structure/{constraint.d.ts → check.d.ts}

@@ -4,7 +4,7 @@ import Field from './field';
 import Table from './table';
 import TablePartial from './tablePartial';
 
-interface RawConstraint {
+interface RawCheck {
     token: Token;
     name: string;
     expression: string;
@@ -13,14 +13,14 @@ interface RawConstraint {
     injectedPartial?: TablePartial | null;
 }
 
-declare class Constraint extends Element {
+declare class Check extends Element {
     name: string;
     expression: string;
     table: Table;
     column: Field | null;
     injectedPartial: TablePartial | null;
 
-    constructor({ token, name, expression, table, column, injectedPartial }: RawConstraint);
+    constructor({ token, name, expression, table, column, injectedPartial }: RawCheck);
     generateId(): void;
     export(): {
         name: string;
@@ -38,7 +38,7 @@ declare class Constraint extends Element {
     normalize(model: NormalizedDatabase): void;
 }
 
-export interface NormalizedConstraint {
+export interface NormalizedCheck {
     [_id: number]: {
         id: number;
         name: string;
@@ -49,4 +49,4 @@ export interface NormalizedConstraint {
     };
 }
 
-export default Constraint;
+export default Check;

package/types/model_structure/database.d.ts

@@ -11,7 +11,7 @@ import { NormalizedEnumValue } from './enumValue';
 import { NormalizedField } from './field';
 import { NormalizedIndexColumn } from './indexColumn';
 import { NormalizedIndex } from './indexes';
-import { NormalizedConstraint } from './constraint';
+import { NormalizedCheck } from './check';
 import TablePartial, { NormalizedTablePartial } from './tablePartial';
 export interface Project {
     note: RawNote;
@@ -300,7 +300,7 @@ export interface NormalizedDatabase {
     enumValues: NormalizedEnumValue;
     indexes: NormalizedIndex;
     indexColumns: NormalizedIndexColumn;
-    constraints: NormalizedConstraint;
+    checks: NormalizedCheck;
     fields: NormalizedField;
     records: NormalizedRecords;
     tablePartials: NormalizedTablePartial;

package/types/model_structure/dbState.d.ts

@@ -8,6 +8,7 @@ export default class DbState {
     noteId: number;
     enumValueId: number;
     endpointId: number;
+    checkId: number;
     indexId: number;
     fieldId: number;
     indexColumnId: number;

package/types/model_structure/field.d.ts

@@ -5,7 +5,7 @@ import Endpoint from './endpoint';
 import Enum from './enum';
 import Table from './table';
 import TablePartial from './tablePartial';
-import Constraint from './constraint';
+import Check from './check';
 interface RawField {
     name: string;
     type: any;
@@ -16,7 +16,7 @@ interface RawField {
     note: RawNote;
     dbdefault: any;
     increment: boolean;
-    constraints?: any[];
+    checks?: any[];
     table: Table;
 }
 declare class Field extends Element {
@@ -30,16 +30,16 @@ declare class Field extends Element {
     noteToken: Token;
     dbdefault: any;
     increment: boolean;
-    constraints: Constraint[];
+    checks: Check[];
     table: Table;
     endpoints: Endpoint[];
     _enum: Enum;
     injectedPartial?: TablePartial;
     injectedToken: Token;
-    constructor({ name, type, unique, pk, token, not_null, note, dbdefault, increment, constraints, table }: RawField);
+    constructor({ name, type, unique, pk, token, not_null, note, dbdefault, increment, checks, table }: RawField);
     generateId(): void;
     pushEndpoint(endpoint: any): void;
-    processConstraints(constraints: any[]): void;
+    processChecks(checks: any[]): void;
     export(): {
         name: string;
         type: any;
@@ -68,7 +68,7 @@ declare class Field extends Element {
         dbdefault: any;
         increment: boolean;
         injectedPartialId?: number;
-        constraintIds: number[];
+        checkIds: number[];
     };
     normalize(model: NormalizedDatabase): void;
 }
@@ -87,7 +87,7 @@ export interface NormalizedField {
         endpointIds: number[];
         enumId: number;
         injectedPartialId?: number;
-        constraintIds: number[];
+        checkIds: number[];
     };
 }
 export default Field;