@auxilium/datalynk-client 0.9.12 → 1.0.0

package/dist/index.cjs

@@ -36,6 +36,10 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       return value2;
     }, space);
   }
+  function flattenArr(arr, result = []) {
+    arr.forEach((el) => Array.isArray(el) ? flattenArr(el, result) : result.push(el));
+    return result;
+  }
   class PromiseProgress extends Promise {
     constructor(executor) {
       super((resolve, reject) => executor(
@@ -1679,7 +1683,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * @return {Promise<boolean>} True if system administrator
      */
     async isSysAdmin() {
-      return !!(await this.api.slice("sysadmin").select().where("auth_ref", "==", "$viewer").exec().keys()).length;
+      return !!(await this.api.slice("sysadmin").select().where("auth_ref", "==", "$viewer").rows().exec()).length;
     }
     /**
      * Check if user is a table administrator
@@ -1687,7 +1691,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * @return {Promise<boolean>} True if table administrator
      */
     async isTableAdmin() {
-      return !!(await this.api.slice("tableadmins").select().where("auth_ref", "==", "$viewer").exec().keys()).length;
+      return !!(await this.api.slice("tableadmins").select().where("auth_ref", "==", "$viewer").rows().exec()).length;
     }
     /**
      * Check if user is a user administrator
@@ -1695,7 +1699,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * @return {Promise<boolean>} True if user administrator
      */
     async isUserAdmin() {
-      return !!(await this.api.slice("useradmins").select().where("auth_ref", "==", "$viewer").exec().keys()).length;
+      return !!(await this.api.slice("useradmins").select().where("auth_ref", "==", "$viewer").rows().exec()).length;
     }
     /**
      * Perform login and save the session token
@@ -1836,7 +1840,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       })).then(async (files2) => {
         if (associate) {
           let id = typeof associate.row == "number" ? associate.row : associate.row[associate.pk || "id"];
-          if (!id) id = await this.api.slice(associate.slice).insert(associate.row).exec().key();
+          if (!id) id = await this.api.slice(associate.slice).insert(associate.row).id();
           await this.associate(files2.map((f2) => f2.id), associate == null ? void 0 : associate.slice, associate == null ? void 0 : associate.row, associate == null ? void 0 : associate.field);
         }
         return files2;
@@ -1996,112 +2000,6 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       }
     }
   };
-  class SlicePromise {
-    /**
-     * An object to provide helpers for Datalynk results
-     *
-     * @param slice
-     * @param {SliceResponse<T>} promise Datalynk promise to handle
-     */
-    constructor(slice, promise) {
-      this.slice = slice;
-      this.promise = promise;
-    }
-    /**
-     * Catch promise errors
-     */
-    catch(callback) {
-      return this.promise.catch(callback);
-    }
-    /**
-     * Count rows or fetch count alias result
-     */
-    async count() {
-      var _a, _b;
-      const rows = await this.rows();
-      if (typeof ((_a = rows == null ? void 0 : rows[0]) == null ? void 0 : _a["count"]) == "number") return (_b = rows == null ? void 0 : rows[0]) == null ? void 0 : _b["count"];
-      return rows.length;
-    }
-    /**
-     * Log the raw result to the console for inspection
-     */
-    debug() {
-      this.promise.then((resp) => console.log(resp));
-      return this;
-    }
-    /**
-     * Fields that failed
-     */
-    async failed() {
-      let resp = await this.promise;
-      return resp.failed;
-    }
-    /**
-     * Catch promise errors
-     */
-    finally(callback) {
-      return this.promise.finally(callback);
-    }
-    /**
-     * Fields that were ignored (Perms or readonly)
-     */
-    async ignored() {
-      let resp = await this.promise;
-      return resp["ignored-fields"];
-    }
-    /**
-     * ID of first affected row
-     */
-    async key() {
-      return (await this.keys())[0];
-    }
-    /**
-     * IDs of all affected rows
-     */
-    async keys() {
-      let resp = await this.promise;
-      return resp.keys;
-    }
-    /**
-     * Fields that were affected successfully
-     */
-    async granted() {
-      let resp = await this.promise;
-      return resp.granted;
-    }
-    /**
-     * First row of data
-     */
-    async row() {
-      return (await this.rows())[0];
-    }
-    /**
-     * All rows of data
-     */
-    async rows() {
-      let resp = await this.promise;
-      return resp.rows;
-    }
-    /**
-     * Handle as normal request
-     */
-    then(success, error) {
-      return this.promise.then(success, error);
-    }
-    /**
-     * Get the raw promise
-     */
-    toPromise() {
-      return this.promise;
-    }
-    /**
-     * Get the transaction ID
-     */
-    async transaction() {
-      let resp = await this.promise;
-      return resp.tx;
-    }
-  }
   const _Slice = class _Slice {
     /**
      * An object to aid in constructing requests
@@ -2111,11 +2009,25 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      */
     constructor(slice, api) {
       __publicField(this, "operation");
+      __publicField(this, "popField");
       __publicField(this, "request", {});
+      /** Log response automatically */
+      __publicField(this, "debugging");
       /** Unsubscribe from changes, undefined if not subscribed */
       __publicField(this, "unsubscribe");
       /** Cached slice data as an observable */
       __publicField(this, "cache$", new BehaviorSubject([]));
+      /**
+       * Whitelist and alias fields. Alias of `fields()`
+       * @example
+       * ```ts
+       * const id: {id: number, field2: any}[] = await new Slice<T>(12345)
+       * 		.select().alias({id: 'id', field1: 'field2'}).exec().keys();
+       * ```
+       * @param {object} aliasKeyVals List of properties to whitelist and what to rename them to
+       * @return {Slice<T>}
+       */
+      __publicField(this, "alias", this.fields);
       this.slice = slice;
       this.api = api;
     }
@@ -2129,19 +2041,13 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     /** Get raw API request */
     get raw() {
-      return { [this.operation]: { slice: this.slice, ...this.request } };
-    }
-    /**
-     * Whitelist and alias fields. Alias for the fields functions
-     * @example
-     * ```ts
-     * const id: {id: number, field2: any}[] = await new Slice<T>(12345)
-     * 		.select().alias({id: 'id', field1: 'field2'}).exec().keys();
-     * ```
-     * @param {object} aliasKeyVals List of properties to whitelist and what to rename them to
-     */
-    alias(aliasKeyVals) {
-      return this.fields(aliasKeyVals);
+      return clean({
+        [this.operation]: {
+          ...this.request,
+          slice: this.slice
+        },
+        "$pop": this.popField ? this.popField : void 0
+      });
     }
     /**
      * Add an 'AND' condition inside the where argument
@@ -2153,6 +2059,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      *                 .where({field2: 2, field3: 3})
      *                 .exec().rows();
      * ```
+     * @return {Slice<T>}
      */
     and() {
       var _a;
@@ -2170,17 +2077,20 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * 					.exec().count();
      * ```
      * @param {object | string} arg Count argument
+     * @return {Slice<T>}
      */
     count(arg = "id") {
       this.operation = "$/slice/report";
       this.request.fields = { count: ["$count", typeof arg == "object" ? arg : ["$field", arg]] };
-      return this;
+      return this.pop("rows:0:count");
     }
     /**
      * Output the formed request to the console for inspection
+     * @param {boolean} enabled Enable/Disable console logging
+     * @return {Slice<T>}
      */
-    debug() {
-      console.debug(this.request);
+    debug(enabled = true) {
+      this.debugging = enabled;
       return this;
     }
     /**
@@ -2190,6 +2100,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * await new Slice(12345).delete(id).exec();
      * ```
      * @param {number | number[]} id ID(s) to delete
+     * @return {Slice<T>}
      */
     delete(id) {
       this.operation = "$/slice/delete";
@@ -2208,6 +2119,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      *                 .exec().rows();
      * ```
      * @param formula Excel formula to use as where clause
+     * @return {Slice<T>}
      */
     excel(formula) {
       this.where(["$excel", formula]);
@@ -2216,17 +2128,26 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     /**
      * Compile the request and send it
      * @param {ApiRequestOptions} options API Request options
-     * @return {SlicePromise<T>}
+     * @return {Promise<T = any>} API response
      */
     exec(options) {
       if (!this.operation) throw new Error("No operation chosen");
-      this.request.slice = this.slice;
-      return new SlicePromise(this, this.api.request({ [this.operation]: this.request }, options));
+      return this.api.request(this.raw, options).then((resp) => {
+        if (this.debugging) console.log(resp);
+        return resp;
+      });
     }
     fields(keys) {
       this.request.fields = Array.isArray(keys) ? keys.reduce((acc, key) => ({ ...acc, [key]: key }), {}) : keys;
       return this;
     }
+    /**
+     * Unwrap response returning the first ID
+     * @return {Slice<T>}
+     */
+    id() {
+      return this.pop("rows:0:id");
+    }
     /**
      * Set the request type to insert
      * @example
@@ -2237,6 +2158,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * ]).exec().keys();
      * ```
      * @param {T | T[]} rows Rows to be inserted into the slice
+     * @return {Slice<T>}
      */
     insert(rows) {
       this.operation = "$/slice/xinsert";
@@ -2253,9 +2175,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      *                 .exec().rows();
      * ```
      * @param {number} num Number of rows to return
+     * @return {Slice<T>}
      */
     limit(num) {
       this.request.limit = num;
+      return this;
     }
     /**
      * Add an 'OR' condition inside the where argument
@@ -2269,6 +2193,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      *                 .where(['$gt', ['$field', field4], 4)
      *                 .exec().rows();
      * ```
+     * @return {Slice<T>}
      */
     or() {
       var _a;
@@ -2289,12 +2214,36 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * ```
      * @param {string} field property name
      * @param {boolean} ascending Sort in ascending or descending order
+     * @return {Slice<T>}
      */
     order(field, ascending = true) {
       if (!this.request.order) this.request.order = [];
       this.request.order.push([ascending ? "$asc" : "$desc", ["$field", field]]);
       return this;
     }
+    /**
+     * Unwrap response, returning the field
+     * @param {string} field Colon seperated path: `rows:0`
+     * @return {Slice<T>}
+     */
+    pop(field) {
+      this.popField = field;
+      return this;
+    }
+    /**
+     * Unwrap response returning the first row
+     * @return {Slice<T>}
+     */
+    row() {
+      return this.pop("rows:0");
+    }
+    /**
+     * Unwrap response returning the rows
+     * @return {Slice<T>}
+     */
+    rows() {
+      return this.pop("rows");
+    }
     /**
      * Set the request type to select
      * @example
@@ -2303,6 +2252,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * const row: T = new Slice<T>(12345).select(id).exec().row();
      * ```
      * @param {number | number[]} id ID(s) to select, leaving blank will return all rows
+     * @return {Slice<T>}
      */
     select(id) {
       this.operation = "$/slice/report";
@@ -2324,10 +2274,10 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      */
     sync(on = true) {
       if (on) {
-        new _Slice(this.slice, this.api).select().exec().rows().then((rows) => this.cache = rows);
+        new _Slice(this.slice, this.api).select().rows().exec().then((rows) => this.cache = rows);
         if (!this.unsubscribe) this.unsubscribe = this.api.socket.sliceEvents(this.slice, (event) => {
           const ids = [...event.data.new, ...event.data.changed];
-          new _Slice(this.slice, this.api).select(ids).exec().rows().then((rows) => this.cache = [...this.cache.filter((c) => c.id != null && !ids.includes(c.id)), ...rows]);
+          new _Slice(this.slice, this.api).select(ids).rows().exec().then((rows) => this.cache = [...this.cache.filter((c) => c.id != null && !ids.includes(c.id)), ...rows]);
           this.cache = this.cache.filter((v) => v.id && !event.data.lost.includes(v.id));
         });
         return this.cache$;
@@ -2346,6 +2296,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * ]).exec().keys();
      * ```
      * @param {T | T[]} rows Rows to be updated, each row must have an ID
+     * @return {Slice<T>}
      */
     update(rows) {
       this.operation = "$/slice/xupdate";
@@ -2368,6 +2319,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * @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
+     * @return {Slice<T>}
      */
     where(field, operator, value) {
       if (this.request.where && this.request.where[0] != "$or") this.and();
@@ -2556,9 +2508,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       __publicField(this, "bundleOngoing", false);
       /** LocalStorage key for persisting logins */
       __publicField(this, "localStorageKey", "datalynk-token");
-      /** Pending requests */
+      /** Pending requests cache */
       __publicField(this, "pending", {});
-      // Cache for ongoing requests
       /** Authentication helpers */
       __publicField(this, "auth", new Auth(this));
       /** File helpers */
@@ -2569,9 +2520,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       __publicField(this, "socket");
       /** Superuser helpers */
       __publicField(this, "superuser", new Superuser(this));
-      /** API endpoint */
+      /** API URL endpoint */
       __publicField(this, "url");
-      // API URL endpoint for requests
       /** API Session token */
       __publicField(this, "token$", new BehaviorSubject(null));
       this.options = options;
@@ -2651,10 +2601,10 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     /**
      * Chain multiple requests to execute together
      * @param {Slice<any>} requests List of requests to chain
-     * @return {Promise<SlicePromise[]>} API Response
+     * @return {Promise<any>} API Response
      */
     chain(...requests) {
-      return this.request({ "$/tools/action_chain": requests.flatMap((r) => r instanceof Slice ? r.raw : r) });
+      return this.request({ "$/tools/action_chain": flattenArr(requests).map((r) => r instanceof Slice ? r.raw : r) });
     }
     /**
      * Organize multiple requests into a single mapped request
@@ -2663,11 +2613,27 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      */
     chainMap(request) {
       return this.request({ "$/tools/do": [
-        ...Object.entries(request).flatMap(([key, r]) => [key, r instanceof Slice ? r.raw : r]),
+        ...Object.entries(request).flatMap(([key, r]) => [key, r instanceof Slice ? r == null ? void 0 : r.raw : r]),
         "returnAllBoilerplate",
         { "$_": "*" }
       ] }, {});
     }
+    /**
+     * Exact same as `request` method, but logs the response in the console automatically
+     *
+     * @param {object | string} data Datalynk request as object or string
+     * @param {ApiRequestOptions} options
+     * @returns {Promise<any>} Datalynk response
+     */
+    debug(data, options = {}) {
+      return this.request(data, options).then((data2) => {
+        console.log(data2);
+        return data2;
+      }).catch((err) => {
+        console.error(err);
+        return err;
+      });
+    }
     /**
      * Send a request to Datalynk
      *
@@ -2682,7 +2648,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      */
     request(data, options = {}) {
       data = typeof data == "string" ? { [data]: {} } : data;
-      if (options.force) {
+      if (options.noOptimize) {
         return new Promise((res, rej) => {
           this._request(data, options).then((resp) => {
             (resp == null ? void 0 : resp.error) ? rej(resp) : res(resp);
@@ -2720,27 +2686,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
      * ```
      *
      * @param {number} slice Slice number the object will target
-     * @returns {Slice<T extends SliceMeta>} Object for making requests & caching rows
+     * @returns {Slice<T = any>} Object for making requests & caching rows
      */
     slice(slice) {
       return new Slice(slice, this);
     }
-    /**
-     * Exact same as `request` method, but logs the response in the console automatically
-     *
-     * @param {object | string} data Datalynk request as object or string
-     * @param {ApiRequestOptions} options
-     * @returns {Promise<any>} Datalynk response
-     */
-    test(data, options = {}) {
-      return this.request(data, options).then((data2) => {
-        console.log(data2);
-        return data2;
-      }).catch((err) => {
-        console.error(err);
-        return err;
-      });
-    }
   }
   exports2.Api = Api;
   exports2.Auth = Auth;
@@ -2749,7 +2699,6 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   exports2.Pdf = Pdf;
   exports2.Serializer = Serializer;
   exports2.Slice = Slice;
-  exports2.SlicePromise = SlicePromise;
   exports2.Socket = Socket;
   exports2.Superuser = Superuser;
   Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });