@frontegg/rest-api 3.1.4 → 3.1.5

package/ContextHolder/index.d.ts

@@ -1,5 +1,5 @@
 import { ContextOptions, RedirectOptions, RequestSource } from '../interfaces';
-import { IUserDTO } from "../users/interfaces";
+import { IUserProfile } from "../users/interfaces";
 /**
  * Entitlements config from frontegg provider
  */
@@ -20,7 +20,7 @@ export declare class ContextHolder {
     static getInstance(): ContextHolder;
     static setContext(context: ContextOptions): void;
     static setAccessToken(accessToken: string | null): void;
-    static setUser(user: IUserDTO | null): void;
+    static setUser(user: IUserProfile | null): void;
     static setRequestSource(requestSource: RequestSource | null): void;
     static setOnRedirectTo(onRedirectTo: (path: string, opts?: RedirectOptions) => void): void;
     static setLogout(logout: (callback?: () => void) => void, logoutUrl: string): void;
@@ -36,7 +36,7 @@ export declare class ContextHolder {
     static getContext(): ContextOptions;
     static getAccessToken(): string | null;
     static getRequestSource(): RequestSource | null;
-    static getUser(): IUserDTO | null;
+    static getUser(): IUserProfile | null;
     static onRedirectTo(path: string, opts?: RedirectOptions): void;
     static logout(callback?: () => void): void;
     /**
@@ -51,7 +51,7 @@ export declare class ContextHolder {
 export declare const FronteggContext: {
     getContext: () => ContextOptions;
     getAccessToken: () => string | null;
-    getUser: () => IUserDTO | null;
+    getUser: () => IUserProfile | null;
     onRedirectTo: (path: string, opts: RedirectOptions) => void;
     logout: (callback?: (() => void) | undefined) => void;
 };

package/auth/index.d.ts

@@ -2,7 +2,7 @@ export * from "./secutiry-poilicy";
 export * from "./enums";
 import { ISamlRolesGroup } from "../teams/interfaces";
 import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData, IWebAuthnDevices, ICustomSocialLoginProviderConfigurationV1, ILoginResponseV3, IPreVerifyMFAEmailCodeResponse, IVerifyMFAEmailCode } from './interfaces';
-import { IUserDTO } from "../users/interfaces";
+import { IUserProfile } from "../users/interfaces";
 /*****************************************
  * Authentication
  *****************************************/
@@ -736,4 +736,4 @@ export declare function getMFAStrategiesConfig(): Promise<IMFAStrategiesResponse
 /**
  * @returns me response with entitlements inside user.entitlements
  */
-export declare function getMeAndEntitlements(): Promise<IUserDTO>;
+export declare function getMeAndEntitlements(): Promise<IUserProfile>;

package/auth/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { ITenantsResponse, IUserDTO, UserEntitlementsResponse } from "..";
+import { ITenantsResponse, IUserProfile, UserEntitlementsResponse } from "..";
 import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from "./enums";
 import { ISamlRolesGroup } from "../teams/interfaces";
 export * from "./secutiry-poilicy/interfaces";
@@ -30,7 +30,7 @@ export declare type ILogin = {
     recaptchaToken?: string;
     invitationToken?: string;
 };
-export declare type ILoginResponse = IUserDTO & {
+export declare type ILoginResponse = IUserProfile & {
     mfaRequired: boolean;
     accessToken: string;
     refreshToken: string;

package/index.d.ts

@@ -77,7 +77,7 @@ declare const _default: {
     FronteggContext: {
         getContext: () => import("./interfaces").ContextOptions;
         getAccessToken: () => string | null;
-        getUser: () => import("./users/interfaces").IUserDTO | null;
+        getUser: () => import("./users/interfaces").IGetUsersV2Response | null;
         onRedirectTo: (path: string, opts: import("./interfaces").RedirectOptions) => void;
         logout: (callback?: (() => void) | undefined) => void;
     };

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.1.4
+/** @license Frontegg v3.1.5
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.1.4
+/** @license Frontegg v3.1.5
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {

package/teams/index.d.ts

@@ -1,7 +1,7 @@
-import { IAddUser, IChangePassword, ILoadUsers, IResendActivationLink, ITeamUserRole, ITeamStats, ITeamUser, IUpdateProfile, IUpdateUser, IDeleteUser, ITeamUserPermission, IResendInvitationLink, IInviteUserLinkResponse, ICreateOrUpdateInviteUserLink, IInviteLinkConfiguration, IUserProfile } from './interfaces';
+import { IAddUser, IChangePassword, ILoadUsers, IResendActivationLink, ITeamUserRole, ITeamStats, ITeamUser, IUpdateProfile, IUpdateUser, IDeleteUser, ITeamUserPermission, IResendInvitationLink, IInviteUserLinkResponse, ICreateOrUpdateInviteUserLink, IInviteLinkConfiguration } from './interfaces';
 import { PaginationResult } from '../interfaces';
-import { IUserDTO } from "../users/interfaces";
-/*****************************************
+import { IUserProfile } from "../users/interfaces";
+/****************************************s*
  * Profile Api
  *****************************************/
 /**
@@ -10,7 +10,7 @@ import { IUserDTO } from "../users/interfaces";
  * @throws exception if the current password incorrect or new password validation failed.
  * ``authorized user``
  */
-export declare function getProfile(params?: object): Promise<IUserDTO>;
+export declare function getProfile(params?: object): Promise<IUserProfile>;
 /**
  * update user profile by providing updated fields.
  * ``authorized user``

package/teams/interfaces.d.ts

@@ -1,29 +1,9 @@
 import { QueryFilter, QuerySort } from "../interfaces";
-import { IRole, IRolePermission } from "../roles/interfaces";
+import { IRole } from "../roles/interfaces";
 export declare enum UserManagedByEnum {
     FRONTEGG = "frontegg",
     SCIM2 = "scim2"
 }
-export declare type IUserProfile = {
-    id: string;
-    email: string;
-    mfaEnrolled: boolean;
-    name: string;
-    phoneNumber?: string;
-    profileImage?: string;
-    profilePictureUrl: string | null;
-    roles: IRole[];
-    permissions: IRolePermission[];
-    tenantId: string;
-    tenantIds: string[];
-    activatedForTenant?: boolean;
-    metadata: any;
-    roleIds?: string[];
-    verified?: boolean;
-    superUser?: boolean;
-    managedBy?: UserManagedByEnum;
-    provider?: string;
-};
 export declare type ITeamUserTenant = {
     tenantId: string;
     roles: IRole[];

package/users/index.d.ts

@@ -1,4 +1,4 @@
-import { GetCurrentUserTenantsResponse, GetUserGroupsParams, GetUserGroupsResponse, GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, IGetUsersV2Response, ISearchUserQueryParamsV2, ISearchUserQueryParamsV3, IUpdateUserDto, IUserDTO, IUsersV3Data } from './interfaces';
+import { GetCurrentUserTenantsResponse, GetUserGroupsParams, GetUserGroupsResponse, GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, IGetUsersV2Response, ISearchUserQueryParamsV2, ISearchUserQueryParamsV3, IUpdateUserDto, IUserProfile, IUsersV3Data } from './interfaces';
 import { FronteggPaginationWrapper, UserJwtOptions } from '../interfaces';
 export declare function GetUserJwt(body: GetUserJwtRequestDto): Promise<GetUserJwtResponseDto>;
 export declare function getUsersV2(queryParams: ISearchUserQueryParamsV2, options?: UserJwtOptions): Promise<FronteggPaginationWrapper<IGetUsersV2Response>>;
@@ -7,4 +7,4 @@ export declare function getUsersRoles(queryParams: GetUsersRolesParams, options?
 export declare function getUsersGroups(queryParams: GetUserGroupsParams, options?: UserJwtOptions): Promise<GetUserGroupsResponse[]>;
 export declare function getCurrentUserTenantsV3(options?: UserJwtOptions): Promise<GetCurrentUserTenantsResponse>;
 export declare function sendResetBreachedPasswordEmails(): Promise<void>;
-export declare function updateUserProfileV2(body: Partial<IUpdateUserDto>): Promise<IUserDTO>;
+export declare function updateUserProfileV2(body: Partial<IUpdateUserDto>): Promise<IUserProfile>;

package/users/interfaces.d.ts

@@ -3,6 +3,7 @@ import { ITenantsResponse } from '../tenants/interfaces';
 import { IRole } from '../roles/interfaces';
 import { ITeamUserPermission, UserManagedByEnum } from '../teams/interfaces';
 import { IGroupResponse } from '../groups/interfaces';
+import { UserEntitlementsResponse } from "../entitlements/interfaces";
 export declare enum SortByEnum {
     createdAt = "createdAt",
     name = "name",
@@ -38,16 +39,21 @@ export interface ISearchUserQueryParamsV3 extends IGetUserQueryParams {
     _tenantId?: string;
     _includeSubTenants?: boolean;
 }
-export interface IBaseUserData {
-    id: string;
-    email: string;
-    name?: string;
-    profilePictureUrl?: string;
-}
 export interface IUserTenantData {
     tenantId: string;
     roles: IRole[];
 }
+export interface IBaseUserData {
+    id: string;
+    email: string;
+    name: string;
+    /**
+    * @deprecated
+    * use profilePictureUrl instead
+    */
+    profileImage?: string;
+    profilePictureUrl?: string | null;
+}
 export interface IBaseGetUserResponse extends IBaseUserData {
     sub: string;
     verified: boolean;
@@ -56,7 +62,7 @@ export interface IBaseGetUserResponse extends IBaseUserData {
     phoneNumber?: string;
     provider?: string;
     tenantId: string;
-    tenantIds?: string[];
+    tenantIds: string[];
     activatedForTenant?: boolean;
     isLocked?: boolean;
     tenants: IUserTenantData[];
@@ -67,10 +73,16 @@ export interface IBaseGetUserResponse extends IBaseUserData {
     createdAt?: Date;
     lastLogin?: Date;
     subAccountAccessAllowed?: boolean;
+    entitlements?: UserEntitlementsResponse;
 }
-export declare type IGetUsersV2Response = IUserDTO;
-export interface IUserDTO extends IBaseGetUserResponse {
+export declare type IUserProfile = IGetUsersV2Response;
+export interface IGetUsersV2Response extends IBaseGetUserResponse {
     roles: IRole[];
+    /**
+     * @deprecated
+     * use roles instead
+     */
+    rolesIds?: string[];
     permissions: ITeamUserPermission[];
     groups?: Pick<IGroupResponse, 'id' | 'roles'>[];
 }