bruce-models 5.4.5 → 5.4.7

package/dist/types/account/account-template.d.ts

@@ -0,0 +1,55 @@
+import { Api } from "../api/api";
+import { GuardianApi } from "../api/guardian-api";
+/**
+ * Account templates are templates for sending emails to users.
+ * In the future it might also be tied to other communication, eg: SMS.
+ * When a template is not found then our hypeportal ones will be used as a fallback.
+ */
+export declare namespace AccountTemplate {
+    interface ITemplate {
+        Key: string;
+        ID?: string;
+        Subject?: string;
+        Body?: string;
+        "ClientAccount.ID"?: string;
+    }
+    /**
+     * Known keywords that will be substituted in the template.
+     * A keyword must be surrounded by ${blah} in the template.
+     */
+    enum EKeyword {
+        AccountName = "ClientAccount.Name",
+        InvitedByUserName = "InvitedBy.User.FullName",
+        InvitedUserName = "Invited.User.FullName",
+        URL = "URL",
+        ActivationCode = "ActivationCode"
+    }
+    function GetList(params: {
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        templates: ITemplate[];
+    }>;
+    function Get(params: {
+        key: string;
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        template: ITemplate;
+    }>;
+    function Update(params: {
+        template: ITemplate;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        template: ITemplate;
+    }>;
+    function Delete(params: {
+        key: string;
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+}

package/dist/types/account/account-type.d.ts

@@ -0,0 +1,18 @@
+import { Api } from "../api/api";
+import { GuardianApi } from "../api/guardian-api";
+/**
+ * An account type dictates limitations and available features.
+ * Eg: how many Entities an account can have.
+ */
+export declare namespace AccountType {
+    interface IType {
+        ID: string;
+        Description: string;
+    }
+    function GetList(params: {
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        types: IType[];
+    }>;
+}

package/dist/types/account/account.d.ts

@@ -44,7 +44,8 @@ export declare namespace Account {
     enum EAppId {
         BruceApi = "BruceAPI",
         Navigator = "Navigator",
-        Operator = "BruceClientAdmin"
+        Operator = "BruceClientAdmin",
+        UI = "UI"
     }
     type AppId = EAppId | string;
     /**
@@ -85,6 +86,7 @@ export declare namespace Account {
      * @returns
      */
     function GetRelatedList(params: {
+        owned?: boolean;
         api?: GuardianApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
@@ -170,7 +172,7 @@ export declare namespace Account {
      * @param ssid
      * @returns
      */
-    function GetListCacheKey(ssid: string): string;
+    function GetListCacheKey(ssid: string, owned?: boolean): string;
     /**
      * Returns cache identifier for a list of database regions.
      * Example: {

package/dist/types/bruce-models.d.ts

@@ -69,6 +69,8 @@ export * from "./account/account-settings";
 export * from "./account/account-invite";
 export * from "./account/account-features";
 export * from "./account/account-limits";
+export * from "./account/account-template";
+export * from "./account/account-type";
 export * from "./util/encrypt-utils";
 export * from "./util/math-utils";
 export * from "./util/object-utils";
@@ -90,4 +92,4 @@ export * from "./internal/uploader";
 export * from "./plugin/plugin";
 export * from "./environment";
 export * from "./data-source/data-source";
-export declare const VERSION = "5.4.5";
+export declare const VERSION = "5.4.7";

package/dist/types/user/user-group.d.ts

@@ -90,4 +90,27 @@ export declare namespace UserGroup {
     }): Promise<{
         group: IGroup;
     }>;
+    /**
+     * Adds a user to specified groups.
+     * @param params
+     * @returns
+     */
+    function AddUser(params: {
+        userId: string;
+        groupIds: string[];
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Removes a user from specified groups.
+     * @param params
+     */
+    function RemoveUser(params: {
+        userId: string;
+        groupIds: string[];
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
 }

package/dist/types/user/user.d.ts

@@ -66,6 +66,19 @@ export declare namespace User {
     }): Promise<{
         user: IUser;
     }>;
+    /**
+     * 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: {
+        api?: GuardianApi.Api;
+        user: IUser;
+        req?: Api.IReqParams;
+    }): Promise<{
+        user: IUser;
+    }>;
     /**
      * Loads settings for a given user + app.
      * The session's account id is used to separate settings between accounts.
@@ -116,9 +129,11 @@ export declare namespace User {
          *     api.Cache.Remove(key);
          * }
          * @param accountId
+         * @param exclusive
+         * @param search
          * @returns
          */
-        function GetListCacheKey(accountId: string): string;
+        function GetListCacheKey(accountId: string, exclusive?: boolean, search?: string): string;
         /**
          * Returns a user by their email address.
          * @param params
@@ -139,8 +154,9 @@ export declare namespace User {
          */
         function GetList(params: {
             api?: GuardianApi.Api;
-            accountId: string;
+            accountId?: string;
             exclusive?: boolean;
+            search?: string;
             req?: Api.IReqParams;
         }): Promise<{
             users: IUser[];
@@ -253,6 +269,17 @@ export declare namespace User {
             user: IUser;
         }>;
     }
+    /**
+     * Updates the password for a user by supplying the existing and new password.
+     * @param params
+     */
+    function UpdatePassword(params: {
+        userId: string;
+        passwordCurrent: string;
+        passwordNew: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
     /**
      * Returns cache identifier for a user.
      * Example: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "5.4.5",
+    "version": "5.4.7",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",