@auxilium/datalynk-client 0.8.2 → 0.9.0

package/README.md

@@ -11,7 +11,7 @@ Datalynk client library to integrate JavaScript clients with the Datalynk API.
   - [Table of Contents](#Table-of-Contents)
   - [Quick Start](#quick-start)
   - [Documentation](#documentation)
-    - [API Documentation](https://auxilium.pages.gitlab.auxiliumgroup.com/datalynk/datalynk-client) 
+    - [API Documentation](https://datalynk-client.scarborough.auxilium.world) 
     - [Integration](#integration)
       - [Angular](#integration)
       - [Node / Vue](#integration)
@@ -46,7 +46,7 @@ const resp = await api.request({'$/auth/current':{}});
 
 ## Documentation
 
-[Full API Documentation](https://auxilium.pages.gitlab.auxiliumgroup.com/datalynk/datalynk-client)
+[Full API Documentation](https://datalynk-client.scarborough.auxilium.world)
 
 <details>
   <summary>
@@ -227,9 +227,11 @@ const rows = await api.slice<T>(12345)
 // Advanced queries
 const rows = await api.slice<T>(12345)
                       .select()
-                      .where('field1', '==', 'value')
+                      .where('field1', '<', 0)
+                      .or()
+                      .where({field1: 0, field2: false})
                       .fields({'field1': 'field2'})
-                      .order('field2', true /* ascending */)
+                      .order('field2', true) // ascending
                       .limit(10)
                       .exec().rows();                      
 ```

package/dist/index.cjs

@@ -2013,6 +2013,16 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     alias(aliasKeyVals) {
       return this.fields(aliasKeyVals);
     }
+    /**
+     * Add an 'AND' condition inside the where argument
+     */
+    and() {
+      var _a;
+      if (((_a = this.request.where) == null ? void 0 : _a[0]) == "$and") return this;
+      if (this.request.where) this.request.where = ["$and", this.request.where];
+      else this.request.where = ["$and"];
+      return this;
+    }
     /**
      * Output the formed request to the console for inspection
      */
@@ -2077,6 +2087,16 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     limit(num) {
       this.request.limit = num;
     }
+    /**
+     * Add an 'OR' condition inside the where argument
+     */
+    or() {
+      var _a;
+      if (((_a = this.request.where) == null ? void 0 : _a[0]) == "$or") return this;
+      if (this.request.where) this.request.where = ["$or", this.request.where];
+      else this.request.where = ["$or"];
+      return this;
+    }
     /**
      * Order rows by a field
      *
@@ -2137,39 +2157,45 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * Add where condition to request. Chaining wheres creates an AND between them. To perform an OR look at
      * the filter function
      *
-     * @param {string} field property to compare
+     * @param {string | object} field property to compare or a map of equality comparisons
      * @param {string} operator Operation to compare with. Accepts JS operators (>=, ==, !=, ...) as well as datalynk styax ($gte, $eq, $is, $not, ...)
      * @param {any} value value to compare against
      */
     where(field, operator, value) {
-      switch (operator) {
-        case "==":
-          operator = "$eq";
-          break;
-        case "!=":
-          operator = "$neq";
-          break;
-        case ">":
-          operator = "$gt";
-          break;
-        case ">=":
-          operator = "$gte";
-          break;
-        case "<":
-          operator = "$lt";
-          break;
-        case "<=":
-          operator = "$lte";
-          break;
-        case "!":
-          operator = "$not";
-          break;
-        case "%":
-          operator = "$mod";
-          break;
+      this.and();
+      if (typeof field == "object") {
+        Object.entries(field).forEach(([key, value2]) => this.request.where.push(["$eq", ["$field", key], value2]));
+      } else if (operator == null) {
+        throw new Error("Malformed where clause");
+      } else {
+        switch (operator) {
+          case "==":
+            operator = "$eq";
+            break;
+          case "!=":
+            operator = "$neq";
+            break;
+          case ">":
+            operator = "$gt";
+            break;
+          case ">=":
+            operator = "$gte";
+            break;
+          case "<":
+            operator = "$lt";
+            break;
+          case "<=":
+            operator = "$lte";
+            break;
+          case "!":
+            operator = "$not";
+            break;
+          case "%":
+            operator = "$mod";
+            break;
+        }
+        this.request.where.push([operator, ["$field", field], value]);
       }
-      if (!this.request.where) this.request.where = ["$and"];
-      this.request.where.push([operator, ["$field", field], value]);
       return this;
     }
   }

package/dist/index.mjs

@@ -2009,6 +2009,16 @@ class Slice {
   alias(aliasKeyVals) {
     return this.fields(aliasKeyVals);
   }
+  /**
+   * Add an 'AND' condition inside the where argument
+   */
+  and() {
+    var _a;
+    if (((_a = this.request.where) == null ? void 0 : _a[0]) == "$and") return this;
+    if (this.request.where) this.request.where = ["$and", this.request.where];
+    else this.request.where = ["$and"];
+    return this;
+  }
   /**
    * Output the formed request to the console for inspection
    */
@@ -2073,6 +2083,16 @@ class Slice {
   limit(num) {
     this.request.limit = num;
   }
+  /**
+   * Add an 'OR' condition inside the where argument
+   */
+  or() {
+    var _a;
+    if (((_a = this.request.where) == null ? void 0 : _a[0]) == "$or") return this;
+    if (this.request.where) this.request.where = ["$or", this.request.where];
+    else this.request.where = ["$or"];
+    return this;
+  }
   /**
    * Order rows by a field
    *
@@ -2133,39 +2153,45 @@ class Slice {
    * Add where condition to request. Chaining wheres creates an AND between them. To perform an OR look at
    * the filter function
    *
-   * @param {string} field property to compare
+   * @param {string | object} field property to compare or a map of equality comparisons
    * @param {string} operator Operation to compare with. Accepts JS operators (>=, ==, !=, ...) as well as datalynk styax ($gte, $eq, $is, $not, ...)
    * @param {any} value value to compare against
    */
   where(field, operator, value) {
-    switch (operator) {
-      case "==":
-        operator = "$eq";
-        break;
-      case "!=":
-        operator = "$neq";
-        break;
-      case ">":
-        operator = "$gt";
-        break;
-      case ">=":
-        operator = "$gte";
-        break;
-      case "<":
-        operator = "$lt";
-        break;
-      case "<=":
-        operator = "$lte";
-        break;
-      case "!":
-        operator = "$not";
-        break;
-      case "%":
-        operator = "$mod";
-        break;
+    this.and();
+    if (typeof field == "object") {
+      Object.entries(field).forEach(([key, value2]) => this.request.where.push(["$eq", ["$field", key], value2]));
+    } else if (operator == null) {
+      throw new Error("Malformed where clause");
+    } else {
+      switch (operator) {
+        case "==":
+          operator = "$eq";
+          break;
+        case "!=":
+          operator = "$neq";
+          break;
+        case ">":
+          operator = "$gt";
+          break;
+        case ">=":
+          operator = "$gte";
+          break;
+        case "<":
+          operator = "$lt";
+          break;
+        case "<=":
+          operator = "$lte";
+          break;
+        case "!":
+          operator = "$not";
+          break;
+        case "%":
+          operator = "$mod";
+          break;
+      }
+      this.request.where.push([operator, ["$field", field], value]);
     }
-    if (!this.request.where) this.request.where = ["$and"];
-    this.request.where.push([operator, ["$field", field], value]);
     return this;
   }
 }

package/dist/slice.d.ts

@@ -117,6 +117,10 @@ export declare class Slice<T extends SliceMeta> {
     alias(aliasKeyVals: {
         [key: string]: string | object;
     }): Slice<T>;
+    /**
+     * Add an 'AND' condition inside the where argument
+     */
+    and(): this;
     /**
      * Output the formed request to the console for inspection
      */
@@ -161,6 +165,10 @@ export declare class Slice<T extends SliceMeta> {
      * @param {number} num Number of rows to return
      */
     limit(num: number): void;
+    /**
+     * Add an 'OR' condition inside the where argument
+     */
+    or(): this;
     /**
      * Order rows by a field
      *
@@ -191,10 +199,10 @@ export declare class Slice<T extends SliceMeta> {
      * Add where condition to request. Chaining wheres creates an AND between them. To perform an OR look at
      * the filter function
      *
-     * @param {string} field property to compare
+     * @param {string | object} field property to compare or a map of equality comparisons
      * @param {string} operator Operation to compare with. Accepts JS operators (>=, ==, !=, ...) as well as datalynk styax ($gte, $eq, $is, $not, ...)
      * @param {any} value value to compare against
      */
-    where(field: string, operator: string, value: any): Slice<T>;
+    where(field: string | object, operator?: string, value?: any): Slice<T>;
 }
 //# sourceMappingURL=slice.d.ts.map

package/dist/slice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,MAAM,CAAC;AACrC,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAC,MAAM,UAAU,CAAC;AAEvD,MAAM,WAAW,SAAS;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,SAAS;aAQhB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;aAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAN/F;;;;;OAKG;gBACyB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE/F;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG;IAI9C;;OAEG;IACH,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC;IAKxB;;OAEG;IACG,MAAM;IAKZ;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG;IAI3B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAK/B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC;IAIvB;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAK1B;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAIrH;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAItC;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;CAIpC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,SAAS;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,SAAS;IAoBzB,OAAO,CAAC,KAAK;IAAmB,OAAO,CAAC,GAAG;IAnBvD,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,OAAO,CAAW;IAE1B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC,yCAAyC;IACzC,OAAO,CAAC,MAAM,CAAgC;IAC9C,wBAAwB;IACxB,OAAO,KAAK,KAAK,GAA0C;IAC3D,0CAA0C;IAC1C,OAAO,KAAK,KAAK,QAAyC;IAE1D;;;;;OAKG;gBACiB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAU,GAAG,EAAE,GAAG;IAE5D;;;;OAIG;IACH,KAAK,CAAC,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAIjE;;OAEG;IACH,KAAK;IAKL;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;OAIG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAKlC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC,CAAC,CAAC;IAMlD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAQzD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQ/B;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM;IAIjB;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,KAAK,CAAC,CAAC,CAAC;IAMhD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,UAAO;IAoBd;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAQpB;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC;CAgC5D"}
+{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,MAAM,CAAC;AACrC,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAC,MAAM,UAAU,CAAC;AAEvD,MAAM,WAAW,SAAS;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,SAAS;aAQhB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;aAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAN/F;;;;;OAKG;gBACyB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE/F;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG;IAI9C;;OAEG;IACH,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC;IAKxB;;OAEG;IACG,MAAM;IAKZ;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG;IAI3B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAK/B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC;IAIvB;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAK1B;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAIrH;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAItC;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;CAIpC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,SAAS;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,SAAS;IAoBzB,OAAO,CAAC,KAAK;IAAmB,OAAO,CAAC,GAAG;IAnBvD,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,OAAO,CAAW;IAE1B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC,yCAAyC;IACzC,OAAO,CAAC,MAAM,CAAgC;IAC9C,wBAAwB;IACxB,OAAO,KAAK,KAAK,GAA0C;IAC3D,0CAA0C;IAC1C,OAAO,KAAK,KAAK,QAAyC;IAE1D;;;;;OAKG;gBACiB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAU,GAAG,EAAE,GAAG;IAE5D;;;;OAIG;IACH,KAAK,CAAC,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAIjE;;OAEG;IACH,GAAG;IAOH;;OAEG;IACH,KAAK;IAKL;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;OAIG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAKlC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC,CAAC,CAAC;IAMlD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAQzD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQ/B;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM;IAIjB;;OAEG;IACH,EAAE;IAOF;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,KAAK,CAAC,CAAC,CAAC;IAMhD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,UAAO;IAoBd;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAQpB;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC;CAsCvE"}

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@auxilium/datalynk-client",
 	"description": "Datalynk client library",
 	"repository": "https://gitlab.auxiliumgroup.com/auxilium/datalynk/datalynk-client",
-	"version": "0.8.2",
+	"version": "0.9.0",
 	"author": "Zak Timson <zaktimson@gmail.com>",
 	"private": false,
 	"main": "./dist/index.cjs",