tg-client-query-builder 2.13.0 → 2.14.2

package/build/query-builder/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-// valid filters: 
+// valid filters:
 // greaterThan
 // inList
 // lessThan
@@ -16,11 +16,14 @@
 // endsWithExactly
 // containsExactly
 // startsWith
+// notStartsWith
 // endsWith
+// notEndsWith
 // contains
+// notContains
 // upperCase
 // lowerCase
-// matchesRegex (note: this takes a string like "thomas.*is.*cool", don't include the outer slashes like /asdf/ and don't pass a regex object ) 
+// matchesRegex (note: this takes a string like "thomas.*is.*cool", don't include the outer slashes like /asdf/ and don't pass a regex object )
 // fuzzy
 var FilterExpression = require("./filter-expression");
 var _ = require("lodash");
@@ -35,7 +38,7 @@ function isDateOrNumber(opName) {
     if (args.some(function (arg) {
       return !(_.isDate(arg) || _.isString(arg) || _.isNumber(arg));
     })) {
-      throw new Error("QueryBuilderError: You must pass a date or number as args to " + opName + ". You passed: Args " + args.join(','));
+      throw new Error("QueryBuilderError: You must pass a date or number as args to " + opName + ". You passed: Args " + args.join(","));
     }
   };
 }
@@ -107,9 +110,15 @@ var expressionOperators = [{
 }, {
   opName: "startsWith",
   sanityChecks: [numberOfArgs("startsWith", 1), isString("startsWith")]
+}, {
+  opName: "notStartsWith",
+  sanityChecks: [numberOfArgs("notStartsWith", 1), isString("notStartsWith")]
 }, {
   opName: "endsWith",
   sanityChecks: [numberOfArgs("endsWith", 1), isString("endsWith")]
+}, {
+  opName: "notEndsWith",
+  sanityChecks: [numberOfArgs("notEndsWith", 1), isString("notEndsWith")]
 }, {
   opName: "contains",
   sanityChecks: [numberOfArgs("contains", 1), isString("contains")]
@@ -125,26 +134,26 @@ var expressionOperators = [{
 }, {
   opName: "matchesRegex",
   sanityChecks: [numberOfArgs("matchesRegex", 1), isString("matchesRegex")]
+}, {
+  opName: "matchesSimilar",
+  sanityChecks: [numberOfArgs("matchesSimilar", 1), isString("matchesSimilar")]
 }, {
   opName: "fuzzy",
   sanityChecks: [numberOfArgs("fuzzy", 1), isString("fuzzy")],
   transform: function transform(arg) {
-    // Build Regex String 
-    var matchTerm = '';
+    // Build Regex String
+    var matchTerm = "";
     // Split all the search terms
-    var terms = arg.replace(/\W/g, '').replace(' ', '').split("");
+    var terms = arg.replace(/\W/g, "").replace(" ", "").split("");
     for (var i = 0; i < terms.length; i++) {
-      matchTerm += '.*' + terms[i];
+      matchTerm += ".*" + terms[i];
     }
-    matchTerm += '.*';
+    matchTerm += ".*";
     return {
-      newOpName: 'matchesRegex',
+      newOpName: "matchesRegex",
       newArgs: [matchTerm]
     };
   }
-
-  // 'subString', //tnr: not yet implemented
-  // 'dateOnly', //tnr: not yet implemented
 }];
 
 module.exports = function () {
@@ -198,6 +207,7 @@ module.exports = function () {
         entity: subQuery.entity,
         foreignKey: subQuery.foreignKey,
         modifier: subQuery.modifier,
+        isArrayRelation: subQuery.isArrayRelation,
         filters: [],
         countExpression: undefined
       };
@@ -218,7 +228,7 @@ module.exports = function () {
     };
   };
 
-  QueryBuilder.prototype.related = function (relatedEntity) {
+  QueryBuilder.prototype.related = function (relatedEntity, isArrayRelation) {
     var tokens = relatedEntity.split(".");
     var entity = tokens[0];
     var key = tokens[1];
@@ -226,10 +236,10 @@ module.exports = function () {
     // log("FilterBuilder in related");
     // log(FilterBuilder);
 
-    return createSubQueryBuilder(this, entity, key);
+    return createSubQueryBuilder(this, entity, key, isArrayRelation);
   };
 
-  QueryBuilder.prototype.notRelated = function (relatedEntity) {
+  QueryBuilder.prototype.notRelated = function (relatedEntity, isArrayRelation) {
     var tokens = relatedEntity.split(".");
     var entity = tokens[0];
     var key = tokens[1];
@@ -237,7 +247,7 @@ module.exports = function () {
     // log("FilterBuilder in notRelated");
     // log(FilterBuilder);
 
-    return createSubQueryBuilder(this, entity, key, "not");
+    return createSubQueryBuilder(this, entity, key, isArrayRelation, "not");
   };
 
   QueryBuilder.prototype.toJSON = function () {
@@ -245,8 +255,8 @@ module.exports = function () {
     if (qry.filters.length > 1) {
       qry.filters = [{
         type: "group",
-        operator: 'and',
-        chainedWith: 'and',
+        operator: "and",
+        chainedWith: "and",
         filters: qry.filters
       }];
     }
@@ -359,12 +369,16 @@ module.exports = function () {
 
   return QueryBuilder;
 
-  function createSubQueryBuilder(qb, entity, key, modifier) {
+  function createSubQueryBuilder(qb, entity, key) {
+    var isArrayRelation = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+    var modifier = arguments[4];
+
     return new QueryBuilder({
       parentBuilder: qb,
       entity: entity,
       key: key,
-      modifier: modifier
+      modifier: modifier,
+      isArrayRelation: isArrayRelation
     });
   }
 

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "tg-client-query-builder",
-  "version": "2.13.0",
+  "version": "2.14.2",
   "description": "Teselagen Client Side (browser) SQL Query Builder",
   "main": "build/query-builder/index.js",
   "repository": "https://github.com/TeselaGen/tg-query.git",
   "author": "TeselaGen",
   "license": "ISC",
   "scripts": {
-    "build": "babel --presets=es2015 query-builder/ --out-dir build/query-builder/"
+    "prepublishOnly": "yarn build",
+    "build": "babel --presets=es2015 query-builder/ --out-dir build/query-builder/",
+    "test": "jest"
   },
-  "prepublish": "yarn build",
   "dependencies": {
     "lodash": "^4.17.4"
   },
   "devDependencies": {
-    "chai": "^4.0.2",
-    "fs-extra": "^3.0.1",
     "babel-cli": "^6.26.0",
     "babel-preset-latest": "^6.24.1",
+    "chai": "^4.0.2",
+    "fs-extra": "^3.0.1",
+    "jest": "^28.1.2",
     "json-beautify": "^1.0.1",
     "json-format": "^1.0.1",
     "jsonfile": "^3.0.0"

package/query-builder/index.js

@@ -1,4 +1,4 @@
-// valid filters: 
+// valid filters:
 // greaterThan
 // inList
 // lessThan
@@ -21,232 +21,163 @@
 // notContains
 // upperCase
 // lowerCase
-// matchesRegex (note: this takes a string like "thomas.*is.*cool", don't include the outer slashes like /asdf/ and don't pass a regex object ) 
+// matchesRegex (note: this takes a string like "thomas.*is.*cool", don't include the outer slashes like /asdf/ and don't pass a regex object )
 // fuzzy
 const FilterExpression = require("./filter-expression");
 const _ = require("lodash");
 
-
 const combineQueries = require("./combine-queries");
 
 function isDateOrNumber(opName) {
   return () => {
     var args = [].slice.call(arguments);
-    if (args.some((arg) => {
-      return !(_.isDate(arg) || _.isString(arg) || _.isNumber(arg))
-    })) {
-      throw new Error(
-        `QueryBuilderError: You must pass a date or number as args to ${opName}. You passed: Args ${args.join(',')}`
-      );
+    if (
+      args.some((arg) => {
+        return !(_.isDate(arg) || _.isString(arg) || _.isNumber(arg));
+      })
+    ) {
+      throw new Error(`QueryBuilderError: You must pass a date or number as args to ${opName}. You passed: Args ${args.join(",")}`);
     }
-  }
+  };
 }
 function isArray(opName) {
   return (arg) => {
     if (!_.isArray(arg)) {
-      throw new Error(
-        `QueryBuilderError: You must pass an array for ${opName} filters. You passed:  ${arg}`
-      );
+      throw new Error(`QueryBuilderError: You must pass an array for ${opName} filters. You passed:  ${arg}`);
     }
-  }
+  };
 }
 function isString(opName) {
   return (arg) => {
     if (!_.isString(arg)) {
-      throw new Error(
-        `QueryBuilderError: You must pass a string for ${opName} filters. You passed:  ${arg}`
-      );
+      throw new Error(`QueryBuilderError: You must pass a string for ${opName} filters. You passed:  ${arg}`);
     }
-  }
+  };
 }
 
 function numberOfArgs(opName, argLength) {
   return (...args) => {
     if (args.length !== argLength) {
-      throw new Error(
-        `QueryBuilderError: Args for ${opName} are of length ${args.length}, but they should be of length ${argLength}`
-      );
+      throw new Error(`QueryBuilderError: Args for ${opName} are of length ${args.length}, but they should be of length ${argLength}`);
     }
   };
 }
 
-
 const expressionOperators = [
   {
     opName: "greaterThan",
-    sanityChecks: [
-      numberOfArgs("greaterThan", 1),
-      isDateOrNumber("greaterThan")
-    ]
+    sanityChecks: [numberOfArgs("greaterThan", 1), isDateOrNumber("greaterThan")],
   },
   {
     opName: "inList",
-    sanityChecks: [numberOfArgs("inList", 1), isArray("inList")]
+    sanityChecks: [numberOfArgs("inList", 1), isArray("inList")],
   },
   {
     opName: "lessThan",
-    sanityChecks: [
-      numberOfArgs("lessThan", 1),
-      isDateOrNumber("lessThan"),
-    ]
+    sanityChecks: [numberOfArgs("lessThan", 1), isDateOrNumber("lessThan")],
   },
   {
     opName: "lessThanOrEqual",
-    sanityChecks: [
-      numberOfArgs("lessThanOrEqual", 1),
-      isDateOrNumber("lessThanOrEqual"),
-    ]
+    sanityChecks: [numberOfArgs("lessThanOrEqual", 1), isDateOrNumber("lessThanOrEqual")],
   },
   {
     opName: "equals",
-    sanityChecks: [
-      numberOfArgs("equals", 1),
-    ]
+    sanityChecks: [numberOfArgs("equals", 1)],
   },
   {
     opName: "greaterThanOrEqual",
-    sanityChecks: [
-      numberOfArgs("greaterThanOrEqual", 1),
-      isDateOrNumber("greaterThanOrEqual"),
-    ]
+    sanityChecks: [numberOfArgs("greaterThanOrEqual", 1), isDateOrNumber("greaterThanOrEqual")],
   },
   {
     opName: "notEquals",
-    sanityChecks: [
-      numberOfArgs("notEquals", 1),
-    ]
+    sanityChecks: [numberOfArgs("notEquals", 1)],
   },
   {
     opName: "notNull",
-    sanityChecks: [
-      numberOfArgs("notNull", 0),
-    ]
+    sanityChecks: [numberOfArgs("notNull", 0)],
   },
   {
     opName: "isNull",
-    sanityChecks: [
-      numberOfArgs("isNull", 0),
-    ]
+    sanityChecks: [numberOfArgs("isNull", 0)],
   },
   {
     opName: "between",
-    sanityChecks: [
-      numberOfArgs("between", 2),
-      isDateOrNumber("between"),
-    ]
+    sanityChecks: [numberOfArgs("between", 2), isDateOrNumber("between")],
   },
   {
     opName: "notInList",
-    sanityChecks: [
-      numberOfArgs("notInList", 1),
-      isArray("notInList"),
-    ]
+    sanityChecks: [numberOfArgs("notInList", 1), isArray("notInList")],
   },
   {
     opName: "startsWithExactly",
-    sanityChecks: [
-      numberOfArgs("startsWith", 1),
-      isString("startsWith")
-    ]
+    sanityChecks: [numberOfArgs("startsWith", 1), isString("startsWith")],
   },
   {
     opName: "endsWithExactly",
-    sanityChecks: [
-      numberOfArgs("endsWith", 1),
-      isString("endsWith")
-    ]
+    sanityChecks: [numberOfArgs("endsWith", 1), isString("endsWith")],
   },
   {
     opName: "containsExactly",
-    sanityChecks: [
-      numberOfArgs("contains", 1),
-      isString("contains")
-    ]
+    sanityChecks: [numberOfArgs("contains", 1), isString("contains")],
   },
   {
     opName: "startsWith",
-    sanityChecks: [
-      numberOfArgs("startsWith", 1),
-      isString("startsWith")
-    ]
+    sanityChecks: [numberOfArgs("startsWith", 1), isString("startsWith")],
   },
   {
     opName: "notStartsWith",
-    sanityChecks: [
-      numberOfArgs("notStartsWith", 1),
-      isString("notStartsWith")
-    ]
+    sanityChecks: [numberOfArgs("notStartsWith", 1), isString("notStartsWith")],
   },
   {
     opName: "endsWith",
-    sanityChecks: [
-      numberOfArgs("endsWith", 1),
-      isString("endsWith")
-    ]
+    sanityChecks: [numberOfArgs("endsWith", 1), isString("endsWith")],
   },
   {
     opName: "notEndsWith",
-    sanityChecks: [
-      numberOfArgs("notEndsWith", 1),
-      isString("notEndsWith")
-    ]
+    sanityChecks: [numberOfArgs("notEndsWith", 1), isString("notEndsWith")],
   },
   {
     opName: "contains",
-    sanityChecks: [
-      numberOfArgs("contains", 1),
-      isString("contains")
-    ]
+    sanityChecks: [numberOfArgs("contains", 1), isString("contains")],
   },
   {
     opName: "notContains",
-    sanityChecks: [
-      numberOfArgs("notContains", 1),
-      isString("notContains")
-    ]
+    sanityChecks: [numberOfArgs("notContains", 1), isString("notContains")],
   },
   {
     opName: "upperCase",
-    sanityChecks: [
-      numberOfArgs("upperCase", 1),
-      isString("upperCase")
-    ]
+    sanityChecks: [numberOfArgs("upperCase", 1), isString("upperCase")],
   },
   {
     opName: "lowerCase",
-    sanityChecks: [
-      numberOfArgs("lowerCase", 1),
-      isString("lowerCase")
-    ]
+    sanityChecks: [numberOfArgs("lowerCase", 1), isString("lowerCase")],
   },
   {
     opName: "matchesRegex",
-    sanityChecks: [
-      numberOfArgs("matchesRegex", 1),
-      isString("matchesRegex")
-    ]
+    sanityChecks: [numberOfArgs("matchesRegex", 1), isString("matchesRegex")],
+  },
+  {
+    opName: "matchesSimilar",
+    sanityChecks: [numberOfArgs("matchesSimilar", 1), isString("matchesSimilar")],
   },
   {
     opName: "fuzzy",
-    sanityChecks: [
-      numberOfArgs("fuzzy", 1),
-      isString("fuzzy")
-    ],
+    sanityChecks: [numberOfArgs("fuzzy", 1), isString("fuzzy")],
     transform: (arg) => {
-      // Build Regex String 
-      var matchTerm = ''
+      // Build Regex String
+      var matchTerm = "";
       // Split all the search terms
-      var terms = arg.replace(/\W/g, '').replace(' ', '').split("");
+      var terms = arg.replace(/\W/g, "").replace(" ", "").split("");
       for (var i = 0; i < terms.length; i++) {
-        matchTerm += '.*' + terms[i];
+        matchTerm += ".*" + terms[i];
       }
-      matchTerm += '.*';
+      matchTerm += ".*";
       return {
-        newOpName: 'matchesRegex',
-        newArgs: [matchTerm]
-      }
-    }
-  }
+        newOpName: "matchesRegex",
+        newArgs: [matchTerm],
+      };
+    },
+  },
 
   // 'subString', //tnr: not yet implemented
   // 'dateOnly', //tnr: not yet implemented
@@ -286,15 +217,14 @@ module.exports = (function () {
   function QueryBuilder(entity) {
     this.query = {};
 
-    if (entity == null)
-      throw new Error("You must pass the name of the model being filtered!");
+    if (entity == null) throw new Error("You must pass the name of the model being filtered!");
 
     if (typeof entity === "string") {
       this.query = {
         __objectType: "query",
         type: "root",
         entity,
-        filters: []
+        filters: [],
       };
     } else {
       let subQuery = entity;
@@ -304,8 +234,9 @@ module.exports = (function () {
         entity: subQuery.entity,
         foreignKey: subQuery.foreignKey,
         modifier: subQuery.modifier,
+        isArrayRelation: subQuery.isArrayRelation,
         filters: [],
-        countExpression: undefined
+        countExpression: undefined,
       };
       this.parentBuilder = subQuery.parentBuilder;
       this.toFilter = function (filterBuilder, name) {
@@ -320,11 +251,11 @@ module.exports = (function () {
   QueryBuilder.prototype.field = function (fieldName) {
     return {
       __objectType: "field",
-      field: fieldName
+      field: fieldName,
     };
   };
 
-  QueryBuilder.prototype.related = function (relatedEntity) {
+  QueryBuilder.prototype.related = function (relatedEntity, isArrayRelation) {
     var tokens = relatedEntity.split(".");
     var entity = tokens[0];
     var key = tokens[1];
@@ -332,10 +263,10 @@ module.exports = (function () {
     // log("FilterBuilder in related");
     // log(FilterBuilder);
 
-    return createSubQueryBuilder(this, entity, key);
+    return createSubQueryBuilder(this, entity, key, isArrayRelation);
   };
 
-  QueryBuilder.prototype.notRelated = function (relatedEntity) {
+  QueryBuilder.prototype.notRelated = function (relatedEntity, isArrayRelation) {
     var tokens = relatedEntity.split(".");
     var entity = tokens[0];
     var key = tokens[1];
@@ -343,7 +274,7 @@ module.exports = (function () {
     // log("FilterBuilder in notRelated");
     // log(FilterBuilder);
 
-    return createSubQueryBuilder(this, entity, key, "not");
+    return createSubQueryBuilder(this, entity, key, isArrayRelation, "not");
   };
 
   QueryBuilder.prototype.toJSON = function () {
@@ -352,10 +283,10 @@ module.exports = (function () {
       qry.filters = [
         {
           type: "group",
-          operator: 'and',
-          chainedWith: 'and',
-          filters: qry.filters
-        }
+          operator: "and",
+          chainedWith: "and",
+          filters: qry.filters,
+        },
       ];
     }
     return qry;
@@ -374,7 +305,7 @@ module.exports = (function () {
       // }
       if (!isFilterExpresionOrSubQuery(name, arg)) {
         if (Array.isArray(arg)) {
-          filters.push(this.inList(arg).toFilter(this, name))
+          filters.push(this.inList(arg).toFilter(this, name));
         } else {
           //log("Is Where Filter: " + name);
           whereArgs[name] = arg;
@@ -387,7 +318,7 @@ module.exports = (function () {
     if (_.keys(whereArgs).length > 0) {
       filters.unshift({
         type: "where",
-        args: whereArgs
+        args: whereArgs,
       });
     }
 
@@ -397,7 +328,7 @@ module.exports = (function () {
     var filterDef = {
       type: "group",
       operator: operator || "and",
-      filters
+      filters,
     };
     return filterDef;
   };
@@ -451,9 +382,7 @@ module.exports = (function () {
     var args = [].slice.call(arguments);
     if (this.query.type === "subquery") {
       if (this.query.countExpression) {
-        throw new Error(
-          "QueryBuilder subquery can only have one count expression"
-        );
+        throw new Error("QueryBuilder subquery can only have one count expression");
       }
       this.query.countExpression = args[0].toFilter(this, "count");
     } else {
@@ -467,30 +396,33 @@ module.exports = (function () {
 
   return QueryBuilder;
 
-  function createSubQueryBuilder(qb, entity, key, modifier) {
+  function createSubQueryBuilder(qb, entity, key, isArrayRelation = true, modifier) {
     return new QueryBuilder({
       parentBuilder: qb,
       entity,
       key,
-      modifier
+      modifier,
+      isArrayRelation,
     });
   }
 
   function attachExpressionFunctions() {
     expressionOperators.forEach(({ opName, sanityChecks, transform }) => {
-      const filter = (...args)=> {
-        let argsToUse = args
-        let opNameToUse = opName
+      const filter = (...args) => {
+        let argsToUse = args;
+        let opNameToUse = opName;
         if (transform) {
-          let { newOpName, newArgs } = transform(...args)
-          argsToUse = newArgs
-          opNameToUse = newOpName
+          let { newOpName, newArgs } = transform(...args);
+          argsToUse = newArgs;
+          opNameToUse = newOpName;
         }
-        sanityChecks.forEach((sanityCheck) => { sanityCheck(...args) })
+        sanityChecks.forEach((sanityCheck) => {
+          sanityCheck(...args);
+        });
         return new FilterExpression(opNameToUse, argsToUse);
       };
-      QueryBuilder.prototype[opName] = filter
-      QueryBuilder.ExpressionJson[opName] = filter
+      QueryBuilder.prototype[opName] = filter;
+      QueryBuilder.ExpressionJson[opName] = filter;
     });
   }
 
@@ -509,17 +441,16 @@ module.exports = (function () {
   }
 
   function where(filterBuilder, operator, whereArgs, chainedWith) {
-    if (!Array.isArray(whereArgs))
-      return where(filterBuilder, operator, [whereArgs], chainedWith);
+    if (!Array.isArray(whereArgs)) return where(filterBuilder, operator, [whereArgs], chainedWith);
 
     var filterDef = {
       type: "group",
       operator,
       chainedWith,
-      filters: []
+      filters: [],
     };
 
-    whereArgs.forEach(arg => {
+    whereArgs.forEach((arg) => {
       //add check for object type TODO
       var filter = filterBuilder.convertToFilter(arg, operator);
       filterDef.filters.push(filter);