bruce-models 2.3.7 → 2.3.9

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

@@ -1,66 +1,72 @@
-import { Api } from "../api/api";
-import { IdmApi } from "../api/idm-api";
-import { UTC } from "../common/utc";
-import { Permission } from "./permission";
-import { User } from "./user";
-/**
- * Describes the "Session" concept within Bruce.
- * A session is a set of settings produced from a user or access token login.
- * The session describes what the access should be allowed to do.
- */
-export declare namespace Session {
-    interface ISession {
-        AccessPermissions: IAccountPermissions;
-        HypeportalAccessPermisssions?: ISuperPermissions;
-        "ClientAccount.ID": string;
-        ID: string;
-        IP: string;
-        LastAccessTime: UTC.IUTC;
-        User: User.IUser;
-    }
-    interface IAccountPermissions {
-        "ClientAccount.ID"?: string;
-        EnabledFeatures?: Permission.Perm[];
-        UserGroups?: string[];
-    }
-    interface ISuperPermissions {
-        EnabledFeatures?: Permission.Perm[];
-        UserGroups?: string[];
-    }
-    function Get(params: {
-        api: IdmApi.Api;
-        sessionId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        session: ISession;
-    }>;
-    function Login(params: {
-        api: IdmApi.Api;
-        username: string;
-        password: string;
-        accountId?: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        session: ISession;
-    }>;
-    function Logout(params: {
-        api: IdmApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    function IsPermEnabled(params: {
-        session: ISession;
-        accountId: string;
-        perm: string;
-    }): boolean;
-    function IsSuperPermEnabled(params: {
-        session: ISession;
-        perm: string;
-    }): boolean;
-    function IsAccountAdmin(params: {
-        session: ISession;
-        accountId: string;
-    }): boolean;
-    function IsSuperAdmin(params: {
-        session: ISession;
-    }): boolean;
-}
+import { Api } from "../api/api";
+import { IdmApi } from "../api/idm-api";
+import { UTC } from "../common/utc";
+import { Permission } from "./permission";
+import { User } from "./user";
+/**
+ * Describes the "Session" concept within Bruce.
+ * A session is a set of settings produced from a user or access token login.
+ * The session describes what the access should be allowed to do.
+ */
+export declare namespace Session {
+    interface ISession {
+        AccessPermissions: IAccountPermissions;
+        HypeportalAccessPermisssions?: ISuperPermissions;
+        "ClientAccount.ID": string;
+        ID: string;
+        IP: string;
+        LastAccessTime: UTC.IUTC;
+        User: User.IUser;
+    }
+    interface IAccountPermissions {
+        "ClientAccount.ID"?: string;
+        EnabledFeatures?: Permission.Perm[];
+        UserGroups?: string[];
+    }
+    interface ISuperPermissions {
+        EnabledFeatures?: Permission.Perm[];
+        UserGroups?: string[];
+    }
+    function Get(params: {
+        api: IdmApi.Api;
+        sessionId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        session: ISession;
+    }>;
+    /**
+     * Request to login or to swap existing session to a different account.
+     * If api is already logged in, pass account param to swap the session.
+     * @param params
+     * @returns
+     */
+    function Login(params: {
+        api: IdmApi.Api;
+        username?: string;
+        password?: string;
+        accountId?: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        session: ISession;
+    }>;
+    function Logout(params: {
+        api: IdmApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    function IsPermEnabled(params: {
+        session: ISession;
+        accountId: string;
+        perm: string;
+    }): boolean;
+    function IsSuperPermEnabled(params: {
+        session: ISession;
+        perm: string;
+    }): boolean;
+    function IsAccountAdmin(params: {
+        session: ISession;
+        accountId: string;
+    }): boolean;
+    function IsSuperAdmin(params: {
+        session: ISession;
+    }): boolean;
+}

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

@@ -1,58 +1,58 @@
-import { Api, IdmApi, Permission } from "../bruce-models";
-import { User } from "./user";
-/**
- * Describes the "User Group" concept within Bruce.
- * A user group is a collection of permissions ("Features") and what users should be in the group.
- */
-export declare namespace UserGroup {
-    interface IGroup {
-        "ClientAccount.ID"?: string;
-        "Features": Permission.Perm[];
-        "ID": string;
-        "Name"?: string;
-    }
-    function GetByName(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        name: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        group: IGroup;
-    }>;
-    function GetUsers(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        groupId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        users: User.IUser[];
-    }>;
-    function GetListByPerm(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        perm: Permission.Perm;
-        req?: Api.IReqParams;
-    }): Promise<{
-        groups: IGroup[];
-    }>;
-    function GetList(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        groups: IGroup[];
-    }>;
-    function Delete(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        groupId: string;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    function Update(params: {
-        api: IdmApi.Api;
-        group: IGroup;
-        reqParams?: Api.IReqParams;
-    }): Promise<{
-        group: IGroup;
-    }>;
-}
+import { Api, IdmApi, Permission } from "../bruce-models";
+import { User } from "./user";
+/**
+ * Describes the "User Group" concept within Bruce.
+ * A user group is a collection of permissions ("Features") and what users should be in the group.
+ */
+export declare namespace UserGroup {
+    interface IGroup {
+        "ClientAccount.ID"?: string;
+        "Features": Permission.Perm[];
+        "ID": string;
+        "Name"?: string;
+    }
+    function GetByName(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        name: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        group: IGroup;
+    }>;
+    function GetUsers(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        groupId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        users: User.IUser[];
+    }>;
+    function GetListByPerm(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        perm: Permission.Perm;
+        req?: Api.IReqParams;
+    }): Promise<{
+        groups: IGroup[];
+    }>;
+    function GetList(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        groups: IGroup[];
+    }>;
+    function Delete(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        groupId: string;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    function Update(params: {
+        api: IdmApi.Api;
+        group: IGroup;
+        reqParams?: Api.IReqParams;
+    }): Promise<{
+        group: IGroup;
+    }>;
+}

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

@@ -1,188 +1,189 @@
-import { Api } from "../api/api";
-import { IdmApi } from "../api/idm-api";
-import { UserGroup } from "./user-group";
-/**
- * Describes the "User" concept within Bruce.
- * A user is either a login-user or an access-token.
- *
- * You cannot login using an access-token, but both concepts are-
- * treated the same way in terms of permissions and user groups.
- */
-export declare namespace User {
-    function GetCacheKey(userId: string, accountId?: string): string;
-    function GetEmailCacheKey(email: string, accountId?: string): string;
-    function GetSettingsCacheKey(userId: string, appId: string): string;
-    interface IUser {
-        AccessPermissions?: IAccessPermission[];
-        Email?: string;
-        Login?: string;
-        FullName?: string;
-        ID?: string;
-        IsActivated?: boolean;
-        IsDisabled?: boolean;
-        IsPasswordChangeRequired?: boolean;
-        Mobile?: string;
-        Password?: string;
-        Type?: EType;
-    }
-    enum EType {
-        User = "LOGIN_USER",
-        AccessToken = "ACCESS_TOKEN"
-    }
-    interface IAccessPermission {
-        "ClientAccount.ID": string;
-        "UserGroup.ID"?: string[];
-        "UserGroups"?: UserGroup.IGroup[];
-    }
-    function Get(params: {
-        api: IdmApi.Api;
-        userId: string;
-        accountId?: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        user: IUser;
-    }>;
-    function Update(params: {
-        api: IdmApi.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.
-     * @param params
-     */
-    function GetSettings(params: {
-        api: IdmApi.Api;
-        userId: string;
-        appId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        settings: any;
-    }>;
-    /**
-     * Updates settings for a given accId + user + app.
-     * The settings update will replace the existing record, please ensure to merge with existing settings.
-     * @param params
-     */
-    function UpdateSettings(params: {
-        api: IdmApi.Api;
-        accId: string;
-        userId: string;
-        appId: string;
-        settings: any;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    function GetUsernameAvailable(params: {
-        api: IdmApi.Api;
-        username: string;
-        excludeUserId?: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        isAvailable: boolean;
-    }>;
-    namespace LoginUser {
-        function GetListCacheKey(accountId: string): string;
-        function GetByEmail(params: {
-            api: IdmApi.Api;
-            email: string;
-            accountId?: string;
-            req?: Api.IReqParams;
-        }): Promise<{
-            user: IUser;
-        }>;
-        function GetList(params: {
-            api: IdmApi.Api;
-            accountId: string;
-            exclusive?: boolean;
-            req?: Api.IReqParams;
-        }): Promise<{
-            users: IUser[];
-        }>;
-        /**
-         * Sends a signup email to the specified email address.
-         * @param params
-         * @returns
-         */
-        function Signup(params: {
-            api: IdmApi.Api;
-            email: string;
-            req?: Api.IReqParams;
-        }): Promise<void>;
-        /**
-         * Sends a new signup email using a previous one's expired code.
-         * @param params
-         * @returns
-         */
-        function SignupResend(params: {
-            api: IdmApi.Api;
-            expiredCode: string;
-            req?: Api.IReqParams;
-        }): Promise<void>;
-        /**
-         * Completes signup using user data and a signup code.
-         * @param params
-         * @returns
-         */
-        function SignupComplete(params: {
-            api: IdmApi.Api;
-            code: string;
-            user: IUser;
-            accountId?: string;
-            req?: Api.IReqParams;
-        }): Promise<{
-            user: IUser;
-        }>;
-        /**
-         * Sends a password reset email to the specified email address.
-         * @param params
-         * @returns user id associated with provided email.
-         */
-        function ForgotPassword(params: {
-            api: IdmApi.Api;
-            accountId: string;
-            email: string;
-            req?: Api.IReqParams;
-        }): Promise<{
-            userId: string;
-        }>;
-        /**
-         * Completes password reset using a password reset code and new password.
-         * @param params
-         * @returns
-         */
-        function ForgotPasswordComplete(params: {
-            api: IdmApi.Api;
-            code: string;
-            userId: string;
-            password: string;
-            req?: Api.IReqParams;
-        }): Promise<{
-            user: IUser;
-        }>;
-    }
-    namespace AccessToken {
-        function GetListCacheKey(accountId: string): string;
-        function GetList(params: {
-            api: IdmApi.Api;
-            accountId: string;
-            req?: Api.IReqParams;
-        }): Promise<{
-            users: IUser[];
-        }>;
-        function Delete(params: {
-            api: IdmApi.Api;
-            tokenId: string;
-            req?: Api.IReqParams;
-        }): Promise<void>;
-        function Create(params: {
-            api: IdmApi.Api;
-            token: IUser;
-            req?: Api.IReqParams;
-        }): Promise<{
-            user: IUser;
-        }>;
-    }
-}
+import { Api } from "../api/api";
+import { IdmApi } from "../api/idm-api";
+import { UserGroup } from "./user-group";
+/**
+ * Describes the "User" concept within Bruce.
+ * A user is either a login-user or an access-token.
+ *
+ * You cannot login using an access-token, but both concepts are-
+ * treated the same way in terms of permissions and user groups.
+ */
+export declare namespace User {
+    function GetCacheKey(userId: string, accountId?: string): string;
+    function GetEmailCacheKey(email: string, accountId?: string): string;
+    function GetSettingsCacheKey(userId: string, appId: string): string;
+    interface IUser {
+        AccessPermissions?: IAccessPermission[];
+        Email?: string;
+        Login?: string;
+        FullName?: string;
+        ID?: string;
+        IsActivated?: boolean;
+        IsDisabled?: boolean;
+        IsPasswordChangeRequired?: boolean;
+        Mobile?: string;
+        Password?: string;
+        Type?: EType;
+    }
+    enum EType {
+        User = "LOGIN_USER",
+        AccessToken = "ACCESS_TOKEN"
+    }
+    interface IAccessPermission {
+        "ClientAccount.ID": string;
+        "UserGroup.ID"?: string[];
+        "UserGroups"?: UserGroup.IGroup[];
+    }
+    function Get(params: {
+        api: IdmApi.Api;
+        userId: string;
+        accountId?: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        user: IUser;
+    }>;
+    function Update(params: {
+        api: IdmApi.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.
+     * @param params
+     */
+    function GetSettings(params: {
+        api: IdmApi.Api;
+        userId: string;
+        appId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        settings: any;
+    }>;
+    /**
+     * Updates settings for a given accId + user + app.
+     * The settings update will replace the existing record, please ensure to merge with existing settings.
+     * AccountId is optional and will use a globally shared record if not provided.
+     * @param params
+     */
+    function UpdateSettings(params: {
+        api: IdmApi.Api;
+        accId?: string;
+        userId: string;
+        appId: string;
+        settings: any;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    function GetUsernameAvailable(params: {
+        api: IdmApi.Api;
+        username: string;
+        excludeUserId?: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        isAvailable: boolean;
+    }>;
+    namespace LoginUser {
+        function GetListCacheKey(accountId: string): string;
+        function GetByEmail(params: {
+            api: IdmApi.Api;
+            email: string;
+            accountId?: string;
+            req?: Api.IReqParams;
+        }): Promise<{
+            user: IUser;
+        }>;
+        function GetList(params: {
+            api: IdmApi.Api;
+            accountId: string;
+            exclusive?: boolean;
+            req?: Api.IReqParams;
+        }): Promise<{
+            users: IUser[];
+        }>;
+        /**
+         * Sends a signup email to the specified email address.
+         * @param params
+         * @returns
+         */
+        function Signup(params: {
+            api: IdmApi.Api;
+            email: string;
+            req?: Api.IReqParams;
+        }): Promise<void>;
+        /**
+         * Sends a new signup email using a previous one's expired code.
+         * @param params
+         * @returns
+         */
+        function SignupResend(params: {
+            api: IdmApi.Api;
+            expiredCode: string;
+            req?: Api.IReqParams;
+        }): Promise<void>;
+        /**
+         * Completes signup using user data and a signup code.
+         * @param params
+         * @returns
+         */
+        function SignupComplete(params: {
+            api: IdmApi.Api;
+            code: string;
+            user: IUser;
+            accountId?: string;
+            req?: Api.IReqParams;
+        }): Promise<{
+            user: IUser;
+        }>;
+        /**
+         * Sends a password reset email to the specified email address.
+         * @param params
+         * @returns user id associated with provided email.
+         */
+        function ForgotPassword(params: {
+            api: IdmApi.Api;
+            accountId: string;
+            email: string;
+            req?: Api.IReqParams;
+        }): Promise<{
+            userId: string;
+        }>;
+        /**
+         * Completes password reset using a password reset code and new password.
+         * @param params
+         * @returns
+         */
+        function ForgotPasswordComplete(params: {
+            api: IdmApi.Api;
+            code: string;
+            userId: string;
+            password: string;
+            req?: Api.IReqParams;
+        }): Promise<{
+            user: IUser;
+        }>;
+    }
+    namespace AccessToken {
+        function GetListCacheKey(accountId: string): string;
+        function GetList(params: {
+            api: IdmApi.Api;
+            accountId: string;
+            req?: Api.IReqParams;
+        }): Promise<{
+            users: IUser[];
+        }>;
+        function Delete(params: {
+            api: IdmApi.Api;
+            tokenId: string;
+            req?: Api.IReqParams;
+        }): Promise<void>;
+        function Create(params: {
+            api: IdmApi.Api;
+            token: IUser;
+            req?: Api.IReqParams;
+        }): Promise<{
+            user: IUser;
+        }>;
+    }
+}

package/dist/types/util/encrypt-utils.d.ts

@@ -1,3 +1,3 @@
-export declare namespace EncryptUtils {
-    function Cyrb53Hash(str: string, seed?: number): number;
-}
+export declare namespace EncryptUtils {
+    function Cyrb53Hash(str: string, seed?: number): number;
+}