@steffesgroup/steffes-auth - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

dist/api.d.ts

@@ -8,7 +8,75 @@ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
 }
+export interface IUserClient {
+    /**
+     * Gets the current logged in user
+     */
+    getUser(tenantId: string): Promise<AuthUserDTO>;
+    /**
+     * Gets the current logged in user's industries
+     */
+    getUserIndustries(tenantId: string): Promise<RelationEntity[]>;
+    /**
+     * Updates the currently logged in user's profile
+     */
+    update(tenantId: string, updateUserInfoDTO: UpdateUserInfoDTO): Promise<FileResponse>;
+    /**
+     * Updates the currently logged in user's industries
+     */
+    updateIndustries(tenantId: string, industryIds: string[]): Promise<FileResponse>;
+    /**
+     * Updates the currently logged in user's password
+     */
+    updatePassword(tenantId: string, updatePasswordDTO: UpdatePasswordDTO): Promise<FileResponse>;
+}
+export declare class UserClient extends AuthorizedApiBase implements IUserClient {
+    protected instance: AxiosInstance;
+    protected baseUrl: string;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: IConfig, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets the current logged in user
+     */
+    getUser(tenantId: string, cancelToken?: CancelToken): Promise<AuthUserDTO>;
+    protected processGetUser(response: AxiosResponse): Promise<AuthUserDTO>;
+    /**
+     * Gets the current logged in user's industries
+     */
+    getUserIndustries(tenantId: string, cancelToken?: CancelToken): Promise<RelationEntity[]>;
+    protected processGetUserIndustries(response: AxiosResponse): Promise<RelationEntity[]>;
+    /**
+     * Updates the currently logged in user's profile
+     */
+    update(tenantId: string, updateUserInfoDTO: UpdateUserInfoDTO, cancelToken?: CancelToken): Promise<FileResponse>;
+    protected processUpdate(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Updates the currently logged in user's industries
+     */
+    updateIndustries(tenantId: string, industryIds: string[], cancelToken?: CancelToken): Promise<FileResponse>;
+    protected processUpdateIndustries(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Updates the currently logged in user's password
+     */
+    updatePassword(tenantId: string, updatePasswordDTO: UpdatePasswordDTO, cancelToken?: CancelToken): Promise<FileResponse>;
+    protected processUpdatePassword(response: AxiosResponse): Promise<FileResponse>;
+}
 export interface IAuthClient {
+    /**
+     * Creates a new token for the user
+     */
     getToken(tenantId: string, loginDTO: LoginDTO): Promise<TokenDTO>;
+    /**
+     * Refreshes a token for the user
+     */
     refreshToken(tenantId: string, refreshTokenDTO: RefreshTokenDTO): Promise<TokenDTO>;
+    /**
+     * Resets the current users password
+     */
     resetPassword(tenantId: string, resetPasswordDTO: ResetPasswordDTO): Promise<FileResponse>;
+    /**
+     * Sends the password reset token
+     */
     sendResetPassword(tenantId: string, email: string): Promise<FileResponse>;
+    /**
+     * Unlocks the users account
+     */
     unlock(tenantId: string, unlockDTO: UnlockDTO): Promise<FileResponse>;
@@ -21,10 +89,25 @@ }
     constructor(configuration: IConfig, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Creates a new token for the user
+     */
     getToken(tenantId: string, loginDTO: LoginDTO, cancelToken?: CancelToken): Promise<TokenDTO>;
     protected processGetToken(response: AxiosResponse): Promise<TokenDTO>;
+    /**
+     * Refreshes a token for the user
+     */
     refreshToken(tenantId: string, refreshTokenDTO: RefreshTokenDTO, cancelToken?: CancelToken): Promise<TokenDTO>;
     protected processRefreshToken(response: AxiosResponse): Promise<TokenDTO>;
+    /**
+     * Resets the current users password
+     */
     resetPassword(tenantId: string, resetPasswordDTO: ResetPasswordDTO, cancelToken?: CancelToken): Promise<FileResponse>;
     protected processResetPassword(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Sends the password reset token
+     */
     sendResetPassword(tenantId: string, email: string, cancelToken?: CancelToken): Promise<FileResponse>;
     protected processSendResetPassword(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Unlocks the users account
+     */
     unlock(tenantId: string, unlockDTO: UnlockDTO, cancelToken?: CancelToken): Promise<FileResponse>;
@@ -52,2 +135,118 @@ protected processUnlock(response: AxiosResponse): Promise<FileResponse>;
 }
+export declare abstract class Collection implements ICollection {
+    id?: string;
+    tenantId?: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    entityState?: EntityState;
+    entityType?: string;
+    _etag?: string | undefined;
+    schemaVersion?: string;
+    constructor(data?: ICollection);
+    init(_data?: any): void;
+    static fromJS(data: any): Collection;
+    toJSON(data?: any): any;
+}
+export interface ICollection {
+    id?: string;
+    tenantId?: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    entityState?: EntityState;
+    entityType?: string;
+    _etag?: string | undefined;
+    schemaVersion?: string;
+}
+export declare abstract class ExtensibleCollection extends Collection implements IExtensibleCollection {
+    customFields?: {
+        [key: string]: any;
+    };
+    constructor(data?: IExtensibleCollection);
+    init(_data?: any): void;
+    static fromJS(data: any): ExtensibleCollection;
+    toJSON(data?: any): any;
+}
+export interface IExtensibleCollection extends ICollection {
+    customFields?: {
+        [key: string]: any;
+    };
+}
+export declare class AuthUserDTO extends ExtensibleCollection implements IAuthUserDTO {
+    onlineBidderNumber?: string | undefined;
+    company?: string | undefined;
+    defaultImage?: RelationEntity | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    status?: UserStatus;
+    isAdmin?: boolean;
+    constructor(data?: IAuthUserDTO);
+    init(_data?: any): void;
+    static fromJS(data: any): AuthUserDTO;
+    toJSON(data?: any): any;
+}
+export interface IAuthUserDTO extends IExtensibleCollection {
+    onlineBidderNumber?: string | undefined;
+    company?: string | undefined;
+    defaultImage?: RelationEntity | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    status?: UserStatus;
+    isAdmin?: boolean;
+}
+export declare class RelationEntity implements IRelationEntity {
+    entityType?: string;
+    id?: string;
+    name?: string | undefined;
+    [key: string]: any;
+    constructor(data?: IRelationEntity);
+    init(_data?: any): void;
+    static fromJS(data: any): RelationEntity;
+    toJSON(data?: any): any;
+}
+export interface IRelationEntity {
+    entityType?: string;
+    id?: string;
+    name?: string | undefined;
+    [key: string]: any;
+}
+export declare enum UserStatus {
+    Active = "Active",
+    Suspended = "Suspended"
+}
+export declare enum EntityState {
+    Active = "Active",
+    Archived = "Archived",
+    Deleted = "Deleted",
+    Default = "Default"
+}
+export declare class UpdateUserInfoDTO implements IUpdateUserInfoDTO {
+    firstName: string;
+    lastName: string;
+    company?: string | undefined;
+    email: string;
+    constructor(data?: IUpdateUserInfoDTO);
+    init(_data?: any): void;
+    static fromJS(data: any): UpdateUserInfoDTO;
+    toJSON(data?: any): any;
+}
+export interface IUpdateUserInfoDTO {
+    firstName: string;
+    lastName: string;
+    company?: string | undefined;
+    email: string;
+}
+export declare class UpdatePasswordDTO implements IUpdatePasswordDTO {
+    newPassword: string;
+    oldPassword: string;
+    constructor(data?: IUpdatePasswordDTO);
+    init(_data?: any): void;
+    static fromJS(data: any): UpdatePasswordDTO;
+    toJSON(data?: any): any;
+}
+export interface IUpdatePasswordDTO {
+    newPassword: string;
+    oldPassword: string;
+}
 export declare class TokenDTO implements ITokenDTO {
@@ -91,3 +290,4 @@ accessToken?: string | undefined;
     SalesTool = "SalesTool",
-    Watcher = "Watcher"
+    Watcher = "Watcher",
+    Website = "Website"
 }
@@ -132,40 +332,2 @@ export declare class RefreshTokenDTO implements IRefreshTokenDTO {
 }
-export declare abstract class Collection implements ICollection {
-    id?: string;
-    tenantId?: string;
-    createdOn?: Date;
-    updatedOn?: Date;
-    entityState?: EntityState;
-    entityType?: string;
-    _etag?: string | undefined;
-    schemaVersion?: string;
-    constructor(data?: ICollection);
-    init(_data?: any): void;
-    static fromJS(data: any): Collection;
-    toJSON(data?: any): any;
-}
-export interface ICollection {
-    id?: string;
-    tenantId?: string;
-    createdOn?: Date;
-    updatedOn?: Date;
-    entityState?: EntityState;
-    entityType?: string;
-    _etag?: string | undefined;
-    schemaVersion?: string;
-}
-export declare abstract class ExtensibleCollection extends Collection implements IExtensibleCollection {
-    customFields?: {
-        [key: string]: any;
-    };
-    constructor(data?: IExtensibleCollection);
-    init(_data?: any): void;
-    static fromJS(data: any): ExtensibleCollection;
-    toJSON(data?: any): any;
-}
-export interface IExtensibleCollection extends ICollection {
-    customFields?: {
-        [key: string]: any;
-    };
-}
 export declare class UserDTO extends ExtensibleCollection implements IUserDTO {
@@ -345,18 +507,2 @@ addresses?: Address[];
 }
-export declare class RelationEntity implements IRelationEntity {
-    entityType?: string;
-    id?: string;
-    name?: string | undefined;
-    [key: string]: any;
-    constructor(data?: IRelationEntity);
-    init(_data?: any): void;
-    static fromJS(data: any): RelationEntity;
-    toJSON(data?: any): any;
-}
-export interface IRelationEntity {
-    entityType?: string;
-    id?: string;
-    name?: string | undefined;
-    [key: string]: any;
-}
 export declare class Phone implements IPhone {
@@ -406,12 +552,2 @@ countryCode?: string | undefined;
 }
-export declare enum UserStatus {
-    Active = "Active",
-    Suspended = "Suspended"
-}
-export declare enum EntityState {
-    Active = "Active",
-    Archived = "Archived",
-    Deleted = "Deleted",
-    Default = "Default"
-}
 export declare class RegisterUserDTO implements IRegisterUserDTO {
@@ -418,0 +554,0 @@ address?: CreateAddressDTO;

package.json

 {
   "name": "@steffesgroup/steffes-auth",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Steffes Auth",
@@ -5,0 +5,0 @@ "main": "dist/api.js",

No alert changes

Improved metrics

Total package byte prevSize

92869

increased by30.47%

Lines of code

2536

increased by28.54%

No dependency changes