bruce-models 0.1.6 → 0.1.8

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

@@ -1,5 +1,9 @@
 import { 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;

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

@@ -1,5 +1,12 @@
 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;
     interface IUser {
@@ -27,9 +34,50 @@ export declare namespace User {
     }
     function Get(api: IdmApi, id: string, accountId: string): Promise<IUser>;
     function Update(api: IdmApi, data: IUser): Promise<IUser>;
+    function GetUsernameAvailable(api: IdmApi, username: string): Promise<boolean>;
     namespace LoginUser {
         function GetListCacheKey(accountId: string): string;
         function GetList(api: IdmApi, accountId: string, exclusive?: boolean): Promise<IUser[]>;
+        /**
+         * Sends a signup email to the specified email address.
+         * @param api
+         * @param email
+         * @returns
+         */
+        function Signup(api: IdmApi, email: string): Promise<void>;
+        /**
+         * Sends a new signup email using a previous one's expired code.
+         * @param api
+         * @param expiredCode
+         * @returns
+         */
+        function SignupResend(api: IdmApi, expiredCode: string): Promise<void>;
+        /**
+         * Completes signup using user data and a signup code.
+         * @param api
+         * @param accountId
+         * @param code
+         * @param data
+         * @returns
+         */
+        function SignupComplete(api: IdmApi, accountId: string, code: string, data: IUser): Promise<IUser>;
+        /**
+         * Sends a password reset email to the specified email address.
+         * @param api
+         * @param accountId
+         * @param email
+         * @returns user id associated with provided email.
+         */
+        function ForgotPassword(api: IdmApi, accountId: string, email: string): Promise<string>;
+        /**
+         * Completes password reset using a password reset code and new password.
+         * @param api
+         * @param code
+         * @param userId
+         * @param password
+         * @returns
+         */
+        function ForgotPasswordComplete(api: IdmApi, code: string, userId: string, password: string): Promise<IUser>;
     }
     namespace AccessToken {
         function GetListCacheKey(accountId: string): string;

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

@@ -1,4 +1,16 @@
 export declare namespace MathUtils {
+    /**
+     * Rounds a number to a given number of decimal places.
+     * @param num
+     * @param decimals
+     * @returns
+     */
     function Round(num: number, decimals?: number): number;
+    /**
+     * Returns a random integer between min (inclusive) and max (inclusive).
+     * @param min
+     * @param max
+     * @returns
+     */
     function RandInt(min: number, max: number): number;
 }

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

@@ -1,3 +1,7 @@
 export declare namespace ObjectUtils {
+    /**
+     * Generates a Bruce compatible UID.
+     * @returns
+     */
     function UId(): string;
 }

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

@@ -1,3 +1,6 @@
+/**
+ * Utility to help with parsing and wrapping Bruce paths.
+ */
 export declare namespace PathUtils {
     function Parse(str: string): string[];
     function Wrap(path: string[]): string;

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

@@ -1,6 +1,12 @@
 import { IDictionary } from "../common/dictionary";
+/**
+ * Utility to help with url manipulation.
+ */
 export declare namespace UrlUtils {
     function GetQueryString(doc: Document): IDictionary<string>;
+    /**
+     * Helper to get and set url params for a given window.
+     */
     class Handler {
         private _window;
         get window(): Window;

package/package.json

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