bruce-models 7.1.129 → 7.1.130

package/dist/bruce-models.umd.js

@@ -51,6 +51,8 @@
             ECacheKey["DataFeed"] = "datafeed";
             ECacheKey["ProjectView"] = "projectview";
             ECacheKey["ProjectViewBookmark"] = "pvbookmark";
+            ECacheKey["ReportTemplate"] = "reporttemplate";
+            ECacheKey["ReportTemplateSection"] = "reporttemplatesection";
             ECacheKey["Tileset"] = "tileset";
             ECacheKey["ClientFile"] = "clientfile";
             ECacheKey["ClientFileFolder"] = "clientfilefolder";
@@ -362,6 +364,9 @@
             EConcept["PROJECT_VIEW"] = "pv";
             EConcept["PENDING_ACTION"] = "pa";
             EConcept["RELATION_TYPE"] = "rt";
+            // Reusable report definitions and their individually permissioned sections.
+            EConcept["REPORT_TEMPLATE"] = "rpt";
+            EConcept["REPORT_TEMPLATE_SECTION"] = "rpts";
             EConcept["SCENARIO"] = "sc";
             EConcept["TILESET"] = "ts";
             EConcept["UI_DASHBOARD_VIEW"] = "dbv";
@@ -436,6 +441,8 @@
             { concept: EConcept.LOD_CATEGORY, label: "LOD Category", description: undefined },
             { concept: EConcept.PROGRAM_KEY, label: "Third Party Key", description: undefined },
             { concept: EConcept.RELATION_TYPE, label: "Relation Type", description: undefined },
+            { concept: EConcept.REPORT_TEMPLATE, label: "Report Template", description: "Reusable report definitions with ordered sections" },
+            { concept: EConcept.REPORT_TEMPLATE_SECTION, label: "Report Template Section", description: "Ordered sections belonging to a Report Template" },
             { concept: EConcept.SCENARIO, label: "Scenario", description: undefined },
             { concept: EConcept.PROJECT_VIEW, label: "Project View", description: undefined },
             { concept: EConcept.TILESET, label: "Tileset", description: undefined },
@@ -710,6 +717,10 @@
                     return [exports.Api.ECacheKey.ProjectView, exports.Api.ECacheKey.ProjectViewBookmark];
                 case exports.AccountConcept.EConcept.RELATION_TYPE:
                     return [exports.Api.ECacheKey.RelationType];
+                case exports.AccountConcept.EConcept.REPORT_TEMPLATE:
+                    return [exports.Api.ECacheKey.ReportTemplate, exports.Api.ECacheKey.ReportTemplateSection];
+                case exports.AccountConcept.EConcept.REPORT_TEMPLATE_SECTION:
+                    return [exports.Api.ECacheKey.ReportTemplateSection];
                 case exports.AccountConcept.EConcept.WORKFLOW_ITEM:
                     return [exports.Api.ECacheKey.WorkflowItem];
                 case exports.AccountConcept.EConcept.WORKFLOW_ITEM_STATUS:
@@ -743,6 +754,14 @@
             if (!cacheKeys.length) {
                 return;
             }
+            if (event.concept === exports.AccountConcept.EConcept.REPORT_TEMPLATE ||
+                event.concept === exports.AccountConcept.EConcept.REPORT_TEMPLATE_SECTION) {
+                // Events can contain ID ranges and omit section parents; evict the affected namespaces in full.
+                for (const cacheKey of cacheKeys) {
+                    cache.RemoveByCallback(key => key === cacheKey || String(key).startsWith(cacheKey + exports.Api.ECacheKey.Id));
+                }
+                return;
+            }
             // Entity-concept events use internal ID ranges, not public record IDs,
             // so individual entity cache entries cannot be matched.
             const isEntityConcept = event.concept === ENTITY_CONCEPT;
@@ -22445,6 +22464,214 @@
         ];
     })(exports.ProjectViewTile || (exports.ProjectViewTile = {}));
 
+    (function (ReportTemplate) {
+        /**
+         * Validates and normalizes a signed 64-bit identity for routes and cache keys without rounding it.
+         * Zero is accepted only for creation; decimal strings can represent the full positive bigint range.
+         */
+        function NormalizeId(id, allowZero = false) {
+            if (typeof id === "number" && (!Number.isSafeInteger(id) || id < 0)) {
+                throw new Error("Report Template ID must be a safe integer or a decimal string for a larger bigint ID.");
+            }
+            if ((typeof id !== "number" && typeof id !== "string") || !/^\d+$/.test(String(id))) {
+                throw new Error("Report Template ID must be a non-negative decimal integer.");
+            }
+            const value = String(id).replace(/^0+(?=\d)/, "");
+            if ((!allowZero && value === "0") || value.length > 19 ||
+                (value.length === 19 && value > "9223372036854775807")) {
+                throw new Error("Report Template ID must be a positive signed 64-bit integer; use 0 only to create.");
+            }
+            return value;
+        }
+        ReportTemplate.NormalizeId = NormalizeId;
+        /**
+         * Reads a template by ID, subject to the caller's template view permission.
+         */
+        function Get(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const id = NormalizeId(params.reportTemplateId);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const key = GetCacheKey(id);
+                const cache = api.GetCacheItem(key, params.req);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const promise = api.GET(`reportTemplate/${id}`, exports.Api.PrepReqParams(params.req))
+                    .then(reportTemplate => ({ reportTemplate }));
+                api.SetCacheItem({ key, value: promise, req: params.req });
+                return promise;
+            });
+        }
+        ReportTemplate.Get = Get;
+        /**
+         * Lists visible templates in name order; the server filters out records the caller cannot view.
+         */
+        function GetList(params = {}) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const key = GetListCacheKey();
+                const cache = api.GetCacheItem(key, params.req);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const promise = api.GET("reportTemplates", exports.Api.PrepReqParams(params.req))
+                    .then(data => { var _a; return ({ reportTemplates: (_a = data === null || data === void 0 ? void 0 : data.Items) !== null && _a !== void 0 ? _a : [] }); });
+                api.SetCacheItem({ key, value: promise, req: params.req });
+                return promise;
+            });
+        }
+        ReportTemplate.GetList = GetList;
+        /**
+         * Creates with ID 0 or updates the identified template, preserving omitted fields on the server.
+         * Explicit null clears Description or Settings; identity and creation metadata come from the server.
+         */
+        function Update(params) {
+            var _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!params.reportTemplate) {
+                    throw new Error("Report Template data is required.");
+                }
+                const id = NormalizeId(params.reportTemplateId !== undefined
+                    ? params.reportTemplateId : (_a = params.reportTemplate.ID) !== null && _a !== void 0 ? _a : 0, true);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const reportTemplate = yield api.POST(`reportTemplate/${id}`, params.reportTemplate, exports.Api.PrepReqParams(params.req));
+                api.Cache.Remove(GetCacheKey(id));
+                if (reportTemplate === null || reportTemplate === void 0 ? void 0 : reportTemplate.ID) {
+                    api.Cache.Remove(GetCacheKey(reportTemplate.ID));
+                }
+                api.Cache.Remove(GetListCacheKey());
+                return { reportTemplate };
+            });
+        }
+        ReportTemplate.Update = Update;
+        /**
+         * Deletes a template and every section it owns; requires template delete permission.
+         */
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const id = NormalizeId(params.reportTemplateId);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                yield api.DELETE(`reportTemplate/${id}`, exports.Api.PrepReqParams(params.req));
+                api.Cache.Remove(GetCacheKey(id));
+                api.Cache.Remove(GetListCacheKey());
+                const sectionsKey = `${exports.Api.ECacheKey.ReportTemplateSection}${exports.Api.ECacheKey.Id}${id}`;
+                api.Cache.Remove(sectionsKey);
+                api.Cache.RemoveByStartsWith(`${sectionsKey}${exports.Api.ECacheKey.Id}`);
+            });
+        }
+        ReportTemplate.Delete = Delete;
+        /**
+         * Cache identifier for one template, shared by numeric IDs and their decimal string equivalents.
+         */
+        function GetCacheKey(reportTemplateId) {
+            return `${exports.Api.ECacheKey.ReportTemplate}${exports.Api.ECacheKey.Id}${NormalizeId(reportTemplateId, true)}`;
+        }
+        ReportTemplate.GetCacheKey = GetCacheKey;
+        /**
+         * Cache identifier for the account's visible template list.
+         */
+        function GetListCacheKey() {
+            return exports.Api.ECacheKey.ReportTemplate;
+        }
+        ReportTemplate.GetListCacheKey = GetListCacheKey;
+    })(exports.ReportTemplate || (exports.ReportTemplate = {}));
+
+    (function (ReportTemplateSection) {
+        /**
+         * Reads one section; a section belonging to another template is rejected by the server.
+         */
+        function Get(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const templateId = exports.ReportTemplate.NormalizeId(params.reportTemplateId);
+                const sectionId = exports.ReportTemplate.NormalizeId(params.sectionId);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const key = GetCacheKey(templateId, sectionId);
+                const cache = api.GetCacheItem(key, params.req);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const promise = api.GET(`reportTemplate/${templateId}/section/${sectionId}`, exports.Api.PrepReqParams(params.req))
+                    .then(reportTemplateSection => ({ reportTemplateSection }));
+                api.SetCacheItem({ key, value: promise, req: params.req });
+                return promise;
+            });
+        }
+        ReportTemplateSection.Get = Get;
+        /**
+         * Lists visible sections of a template in display order, filtered by the caller's permissions.
+         */
+        function GetList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const templateId = exports.ReportTemplate.NormalizeId(params.reportTemplateId);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const key = GetListCacheKey(templateId);
+                const cache = api.GetCacheItem(key, params.req);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const promise = api.GET(`reportTemplate/${templateId}/sections`, exports.Api.PrepReqParams(params.req))
+                    .then(data => { var _a; return ({ reportTemplateSections: (_a = data === null || data === void 0 ? void 0 : data.Items) !== null && _a !== void 0 ? _a : [] }); });
+                api.SetCacheItem({ key, value: promise, req: params.req });
+                return promise;
+            });
+        }
+        ReportTemplateSection.GetList = GetList;
+        /**
+         * Creates with section ID 0 or updates under an existing parent; Settings accepts null to clear it.
+         * The server ignores body IDs, preserves omitted fields and never moves a section to another parent.
+         */
+        function Update(params) {
+            var _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!params.reportTemplateSection) {
+                    throw new Error("Report Template Section data is required.");
+                }
+                const section = params.reportTemplateSection;
+                const templateId = exports.ReportTemplate.NormalizeId(params.reportTemplateId !== undefined
+                    ? params.reportTemplateId : section["ReportTemplate.ID"]);
+                const sectionId = exports.ReportTemplate.NormalizeId(params.sectionId !== undefined
+                    ? params.sectionId : (_a = section.ID) !== null && _a !== void 0 ? _a : 0, true);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                const reportTemplateSection = yield api.POST(`reportTemplate/${templateId}/section/${sectionId}`, section, exports.Api.PrepReqParams(params.req));
+                api.Cache.Remove(GetCacheKey(templateId, sectionId));
+                if (reportTemplateSection === null || reportTemplateSection === void 0 ? void 0 : reportTemplateSection.ID) {
+                    api.Cache.Remove(GetCacheKey(templateId, reportTemplateSection.ID));
+                }
+                api.Cache.Remove(GetListCacheKey(templateId));
+                return { reportTemplateSection };
+            });
+        }
+        ReportTemplateSection.Update = Update;
+        /**
+         * Deletes only the identified section, preserving its template and sibling sections.
+         */
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const templateId = exports.ReportTemplate.NormalizeId(params.reportTemplateId);
+                const sectionId = exports.ReportTemplate.NormalizeId(params.sectionId);
+                const api = params.api || exports.ENVIRONMENT.Api().GetBruceApi();
+                yield api.DELETE(`reportTemplate/${templateId}/section/${sectionId}`, exports.Api.PrepReqParams(params.req));
+                api.Cache.Remove(GetCacheKey(templateId, sectionId));
+                api.Cache.Remove(GetListCacheKey(templateId));
+            });
+        }
+        ReportTemplateSection.Delete = Delete;
+        /**
+         * Cache identifier scoped to both parent and section, so another parent's read cannot reuse it.
+         */
+        function GetCacheKey(reportTemplateId, sectionId) {
+            return `${GetListCacheKey(reportTemplateId)}${exports.Api.ECacheKey.Id}${exports.ReportTemplate.NormalizeId(sectionId, true)}`;
+        }
+        ReportTemplateSection.GetCacheKey = GetCacheKey;
+        /**
+         * Cache identifier for one template's visible section list.
+         */
+        function GetListCacheKey(reportTemplateId) {
+            return `${exports.Api.ECacheKey.ReportTemplateSection}${exports.Api.ECacheKey.Id}${exports.ReportTemplate.NormalizeId(reportTemplateId)}`;
+        }
+        ReportTemplateSection.GetListCacheKey = GetListCacheKey;
+    })(exports.ReportTemplateSection || (exports.ReportTemplateSection = {}));
+
     (function (Scenario) {
         /**
          * Returns a scenario record matching the provided ID or Key.
@@ -25551,7 +25778,7 @@
     }
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.129";
+    const VERSION = "7.1.130";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;