@frontegg/rest-api - npm Package Compare versions

Comparing version 3.1.4 to 3.1.5

auth/index.d.ts

@@ -5,3 +5,3 @@ export * from "./secutiry-poilicy";
 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";
 /*****************************************
@@ -740,2 +740,2 @@ * Authentication
  */
-export declare function getMeAndEntitlements(): Promise<IUserDTO>;
+export declare function getMeAndEntitlements(): Promise<IUserProfile>;

auth/interfaces.d.ts

@@ -1,2 +0,2 @@
-import { ITenantsResponse, IUserDTO, UserEntitlementsResponse } from "..";
+import { ITenantsResponse, IUserProfile, UserEntitlementsResponse } from "..";
 import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from "./enums";
@@ -33,3 +33,3 @@ import { ISamlRolesGroup } from "../teams/interfaces";
 };
-export declare type ILoginResponse = IUserDTO & {
+export declare type ILoginResponse = IUserProfile & {
     mfaRequired: boolean;
@@ -36,0 +36,0 @@ accessToken: string;

ContextHolder/index.d.ts

 import { ContextOptions, RedirectOptions, RequestSource } from '../interfaces';
-import { IUserDTO } from "../users/interfaces";
+import { IUserProfile } from "../users/interfaces";
 /**
@@ -23,3 +23,3 @@ * Entitlements config from frontegg provider
     static setAccessToken(accessToken: string | null): void;
-    static setUser(user: IUserDTO | null): void;
+    static setUser(user: IUserProfile | null): void;
     static setRequestSource(requestSource: RequestSource | null): void;
@@ -40,3 +40,3 @@ static setOnRedirectTo(onRedirectTo: (path: string, opts?: RedirectOptions) => void): void;
     static getRequestSource(): RequestSource | null;
-    static getUser(): IUserDTO | null;
+    static getUser(): IUserProfile | null;
     static onRedirectTo(path: string, opts?: RedirectOptions): void;
@@ -56,5 +56,5 @@ static logout(callback?: () => void): void;
     getAccessToken: () => string | null;
-    getUser: () => IUserDTO | null;
+    getUser: () => IUserProfile | null;
     onRedirectTo: (path: string, opts: RedirectOptions) => void;
     logout: (callback?: (() => void) | undefined) => void;
 };

index.d.ts

@@ -80,3 +80,3 @@ import * as auth from "./auth";
         getAccessToken: () => string | null;
-        getUser: () => import("./users/interfaces").IUserDTO | null;
+        getUser: () => import("./users/interfaces").IGetUsersV2Response | null;
         onRedirectTo: (path: string, opts: import("./interfaces").RedirectOptions) => void;
@@ -83,0 +83,0 @@ logout: (callback?: (() => void) | undefined) => void;

index.js

@@ -1,2 +0,2 @@
-/** @license Frontegg v3.1.4
+/** @license Frontegg v3.1.5
  *
@@ -3,0 +3,0 @@ * This source code is licensed under the MIT license found in the

node/index.js

@@ -1,2 +0,2 @@
-/** @license Frontegg v3.1.4
+/** @license Frontegg v3.1.5
  *
@@ -3,0 +3,0 @@ * This source code is licensed under the MIT license found in the

package.json

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

teams/index.d.ts

@@ -1,5 +0,5 @@
-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
@@ -13,3 +13,3 @@ *****************************************/
  */
-export declare function getProfile(params?: object): Promise<IUserDTO>;
+export declare function getProfile(params?: object): Promise<IUserProfile>;
 /**
@@ -16,0 +16,0 @@ * update user profile by providing updated fields.

teams/interfaces.d.ts

 import { QueryFilter, QuerySort } from "../interfaces";
-import { IRole, IRolePermission } from "../roles/interfaces";
+import { IRole } from "../roles/interfaces";
 export declare enum UserManagedByEnum {
@@ -7,22 +7,2 @@ FRONTEGG = "frontegg",
 }
-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 = {
@@ -29,0 +9,0 @@ tenantId: string;

users/index.d.ts

@@ -1,2 +0,2 @@
-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';
@@ -10,2 +10,2 @@ export declare function GetUserJwt(body: GetUserJwtRequestDto): Promise<GetUserJwtResponseDto>;
 export declare function sendResetBreachedPasswordEmails(): Promise<void>;
-export declare function updateUserProfileV2(body: Partial<IUpdateUserDto>): Promise<IUserDTO>;
+export declare function updateUserProfileV2(body: Partial<IUpdateUserDto>): Promise<IUserProfile>;

users/interfaces.d.ts

@@ -6,2 +6,3 @@ import { PaginationOrderEnum } from '../interfaces';
 import { IGroupResponse } from '../groups/interfaces';
+import { UserEntitlementsResponse } from "../entitlements/interfaces";
 export declare enum SortByEnum {
@@ -42,12 +43,17 @@ createdAt = "createdAt",
 }
+export interface IUserTenantData {
+    tenantId: string;
+    roles: IRole[];
+}
 export interface IBaseUserData {
     id: string;
     email: string;
-    name?: string;
-    profilePictureUrl?: string;
+    name: string;
+    /**
+    * @deprecated
+    * use profilePictureUrl instead
+    */
+    profileImage?: string;
+    profilePictureUrl?: string | null;
 }
-export interface IUserTenantData {
-    tenantId: string;
-    roles: IRole[];
-}
 export interface IBaseGetUserResponse extends IBaseUserData {
@@ -61,3 +67,3 @@ sub: string;
     tenantId: string;
-    tenantIds?: string[];
+    tenantIds: string[];
     activatedForTenant?: boolean;
@@ -73,6 +79,12 @@ isLocked?: boolean;
     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[];
@@ -79,0 +91,0 @@ groups?: Pick<IGroupResponse, 'id' | 'roles'>[];

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

382426

decreased by-0.04%

Lines of code

10466

decreased by-0.08%

No dependency changes