bruce-models 5.4.5 → 5.4.7

package/dist/bruce-models.umd.js

@@ -625,9 +625,11 @@
                 }
             }
             formatApiUri(uri) {
-                const wsProtocol = window.document.location.protocol === "https:" ? "wss" : "ws";
                 const currentUrl = new URL(uri);
-                let full = wsProtocol + "://" + currentUrl.host + currentUrl.pathname + "websocket";
+                // Protocol matching the Bruce API one.
+                // In almost all cases it will be wss, in a localhost BruceAPI then it might be ws.
+                const protocol = currentUrl.protocol === "http:" ? "ws:" : "wss:";
+                let full = protocol + "://" + currentUrl.host + currentUrl.pathname + "websocket";
                 // Check if we have a queryParam for accountId.
                 const accountId = currentUrl.searchParams.get("accountId");
                 if (accountId) {
@@ -10820,6 +10822,7 @@
             EAppId["BruceApi"] = "BruceAPI";
             EAppId["Navigator"] = "Navigator";
             EAppId["Operator"] = "BruceClientAdmin";
+            EAppId["UI"] = "UI";
         })(EAppId = Account.EAppId || (Account.EAppId = {}));
         /**
          * Possible starter content options.
@@ -10923,15 +10926,15 @@
          */
         function GetRelatedList(params) {
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, req: reqParams } = params;
+                let { api, req: reqParams, owned } = params;
                 if (!api) {
                     api = exports.ENVIRONMENT.Api().GetGuardianApi();
                 }
-                const cache = api.GetCacheItem(GetListCacheKey(api.GetSessionId()), reqParams);
+                const cache = api.GetCacheItem(GetListCacheKey(api.GetSessionId(), owned), reqParams);
                 if (cache === null || cache === void 0 ? void 0 : cache.found) {
                     return cache.data;
                 }
-                const req = api.GET("user/relatedClientAccounts", reqParams);
+                const req = api.GET(owned ? "user/ownedClientAccounts" : "user/relatedClientAccounts", reqParams);
                 const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
                     try {
                         const data = yield req;
@@ -10945,7 +10948,7 @@
                     }
                 }));
                 api.SetCacheItem({
-                    key: GetListCacheKey(api.GetSessionId()),
+                    key: GetListCacheKey(api.GetSessionId(), owned),
                     value: prom,
                     req: reqParams
                 });
@@ -11037,7 +11040,7 @@
                 const resData = {
                     account: res
                 };
-                api.Cache.Remove(GetListCacheKey(api.GetSessionId()));
+                api.Cache.RemoveByStartsWith(GetListCacheKey(api.GetSessionId()));
                 return resData;
             });
         }
@@ -11091,8 +11094,11 @@
          * @param ssid
          * @returns
          */
-        function GetListCacheKey(ssid) {
-            return exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Session + exports.Api.ECacheKey.Id + ssid;
+        function GetListCacheKey(ssid, owned) {
+            if (!owned) {
+                owned = false;
+            }
+            return exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Session + exports.Api.ECacheKey.Id + ssid + exports.Api.ECacheKey.Id + (owned ? "owned" : "related");
         }
         Account.GetListCacheKey = GetListCacheKey;
         /**
@@ -11595,153 +11601,6 @@
         }
     })(exports.Session || (exports.Session = {}));
 
-    (function (UserGroup) {
-        /**
-         * Returns a user group by its name.
-         * @param params
-         * @returns
-         */
-        function GetByName(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, accountId, name, req: reqParams } = params;
-                if (!name) {
-                    throw ("Name is required.");
-                }
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                // Default groups.
-                if (!accountId) {
-                    accountId = "";
-                }
-                const data = yield api.GET(`account/${accountId}/userGroupByName/${name}`, reqParams);
-                return {
-                    group: data
-                };
-            });
-        }
-        UserGroup.GetByName = GetByName;
-        /**
-         * Returns all users in a user group.
-         * @param params
-         * @returns
-         */
-        function GetUsers(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, accountId, groupId: id, req: reqParams } = params;
-                if (!id) {
-                    throw ("ID is required.");
-                }
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                // Default groups.
-                if (!accountId) {
-                    accountId = "";
-                }
-                const data = yield api.GET(`userGroup/${accountId}/${id}/users`, reqParams);
-                return {
-                    users: data.Items
-                };
-            });
-        }
-        UserGroup.GetUsers = GetUsers;
-        /**
-         * Returns list of user groups that have a specific permission enabled.
-         * @param params
-         * @returns
-         */
-        function GetListByPerm(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, accountId, perm, req: reqParams } = params;
-                if (!perm) {
-                    throw ("Perm is required.");
-                }
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                // Default groups.
-                if (!accountId) {
-                    accountId = "";
-                }
-                const data = yield api.GET(`userGroupsByFeature/${accountId}/${perm}`, reqParams);
-                return {
-                    groups: data.Items
-                };
-            });
-        }
-        UserGroup.GetListByPerm = GetListByPerm;
-        /**
-         * Returns all user groups for an account.
-         * @param params
-         * @returns
-         */
-        function GetList(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, accountId, req: reqParams } = params;
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                // Default groups.
-                if (!accountId) {
-                    accountId = "";
-                }
-                const data = yield api.GET(`userGroups/${accountId}`, reqParams);
-                return {
-                    groups: data.Items
-                };
-            });
-        }
-        UserGroup.GetList = GetList;
-        /**
-         * Deletes a user group.
-         * @param params
-         * @returns
-         */
-        function Delete(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, accountId, groupId: id, req: reqParams } = params;
-                if (!id) {
-                    throw ("ID is required.");
-                }
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                // Default groups.
-                if (!accountId) {
-                    accountId = "";
-                }
-                return api.DELETE(`account/${accountId}/userGroupID/${id}`, reqParams);
-            });
-        }
-        UserGroup.Delete = Delete;
-        /**
-         * Creates or updates a user group.
-         * @param params
-         * @returns
-         */
-        function Update(params) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let { api, group: data, reqParams } = params;
-                if (!data.Name) {
-                    throw ("User group name is required.");
-                }
-                // Default groups.
-                if (!data["ClientAccount.ID"]) {
-                    data["ClientAccount.ID"] = "";
-                }
-                if (!api) {
-                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
-                }
-                const res = yield api.POST(`userGroup${data.ID ? ("/" + data.ID) : ""}`, data, reqParams);
-                return {
-                    group: res
-                };
-            });
-        }
-        UserGroup.Update = Update;
-    })(exports.UserGroup || (exports.UserGroup = {}));
-
     (function (User) {
         /**
          * Available user types.
@@ -11842,6 +11701,36 @@
             });
         }
         User.Update = Update;
+        /**
+         * Creates a user record.
+         * This is not a user invitation, this creates a new user which you can then manage or invite yourself.
+         * TODO: The user should be tied to the client account's client and not the global list.
+         * @param params
+         */
+        function Create(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, user: data, req: reqParams } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                if (data.Type == EType.AccessToken) {
+                    throw ("Access tokens cannot be created this way.");
+                }
+                if (!data.Type) {
+                    data.Type = EType.User;
+                }
+                if (!data.ID) {
+                    data.ID = exports.ObjectUtils.UId();
+                }
+                const res = yield api.POST("user", data, reqParams);
+                api.Cache.RemoveByContains(exports.Api.ECacheKey.User + exports.Api.ECacheKey.Id + data.ID);
+                api.Cache.RemoveByStartsWith(exports.Api.ECacheKey.User + exports.Api.ECacheKey.Account);
+                return {
+                    user: res
+                };
+            });
+        }
+        User.Create = Create;
         /**
          * Loads settings for a given user + app.
          * The session's account id is used to separate settings between accounts.
@@ -11958,10 +11847,18 @@
              *     api.Cache.Remove(key);
              * }
              * @param accountId
+             * @param exclusive
+             * @param search
              * @returns
              */
-            function GetListCacheKey(accountId) {
-                return exports.Api.ECacheKey.User + exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Id + accountId;
+            function GetListCacheKey(accountId, exclusive, search) {
+                if (!exclusive) {
+                    exclusive = false;
+                }
+                if (!search) {
+                    search = "";
+                }
+                return exports.Api.ECacheKey.User + exports.Api.ECacheKey.Account + exports.Api.ECacheKey.Id + accountId + exports.Api.ECacheKey.Id + exclusive + exports.Api.ECacheKey.Id + search;
             }
             LoginUser.GetListCacheKey = GetListCacheKey;
             /**
@@ -12009,23 +11906,31 @@
              */
             function GetList(params) {
                 return __awaiter(this, void 0, void 0, function* () {
-                    let { api, accountId, exclusive, req: reqParams } = params;
-                    if (!accountId) {
-                        throw ("Client account ID is required.");
-                    }
+                    let { api, accountId, exclusive, req: reqParams, search } = params;
                     if (!api) {
                         api = exports.ENVIRONMENT.Api().GetGuardianApi();
                     }
                     if (!exclusive) {
                         exclusive = false;
                     }
-                    const cache = exclusive ? null : api.GetCacheItem(GetListCacheKey(accountId), reqParams);
+                    const cacheKey = GetListCacheKey(accountId, exclusive, search);
+                    const cache = exclusive ? null : api.GetCacheItem(cacheKey, reqParams);
                     if (cache === null || cache === void 0 ? void 0 : cache.found) {
                         return cache.data;
                     }
                     const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
                         try {
-                            const data = yield api.GET(`users?clientAccountID=${accountId}${exclusive ? "&allExcludingClientAccount=true" : ""}`, reqParams);
+                            const urlParams = new URLSearchParams();
+                            if (accountId) {
+                                urlParams.append("clientAccountID", accountId);
+                            }
+                            if (search) {
+                                urlParams.append("search", search);
+                            }
+                            if (exclusive) {
+                                urlParams.append("allExcludingClientAccount", "true");
+                            }
+                            const data = yield api.GET(`users?${urlParams.toString()}`, reqParams);
                             res({
                                 users: data.Items
                             });
@@ -12048,7 +11953,7 @@
                     }));
                     if (!exclusive) {
                         api.SetCacheItem({
-                            key: GetListCacheKey(accountId),
+                            key: cacheKey,
                             value: req,
                             req: reqParams
                         });
@@ -12283,6 +12188,26 @@
             }
             AccessToken.Create = Create;
         })(AccessToken = User.AccessToken || (User.AccessToken = {}));
+        /**
+         * Updates the password for a user by supplying the existing and new password.
+         * @param params
+         */
+        function UpdatePassword(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { userId, passwordCurrent, passwordNew, api, req } = params;
+                if (!userId || !passwordCurrent || !passwordNew) {
+                    throw ("UserId, current password, and new password are required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                return api.POST(`user/${userId}/setPassword`, {
+                    CurrentPassword: passwordCurrent,
+                    NewPassword: passwordNew
+                }, req);
+            });
+        }
+        User.UpdatePassword = UpdatePassword;
         /**
          * Returns cache identifier for a user.
          * Example: {
@@ -12336,6 +12261,206 @@
         User.GetSettingsCacheKey = GetSettingsCacheKey;
     })(exports.User || (exports.User = {}));
 
+    (function (UserGroup) {
+        /**
+         * Returns a user group by its name.
+         * @param params
+         * @returns
+         */
+        function GetByName(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, accountId, name, req: reqParams } = params;
+                if (!name) {
+                    throw ("Name is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                // Default groups.
+                if (!accountId) {
+                    accountId = "";
+                }
+                const data = yield api.GET(`account/${accountId}/userGroupByName/${name}`, reqParams);
+                return {
+                    group: data
+                };
+            });
+        }
+        UserGroup.GetByName = GetByName;
+        /**
+         * Returns all users in a user group.
+         * @param params
+         * @returns
+         */
+        function GetUsers(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, accountId, groupId: id, req: reqParams } = params;
+                if (!id) {
+                    throw ("ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                // Default groups.
+                if (!accountId) {
+                    accountId = "";
+                }
+                const data = yield api.GET(`userGroup/${accountId}/${id}/users`, reqParams);
+                return {
+                    users: data.Items
+                };
+            });
+        }
+        UserGroup.GetUsers = GetUsers;
+        /**
+         * Returns list of user groups that have a specific permission enabled.
+         * @param params
+         * @returns
+         */
+        function GetListByPerm(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, accountId, perm, req: reqParams } = params;
+                if (!perm) {
+                    throw ("Perm is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                // Default groups.
+                if (!accountId) {
+                    accountId = "";
+                }
+                const data = yield api.GET(`userGroupsByFeature/${accountId}/${perm}`, reqParams);
+                return {
+                    groups: data.Items
+                };
+            });
+        }
+        UserGroup.GetListByPerm = GetListByPerm;
+        /**
+         * Returns all user groups for an account.
+         * @param params
+         * @returns
+         */
+        function GetList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, accountId, req: reqParams } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                // Default groups.
+                if (!accountId) {
+                    accountId = "";
+                }
+                const data = yield api.GET(`userGroups/${accountId}`, reqParams);
+                return {
+                    groups: data.Items
+                };
+            });
+        }
+        UserGroup.GetList = GetList;
+        /**
+         * Deletes a user group.
+         * @param params
+         * @returns
+         */
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, accountId, groupId: id, req: reqParams } = params;
+                if (!id) {
+                    throw ("ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                // Default groups.
+                if (!accountId) {
+                    accountId = "";
+                }
+                return api.DELETE(`account/${accountId}/userGroupID/${id}`, reqParams);
+            });
+        }
+        UserGroup.Delete = Delete;
+        /**
+         * Creates or updates a user group.
+         * @param params
+         * @returns
+         */
+        function Update(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, group: data, reqParams } = params;
+                if (!data.Name) {
+                    throw ("User group name is required.");
+                }
+                // Default groups.
+                if (!data["ClientAccount.ID"]) {
+                    data["ClientAccount.ID"] = "";
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                const res = yield api.POST(`userGroup${data.ID ? ("/" + data.ID) : ""}`, data, reqParams);
+                return {
+                    group: res
+                };
+            });
+        }
+        UserGroup.Update = Update;
+        /**
+         * Adds a user to specified groups.
+         * @param params
+         * @returns
+         */
+        function AddUser(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, userId, groupIds, accountId, req: reqParams } = params;
+                if (!userId) {
+                    throw ("User ID is required.");
+                }
+                if (!(groupIds === null || groupIds === void 0 ? void 0 : groupIds.length)) {
+                    throw ("At least one group ID is required.");
+                }
+                if (!accountId) {
+                    accountId = "";
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                yield api.POST(`user/${userId}/account/${accountId}/addToGroups`, {
+                    UserGroups: groupIds
+                }, reqParams);
+                api.Cache.RemoveByContains(exports.User.GetCacheKey(userId, accountId));
+            });
+        }
+        UserGroup.AddUser = AddUser;
+        /**
+         * Removes a user from specified groups.
+         * @param params
+         */
+        function RemoveUser(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, userId, groupIds, accountId, req: reqParams } = params;
+                if (!userId) {
+                    throw ("User ID is required.");
+                }
+                if (!(groupIds === null || groupIds === void 0 ? void 0 : groupIds.length)) {
+                    throw ("At least one group ID is required.");
+                }
+                if (!accountId) {
+                    accountId = "";
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                yield api.POST(`user/${userId}/account/${accountId}/removeFromGroups`, {
+                    UserGroups: groupIds
+                }, reqParams);
+                api.Cache.RemoveByContains(exports.User.GetCacheKey(userId, accountId));
+            });
+        }
+        UserGroup.RemoveUser = RemoveUser;
+    })(exports.UserGroup || (exports.UserGroup = {}));
+
     (function (AccountInvite) {
         /**
          * Possible invite statuses.
@@ -13149,6 +13274,104 @@
         AccountLimits.GetLimitsCacheKey = GetLimitsCacheKey;
     })(exports.AccountLimits || (exports.AccountLimits = {}));
 
+    (function (AccountTemplate) {
+        /**
+         * Known keywords that will be substituted in the template.
+         * A keyword must be surrounded by ${blah} in the template.
+         */
+        let EKeyword;
+        (function (EKeyword) {
+            EKeyword["AccountName"] = "ClientAccount.Name";
+            EKeyword["InvitedByUserName"] = "InvitedBy.User.FullName";
+            EKeyword["InvitedUserName"] = "Invited.User.FullName";
+            EKeyword["URL"] = "URL";
+            EKeyword["ActivationCode"] = "ActivationCode";
+        })(EKeyword = AccountTemplate.EKeyword || (AccountTemplate.EKeyword = {}));
+        function GetList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { accountId, api, req } = params;
+                if (!accountId) {
+                    throw new Error("accountId is required");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                const data = yield api.GET(`templates/${accountId}`, exports.Api.PrepReqParams(req));
+                return {
+                    templates: data.Items
+                };
+            });
+        }
+        AccountTemplate.GetList = GetList;
+        function Get(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { key, accountId, api, req } = params;
+                if (!accountId) {
+                    throw new Error("accountId is required");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                const data = yield api.GET(`template/${accountId}/${key}`, exports.Api.PrepReqParams(req));
+                return {
+                    template: data
+                };
+            });
+        }
+        AccountTemplate.Get = Get;
+        function Update(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { template, api, req } = params;
+                if (!(template === null || template === void 0 ? void 0 : template["ClientAccount.ID"])) {
+                    throw new Error("ClientAccount.ID is required");
+                }
+                if (!(template === null || template === void 0 ? void 0 : template.Key)) {
+                    throw new Error("Key is required");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                const data = yield api.POST(`template/${template["ClientAccount.ID"]}/${template.Key}`, template, exports.Api.PrepReqParams(req));
+                return {
+                    template: data
+                };
+            });
+        }
+        AccountTemplate.Update = Update;
+        function Delete(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { key, accountId, api, req } = params;
+                if (!accountId) {
+                    throw new Error("accountId is required");
+                }
+                if (!key) {
+                    throw new Error("key is required");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                yield api.DELETE(`template/${accountId}/${key}`, exports.Api.PrepReqParams(req));
+            });
+        }
+        AccountTemplate.Delete = Delete;
+    })(exports.AccountTemplate || (exports.AccountTemplate = {}));
+
+    (function (AccountType) {
+        function GetList(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, req } = params;
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetGuardianApi();
+                }
+                const data = yield api.GET("accountTypes", exports.Api.PrepReqParams(req));
+                return {
+                    types: data.Items
+                };
+            });
+        }
+        AccountType.GetList = GetList;
+    })(exports.AccountType || (exports.AccountType = {}));
+
     (function (EncryptUtils) {
         // https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript
         function Cyrb53Hash(str, seed = 0) {
@@ -14477,7 +14700,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "5.4.5";
+    const VERSION = "5.4.7";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;