bruce-models 7.1.129 → 7.1.130

package/dist/bruce-models.es5.js

@@ -46,6 +46,8 @@ var Api;
         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 @@ var AccountConcept;
         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 @@ var AccountConcept;
         { 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 },
@@ -715,6 +722,10 @@ var RecordChangeFeed;
                 return [Api.ECacheKey.ProjectView, Api.ECacheKey.ProjectViewBookmark];
             case AccountConcept.EConcept.RELATION_TYPE:
                 return [Api.ECacheKey.RelationType];
+            case AccountConcept.EConcept.REPORT_TEMPLATE:
+                return [Api.ECacheKey.ReportTemplate, Api.ECacheKey.ReportTemplateSection];
+            case AccountConcept.EConcept.REPORT_TEMPLATE_SECTION:
+                return [Api.ECacheKey.ReportTemplateSection];
             case AccountConcept.EConcept.WORKFLOW_ITEM:
                 return [Api.ECacheKey.WorkflowItem];
             case AccountConcept.EConcept.WORKFLOW_ITEM_STATUS:
@@ -748,6 +759,14 @@ var RecordChangeFeed;
         if (!cacheKeys.length) {
             return;
         }
+        if (event.concept === AccountConcept.EConcept.REPORT_TEMPLATE ||
+            event.concept === 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 + 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;
@@ -22786,6 +22805,224 @@ var ProjectViewTile;
     ];
 })(ProjectViewTile || (ProjectViewTile = {}));
 
+/**
+ * Reusable report definitions whose ordered sections are separate ReportTemplateSection records.
+ * These calls require an API deployment that supports the Report Template concepts.
+ */
+var ReportTemplate;
+(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 || 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}`, 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 || 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", 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 || ENVIRONMENT.Api().GetBruceApi();
+            const reportTemplate = yield api.POST(`reportTemplate/${id}`, params.reportTemplate, 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 || ENVIRONMENT.Api().GetBruceApi();
+            yield api.DELETE(`reportTemplate/${id}`, Api.PrepReqParams(params.req));
+            api.Cache.Remove(GetCacheKey(id));
+            api.Cache.Remove(GetListCacheKey());
+            const sectionsKey = `${Api.ECacheKey.ReportTemplateSection}${Api.ECacheKey.Id}${id}`;
+            api.Cache.Remove(sectionsKey);
+            api.Cache.RemoveByStartsWith(`${sectionsKey}${Api.ECacheKey.Id}`);
+        });
+    }
+    ReportTemplate.Delete = Delete;
+    /**
+     * Cache identifier for one template, shared by numeric IDs and their decimal string equivalents.
+     */
+    function GetCacheKey(reportTemplateId) {
+        return `${Api.ECacheKey.ReportTemplate}${Api.ECacheKey.Id}${NormalizeId(reportTemplateId, true)}`;
+    }
+    ReportTemplate.GetCacheKey = GetCacheKey;
+    /**
+     * Cache identifier for the account's visible template list.
+     */
+    function GetListCacheKey() {
+        return Api.ECacheKey.ReportTemplate;
+    }
+    ReportTemplate.GetListCacheKey = GetListCacheKey;
+})(ReportTemplate || (ReportTemplate = {}));
+
+/**
+ * Ordered sections belonging to a single Report Template; every route requires the owning template ID.
+ * Access can be granted directly or inherited through the parent template's permissions.
+ */
+var ReportTemplateSection;
+(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 = ReportTemplate.NormalizeId(params.reportTemplateId);
+            const sectionId = ReportTemplate.NormalizeId(params.sectionId);
+            const api = params.api || 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}`, 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 = ReportTemplate.NormalizeId(params.reportTemplateId);
+            const api = params.api || 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`, 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 = ReportTemplate.NormalizeId(params.reportTemplateId !== undefined
+                ? params.reportTemplateId : section["ReportTemplate.ID"]);
+            const sectionId = ReportTemplate.NormalizeId(params.sectionId !== undefined
+                ? params.sectionId : (_a = section.ID) !== null && _a !== void 0 ? _a : 0, true);
+            const api = params.api || ENVIRONMENT.Api().GetBruceApi();
+            const reportTemplateSection = yield api.POST(`reportTemplate/${templateId}/section/${sectionId}`, section, 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 = ReportTemplate.NormalizeId(params.reportTemplateId);
+            const sectionId = ReportTemplate.NormalizeId(params.sectionId);
+            const api = params.api || ENVIRONMENT.Api().GetBruceApi();
+            yield api.DELETE(`reportTemplate/${templateId}/section/${sectionId}`, 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)}${Api.ECacheKey.Id}${ReportTemplate.NormalizeId(sectionId, true)}`;
+    }
+    ReportTemplateSection.GetCacheKey = GetCacheKey;
+    /**
+     * Cache identifier for one template's visible section list.
+     */
+    function GetListCacheKey(reportTemplateId) {
+        return `${Api.ECacheKey.ReportTemplateSection}${Api.ECacheKey.Id}${ReportTemplate.NormalizeId(reportTemplateId)}`;
+    }
+    ReportTemplateSection.GetListCacheKey = GetListCacheKey;
+})(ReportTemplateSection || (ReportTemplateSection = {}));
+
 /**
  * A scenario is a way to manage alternative states for Entities.
  * Once a scenario is made, you can use its ID to create/update an Entity record without affecting the primary state.
@@ -25949,7 +26186,7 @@ function getFirstWrappedArray(data, wrapperKeys) {
 }
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.129";
+const VERSION = "7.1.130";
 
-export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, ClientFileFolder, ClientFileValueMap, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, RequestLane, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeSource, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportNsx, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportTif, ImportedFile, Uploader, Markup, UIMarkup, NavigatorChatClient, NAVIGATOR_CHAT_RPC_METHOD_CHAT_EVENT, NAVIGATOR_CHAT_RPC_METHOD_SERVER_READY, NAVIGATOR_CHAT_RPC_METHOD_SERVER_READY_ACK, NAVIGATOR_CHAT_RPC_METHOD_TOOLS_CALL, NAVIGATOR_CHAT_RPC_METHOD_TOOL_RESPONSE, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NAVIGATOR_CHAT_EVENT_PRESENTATION_PLAN_APPLIED, NAVIGATOR_CHAT_LEGACY_EVENT_SESSION_CLEARED, NAVIGATOR_CHAT_STEP_TRACKING_UPDATE, NAVIGATOR_CHAT_STEP_JOB_COMPLETE, NAVIGATOR_CHAT_STEP_QUEUED_INPUT, NAVIGATOR_CHAT_STEP_LLM_CONTEXT, NAVIGATOR_CHAT_TRACKING_KIND_PRESENTATION_PLAN, NAVIGATOR_CHAT_CANCELLED_JOB_STATUSES, isNavigatorChatClientEventType, isNavigatorChatCancelledJobStatus, buildNavigatorChatEventMessage, parseNavigatorChatServerMessage, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserAccessLog, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, WorkflowItem, WorkflowSchedule, WorkflowType, WorkflowItemType };
+export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, ClientFileFolder, ClientFileValueMap, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, RequestLane, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeSource, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportNsx, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportTif, ImportedFile, Uploader, Markup, UIMarkup, NavigatorChatClient, NAVIGATOR_CHAT_RPC_METHOD_CHAT_EVENT, NAVIGATOR_CHAT_RPC_METHOD_SERVER_READY, NAVIGATOR_CHAT_RPC_METHOD_SERVER_READY_ACK, NAVIGATOR_CHAT_RPC_METHOD_TOOLS_CALL, NAVIGATOR_CHAT_RPC_METHOD_TOOL_RESPONSE, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NAVIGATOR_CHAT_EVENT_PRESENTATION_PLAN_APPLIED, NAVIGATOR_CHAT_LEGACY_EVENT_SESSION_CLEARED, NAVIGATOR_CHAT_STEP_TRACKING_UPDATE, NAVIGATOR_CHAT_STEP_JOB_COMPLETE, NAVIGATOR_CHAT_STEP_QUEUED_INPUT, NAVIGATOR_CHAT_STEP_LLM_CONTEXT, NAVIGATOR_CHAT_TRACKING_KIND_PRESENTATION_PLAN, NAVIGATOR_CHAT_CANCELLED_JOB_STATUSES, isNavigatorChatClientEventType, isNavigatorChatCancelledJobStatus, buildNavigatorChatEventMessage, parseNavigatorChatServerMessage, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, ReportTemplate, ReportTemplateSection, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserAccessLog, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, WorkflowItem, WorkflowSchedule, WorkflowType, WorkflowItemType };
 //# sourceMappingURL=bruce-models.es5.js.map