bruce-models 7.1.38 → 7.1.40

package/dist/bruce-models.umd.js

@@ -2292,6 +2292,25 @@
             });
         }
         AnnDocument.Get = Get;
+        /**
+         * Returns the client files available for downloading from an annotated document.
+         */
+        function GetFiles(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, docId, req: reqParams } = params;
+                if (!docId) {
+                    throw ("Doc ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const data = yield api.GET(`documentView/${docId}/files`, exports.Api.PrepReqParams(reqParams));
+                return {
+                    clientFiles: data.Items
+                };
+            });
+        }
+        AnnDocument.GetFiles = GetFiles;
         /**
          * Returns a list of annotated documents by type.
          * @param params
@@ -10754,6 +10773,7 @@
                 ExternalTilesetURL: (_l = (_k = record.Settings) === null || _k === void 0 ? void 0 : _k.etc) === null || _l === void 0 ? void 0 : _l.ExternalTilesetURL,
                 showAdvancedSettings: (_o = (_m = record.Settings) === null || _m === void 0 ? void 0 : _m.etc) === null || _o === void 0 ? void 0 : _o.showAdvancedSettings
             },
+            permission: record.Permission,
             // Not returned in legacy data.
             creationTime: newer === null || newer === void 0 ? void 0 : newer.creationTime,
             // Not returned in legacy data.
@@ -14548,6 +14568,187 @@
         UserMfaMethod.Verify = Verify;
     })(exports.UserMfaMethod || (exports.UserMfaMethod = {}));
 
+    (function (AccountConcept) {
+        let EConcept;
+        (function (EConcept) {
+            EConcept["ASSEMBLY"] = "a";
+            EConcept["ATTACHMENT_TYPE"] = "at";
+            EConcept["CHANGE_SET"] = "cs";
+            EConcept["CLIENT_FILE"] = "clf";
+            EConcept["CUSTOM_FORM"] = "csf";
+            EConcept["DATA_FEED"] = "df";
+            EConcept["DATA_LAB_QUERY"] = "q";
+            EConcept["DATA_LAB_QUERY_GROUP"] = "qg";
+            EConcept["DATA_SOURCE"] = "ds";
+            EConcept["DATA_TRANSFORM"] = "dt";
+            EConcept["DATA_VALIDATION"] = "dval";
+            EConcept["DOCUMENT_VIEW"] = "dv";
+            EConcept["ENTITY"] = "e";
+            EConcept["ENTITY_LOD"] = "el";
+            EConcept["ENTITY_RELATION"] = "er";
+            EConcept["ENTITY_TYPE"] = "et";
+            EConcept["ENTITY_TYPE_LOD"] = "etl";
+            EConcept["LAYER"] = "l";
+            EConcept["LOD_CATEGORY"] = "lc";
+            EConcept["PROGRAM_KEY"] = "pk";
+            EConcept["PROJECT_VIEW"] = "pv";
+            EConcept["RELATION_TYPE"] = "rt";
+            EConcept["SCENARIO"] = "sc";
+            EConcept["TILESET"] = "ts";
+            EConcept["UI_DASHBOARD_VIEW"] = "dbv";
+            EConcept["UI_ENTITY_DISPLAY_SETTING"] = "s";
+            EConcept["UI_PLUGIN"] = "pg";
+            EConcept["UI_SLIDE"] = "pvs";
+            EConcept["UI_SLIDE_GROUP"] = "sg";
+            EConcept["UI_TABLE_VIEW"] = "tv";
+        })(EConcept = AccountConcept.EConcept || (AccountConcept.EConcept = {}));
+        let EAction;
+        (function (EAction) {
+            // Manage is a squashed version of all CRUD perms.
+            // Helps avoid specifying all 4 CRUD perms as separate permission strings in a User Group.
+            EAction["MANAGE"] = "MANAGE";
+            // Manage own records only (eg: own draft bookmarks within a Project View).
+            // Only implemented for Bookmarks at the moment.
+            EAction["MANAGE_OWN"] = "MANAGE_OWN";
+            EAction["VIEW"] = "VIEW";
+            EAction["CREATE"] = "CREATE";
+            EAction["EDIT"] = "EDIT";
+            EAction["DELETE"] = "DELETE";
+        })(EAction = AccountConcept.EAction || (AccountConcept.EAction = {}));
+        function canCreate(perm) {
+            var _a;
+            return (_a = perm === null || perm === void 0 ? void 0 : perm.includes("C")) !== null && _a !== void 0 ? _a : false;
+        }
+        AccountConcept.canCreate = canCreate;
+        function canRead(perm) {
+            var _a;
+            return (_a = perm === null || perm === void 0 ? void 0 : perm.includes("R")) !== null && _a !== void 0 ? _a : false;
+        }
+        AccountConcept.canRead = canRead;
+        function canUpdate(perm) {
+            var _a;
+            return (_a = perm === null || perm === void 0 ? void 0 : perm.includes("U")) !== null && _a !== void 0 ? _a : false;
+        }
+        AccountConcept.canUpdate = canUpdate;
+        function canDelete(perm) {
+            var _a;
+            return (_a = perm === null || perm === void 0 ? void 0 : perm.includes("D")) !== null && _a !== void 0 ? _a : false;
+        }
+        AccountConcept.canDelete = canDelete;
+        AccountConcept.CONCEPTS = [
+            { concept: EConcept.ASSEMBLY, label: "Assembly", description: undefined },
+            { concept: EConcept.ATTACHMENT_TYPE, label: "Attachment Type", description: undefined },
+            { concept: EConcept.CHANGE_SET, label: "Change Set", description: undefined },
+            { concept: EConcept.CLIENT_FILE, label: "Client File", description: undefined },
+            { concept: EConcept.CUSTOM_FORM, label: "Custom Form", description: undefined },
+            { concept: EConcept.DATA_FEED, label: "Data Feed", description: undefined },
+            { concept: EConcept.DATA_LAB_QUERY, label: "DataLab Query", description: undefined },
+            { concept: EConcept.DATA_LAB_QUERY_GROUP, label: "DataLab Query Group", description: undefined },
+            { concept: EConcept.DATA_SOURCE, label: "Data Source", description: undefined },
+            { concept: EConcept.DATA_TRANSFORM, label: "Data Transform", description: undefined },
+            { concept: EConcept.DATA_VALIDATION, label: "Data Validation", description: undefined },
+            { concept: EConcept.DOCUMENT_VIEW, label: "Document View", description: undefined },
+            { concept: EConcept.ENTITY, label: "Entity", description: "Entities and their owned records (Attachments, Links, LODs, Relationships)" },
+            { concept: EConcept.ENTITY_LOD, label: "Entity LOD", description: undefined },
+            { concept: EConcept.ENTITY_RELATION, label: "Entity Relation", description: undefined },
+            { concept: EConcept.ENTITY_TYPE, label: "Entity Type", description: "Entity Types and their owned records (Entities, Relationships, LODs)" },
+            { concept: EConcept.ENTITY_TYPE_LOD, label: "Entity Type LOD", description: undefined },
+            { concept: EConcept.LAYER, label: "Tag", description: undefined },
+            { 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.SCENARIO, label: "Scenario", description: undefined },
+            { concept: EConcept.PROJECT_VIEW, label: "Project View", description: undefined },
+            { concept: EConcept.TILESET, label: "Tileset", description: undefined },
+            { concept: EConcept.UI_DASHBOARD_VIEW, label: "Dashboard View", description: undefined },
+            { concept: EConcept.UI_ENTITY_DISPLAY_SETTING, label: "Style", description: undefined },
+            { concept: EConcept.UI_PLUGIN, label: "Plugin", description: undefined },
+            { concept: EConcept.UI_SLIDE, label: "Bookmark", description: undefined },
+            { concept: EConcept.UI_SLIDE_GROUP, label: "Bookmark Group", description: undefined },
+            { concept: EConcept.UI_TABLE_VIEW, label: "Tabular View", description: undefined },
+        ];
+        /**
+         * Builds a concept permission string.
+         * Omit recordId for an account-wide permission, eg: "view:pv".
+         * Pass recordId for a record-specific permission, eg: "view:pv:abc123".
+         */
+        function buildPermission(action, concept, recordId) {
+            const base = `${action.toLowerCase()}:${concept}`;
+            return recordId ? `${base}:${recordId}` : base;
+        }
+        AccountConcept.buildPermission = buildPermission;
+        /**
+         * Parses a concept permission string back to its components.
+         * Returns null for legacy permissions (no ':') or unrecognised strings.
+         */
+        function parsePermission(perm) {
+            if (!perm || !perm.includes(":")) {
+                return null;
+            }
+            const lower = perm.toLowerCase().trim();
+            const firstColon = lower.indexOf(":");
+            const actionStr = lower.substring(0, firstColon);
+            let matchedAction;
+            for (const a of Object.values(EAction)) {
+                if (a.toLowerCase() === actionStr) {
+                    matchedAction = a;
+                    break;
+                }
+            }
+            if (!matchedAction) {
+                return null;
+            }
+            const rest = lower.substring(firstColon + 1);
+            // Longest-match prevents "e" matching the start of "el:abc".
+            let matchedConcept;
+            let matchedLen = 0;
+            for (const token of Object.values(EConcept)) {
+                if (token.length > matchedLen && (rest === token || rest.startsWith(token + ":"))) {
+                    matchedConcept = token;
+                    matchedLen = token.length;
+                }
+            }
+            if (!matchedConcept) {
+                return null;
+            }
+            const recordId = rest.length > matchedLen ? rest.substring(matchedLen + 1) : undefined;
+            return {
+                action: matchedAction,
+                concept: matchedConcept,
+                recordId
+            };
+        }
+        AccountConcept.parsePermission = parsePermission;
+        /**
+         * Returns the concept-level CRUD permission rubric for the current session.
+         * Only concepts where the user has at least one permission are included.
+         */
+        function GetPermissions(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!params)
+                    params = {};
+                let { api, req } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                req = exports.Api.PrepReqParams(req);
+                const rubric = {};
+                const data = yield api.GET("permissions", req);
+                if (data) {
+                    for (const [token, permStr] of Object.entries(data)) {
+                        if (typeof permStr === "string") {
+                            rubric[token] = permStr;
+                        }
+                    }
+                }
+                return {
+                    rubric
+                };
+            });
+        }
+        AccountConcept.GetPermissions = GetPermissions;
+    })(exports.AccountConcept || (exports.AccountConcept = {}));
+
     (function (AccountInvite) {
         /**
          * Possible invite statuses.
@@ -17974,7 +18175,7 @@
     })(exports.ChangeSet || (exports.ChangeSet = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.38";
+    const VERSION = "7.1.40";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;