@qrunio/qqq-frontend-core 1.0.128-SNAPSHOT

package/lib/controllers/QControllerV1.js

@@ -0,0 +1,992 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { AxiosError } from "axios";
+import FormData from "form-data";
+import { QException } from "../exceptions/QException";
+import { QAuthenticationMetaData } from "../model/metaData/QAuthenticationMetaData";
+import { QInstance } from "../model/metaData/QInstance";
+import { QProcessMetaData } from "../model/metaData/QProcessMetaData";
+import { QTableMetaData } from "../model/metaData/QTableMetaData";
+import { QTableVariant } from "../model/metaData/QTableVariant";
+import { QJobComplete } from "../model/processes/QJobComplete";
+import { QJobError } from "../model/processes/QJobError";
+import { QJobRunning } from "../model/processes/QJobRunning";
+import { QJobStarted } from "../model/processes/QJobStarted";
+import { QPossibleValue } from "../model/QPossibleValue";
+import { QRecord } from "../model/QRecord";
+var axios = require("axios").default;
+/*******************************************************************************
+ ** Controller for interacting with a QQQ backend going through Middleware V1.
+ *******************************************************************************/
+var QControllerV1 = /** @class */ (function () {
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    function QControllerV1(baseUrl, exceptionHandler) {
+        this.axiosInstance = axios.create({
+            baseURL: baseUrl,
+            timeout: 60000, // todo - evaluate this!
+        });
+        //////////////////////////////////////////////////////////////////////////////////////////////////////
+        // create a promise which will run a busy-loop until setAuthorizationHeaderValue is called.         //
+        // the idea being, to not fire off any other requests until we know that the user is authenticated, //
+        // and we know how to send that authentication to the backend.                                      //
+        //////////////////////////////////////////////////////////////////////////////////////////////////////
+        QControllerV1.awaitAuthenticationPromise = new Promise(function (resolve) {
+            var interval = setInterval(function () {
+                if (QControllerV1.gotAuthentication) {
+                    resolve(true);
+                    clearInterval(interval);
+                }
+            }, 50);
+        });
+        try {
+            this.axiosInstance.defaults.headers.common["X-QQQ-UserTimezone"] = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        }
+        catch (e) {
+            ////////////
+            // ignore //
+            ////////////
+        }
+        ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        // javascript timezone offset is positive for locations west of GMT (e.g., 300 for US/Central) - which seems //
+        // opposite of the convention (e.g., CST=-6, CDT=-5).  So, we'll use a negative version of this value.       //
+        ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        this.axiosInstance.defaults.headers.common["X-QQQ-UserTimezoneOffsetMinutes"] = -new Date().getTimezoneOffset();
+        if (exceptionHandler != null) {
+            this.exceptionHandler = exceptionHandler;
+        }
+        else {
+            this.exceptionHandler = function (error) {
+                throw error;
+            };
+        }
+    }
+    /*******************************************************************************
+     ** Useful for development (e.g., to be able to use the axios instance, to test
+     ** things we probably want to keep in this class, without having to re-install
+     ** this module for the testing cycle), but probably not meant for main-line usage.
+     *******************************************************************************/
+    QControllerV1.prototype.getAxiosInstance = function () {
+        return (this.axiosInstance);
+    };
+    /*******************************************************************************
+     ** clear memoized promises
+     *******************************************************************************/
+    QControllerV1.clearMemoization = function () {
+        QControllerV1.metaDataPromise = undefined;
+        QControllerV1.tableMetaDataPromises.clear();
+        QControllerV1.processMetaDataPromises.clear();
+    };
+    /*******************************************************************************
+     ** Function to be called by an app after it's authenticated the user.  This will
+     ** allow the awaitAuthenticationPromise to resolve, so that other requests can continue.
+     *******************************************************************************/
+    QControllerV1.prototype.setGotAuthentication = function () {
+        QControllerV1.gotAuthentication = true;
+    };
+    /*******************************************************************************
+     ** Clear the authentication meta data from local storage
+     *******************************************************************************/
+    QControllerV1.prototype.clearAuthenticationMetaDataLocalStorage = function () {
+        localStorage.removeItem(QControllerV1.authenticationMetaDataLocalStorageKey);
+    };
+    /*******************************************************************************
+     ** Fetch the authentication meta data from local storage or the server.
+     *******************************************************************************/
+    QControllerV1.prototype.getAuthenticationMetaData = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var authenticationMetaDataJson, authenticationMetaData, age;
+            var _this = this;
+            return __generator(this, function (_a) {
+                try {
+                    authenticationMetaDataJson = localStorage.getItem(QControllerV1.authenticationMetaDataLocalStorageKey);
+                    authenticationMetaData = JSON.parse(authenticationMetaDataJson);
+                    if (authenticationMetaData && authenticationMetaData.timestamp) {
+                        age = ((new Date().getTime()) - authenticationMetaData.timestamp) / 1000;
+                        if (age < 60 * 60) {
+                            console.log("Found authentication meta data in local storage (and it's ".concat(age, " seconds old) - using it."));
+                            return [2 /*return*/, (new QAuthenticationMetaData(authenticationMetaData))];
+                        }
+                    }
+                }
+                catch (e) {
+                    console.log("Caught [".concat(e, "] reading authentication meta data from local storage - proceeding to get from backend."));
+                }
+                //////////////////////////////////////////
+                // resume with a fetch from the backend //
+                //////////////////////////////////////////
+                return [2 /*return*/, this.axiosInstance
+                        .get("/metaData/authentication")
+                        .then(function (response) {
+                        response.data.timestamp = new Date().getTime();
+                        localStorage.setItem(QControllerV1.authenticationMetaDataLocalStorageKey, JSON.stringify(response.data));
+                        console.log("Fetched authentication meta data from backend.");
+                        return new QAuthenticationMetaData(response.data);
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** create or update a user session
+     *******************************************************************************/
+    QControllerV1.prototype.manageSession = function (accessToken, uuid, more) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            var _this = this;
+            return __generator(this, function (_a) {
+                data = __assign({ accessToken: accessToken, uuid: uuid }, (more !== null && more !== void 0 ? more : {}));
+                return [2 /*return*/, this.axiosInstance
+                        .post("/manageSession", data)
+                        .then(function (response) {
+                        return response.data;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch the top-level meta data for a qqq instance.
+     *******************************************************************************/
+    QControllerV1.prototype.loadMetaData = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, QControllerV1.awaitAuthenticationPromise];
+                    case 1:
+                        _a.sent();
+                        if (QControllerV1.metaDataPromise) {
+                            return [2 /*return*/, (QControllerV1.metaDataPromise)];
+                        }
+                        QControllerV1.metaDataPromise = this.axiosInstance
+                            .get("/metaData/")
+                            .then(function (response) {
+                            return new QInstance(response.data);
+                        })
+                            .catch(function (error) {
+                            _this.handleException(error);
+                        });
+                        return [2 /*return*/, QControllerV1.metaDataPromise];
+                }
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch the full meta data for a specific table.
+     *******************************************************************************/
+    QControllerV1.prototype.loadTableMetaData = function (tableName, version) {
+        return __awaiter(this, void 0, void 0, function () {
+            var key, promise;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, QControllerV1.awaitAuthenticationPromise];
+                    case 1:
+                        _a.sent();
+                        key = { tableName: tableName, version: version };
+                        if (QControllerV1.tableMetaDataPromises.has(key)) {
+                            return [2 /*return*/, (QControllerV1.tableMetaDataPromises.get(key))];
+                        }
+                        promise = this.axiosInstance
+                            .get("".concat(this.getVersionPrefix(version), "/metaData/table/").concat(encodeURIComponent(tableName)))
+                            .then(function (response) {
+                            return new QTableMetaData(response.data);
+                        })
+                            .catch(function (error) {
+                            _this.handleException(error);
+                        });
+                        QControllerV1.tableMetaDataPromises.set(key, promise);
+                        return [2 /*return*/, (promise)];
+                }
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch the full meta data for a specific process.
+     *******************************************************************************/
+    QControllerV1.prototype.loadProcessMetaData = function (processName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, QControllerV1.awaitAuthenticationPromise];
+                    case 1:
+                        _a.sent();
+                        if (QControllerV1.processMetaDataPromises.has(processName)) {
+                            return [2 /*return*/, (QControllerV1.processMetaDataPromises.get(processName))];
+                        }
+                        promise = this.axiosInstance
+                            .get("/metaData/process/".concat(encodeURIComponent(processName)))
+                            .then(function (response) {
+                            return new QProcessMetaData(response.data);
+                        })
+                            .catch(function (error) {
+                            _this.handleException(error);
+                        });
+                        QControllerV1.processMetaDataPromises.set(processName, promise);
+                        return [2 /*return*/, (promise)];
+                }
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a count request to the backend
+     *******************************************************************************/
+    QControllerV1.prototype.count = function (tableName, version, queryFilter, queryJoins, includeDistinct, tableVariant) {
+        if (queryJoins === void 0) { queryJoins = null; }
+        if (includeDistinct === void 0) { includeDistinct = false; }
+        if (tableVariant === void 0) { tableVariant = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var countURL, body;
+            var _this = this;
+            return __generator(this, function (_a) {
+                countURL = "".concat(this.getVersionPrefix(version), "/table/").concat(encodeURIComponent(tableName), "/count");
+                body = {};
+                if (queryFilter) {
+                    body.filter = queryFilter;
+                }
+                if (queryJoins) {
+                    body.joins = queryJoins;
+                }
+                if (tableVariant) {
+                    body.tableVariant = tableVariant;
+                }
+                if (includeDistinct) {
+                    countURL += "?includeDistinct=true";
+                }
+                return [2 /*return*/, this.axiosInstance
+                        .post(countURL, body, { "content-type": "application/json" })
+                        .then(function (response) {
+                        return [response.data.count, response.data.distinctCount];
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a query request to the backend
+     *******************************************************************************/
+    QControllerV1.prototype.query = function (tableName, version, queryFilter, queryJoins, tableVariant) {
+        if (queryJoins === void 0) { queryJoins = null; }
+        if (tableVariant === void 0) { tableVariant = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var queryURL, body;
+            var _this = this;
+            return __generator(this, function (_a) {
+                queryURL = "".concat(this.getVersionPrefix(version), "/table/").concat(encodeURIComponent(tableName), "/query");
+                body = {};
+                if (queryFilter) {
+                    body.filter = queryFilter;
+                }
+                if (queryJoins) {
+                    body.joins = queryJoins;
+                }
+                if (tableVariant) {
+                    body.tableVariant = tableVariant;
+                }
+                return [2 /*return*/, this.axiosInstance
+                        .post(queryURL, body, { "content-type": "application/json" })
+                        .then(function (response) {
+                        var records = [];
+                        if (response.data.records) {
+                            for (var i = 0; i < response.data.records.length; i++) {
+                                records.push(new QRecord(response.data.records[i]));
+                            }
+                        }
+                        return records;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a request to the backend for a single record
+     *******************************************************************************/
+    QControllerV1.prototype.get = function (tableName, primaryKey, tableVariant, includeAssociations, queryJoins) {
+        if (tableVariant === void 0) { tableVariant = null; }
+        if (includeAssociations === void 0) { includeAssociations = false; }
+        if (queryJoins === void 0) { queryJoins = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var getURL, queryString;
+            var _this = this;
+            return __generator(this, function (_a) {
+                getURL = "/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(primaryKey));
+                queryString = [];
+                if (tableVariant) {
+                    queryString.push("tableVariant=".concat(encodeURIComponent(JSON.stringify(tableVariant))));
+                }
+                if (includeAssociations) {
+                    queryString.push("includeAssociations=true");
+                }
+                if (queryJoins) {
+                    queryString.push("queryJoins=".concat(encodeURIComponent(JSON.stringify(queryJoins))));
+                }
+                if (queryString.length > 0) {
+                    getURL += "?" + queryString.join("&");
+                }
+                return [2 /*return*/, this.axiosInstance
+                        .get(getURL)
+                        .then(function (response) {
+                        return new QRecord(response.data);
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a request to the backend for a single record's developer mode data
+     *******************************************************************************/
+    QControllerV1.prototype.getRecordDeveloperMode = function (tableName, primaryKey) {
+        return __awaiter(this, void 0, void 0, function () {
+            var getURL;
+            var _this = this;
+            return __generator(this, function (_a) {
+                getURL = "/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(primaryKey), "/developer");
+                return [2 /*return*/, this.axiosInstance
+                        .get(getURL)
+                        .then(function (response) {
+                        return response.data;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a request to the backend to save a new version of a record's associated script
+     *******************************************************************************/
+    QControllerV1.prototype.storeRecordAssociatedScript = function (tableName, primaryKey, fieldName, code, commitMessage) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, formData;
+            var _this = this;
+            return __generator(this, function (_a) {
+                url = "/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(primaryKey), "/developer/associatedScript/").concat(encodeURIComponent(fieldName));
+                formData = new FormData();
+                formData.append("contents", code);
+                formData.append("commitMessage", commitMessage);
+                return [2 /*return*/, this.axiosInstance
+                        .post(url, formData)
+                        .then(function (response) {
+                        return response.data;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a request to the backend to get script logs for an associated script
+     *******************************************************************************/
+    QControllerV1.prototype.getRecordAssociatedScriptLogs = function (tableName, primaryKey, fieldName, scriptRevisionId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            var _this = this;
+            return __generator(this, function (_a) {
+                url = "/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(primaryKey), "/developer/associatedScript/").concat(encodeURIComponent(fieldName), "/").concat(encodeURIComponent(scriptRevisionId), "/logs");
+                return [2 /*return*/, this.axiosInstance
+                        .get(url)
+                        .then(function (response) {
+                        return response.data;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a request to the backend to test a script
+     *******************************************************************************/
+    QControllerV1.prototype.testScript = function (tableName, primaryKey, fieldName, code, inputValues) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, formData, _i, _a, key;
+            var _this = this;
+            return __generator(this, function (_b) {
+                url = "/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(primaryKey), "/developer/associatedScript/").concat(encodeURIComponent(fieldName), "/test");
+                formData = new FormData();
+                formData.append("code", code);
+                for (_i = 0, _a = Array.from(inputValues.keys()); _i < _a.length; _i++) {
+                    key = _a[_i];
+                    formData.append(key, inputValues.get(key));
+                }
+                return [2 /*return*/, this.axiosInstance
+                        .post(url, formData)
+                        .then(function (response) {
+                        return response.data;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a backend call to create a single record
+     **
+     *******************************************************************************/
+    QControllerV1.prototype.create = function (tableName, data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var formData;
+            var _this = this;
+            return __generator(this, function (_a) {
+                formData = this.dataObjectToFormData(data);
+                return [2 /*return*/, this.axiosInstance
+                        .post("/data/".concat(encodeURIComponent(tableName)), formData, this.defaultMultipartFormDataHeaders())
+                        .then(function (response) {
+                        return new QRecord(response.data.records[0]);
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Convert a javascript object of form data to a "FormData" object for multipart posting.
+     *******************************************************************************/
+    QControllerV1.prototype.dataObjectToFormData = function (data) {
+        var formData = new FormData();
+        Object.keys(data).forEach(function (key) {
+            if (data[key] == null) {
+                formData.append(key, "");
+            }
+            else {
+                formData.append(key, data[key]);
+            }
+        });
+        return formData;
+    };
+    /*******************************************************************************
+     ** Make a backend call to update a single record
+     **
+     *******************************************************************************/
+    QControllerV1.prototype.update = function (tableName, id, data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var formData;
+            var _this = this;
+            return __generator(this, function (_a) {
+                formData = this.dataObjectToFormData(data);
+                return [2 /*return*/, this.axiosInstance
+                        .put("/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(id)), formData, this.defaultMultipartFormDataHeaders())
+                        .then(function (response) {
+                        return new QRecord(response.data.records[0]);
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Make a backend call to delete a single record
+     **
+     *******************************************************************************/
+    QControllerV1.prototype.delete = function (tableName, id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.axiosInstance
+                        .delete("/data/".concat(encodeURIComponent(tableName), "/").concat(encodeURIComponent(id)))
+                        .then(function (response) {
+                        var _a, _b, _c;
+                        if (response.data.deletedRecordCount === 1) {
+                            if (response.data.recordsWithWarnings && response.data.recordsWithWarnings.length > 0) {
+                                var recordWithWarnings = response.data.recordsWithWarnings[0];
+                                if (recordWithWarnings && recordWithWarnings.warnings && recordWithWarnings.warnings.length > 0) {
+                                    var warning = recordWithWarnings.warnings[0];
+                                    if (warning) {
+                                        _this.exceptionHandler(new QException(new AxiosError("Warning: ".concat((_a = warning.message) !== null && _a !== void 0 ? _a : warning))));
+                                        return (0);
+                                    }
+                                }
+                            }
+                            return (1);
+                        }
+                        else {
+                            var qException = new QException(new AxiosError("Unknown error deleting record"));
+                            var error = (_c = (_b = response.data) === null || _b === void 0 ? void 0 : _b.recordsWithErrors[0]) === null || _c === void 0 ? void 0 : _c.errors[0];
+                            if (error) {
+                                qException = new QException(error);
+                            }
+                            _this.exceptionHandler(qException);
+                            return (0);
+                        }
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Common logic to parse a process-related server response into an appropriate object.
+     *******************************************************************************/
+    QControllerV1.prototype.parseProcessResponse = function (response) {
+        //////////////////////////////////////////////////////////////////////////////////////
+        // so, the order of these checks is critical (mostly because, complete & error have //
+        // a jobStatus with them too, so, you can't check that one too soon                 //
+        //////////////////////////////////////////////////////////////////////////////////////
+        if (response.data.jobUUID) {
+            return new QJobStarted(response.data);
+        }
+        else if (response.data.values || response.data.nextStep) {
+            return new QJobComplete(response.data);
+        }
+        else if (response.data.error) {
+            return new QJobError(response.data);
+        }
+        else if (response.data.jobStatus) {
+            return new QJobRunning(response.data.jobStatus);
+        }
+        else {
+            return new QJobError({ error: "Unexpected server response." });
+        }
+    };
+    /*******************************************************************************
+     ** Initialize a process
+     *******************************************************************************/
+    QControllerV1.prototype.processInit = function (processName, formDataOrQueryString, formDataHeaders) {
+        if (formDataOrQueryString === void 0) { formDataOrQueryString = ""; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            return __generator(this, function (_a) {
+                url = "/processes/".concat(encodeURIComponent(processName), "/init");
+                return [2 /*return*/, this.processStepOrInit(url, formDataOrQueryString, formDataHeaders)];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fully run a process (i.e., not stopping for frontend steps)
+     *******************************************************************************/
+    QControllerV1.prototype.processRun = function (processName, formDataOrQueryString, formDataHeaders, dontGoAsyncOnBackend) {
+        if (formDataOrQueryString === void 0) { formDataOrQueryString = ""; }
+        if (dontGoAsyncOnBackend === void 0) { dontGoAsyncOnBackend = false; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            return __generator(this, function (_a) {
+                url = "/processes/".concat(encodeURIComponent(processName), "/run");
+                return [2 /*return*/, this.processStepOrInit(url, formDataOrQueryString, formDataHeaders, dontGoAsyncOnBackend)];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Helper function for the process init & step functions, as well as bulk functions
+     ** which may run async.
+     *******************************************************************************/
+    QControllerV1.prototype.postWithQueryStringToPossibleAsyncBackendJob = function (queryString, url) {
+        var _this = this;
+        if (queryString && queryString !== "") {
+            url += "?".concat(queryString);
+        }
+        return this.axiosInstance
+            .post(url)
+            .then(function (response) {
+            var responseObject = _this.parseProcessResponse(response);
+            if (responseObject instanceof QJobRunning) {
+                ////////////////////////////////////////////////////////////////////
+                // we aren't allowed to return "Running" here, so just in case... //
+                ////////////////////////////////////////////////////////////////////
+                return new QJobError({ error: "Unexpected server response." });
+            }
+            return responseObject;
+        })
+            .catch(function (error) {
+            _this.handleException(error);
+        });
+    };
+    /*******************************************************************************
+     ** Proceed to the next step in a process
+     *******************************************************************************/
+    QControllerV1.prototype.processStep = function (processName, processUUID, step, formDataOrQueryString, formDataHeaders) {
+        if (formDataOrQueryString === void 0) { formDataOrQueryString = ""; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            return __generator(this, function (_a) {
+                url = "/processes/".concat(encodeURIComponent(processName), "/").concat(encodeURIComponent(processUUID), "/step/").concat(encodeURIComponent(step));
+                return [2 /*return*/, this.processStepOrInit(url, formDataOrQueryString, formDataHeaders)];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Proceed to the next step in a process
+     *******************************************************************************/
+    QControllerV1.prototype.processStepOrInit = function (url, formDataOrQueryString, formDataHeaders, dontGoAsyncOnBackend) {
+        if (formDataOrQueryString === void 0) { formDataOrQueryString = ""; }
+        if (dontGoAsyncOnBackend === void 0) { dontGoAsyncOnBackend = false; }
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (formDataOrQueryString instanceof FormData) {
+                    if (!formDataHeaders) {
+                        /////////////////////////////////////////////////////////////////////////////////////////////////////////
+                        // so, it looks like FormData is supplied by the browser, when running the browser, but by a form-data //
+                        // lib when running not in the browser.  The browser version doesn't have a getHeaders method...       //
+                        /////////////////////////////////////////////////////////////////////////////////////////////////////////
+                        if (formDataOrQueryString.getHeaders) {
+                            formDataHeaders = formDataOrQueryString.getHeaders();
+                        }
+                        else {
+                            formDataHeaders = { "content-type": "multipart/form-data; boundary=--------------------------320289315924586491558366" };
+                        }
+                    }
+                    if (dontGoAsyncOnBackend) {
+                        formDataOrQueryString.append("_qStepTimeoutMillis", 300 * 1000);
+                    }
+                    return [2 /*return*/, this.axiosInstance
+                            .post(url, formDataOrQueryString, { headers: formDataHeaders })
+                            .then(function (response) {
+                            var responseObject = _this.parseProcessResponse(response);
+                            if (responseObject instanceof QJobRunning) {
+                                ////////////////////////////////////////////////////////////////////
+                                // we aren't allowed to return "Running" here, so just in case... //
+                                ////////////////////////////////////////////////////////////////////
+                                return new QJobError({ error: "Unexpected server response." });
+                            }
+                            return responseObject;
+                        })
+                            .catch(function (error) {
+                            _this.handleException(error);
+                        })];
+                }
+                else {
+                    if (dontGoAsyncOnBackend) {
+                        formDataOrQueryString += "&_qStepTimeoutMillis=".concat(300 * 1000);
+                    }
+                    return [2 /*return*/, this.postWithQueryStringToPossibleAsyncBackendJob(formDataOrQueryString, url)];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Get the status for a currently executing job within a process (init or step)
+     *******************************************************************************/
+    QControllerV1.prototype.processJobStatus = function (processName, processUUID, jobUUID) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.axiosInstance
+                        .get("/processes/".concat(encodeURIComponent(processName), "/").concat(encodeURIComponent(processUUID), "/status/").concat(encodeURIComponent(jobUUID)))
+                        .then(function (response) {
+                        var responseObject = _this.parseProcessResponse(response);
+                        if (responseObject instanceof QJobStarted) {
+                            ////////////////////////////////////////////////////////////////////
+                            // we aren't allowed to return "Started" here, so just in case... //
+                            ////////////////////////////////////////////////////////////////////
+                            return new QJobError({ error: "Unexpected server response." });
+                        }
+                        return responseObject;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Get records from a process's state
+     *******************************************************************************/
+    QControllerV1.prototype.processRecords = function (processName, processUUID, skip, limit) {
+        if (skip === void 0) { skip = 0; }
+        if (limit === void 0) { limit = 20; }
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.axiosInstance
+                        .get("/processes/".concat(encodeURIComponent(processName), "/").concat(encodeURIComponent(processUUID), "/records?skip=").concat(encodeURIComponent(skip), "&limit=").concat(encodeURIComponent(limit)))
+                        .then(function (response) {
+                        var records = [];
+                        if (response.data && response.data.records && response.data.records.length) {
+                            for (var i = 0; i < response.data.records.length; i++) {
+                                records.push(new QRecord(response.data.records[i]));
+                            }
+                        }
+                        return { totalRecords: response.data.totalRecords, records: records };
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Handle a user clicking cancel on a process
+     *******************************************************************************/
+    QControllerV1.prototype.processCancel = function (processName, processUUID) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.axiosInstance
+                        .get("/processes/".concat(encodeURIComponent(processName), "/").concat(encodeURIComponent(processUUID), "/cancel"))
+                        .then(function () {
+                        return true;
+                    })
+                        .catch(function (error) {
+                        _this.handleException(error);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch the data for a specific widget.
+     *******************************************************************************/
+    QControllerV1.prototype.tableVariants = function (tableName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            var _this = this;
+            return __generator(this, function (_a) {
+                url = "/data/".concat(encodeURIComponent(tableName), "/variants");
+                console.log("Looking for variants for table [" + tableName + "]");
+                return [2 /*return*/, this.axiosInstance
+                        .get(url)
+                        .then(function (response) {
+                        var variants = [];
+                        if (response.data && response.data.length) {
+                            for (var i = 0; i < response.data.length; i++) {
+                                variants.push(new QTableVariant(response.data[i]));
+                            }
+                        }
+                        return variants;
+                    })
+                        .catch(function (e) {
+                        if (e.code && e.code === "ERR_CANCELED") {
+                            console.log("Controller request cancellation successful!");
+                            return;
+                        }
+                        _this.handleException(e);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch the data for a specific widget.
+     *******************************************************************************/
+    QControllerV1.prototype.widget = function (widgetName, urlParams) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, controller, signal;
+            var _this = this;
+            return __generator(this, function (_a) {
+                url = "/widget/".concat(encodeURIComponent(widgetName));
+                if (urlParams) {
+                    url += "?".concat(urlParams);
+                }
+                /////////////////////////////////////////////////////////////////
+                // see if an abort controller was created for this widget name //
+                /////////////////////////////////////////////////////////////////
+                console.log("Looking for controller for widget [" + widgetName + "]");
+                controller = QControllerV1.widgetAbortControllerMap.get(widgetName);
+                if (controller) {
+                    console.log("Found existing abort controller for widget '".concat(widgetName, "', aborting..."));
+                    controller.abort();
+                }
+                /////////////////////////////////////////
+                // keep track of this widget's request //
+                /////////////////////////////////////////
+                controller = new AbortController();
+                signal = controller.signal;
+                QControllerV1.widgetAbortControllerMap.set(widgetName, controller);
+                return [2 /*return*/, this.axiosInstance
+                        .get(url, { signal: signal })
+                        .then(function (response) {
+                        ///////////////////////////////////////////////////
+                        // make sure to clear out the request controller //
+                        ///////////////////////////////////////////////////
+                        QControllerV1.widgetAbortControllerMap.set(widgetName, null);
+                        return response.data;
+                    })
+                        .catch(function (e) {
+                        if (e.code && e.code === "ERR_CANCELED") {
+                            console.log("Controller request cancellation successful!");
+                            return;
+                        }
+                        _this.handleException(e);
+                    })];
+            });
+        });
+    };
+    /*******************************************************************************
+     ** Fetch options for a possible-value drop down.
+     **
+     ** This method operates in 3 modes:
+     ** - for a PVS field on a table (pass (tableName, null, fieldName, ...)
+     ** - for a PVS field on a process (pass (null, processName, fieldName, ...)
+     ** - for a standalone PVS (pass (null, null, process, ...)
+     *******************************************************************************/
+    QControllerV1.prototype.possibleValues = function (tableName, processName, fieldNameOrPossibleValueSourceName, searchTerm, ids, values, useCase) {
+        if (searchTerm === void 0) { searchTerm = ""; }
+        if (ids === void 0) { ids = []; }
+        if (values === void 0) { values = new Map(); }
+        if (useCase === void 0) { useCase = ""; }
+        return __awaiter(this, void 0, void 0, function () {
+            var url, queryComponents, postBody;
+            return __generator(this, function (_a) {
+                if (tableName) {
+                    url = "/data/".concat(encodeURIComponent(tableName), "/possibleValues/").concat(encodeURIComponent(fieldNameOrPossibleValueSourceName));
+                }
+                else if (processName) {
+                    url = "/processes/".concat(encodeURIComponent(processName), "/possibleValues/").concat(encodeURIComponent(fieldNameOrPossibleValueSourceName));
+                }
+                else {
+                    url = "/possibleValues/".concat(encodeURIComponent(fieldNameOrPossibleValueSourceName));
+                }
+                queryComponents = [];
+                if (searchTerm !== "") {
+                    queryComponents.push("searchTerm=".concat(encodeURIComponent(searchTerm)));
+                }
+                if (useCase !== "") {
+                    queryComponents.push("useCase=".concat(encodeURIComponent(useCase)));
+                }
+                if (ids && ids.length) {
+                    queryComponents.push("ids=".concat(encodeURIComponent(ids.join(","))));
+                }
+                if (queryComponents.length > 0) {
+                    url += "?".concat(queryComponents.join("&"));
+                }
+                postBody = new FormData();
+                postBody.append("values", JSON.stringify(Object.fromEntries(values)));
+                return [2 /*return*/, this.axiosInstance
+                        .post(url, postBody)
+                        .then(function (response) {
+                        var results = [];
+                        if (response.data && response.data.options) {
+                            for (var i = 0; i < response.data.options.length; i++) {
+                                results.push(new QPossibleValue(response.data.options[i]));
+                            }
+                        }
+                        return results;
+                    })
+                        .catch(this.handleException)];
+            });
+        });
+    };
+    /***************************************************************************
+     ** Let an app piggyback on our axiosInstance and handleException methods
+     ** to issue ad-hock requests.
+     ***************************************************************************/
+    QControllerV1.prototype.axiosRequest = function (config) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.axiosInstance
+                        .request(config)
+                        .then(function (response) {
+                        return (response.data);
+                    })
+                        .catch(this.handleException)];
+            });
+        });
+    };
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    QControllerV1.prototype.defaultMultipartFormDataHeaders = function () {
+        return {
+            "content-type": "multipart/form-data; boundary=--------------------------320289315924586491558366",
+        };
+    };
+    /*******************************************************************************
+     ** exception handler which will marshal axios error into a QException and
+     *  send that the exception handler provided to this class
+     *******************************************************************************/
+    QControllerV1.prototype.handleException = function (error) {
+        var qException = new QException(error);
+        this.exceptionHandler(qException);
+    };
+    /***************************************************************************
+     ** function get map a Version to the string we put into urls
+     ***************************************************************************/
+    QControllerV1.prototype.getVersionPrefix = function (version) {
+        if (version) {
+            return "/".concat(version.path, "/").concat(version.version);
+        }
+        return "";
+    };
+    QControllerV1.STEP_TIMEOUT_MILLIS_PARAM_NAME = "_qStepTimeoutMillis";
+    QControllerV1.tableMetaDataPromises = new Map();
+    QControllerV1.processMetaDataPromises = new Map();
+    QControllerV1.authenticationMetaDataLocalStorageKey = "qqq.authenticationMetaData.json";
+    QControllerV1.gotAuthentication = false;
+    QControllerV1.widgetAbortControllerMap = new Map();
+    return QControllerV1;
+}());
+export { QControllerV1 };
+//# sourceMappingURL=QControllerV1.js.map