bruce-models 7.1.96 → 7.1.97

package/dist/bruce-models.es5.js

@@ -372,6 +372,9 @@ var AccountConcept;
         // Manage own records only (eg: own draft bookmarks within a Project View).
         // Only implemented for Bookmarks at the moment.
         EAction["MANAGE_OWN"] = "MANAGE_OWN";
+        // Full CRUD over every record this one owns, and nothing on this record beyond reading it.
+        // Eg: "manage_content:et:<id>" manages that type's Entities without editing the type.
+        EAction["MANAGE_CONTENT"] = "MANAGE_CONTENT";
         EAction["VIEW"] = "VIEW";
         EAction["CREATE"] = "CREATE";
         EAction["EDIT"] = "EDIT";
@@ -434,10 +437,16 @@ var AccountConcept;
      * 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".
+     * Pass ownedConcept to narrow it to one kind of record that record owns,
+     * eg: "edit:et:abc123:e" for that Entity Type's Entities and nothing else.
      */
-    function buildPermission(action, concept, recordId) {
+    function buildPermission(action, concept, recordId, ownedConcept) {
         const base = `${action.toLowerCase()}:${concept}`;
-        return recordId ? `${base}:${recordId}` : base;
+        if (!recordId) {
+            return base;
+        }
+        const record = `${base}:${recordId}`;
+        return ownedConcept ? `${record}:${ownedConcept}` : record;
     }
     AccountConcept.buildPermission = buildPermission;
     /**
@@ -474,11 +483,27 @@ var AccountConcept;
         if (!matchedConcept) {
             return null;
         }
-        const recordId = rest.length > matchedLen ? rest.substring(matchedLen + 1) : undefined;
+        const tail = rest.length > matchedLen ? rest.substring(matchedLen + 1) : undefined;
+        // A fourth segment narrows the grant to one kind of record the named record owns.
+        // Anything that is not a concept token stays part of the record ID.
+        let recordId = tail;
+        let ownedConcept;
+        if (tail) {
+            const lastColon = tail.lastIndexOf(":");
+            if (lastColon > 0) {
+                const candidate = tail.substring(lastColon + 1);
+                const matched = Object.values(EConcept).find(t => t === candidate);
+                if (matched) {
+                    ownedConcept = matched;
+                    recordId = tail.substring(0, lastColon);
+                }
+            }
+        }
         return {
             action: matchedAction,
             concept: matchedConcept,
-            recordId
+            recordId,
+            ownedConcept
         };
     }
     AccountConcept.parsePermission = parsePermission;
@@ -2935,6 +2960,20 @@ var AccountFeatures;
  */
 var AccountInvite;
 (function (AccountInvite) {
+    // Error type returned when inviting a user who already has access to the account.
+    // Their group membership is changed directly rather than offered to them.
+    AccountInvite.ERROR_ALREADY_MEMBER = "AlreadyMember";
+    /**
+     * Returns whether a failed Create was refused because the user is already in the account.
+     * @param error the value thrown by Create.
+     * @returns
+     */
+    function IsAlreadyMemberError(error) {
+        var _a, _b;
+        const type = (_b = (_a = error === null || error === void 0 ? void 0 : error.ERROR) === null || _a === void 0 ? void 0 : _a.Type) !== null && _b !== void 0 ? _b : error === null || error === void 0 ? void 0 : error.Type;
+        return type === AccountInvite.ERROR_ALREADY_MEMBER;
+    }
+    AccountInvite.IsAlreadyMemberError = IsAlreadyMemberError;
     /**
      * Possible invite statuses.
      */
@@ -2945,6 +2984,8 @@ var AccountInvite;
         EStatus["Sent"] = "Sent";
         EStatus["NotSent"] = "Not sent";
         EStatus["Accepted"] = "Accepted";
+        // Closed because the user accepted another invite to the same account.
+        EStatus["Superseded"] = "Superseded";
     })(EStatus = AccountInvite.EStatus || (AccountInvite.EStatus = {}));
     /**
      * Returns whether an invite is still awaiting a response from its recipient.
@@ -2959,6 +3000,16 @@ var AccountInvite;
         return invite.Status === EStatus.Sent || invite.Status === EStatus.NotSent;
     }
     AccountInvite.IsPending = IsPending;
+    /**
+     * Ways an invited user can prove they are who the invitation was addressed to.
+     */
+    let EIdentityProof;
+    (function (EIdentityProof) {
+        // Confirming the password they already hold.
+        EIdentityProof["Password"] = "Password";
+        // Signing in, by whichever method their account allows, and returning.
+        EIdentityProof["Session"] = "Session";
+    })(EIdentityProof = AccountInvite.EIdentityProof || (AccountInvite.EIdentityProof = {}));
     /**
      * Possible invite methods.
      */
@@ -2995,6 +3046,66 @@ var AccountInvite;
         });
     }
     AccountInvite.GetByCode = GetByCode;
+    /**
+     * Returns one invite by its ID. Requires the session to be an account owner or admin.
+     * @param params
+     * @returns
+     */
+    function GetByID(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, id, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetGuardianApi();
+            }
+            const invite = yield api.GET(`v3/accountInvite/${id}`, Api.PrepReqParams(req));
+            return {
+                invite: invite
+            };
+        });
+    }
+    AccountInvite.GetByID = GetByID;
+    /**
+     * Returns a list of invites grouped by the invited user.
+     * Paging covers users rather than invites, so a user's invitations never straddle a page.
+     * @param params
+     * @returns
+     */
+    function GetListByUser(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield GetList(Object.assign(Object.assign({}, params), { groupByUser: true }));
+            return {
+                users: res.invites,
+                totalCount: res.totalCount,
+                hasNextPage: res.hasNextPage,
+                userGroups: res.userGroups
+            };
+        });
+    }
+    AccountInvite.GetListByUser = GetListByUser;
+    /**
+     * Re-delivers an invitation that is still open, renewing its code and expiry.
+     * @param params
+     * @returns
+     */
+    function Resend(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, id, emailTemplateKey, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetGuardianApi();
+            }
+            if (!id) {
+                throw new Error("An invite ID must be provided.");
+            }
+            const invite = yield api.POST("v3/resendAccountInvite", {
+                ID: id,
+                "Email.Template": emailTemplateKey
+            }, Api.PrepReqParams(req));
+            return {
+                invite: invite
+            };
+        });
+    }
+    AccountInvite.Resend = Resend;
     /**
      * Returns a list of invites matching provided criteria.
      * For example you can get a list of invites for a specific account or user (or both).
@@ -3003,7 +3114,7 @@ var AccountInvite;
      */
     function GetList(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, accountId, userId, status, expired, expandUsers, expandGroups, pageSize, pageIndex, req } = params;
+            let { api, accountId, userId, status, expired, expandUsers, expandGroups, groupByUser, pageSize, pageIndex, req } = params;
             if (!api) {
                 api = ENVIRONMENT.Api().GetGuardianApi();
             }
@@ -3030,6 +3141,9 @@ var AccountInvite;
             if (expand.length) {
                 urlParams.append("Expand", expand.join(","));
             }
+            if (groupByUser) {
+                urlParams.append("GroupBy", "User");
+            }
             if (pageSize !== undefined && pageSize !== null) {
                 urlParams.append("PageSize", String(pageSize));
             }
@@ -3066,19 +3180,23 @@ var AccountInvite;
      */
     function Update(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, code, id, status, groupIds, user, req } = params;
+            let { api, code, id, status, groupIds, user, password, req } = params;
             if (!api) {
                 api = ENVIRONMENT.Api().GetGuardianApi();
             }
             if (!code && !id) {
                 throw new Error("Either an invite ID or InviteCode must be provided.");
             }
+            if (!status && !groupIds) {
+                throw new Error("Either a status or User Groups must be provided.");
+            }
             const invite = yield api.POST("v3/accountInvite", {
                 ID: id,
                 InviteCode: code,
                 Status: status,
                 "UserGroup.ID": groupIds,
-                User: user
+                User: user,
+                Password: password
             }, Api.PrepReqParams(req));
             return {
                 invite: invite
@@ -22831,8 +22949,8 @@ var User;
         function ForgotPassword(params) {
             return __awaiter(this, void 0, void 0, function* () {
                 let { api, accountId, email, req: reqParams } = params;
-                if (!accountId || !email) {
-                    throw ("Account ID and email are required.");
+                if (!email) {
+                    throw new Error("An email address is required.");
                 }
                 if (!api) {
                     api = ENVIRONMENT.Api().GetGuardianApi();
@@ -22841,21 +22959,9 @@ var User;
                 if (accountId) {
                     url += "?Account=" + accountId;
                 }
-                const req = api.POST(url, {
+                yield api.POST(url, {
                     Email: email
                 }, reqParams);
-                const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const data = yield req;
-                        res({
-                            userId: data.ID
-                        });
-                    }
-                    catch (e) {
-                        rej(e);
-                    }
-                }));
-                return prom;
             });
         }
         LoginUser.ForgotPassword = ForgotPassword;
@@ -22866,22 +22972,29 @@ var User;
          */
         function ForgotPasswordComplete(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, code, userId, password, req: reqParams } = params;
+                let { api, code, email, userId, password, req: reqParams } = params;
                 if (!api) {
                     api = ENVIRONMENT.Api().GetGuardianApi();
                 }
-                const { user } = yield Get({
-                    api: api,
-                    userId: userId,
-                    accountId: "",
-                    req: reqParams
-                });
+                if (!email && !userId) {
+                    throw new Error("Either an email or a user ID must be provided.");
+                }
+                // Callers holding only an ID still need the address resolved, but a caller that already
+                // knows it should not have to read the user record back to reset a password.
+                if (!email && userId) {
+                    const { user } = yield Get({
+                        api: api,
+                        userId: userId,
+                        accountId: "",
+                        req: reqParams
+                    });
+                    email = user.Email;
+                }
                 const res = yield api.POST("v3/userForgotPassword/complete", {
                     ID: userId,
-                    Email: user.Email,
+                    Email: email,
                     ActivationCode: code,
-                    Password: password,
-                    FullName: user.FullName
+                    Password: password
                 }, reqParams);
                 return {
                     user: res
@@ -23536,7 +23649,7 @@ var UrlUtils;
 })(UrlUtils || (UrlUtils = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.96";
+const VERSION = "7.1.97";
 
 export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, ClientFileValueMap, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, 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, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportNsx, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportTif, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
 //# sourceMappingURL=bruce-models.es5.js.map