jxp-helper 2.0.0 → 3.2.0

package/dist/jxp-helper.js

@@ -1,17 +1,24 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JXPHelper = void 0;
-const axios_1 = __importDefault(require("axios"));
+const types_1 = require("./types");
+const http_1 = require("./http");
+const errors_1 = require("./errors");
 /**
  * JXPHelper class for interacting with a JXP server.
  */
 class JXPHelper {
+    server;
+    apikey;
+    token;
+    api;
+    debug;
+    hideErrors;
     /**
      * Creates a new instance of the JXP Helper class.
      * @param opts - The options for configuring the JXP Helper.
+     * Provide `apikey` and/or `token`. Credentials may be omitted when only calling
+     * unauthenticated auth endpoints (`login`, `completeMfa`, `refresh`).
      */
     constructor(opts) {
         const defaults = {
@@ -35,20 +42,87 @@ class JXPHelper {
             }
         }
     }
+    /** Prefer bearer access token for subsequent authenticated calls. */
+    useAccessToken(accessToken) {
+        this.token = accessToken;
+        return this;
+    }
+    _isPlainObject(value) {
+        return value !== null && typeof value === 'object' && !Array.isArray(value);
+    }
+    _isEmptyParam(value) {
+        return value === null || value === undefined || value === '';
+    }
+    _encodeParam(key, value) {
+        return key + '=' + encodeURIComponent(String(value));
+    }
+    _appendObjectEntries(parts, prefix, obj) {
+        for (const sub of Object.keys(obj)) {
+            const value = obj[sub];
+            if (this._isEmptyParam(value))
+                continue;
+            if (this._isPlainObject(value) || Array.isArray(value))
+                continue;
+            parts.push(this._encodeParam(`${prefix}[${sub}]`, value));
+        }
+    }
     _configParams(opts = {}) {
-        opts.apikey = this.apikey;
         const parts = [];
         for (const opt in opts) {
-            if (Array.isArray(opts[opt])) {
-                opts[opt].forEach(val => {
-                    parts.push(opt + "=" + encodeURIComponent(val.toString()));
-                });
+            if (['apikey', 'api_key', 'apiKey', 'x-api-key'].includes(opt.toLowerCase()))
+                continue;
+            const value = opts[opt];
+            if (this._isEmptyParam(value))
+                continue;
+            // `filters` (plural) → expand into `filter[key]=value` (never send `filters=`).
+            if (opt === 'filters') {
+                if (Array.isArray(value)) {
+                    for (const item of value) {
+                        if (this._isPlainObject(item))
+                            this._appendObjectEntries(parts, 'filter', item);
+                    }
+                }
+                else if (this._isPlainObject(value)) {
+                    this._appendObjectEntries(parts, 'filter', value);
+                }
+                continue;
             }
-            else {
-                parts.push(opt + "=" + encodeURIComponent(opts[opt].toString()));
+            // `search: { q: '…' }` → full-text `search=…`; other objects → `search[field]=…`.
+            if (opt === 'search' && this._isPlainObject(value)) {
+                const keys = Object.keys(value);
+                if (keys.length === 1 && keys[0] === 'q') {
+                    const q = value.q;
+                    if (!this._isEmptyParam(q) && (typeof q === 'string' || typeof q === 'number' || typeof q === 'boolean')) {
+                        const trimmed = String(q).trim();
+                        if (trimmed)
+                            parts.push(this._encodeParam('search', trimmed));
+                    }
+                }
+                else {
+                    this._appendObjectEntries(parts, 'search', value);
+                }
+                continue;
+            }
+            if (Array.isArray(value)) {
+                for (const item of value) {
+                    if (this._isEmptyParam(item))
+                        continue;
+                    if (this._isPlainObject(item)) {
+                        this._appendObjectEntries(parts, opt, item);
+                    }
+                    else if (!Array.isArray(item)) {
+                        parts.push(this._encodeParam(opt, item));
+                    }
+                }
+                continue;
+            }
+            if (this._isPlainObject(value)) {
+                this._appendObjectEntries(parts, opt, value);
+                continue;
             }
+            parts.push(this._encodeParam(opt, value));
         }
-        return parts.join("&");
+        return parts.join('&');
     }
     _randomString() {
         return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
@@ -57,32 +131,72 @@ class JXPHelper {
         try {
             if (this.hideErrors)
                 return;
-            const config = err.config;
-            const response = err.response;
-            console.error(`${new Date().toISOString()}\turl: ${config?.url}\tmethod: ${config?.method}\tstatus: ${response?.status}\tstatusText: ${response?.statusText}\tdata: ${(response?.data) ? JSON.stringify(response.data) : 'No data'}`);
+            if (err instanceof errors_1.JXPError) {
+                console.error(`${new Date().toISOString()}\turl: ${err.url}\tmethod: ${err.method}\tstatus: ${err.status}\tstatusText: ${err.statusText}\tdata: ${err.body ? JSON.stringify(err.body) : 'No data'}`);
+            }
+            else {
+                console.error(err);
+            }
         }
         catch (error) {
             console.error(error);
         }
     }
+    _request(url, options = {}) {
+        return (0, http_1.jxpRequest)(url, this.apikey, this.token, options);
+    }
+    async _hydrateLogin(data) {
+        this.token = data.token;
+        // Prefer bearer for the user fetch even if a system API key is also configured.
+        const user = await (0, http_1.jxpRequest)(`${this.api}/user/${data.user_id}`, undefined, data.token);
+        return { data, user };
+    }
     url(type, opts, ep = "api") {
-        return `${this.server}/${ep}/${type}?${this._configParams(opts)}`;
+        const params = this._configParams(opts);
+        return `${this.server}/${ep}/${type}${params ? `?${params}` : ''}`;
     }
     /**
-     * Logs in a user with the provided email and password.
-     * @param email - The user's email.
-     * @param password - The user's password.
-     * @returns A promise that resolves to an object containing the login data and user information, or rejects with an error object.
+     * Password login. May return an MFA challenge instead of tokens.
+     * On success, stores the access token on this helper for subsequent calls.
      */
     async login(email, password) {
-        try {
-            const data = (await axios_1.default.post(`${this.server}/login`, { email, password })).data;
-            const user = (await axios_1.default.get(`${this.api}/user/${data.user_id}?apikey=${this.apikey}`)).data;
-            return { data, user };
+        const data = await this._request(`${this.server}/login`, {
+            method: 'POST',
+            body: { email, password }
+        });
+        if ((0, types_1.isMfaRequired)(data))
+            return data;
+        if (!data?.token || !data?.user_id) {
+            throw new Error('Login response missing token/user_id');
         }
-        catch (err) {
-            return err.response?.data;
+        return this._hydrateLogin(data);
+    }
+    /**
+     * Complete MFA after `login` returned `{ status: "mfa_required", challenge, methods }`.
+     */
+    async completeMfa(opts) {
+        const data = await this._request(`${this.server}/login/mfa`, {
+            method: 'POST',
+            body: {
+                method: opts.method || 'totp',
+                challenge: opts.challenge,
+                code: String(opts.code).trim().replace(/\s+/g, '')
+            }
+        });
+        if (!data?.token || !data?.user_id) {
+            throw new Error('MFA response missing token/user_id');
         }
+        return this._hydrateLogin(data);
+    }
+    /**
+     * Exchange a refresh token for a new access / refresh pair.
+     */
+    async refresh(refreshToken) {
+        const data = await (0, http_1.jxpRequest)(`${this.server}/refresh`, undefined, refreshToken, { method: 'POST' });
+        if (!data?.token || !data?.user_id) {
+            throw new Error('Refresh response missing token/user_id');
+        }
+        return this._hydrateLogin(data);
     }
     /**
      * Retrieves a single item of a specified type by its ID.
@@ -98,19 +212,16 @@ class JXPHelper {
             console.time(label);
         const url = `${this.api}/${type}/${id}?${this._configParams(opts)}`;
         try {
-            const result = await axios_1.default.get(url);
+            const result = await this._request(url);
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data;
+            return result;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -126,19 +237,16 @@ class JXPHelper {
             console.time(label);
         const url = this.url(type, opts);
         try {
-            const result = await axios_1.default.get(url);
+            const result = await this._request(url);
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data;
+            return result;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -154,19 +262,16 @@ class JXPHelper {
             console.time(label);
         const url = `${this.server}/csv/${type}?${this._configParams(opts)}`;
         try {
-            const result = await axios_1.default.get(url);
+            const result = await this._request(url);
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data;
+            return result;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -183,19 +288,16 @@ class JXPHelper {
             console.time(label);
         const url = `${this.server}/query/${type}?${this._configParams(opts)}`;
         try {
-            const result = await axios_1.default.post(url, { query });
+            const result = await this._request(url, { method: 'POST', body: { query } });
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data;
+            return result;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -212,19 +314,16 @@ class JXPHelper {
             console.time(label);
         const url = `${this.server}/aggregate/${type}?${this._configParams(opts)}`;
         try {
-            const result = await axios_1.default.post(url, { query });
+            const result = await this._request(url, { method: 'POST', body: { query } });
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data;
+            return result;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -259,12 +358,12 @@ class JXPHelper {
                 }
                 return updateQuery;
             });
-            const url = `${this.server}/bulkwrite/${type}?apikey=${this.apikey}`;
-            return (await axios_1.default.post(url, updates)).data;
+            const url = `${this.server}/bulkwrite/${type}`;
+            return await this._request(url, { method: 'POST', body: updates });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -288,12 +387,12 @@ class JXPHelper {
                 updateQuery.updateOne.filter[key] = item[key];
                 return updateQuery;
             });
-            const url = `${this.server}/bulkwrite/${type}?apikey=${this.apikey}`;
-            return (await axios_1.default.post(url, updates)).data;
+            const url = `${this.server}/bulkwrite/${type}`;
+            return await this._request(url, { method: 'POST', body: updates });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -312,12 +411,12 @@ class JXPHelper {
                     }
                 };
             });
-            const url = `${this.server}/bulkwrite/${type}?apikey=${this.apikey}`;
-            return (await axios_1.default.post(url, updates)).data;
+            const url = `${this.server}/bulkwrite/${type}`;
+            return await this._request(url, { method: 'POST', body: updates });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -331,12 +430,12 @@ class JXPHelper {
         try {
             if (this.debug)
                 console.log("bulk", type);
-            const url = `${this.server}/bulkwrite/${type}?apikey=${this.apikey}`;
-            return (await axios_1.default.post(url, query)).data;
+            const url = `${this.server}/bulkwrite/${type}`;
+            return await this._request(url, { method: 'POST', body: query });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -359,12 +458,12 @@ class JXPHelper {
                     },
                 }
             ];
-            const url = `${this.server}/bulkwrite/${type}?apikey=${this.apikey}`;
-            return (await axios_1.default.post(url, query)).data;
+            const url = `${this.server}/bulkwrite/${type}`;
+            return await this._request(url, { method: 'POST', body: query });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -381,19 +480,16 @@ class JXPHelper {
         options.limit = 1;
         const url = this.url(type, options, "count");
         try {
-            const result = await axios_1.default.get(url);
+            const result = await this._request(url);
             if (this.debug)
                 console.timeEnd(label);
-            if (result.status !== 200) {
-                throw new Error(result.statusText);
-            }
-            return result.data.count;
+            return result.count;
         }
         catch (err) {
             if (this.debug)
                 console.timeEnd(label);
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -403,15 +499,15 @@ class JXPHelper {
      * @returns The response data from the post operation.
      */
     async post(type, data) {
-        const url = `${this.api}/${type}?apikey=${this.apikey}`;
+        const url = `${this.api}/${type}`;
         if (this.debug)
             console.log("POSTing to ", url, data);
         try {
-            return (await axios_1.default.post(url, data)).data;
+            return await this._request(url, { method: 'POST', body: data });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -423,15 +519,15 @@ class JXPHelper {
      * @throws If an error occurs during the request.
      */
     async put(type, id, data) {
-        const url = `${this.api}/${type}/${id}?apikey=${this.apikey}`;
+        const url = `${this.api}/${type}/${id}`;
         if (this.debug)
             console.log("PUTting to ", url, data);
         try {
-            return (await axios_1.default.put(url, data)).data;
+            return await this._request(url, { method: 'PUT', body: data });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -459,7 +555,7 @@ class JXPHelper {
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -470,13 +566,13 @@ class JXPHelper {
      * @throws If an error occurs during the deletion process.
      */
     async del(type, id) {
-        const url = `${this.api}/${type}/${id}?apikey=${this.apikey}`;
+        const url = `${this.api}/${type}/${id}`;
         try {
-            return (await axios_1.default.delete(url)).data;
+            return await this._request(url, { method: 'DELETE' });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -487,13 +583,13 @@ class JXPHelper {
      * @throws If an error occurs during the deletion process.
      */
     async del_perm(type, id) {
-        const url = `${this.api}/${type}/${id}?_permaDelete=1&apikey=${this.apikey}`;
+        const url = `${this.api}/${type}/${id}?_permaDelete=1`;
         try {
-            return (await axios_1.default.delete(url)).data;
+            return await this._request(url, { method: 'DELETE' });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -504,13 +600,13 @@ class JXPHelper {
      * @throws If an error occurs during the deletion process.
      */
     async del_cascade(type, id) {
-        const url = `${this.api}/${type}/${id}?_cascade=1&apikey=${this.apikey}`;
+        const url = `${this.api}/${type}/${id}?_cascade=1`;
         try {
-            return (await axios_1.default.delete(url)).data;
+            return await this._request(url, { method: 'DELETE' });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -521,13 +617,13 @@ class JXPHelper {
      * @throws If an error occurs during the delete request.
      */
     async del_perm_cascade(type, id) {
-        const url = `${this.api}/${type}/${id}?_cascade=1&_permaDelete=1&apikey=${this.apikey}`;
+        const url = `${this.api}/${type}/${id}?_cascade=1&_permaDelete=1`;
         try {
-            return (await axios_1.default.delete(url)).data;
+            return await this._request(url, { method: 'DELETE' });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -551,7 +647,7 @@ class JXPHelper {
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     async sync(type, key, id, data) {
@@ -587,7 +683,7 @@ class JXPHelper {
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -600,14 +696,30 @@ class JXPHelper {
      */
     async call(type, cmd, data) {
         //Call a function in the model
-        const url = `${this.server}/call/${type}/${cmd}?apikey=${this.apikey}`;
+        const url = `${this.server}/call/${type}/${cmd}`;
         if (this.debug)
             console.log("CALLing  ", url, data);
         try {
-            return (await axios_1.default.post(url, data)).data;
+            return await this._request(url, { method: 'POST', body: data });
+        }
+        catch (err) {
+            throw err;
+        }
+    }
+    /**
+     * Retrieves the groups for a user.
+     * @param user_id - The ID of the user.
+     * @returns A promise that resolves to the usergroup document (or `{ groups: [] }`).
+     * @throws If an error occurs during the request.
+     */
+    async groups_get(user_id) {
+        const url = `${this.server}/groups/${user_id}`;
+        try {
+            return await this._request(url);
         }
         catch (err) {
-            throw (err.response ? err.response.data : err);
+            this._displayError(err);
+            throw err;
         }
     }
     /**
@@ -618,12 +730,12 @@ class JXPHelper {
      * @throws If an error occurs during the update.
      */
     async groups_put(user_id, groups) {
-        const url = `${this.server}/groups/${user_id}?apikey=${this.apikey}`;
+        const url = `${this.server}/groups/${user_id}`;
         try {
-            return (await axios_1.default.put(url, { group: groups })).data;
+            return await this._request(url, { method: 'PUT', body: { group: groups } });
         }
         catch (err) {
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -634,13 +746,13 @@ class JXPHelper {
      * @throws If an error occurs during the deletion process.
      */
     async groups_del(user_id, group) {
-        const url = `${this.server}/groups/${user_id}?group=${group}&apikey=${this.apikey}`;
+        const url = `${this.server}/groups/${user_id}?group=${encodeURIComponent(group)}`;
         try {
-            return (await axios_1.default.delete(url)).data;
+            return await this._request(url, { method: 'DELETE' });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -651,16 +763,16 @@ class JXPHelper {
      * @throws If an error occurs during the post request.
      */
     async groups_post(user_id, groups) {
-        const url = `${this.server}/groups/${user_id}?apikey=${this.apikey}`;
+        const url = `${this.server}/groups/${user_id}`;
         const data = { group: groups };
         if (this.debug)
             console.log("GROUP POSTing", url, data);
         try {
-            return (await axios_1.default.post(url, data)).data;
+            return await this._request(url, { method: 'POST', body: data });
         }
         catch (err) {
             this._displayError(err);
-            throw (err.response ? err.response.data : err);
+            throw err;
         }
     }
     /**
@@ -671,12 +783,11 @@ class JXPHelper {
      */
     async getjwt(email) {
         try {
-            const jwt = (await axios_1.default.post(`${this.server}/login/getjwt?apikey=${this.apikey}`, { email })).data;
-            return jwt;
+            return await this._request(`${this.server}/login/getjwt`, { method: 'POST', body: { email } });
         }
         catch (err) {
-            if (err.response && err.response.data)
-                return Promise.reject(err.response.data);
+            if (err instanceof errors_1.JXPError)
+                return Promise.reject(err.body);
             return Promise.reject(err);
         }
     }
@@ -688,12 +799,11 @@ class JXPHelper {
      */
     async model(modelname) {
         try {
-            const modeldef = (await axios_1.default.get(`${this.server}/model/${modelname}?apikey=${this.apikey}`)).data;
-            return modeldef;
+            return await this._request(`${this.server}/model/${modelname}`);
         }
         catch (err) {
-            if (err.response && err.response.data)
-                return Promise.reject(err.response.data);
+            if (err instanceof errors_1.JXPError)
+                return Promise.reject(err.body);
             return Promise.reject(err);
         }
     }
@@ -704,12 +814,11 @@ class JXPHelper {
      */
     async models() {
         try {
-            const modeldef = (await axios_1.default.get(`${this.server}/model?apikey=${this.apikey}`)).data;
-            return modeldef;
+            return await this._request(`${this.server}/model`);
         }
         catch (err) {
-            if (err.response && err.response.data)
-                return Promise.reject(err.response.data);
+            if (err instanceof errors_1.JXPError)
+                return Promise.reject(err.body);
             return Promise.reject(err);
         }
     }