@qrunio/qqq-frontend-core 0.36.1-SNAPSHOT

package/lib/model/metaData/QFieldMetaData.js

@@ -0,0 +1,157 @@
+/*
+ * 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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+import { QPossibleValue } from "../QPossibleValue";
+import { QQueryFilter } from "../query/QQueryFilter";
+import { FieldAdornment } from "./FieldAdornment";
+import { QHelpContent } from "./QHelpContent";
+/*******************************************************************************
+ ** Meta-data to represent a single field in a table.
+ **
+ *******************************************************************************/
+var QFieldMetaData = /** @class */ (function () {
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    function QFieldMetaData(object) {
+        var _a;
+        this.isRequired = false;
+        this.isEditable = true;
+        this.isHeavy = false;
+        this.isHidden = false;
+        this.supplementalFieldMetaData = new Map();
+        this.name = object.name;
+        this.label = object.label;
+        this.defaultValue = object.defaultValue;
+        this.type = object.type;
+        this.isRequired = object.isRequired;
+        this.isEditable = object.isEditable;
+        this.isHeavy = object.isHeavy;
+        this.isHidden = object.isHidden;
+        this.possibleValueSourceName = object.possibleValueSourceName;
+        this.displayFormat = object.displayFormat;
+        this.gridColumns = object.gridColumns;
+        this.maxLength = object.maxLength;
+        if (object.adornments) {
+            this.adornments = [];
+            for (var i = 0; i < object.adornments.length; i++) {
+                this.adornments.push(new FieldAdornment(object.adornments[i]));
+            }
+        }
+        if (object.inlinePossibleValueSource) {
+            this.inlinePossibleValueSource = [];
+            for (var i = 0; i < ((_a = object.inlinePossibleValueSource.enumValues) === null || _a === void 0 ? void 0 : _a.length); i++) {
+                this.inlinePossibleValueSource.push(new QPossibleValue(object.inlinePossibleValueSource.enumValues[i]));
+            }
+        }
+        this.helpContents = QHelpContent.buildArray(object.helpContents);
+        this.behaviors = object.behaviors;
+        if (object.supplementalFieldMetaData) {
+            for (var key in object.supplementalFieldMetaData) {
+                this.supplementalFieldMetaData.set(key, object.supplementalFieldMetaData[key]);
+            }
+        }
+        if (object.possibleValueSourceFilter) {
+            this.possibleValueSourceFilter = QQueryFilter.makeFromObject(object.possibleValueSourceFilter);
+        }
+    }
+    /*******************************************************************************
+     ** test if this field has an adornment of a given type
+     *******************************************************************************/
+    QFieldMetaData.prototype.hasAdornment = function (type) {
+        var adornment = this.getAdornment(type);
+        return (adornment !== null);
+    };
+    /*******************************************************************************
+     ** get the adornment of a given type from this field
+     *******************************************************************************/
+    QFieldMetaData.prototype.getAdornment = function (type) {
+        if (this.adornments) {
+            for (var i = 0; i < this.adornments.length; i++) {
+                if (type === this.adornments[i].type) {
+                    return (this.adornments[i]);
+                }
+            }
+        }
+        return (null);
+    };
+    /***************************************************************************
+     *
+     ***************************************************************************/
+    QFieldMetaData.prototype.clone = function () {
+        var inlinePossibleValueSourceClone = this.inlinePossibleValueSource ? [] : undefined;
+        if (this.inlinePossibleValueSource && inlinePossibleValueSourceClone) {
+            for (var _i = 0, _a = this.inlinePossibleValueSource; _i < _a.length; _i++) {
+                var qPossibleValue = _a[_i];
+                inlinePossibleValueSourceClone.push(qPossibleValue.clone());
+            }
+        }
+        var adornmentsClone = this.adornments ? [] : undefined;
+        if (this.adornments && adornmentsClone) {
+            for (var _b = 0, _c = this.adornments; _b < _c.length; _b++) {
+                var adornment = _c[_b];
+                adornmentsClone.push(adornment.clone());
+            }
+        }
+        var helpContentsClone = this.helpContents ? [] : undefined;
+        if (this.helpContents && helpContentsClone) {
+            for (var _d = 0, _e = this.helpContents; _d < _e.length; _d++) {
+                var helpContent = _e[_d];
+                helpContentsClone.push(helpContent.clone());
+            }
+        }
+        var behaviorsClone = this.behaviors ? __spreadArray([], this.behaviors, true) : undefined;
+        var supplementalFieldMetaDataClone = new Map();
+        this.supplementalFieldMetaData.forEach(function (value, key) {
+            supplementalFieldMetaDataClone.set(key, value);
+        });
+        var possibleValueSourceFilterClone = this.possibleValueSourceFilter ? this.possibleValueSourceFilter.clone() : undefined;
+        var clone = new QFieldMetaData(__assign(__assign({}, this), { inlinePossibleValueSource: inlinePossibleValueSourceClone, behaviors: behaviorsClone, possibleValueSourceFilter: possibleValueSourceFilterClone }));
+        if (adornmentsClone) {
+            clone.adornments = adornmentsClone;
+        }
+        clone.helpContents = helpContentsClone;
+        clone.supplementalFieldMetaData = supplementalFieldMetaDataClone;
+        return (clone);
+    };
+    return QFieldMetaData;
+}());
+export { QFieldMetaData };
+//# sourceMappingURL=QFieldMetaData.js.map

package/lib/model/metaData/QFieldMetaData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QFieldMetaData.js","sourceRoot":"","sources":["../../../src/model/metaData/QFieldMetaData.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;;;;;;;;;;;;;;;;;;;AAEH,OAAO,EAAC,cAAc,EAAC,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAEhD,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;iFAGiF;AACjF;IAsBG;;qFAEiF;IACjF,wBAAY,MAAW;;QAnBvB,eAAU,GAAY,KAAK,CAAC;QAC5B,eAAU,GAAY,IAAI,CAAC;QAC3B,YAAO,GAAY,KAAK,CAAC;QACzB,aAAQ,GAAY,KAAK,CAAC;QAQ1B,8BAAyB,GAAqB,IAAI,GAAG,EAAE,CAAC;QAUrD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAElC,IAAI,MAAM,CAAC,UAAU,EACrB;YACG,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EACjD;gBACG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACjE;SACH;QAED,IAAI,MAAM,CAAC,yBAAyB,EACpC;YACG,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;YACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAG,MAAA,MAAM,CAAC,yBAAyB,CAAC,UAAU,0CAAE,MAAM,CAAA,EAAE,CAAC,EAAE,EAC5E;gBACG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC1G;SACH;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAElC,IAAI,MAAM,CAAC,yBAAyB,EACpC;YACG,KAAK,IAAM,GAAG,IAAI,MAAM,CAAC,yBAAyB,EAClD;gBACG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC;aACjF;SACH;QAED,IAAI,MAAM,CAAC,yBAAyB,EACpC;YACG,IAAI,CAAC,yBAAyB,GAAG,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;SACjG;IACJ,CAAC;IAGD;;qFAEiF;IACjF,qCAAY,GAAZ,UAAa,IAAmB;QAE7B,IAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;IAC/B,CAAC;IAGD;;qFAEiF;IACjF,qCAAY,GAAZ,UAAa,IAAmB;QAE7B,IAAI,IAAI,CAAC,UAAU,EACnB;YACG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAC/C;gBACG,IAAI,IAAI,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,EACpC;oBACG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC9B;aACH;SACH;QAED,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAGD;;iFAE6E;IACtE,8BAAK,GAAZ;QAEG,IAAM,8BAA8B,GAAiC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrH,IAAG,IAAI,CAAC,yBAAyB,IAAI,8BAA8B,EACnE;YACG,KAA2B,UAA8B,EAA9B,KAAA,IAAI,CAAC,yBAAyB,EAA9B,cAA8B,EAA9B,IAA8B,EACzD;gBADK,IAAI,cAAc,SAAA;gBAEpB,8BAA8B,CAAC,IAAI,CAAE,cAAsB,CAAC,KAAK,EAAE,CAAC,CAAC;aACvE;SACH;QAED,IAAM,eAAe,GAAiC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvF,IAAG,IAAI,CAAC,UAAU,IAAI,eAAe,EACrC;YACG,KAAsB,UAAe,EAAf,KAAA,IAAI,CAAC,UAAU,EAAf,cAAe,EAAf,IAAe,EACrC;gBADK,IAAI,SAAS,SAAA;gBAEf,eAAe,CAAC,IAAI,CAAE,SAAiB,CAAC,KAAK,EAAE,CAAC,CAAC;aACnD;SACH;QAED,IAAM,iBAAiB,GAA+B,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAG,IAAI,CAAC,YAAY,IAAI,iBAAiB,EACzC;YACG,KAAwB,UAAiB,EAAjB,KAAA,IAAI,CAAC,YAAY,EAAjB,cAAiB,EAAjB,IAAiB,EACzC;gBADK,IAAI,WAAW,SAAA;gBAEjB,iBAAiB,CAAC,IAAI,CAAE,WAAmB,CAAC,KAAK,EAAE,CAAC,CAAC;aACvD;SACH;QAED,IAAM,cAAc,GAAsB,IAAI,CAAC,SAAS,CAAC,CAAC,mBAAK,IAAI,CAAC,SAAS,QAAE,CAAC,CAAC,SAAS,CAAC;QAE3F,IAAM,8BAA8B,GAAqB,IAAI,GAAG,EAAE,CAAC;QACnE,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAC,KAAK,EAAE,GAAG;YAE/C,8BAA8B,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,IAAM,8BAA8B,GAAG,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAE,IAAI,CAAC,yBAAiC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpI,IAAM,KAAK,GAAG,IAAI,cAAc,uBAC1B,IAAI,KACP,yBAAyB,EAAE,8BAA8B,EACzD,SAAS,EAAE,cAAc,EACzB,yBAAyB,EAAE,8BAA8B,IAC1D,CAAC;QAEH,IAAG,eAAe,EAClB;YACG,KAAK,CAAC,UAAU,GAAG,eAAe,CAAC;SACrC;QAED,KAAK,CAAC,YAAY,GAAG,iBAAiB,CAAC;QAEvC,KAAK,CAAC,yBAAyB,GAAG,8BAA8B,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IAEJ,qBAAC;AAAD,CAAC,AAtKD,IAsKC"}

package/lib/model/metaData/QFieldType.d.ts

@@ -0,0 +1,18 @@
+/*******************************************************************************
+ ** Possible data types for Q-fields.
+ **
+ *******************************************************************************/
+export declare enum QFieldType {
+    BOOLEAN = "BOOLEAN",
+    STRING = "STRING",
+    INTEGER = "INTEGER",
+    LONG = "LONG",
+    DECIMAL = "DECIMAL",
+    DATE = "DATE",
+    TIME = "TIME",
+    DATE_TIME = "DATE_TIME",
+    TEXT = "TEXT",
+    HTML = "HTML",
+    PASSWORD = "PASSWORD",
+    BLOB = "BLOB"
+}

package/lib/model/metaData/QFieldType.js

@@ -0,0 +1,43 @@
+/*
+ * 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/>.
+ */
+/*******************************************************************************
+ ** Possible data types for Q-fields.
+ **
+ *******************************************************************************/
+export var QFieldType;
+(function (QFieldType) {
+    QFieldType["BOOLEAN"] = "BOOLEAN";
+    QFieldType["STRING"] = "STRING";
+    QFieldType["INTEGER"] = "INTEGER";
+    QFieldType["LONG"] = "LONG";
+    QFieldType["DECIMAL"] = "DECIMAL";
+    QFieldType["DATE"] = "DATE";
+    QFieldType["TIME"] = "TIME";
+    QFieldType["DATE_TIME"] = "DATE_TIME";
+    QFieldType["TEXT"] = "TEXT";
+    QFieldType["HTML"] = "HTML";
+    QFieldType["PASSWORD"] = "PASSWORD";
+    QFieldType["BLOB"] = "BLOB";
+    ////////////////////////////////////////////////////////////////////////
+    // keep these values in sync with QFieldType.java in qqq-backend-core //
+    ////////////////////////////////////////////////////////////////////////
+})(QFieldType || (QFieldType = {}));
+//# sourceMappingURL=QFieldType.js.map

package/lib/model/metaData/QFieldType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QFieldType.js","sourceRoot":"","sources":["../../../src/model/metaData/QFieldType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;iFAGiF;AACjF,MAAM,CAAN,IAAY,UAgBX;AAhBD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,qCAAuB,CAAA;IACvB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,wEAAwE;IACxE,wEAAwE;IACxE,wEAAwE;AAC1E,CAAC,EAhBW,UAAU,KAAV,UAAU,QAgBrB"}

package/lib/model/metaData/QFrontendComponent.d.ts

@@ -0,0 +1,10 @@
+import { QComponentType } from "./QComponentType";
+/*******************************************************************************
+ ** Meta-Data to define a component on a screen in a QQQ process.
+ **
+ *******************************************************************************/
+export declare class QFrontendComponent {
+    type: QComponentType;
+    values?: any;
+    constructor(object: any);
+}

package/lib/model/metaData/QFrontendComponent.js

@@ -0,0 +1,35 @@
+/*
+ * 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/>.
+ */
+/*******************************************************************************
+ ** Meta-Data to define a component on a screen in a QQQ process.
+ **
+ *******************************************************************************/
+var QFrontendComponent = /** @class */ (function () {
+    function QFrontendComponent(object) {
+        this.type = object.type;
+        if (object.values) {
+            this.values = object.values;
+        }
+    }
+    return QFrontendComponent;
+}());
+export { QFrontendComponent };
+//# sourceMappingURL=QFrontendComponent.js.map

package/lib/model/metaData/QFrontendComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QFrontendComponent.js","sourceRoot":"","sources":["../../../src/model/metaData/QFrontendComponent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH;;;iFAGiF;AACjF;IAKG,4BAAY,MAAW;QAEpB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QAEvB,IAAI,MAAM,CAAC,MAAM,EACjB;YACG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;SAC9B;IACJ,CAAC;IACJ,yBAAC;AAAD,CAAC,AAdD,IAcC"}

package/lib/model/metaData/QFrontendStepMetaData.d.ts

@@ -0,0 +1,18 @@
+import { QFieldMetaData } from "./QFieldMetaData";
+import { QFrontendComponent } from "./QFrontendComponent";
+import { QHelpContent } from "./QHelpContent";
+/*******************************************************************************
+ ** Meta-Data to define a step (for the frontend) in a QQQ process.
+ **
+ *******************************************************************************/
+export declare class QFrontendStepMetaData {
+    name: string;
+    label: string;
+    format: string;
+    components?: QFrontendComponent[];
+    formFields?: QFieldMetaData[];
+    viewFields?: QFieldMetaData[];
+    recordListFields?: QFieldMetaData[];
+    helpContents?: QHelpContent[];
+    constructor(object: any);
+}

package/lib/model/metaData/QFrontendStepMetaData.js

@@ -0,0 +1,62 @@
+/*
+ * 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/>.
+ */
+import { QFieldMetaData } from "./QFieldMetaData";
+import { QFrontendComponent } from "./QFrontendComponent";
+import { QHelpContent } from "./QHelpContent";
+/*******************************************************************************
+ ** Meta-Data to define a step (for the frontend) in a QQQ process.
+ **
+ *******************************************************************************/
+var QFrontendStepMetaData = /** @class */ (function () {
+    function QFrontendStepMetaData(object) {
+        this.name = object.name;
+        this.label = object.label;
+        this.format = object.format;
+        if (object.components) {
+            this.components = [];
+            for (var i = 0; i < object.components.length; i++) {
+                this.components.push(new QFrontendComponent(object.components[i]));
+            }
+        }
+        if (object.formFields) {
+            this.formFields = [];
+            for (var i = 0; i < object.formFields.length; i++) {
+                this.formFields.push(new QFieldMetaData(object.formFields[i]));
+            }
+        }
+        if (object.viewFields) {
+            this.viewFields = [];
+            for (var i = 0; i < object.viewFields.length; i++) {
+                this.viewFields.push(new QFieldMetaData(object.viewFields[i]));
+            }
+        }
+        if (object.recordListFields) {
+            this.recordListFields = [];
+            for (var i = 0; i < object.recordListFields.length; i++) {
+                this.recordListFields.push(new QFieldMetaData(object.recordListFields[i]));
+            }
+        }
+        this.helpContents = QHelpContent.buildArray(object.helpContents);
+    }
+    return QFrontendStepMetaData;
+}());
+export { QFrontendStepMetaData };
+//# sourceMappingURL=QFrontendStepMetaData.js.map

package/lib/model/metaData/QFrontendStepMetaData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QFrontendStepMetaData.js","sourceRoot":"","sources":["../../../src/model/metaData/QFrontendStepMetaData.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;iFAGiF;AACjF;IAYG,+BAAY,MAAW;QAEpB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE5B,IAAI,MAAM,CAAC,UAAU,EACrB;YACG,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EACjD;gBACG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACrE;SACH;QAED,IAAI,MAAM,CAAC,UAAU,EACrB;YACG,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EACjD;gBACG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACjE;SACH;QAED,IAAI,MAAM,CAAC,UAAU,EACrB;YACG,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EACjD;gBACG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACjE;SACH;QAED,IAAI,MAAM,CAAC,gBAAgB,EAC3B;YACG,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EACvD;gBACG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC7E;SACH;QAED,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IACnE,CAAC;IACJ,4BAAC;AAAD,CAAC,AAxDD,IAwDC"}

package/lib/model/metaData/QHelpContent.d.ts

@@ -0,0 +1,27 @@
+/*******************************************************************************
+ ** Meta-Data to define HelpContent
+ **
+ *******************************************************************************/
+export declare class QHelpContent {
+    content: string;
+    format: string;
+    roles: Set<string>;
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    constructor(object: any);
+    /*******************************************************************************
+     ** factory method, for building an array of QHelpContent objects from array of
+     ** unstructured data (e.g., as it would come from the backend)
+     *******************************************************************************/
+    static buildArray(helpContents: any[]): QHelpContent[] | undefined;
+    /*******************************************************************************
+     ** factory method, for building an map of QHelpContent objects from map of
+     ** unstructured data (e.g., as it would come from the backend)
+     *******************************************************************************/
+    static buildMap(object: any): Map<string, QHelpContent[]> | undefined;
+    /***************************************************************************
+     *
+     ***************************************************************************/
+    clone(): QHelpContent;
+}

package/lib/model/metaData/QHelpContent.js

@@ -0,0 +1,108 @@
+/*
+ * 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);
+};
+/*******************************************************************************
+ ** Meta-Data to define HelpContent
+ **
+ *******************************************************************************/
+var QHelpContent = /** @class */ (function () {
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    function QHelpContent(object) {
+        this.roles = new Set();
+        this.content = object.content;
+        this.format = object.format;
+        if (object.roles) {
+            for (var i = 0; i < object.roles.length; i++) {
+                this.roles.add(object.roles[i]);
+            }
+        }
+    }
+    /*******************************************************************************
+     ** factory method, for building an array of QHelpContent objects from array of
+     ** unstructured data (e.g., as it would come from the backend)
+     *******************************************************************************/
+    QHelpContent.buildArray = function (helpContents) {
+        var rs;
+        if (helpContents) {
+            rs = [];
+            for (var i = 0; i < helpContents.length; i++) {
+                rs.push(new QHelpContent(helpContents[i]));
+            }
+        }
+        return (rs);
+    };
+    /*******************************************************************************
+     ** factory method, for building an map of QHelpContent objects from map of
+     ** unstructured data (e.g., as it would come from the backend)
+     *******************************************************************************/
+    QHelpContent.buildMap = function (object) {
+        var rs = undefined;
+        if (object) {
+            rs = new Map();
+            for (var key in object) {
+                var list = [];
+                rs.set(key, list);
+                //////////////////////////////////////////////////////////////////////////////////////////////////////
+                // allow object from backend to either be an array or a scalar (for migration from scalar to array) //
+                //////////////////////////////////////////////////////////////////////////////////////////////////////
+                if (object[key].length) {
+                    for (var i = 0; i < object[key].length; i++) {
+                        list.push(new QHelpContent(object[key][i]));
+                    }
+                }
+                else {
+                    list.push(new QHelpContent(object[key]));
+                }
+            }
+        }
+        return (rs);
+    };
+    /***************************************************************************
+     *
+     ***************************************************************************/
+    QHelpContent.prototype.clone = function () {
+        var rolesClone = new Set();
+        this.roles.forEach(function (role) {
+            rolesClone.add(role);
+        });
+        var clone = new QHelpContent(__assign({}, this));
+        ////////////////////////////////////////////////////////////////////////////////
+        // sets don't quite work as expected for this kind of clone, so copy manually //
+        ////////////////////////////////////////////////////////////////////////////////
+        clone.roles = rolesClone;
+        return (clone);
+    };
+    return QHelpContent;
+}());
+export { QHelpContent };
+//# sourceMappingURL=QHelpContent.js.map

package/lib/model/metaData/QHelpContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QHelpContent.js","sourceRoot":"","sources":["../../../src/model/metaData/QHelpContent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;;;;;;;;;;AAEH;;;iFAGiF;AACjF;IAOG;;qFAEiF;IACjF,sBAAY,MAAW;QANvB,UAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAQvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE5B,IAAI,MAAM,CAAC,KAAK,EAChB;YACG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAC5C;gBACG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aAClC;SACH;IACJ,CAAC;IAGD;;;qFAGiF;IAC1E,uBAAU,GAAjB,UAAkB,YAAmB;QAElC,IAAI,EAA8B,CAAC;QAEnC,IAAI,YAAY,EAChB;YACG,EAAE,GAAG,EAAE,CAAC;YACR,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAC5C;gBACG,EAAE,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC7C;SACH;QAED,OAAO,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IAGD;;;qFAGiF;IAC1E,qBAAQ,GAAf,UAAgB,MAAW;QAExB,IAAI,EAAE,GAAG,SAAS,CAAC;QAEnB,IAAI,MAAM,EACV;YACG,EAAE,GAAG,IAAI,GAAG,EAA0B,CAAC;YACvC,KAAK,IAAM,GAAG,IAAI,MAAM,EACxB;gBACG,IAAM,IAAI,GAAmB,EAAE,CAAC;gBAChC,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAElB,sGAAsG;gBACtG,sGAAsG;gBACtG,sGAAsG;gBACtG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EACtB;oBACG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAC3C;wBACG,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;qBAC9C;iBACH;qBAED;oBACG,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBAC3C;aACH;SACH;QAED,OAAO,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IAGD;;iFAE6E;IACtE,4BAAK,GAAZ;QAEG,IAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI;YAErB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,IAAM,KAAK,GAAG,IAAI,YAAY,cAAK,IAAI,EAAE,CAAC;QAE1C,gFAAgF;QAChF,gFAAgF;QAChF,gFAAgF;QAChF,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC;QAEzB,OAAO,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IAEJ,mBAAC;AAAD,CAAC,AAxGD,IAwGC"}

package/lib/model/metaData/QIcon.d.ts

@@ -0,0 +1,10 @@
+/*******************************************************************************
+ ** Meta-Data to define an icon for use in a QQQ instance
+ **
+ *******************************************************************************/
+export declare class QIcon {
+    name?: string;
+    path?: string;
+    color?: string;
+    constructor(object: any);
+}

package/lib/model/metaData/QIcon.js

@@ -0,0 +1,34 @@
+/*
+ * 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/>.
+ */
+/*******************************************************************************
+ ** Meta-Data to define an icon for use in a QQQ instance
+ **
+ *******************************************************************************/
+var QIcon = /** @class */ (function () {
+    function QIcon(object) {
+        this.name = object.name;
+        this.path = object.path;
+        this.color = object.color;
+    }
+    return QIcon;
+}());
+export { QIcon };
+//# sourceMappingURL=QIcon.js.map

package/lib/model/metaData/QIcon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QIcon.js","sourceRoot":"","sources":["../../../src/model/metaData/QIcon.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;iFAGiF;AACjF;IAMG,eAAY,MAAW;QAEpB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,CAAC;IACJ,YAAC;AAAD,CAAC,AAZD,IAYC"}

package/lib/model/metaData/QInstance.d.ts

@@ -0,0 +1,43 @@
+import { QAppMetaData } from "./QAppMetaData";
+import { QAppTreeNode } from "./QAppTreeNode";
+import { QBrandingMetaData } from "./QBrandingMetaData";
+import { QHelpContent } from "./QHelpContent";
+import { QProcessMetaData } from "./QProcessMetaData";
+import { QReportMetaData } from "./QReportMetaData";
+import { QTableMetaData } from "./QTableMetaData";
+import { QThemeMetaData } from "./QThemeMetaData";
+import { QWidgetMetaData } from "./QWidgetMetaData";
+/*******************************************************************************
+ ** Meta-Data definition of a QQQ Instance
+ **
+ *******************************************************************************/
+export declare class QInstance {
+    tables?: Map<string, QTableMetaData>;
+    processes?: Map<string, QProcessMetaData>;
+    reports?: Map<string, QReportMetaData>;
+    widgets?: Map<string, QWidgetMetaData>;
+    apps?: Map<string, QAppMetaData>;
+    appTree?: QAppTreeNode[];
+    branding?: QBrandingMetaData;
+    theme?: QThemeMetaData;
+    environmentValues?: Map<string, string>;
+    helpContent?: Map<string, QHelpContent[]>;
+    supplementalInstanceMetaData: Map<String, any>;
+    constructor(object: any);
+    /*******************************************************************************
+     ** Get the full path to an app
+     *******************************************************************************/
+    getAppPath(app: QAppMetaData): string | null;
+    /*******************************************************************************
+     ** Get the full path to a table
+     *******************************************************************************/
+    getTablePath(table: QTableMetaData): string | null;
+    /*******************************************************************************
+     ** Get the full path to a table
+     *******************************************************************************/
+    getTablePathByName(tableName: string): string | null;
+    /*******************************************************************************
+     **
+     *******************************************************************************/
+    private static searchAppTreeForPath;
+}