@frontegg/types 4.39.1 → 4.39.2-dashboard

package/Common.d.ts

@@ -1,3 +1,6 @@
 import * as CSS from 'csstype';
 export declare type CSSProperties = CSS.Properties;
 export declare type Color = CSSProperties['color'];
+export declare type ExtendedCSSProperties = CSSProperties | {
+    [k in string]?: CSSProperties;
+};

package/ContextOptions.d.ts

@@ -1,9 +1,13 @@
-import { KeyValuePair, LogLevel } from '@frontegg/rest-api/src/interfaces';
+import { KeyValuePair, LogLevel } from '@frontegg/rest-api';
 export interface ContextOptions {
     /**
      * Backend API baseUrl, visit https://portal.frontegg.com/administration/domain to get your Frontegg baseUrl
      */
     baseUrl: string;
+    /**
+     * Frontegg clientId. Identifier from your Frontegg workspace account.
+     */
+    clientId?: string;
     /**
      * Whether or not to send Fetch request with Credentials to the Backend
      * default: 'include'

package/FronteggAppInstance.d.ts

@@ -2,6 +2,7 @@ import { EnhancedStore } from '@frontegg/redux-store';
 import { FronteggAppOptions } from './index';
 export interface FronteggAppInstance {
     name: string;
+    iframeRendering: boolean;
     loading: boolean;
     customElementName: string;
     store: EnhancedStore;

package/FronteggAppOptions.d.ts

@@ -9,10 +9,6 @@ export interface FronteggAppOptions extends FronteggStoreOptions {
     withCompanyName?: boolean;
     contextOptions: ContextOptions;
     themeOptions?: FronteggThemeOptions;
-    /**
-     * Authentication header logo image
-     * @deprecated, use components.authPage.headerImage
-     */
     headerImage?: string;
     /**
      * Authentication background logo image
@@ -60,6 +56,10 @@ export interface FronteggAppOptions extends FronteggStoreOptions {
      * Option to open admin portal as Preview mode without HTTP requests for demo mode purpose
      */
     previewMode?: boolean;
+    /**
+     * Option to display login box as Preview mode without HTTP requests for builder customization mode purpose
+     */
+    builderMode?: boolean;
     /**
      * Connect AdminPortal redirects with the wrapper application router
      */

package/FronteggMetadata.d.ts

@@ -1,4 +1,5 @@
 import { PaletteColorOptions, PaletteGreyOptions } from './ThemeOptions/Palette';
+import { FronteggThemeOptions } from './ThemeOptions';
 declare type PageMetadata = {
     visibility: 'hidden' | 'always' | 'byPermissions';
     featureFlag?: string;
@@ -72,6 +73,7 @@ declare type ThemeMetadata = {
 };
 export declare type FronteggMetadata = {
     theme?: ThemeMetadata;
+    themeV2?: FronteggThemeOptions;
     navigation?: NavigationMetadata;
 };
 export declare type RolePermission = 'fe.connectivity.*' | 'fe.connectivity.delete.*' | 'fe.connectivity.delete.bellNotifications' | 'fe.connectivity.delete.emailConfig' | 'fe.connectivity.delete.slackAppRegistration' | 'fe.connectivity.delete.slackSubscriptionEvent' | 'fe.connectivity.delete.slackSubscriptions' | 'fe.connectivity.delete.smsConfig' | 'fe.connectivity.delete.webhook' | 'fe.connectivity.read.*' | 'fe.connectivity.read.emailConfig' | 'fe.connectivity.read.eventCategories' | 'fe.connectivity.read.events' | 'fe.connectivity.read.slackApp' | 'fe.connectivity.read.slackChannels' | 'fe.connectivity.read.slackSubscriptions' | 'fe.connectivity.read.slackUsers' | 'fe.connectivity.read.smsConfig' | 'fe.connectivity.read.userBellNotifications' | 'fe.connectivity.read.webhookLogs' | 'fe.connectivity.read.webhooks' | 'fe.connectivity.write.*' | 'fe.connectivity.write.emailConfig' | 'fe.connectivity.write.sendWebpushNotification' | 'fe.connectivity.write.slackAppRegistration' | 'fe.connectivity.write.slackSubscriptions' | 'fe.connectivity.write.smsConfig' | 'fe.connectivity.write.subscribeWebpush' | 'fe.connectivity.write.triggerEvent' | 'fe.connectivity.write.updateSlackSubscription' | 'fe.connectivity.write.updateUserBellNotification' | 'fe.connectivity.write.webhook' | 'fe.secure.*' | 'fe.secure.delete.*' | 'fe.secure.delete.role' | 'fe.secure.delete.samlConfiguration' | 'fe.secure.delete.securityPolicy' | 'fe.secure.delete.tenantApiTokens' | 'fe.secure.delete.userApiTokens' | 'fe.secure.delete.users' | 'fe.secure.delete.usersRoles' | 'fe.secure.read.*' | 'fe.secure.read.permissions' | 'fe.secure.read.roles' | 'fe.secure.read.samlConfiguration' | 'fe.secure.read.securityPolicy' | 'fe.secure.read.tenantApiTokens' | 'fe.secure.read.userApiTokens' | 'fe.secure.read.users' | 'fe.secure.write.*' | 'fe.secure.write.resendActivationEmail' | 'fe.secure.write.roles' | 'fe.secure.write.samlConfiguration' | 'fe.secure.write.securityPolicy' | 'fe.secure.write.tenantApiTokens' | 'fe.secure.write.updateRole' | 'fe.secure.write.updateUser' | 'fe.secure.write.userApiTokens' | 'fe.secure.write.users' | 'fe.secure.write.usersRoles' | 'fe.subscriptions.*' | 'fe.subscriptions.read.*' | 'fe.subscriptions.write.*' | 'fe.account-settings.delete.account';

package/Localizations/AdminPortalLocalizations/security.d.ts

@@ -125,6 +125,10 @@ export interface SecurityLocalization {
          * Max attempts before lockout user input placeholder
          */
         attemptsInputPlaceholder: string;
+        /**
+         * Max attempts before lockout user input error message
+         */
+        attemptsInputErrorMessage: string;
         /**
          * Cancel editing lockout policy button text
          */

package/Localizations/LocalizationOverrides.d.ts

@@ -16,5 +16,6 @@ export interface LocalizationOverrides {
     validation?: ValidationLocalizationOverrides;
     loginBox?: LoginBoxLocalizationOverrides;
     adminPortal?: AdminPortalLocalizationOverrides;
+    custom?: Record<string, string>;
 }
 export {};

package/Localizations/LocalizationType.d.ts

@@ -40,5 +40,6 @@ export interface Localization {
     validations: ValidationLocalization;
     loginBox: LoginBoxLocalization;
     adminPortal: AdminPortalLocalization;
+    custom: Record<string, string>;
 }
 export {};

package/Localizations/LoginBoxLocalization/acceptInvitation.d.ts

@@ -3,6 +3,10 @@ export interface AcceptInvitationLocalization {
      * strings in accept invitation account page
      */
     acceptInvitation: {
+        /**
+         * Accept invitation page title
+         */
+        title: string;
         /**
          * Title to be displayed if accept invitation succeeded
          */

package/Localizations/LoginBoxLocalization/activateAccount.d.ts

@@ -3,6 +3,10 @@ export interface ActivateAccountLocalization {
      * strings in activate account page
      */
     activateAccount: {
+        /**
+         * Activate account page title
+         */
+        title: string;
         /**
          * New password input label
          */

package/Localizations/LoginBoxLocalization/forgetPassword.d.ts

@@ -3,6 +3,14 @@ export interface ForgetPasswordLocalization {
      * strings in forget password page
      */
     forgetPassword: {
+        /**
+         * Forget password page title
+         */
+        title: string;
+        /**
+         * Text displayed in forget password form before email input
+         */
+        description: string;
         /**
          * Forget password form email input label
          */

package/Localizations/LoginBoxLocalization/index.d.ts

@@ -6,4 +6,12 @@ import { SocialLoginsLocalization } from './socialLogins';
 import { AcceptInvitationLocalization } from './acceptInvitation';
 import { ActivateAccountLocalization } from './activateAccount';
 import { RecoveryMfaLocalization } from './recoveryMfa';
+export * from './login';
+export * from './signup';
+export * from './forgetPassword';
+export * from './resetPassword';
+export * from './socialLogins';
+export * from './acceptInvitation';
+export * from './activateAccount';
+export * from './recoveryMfa';
 export declare type LoginBoxLocalization = LoginLocalization & SignupLocalization & ForgetPasswordLocalization & ResetPasswordLocalization & SocialLoginsLocalization & AcceptInvitationLocalization & ActivateAccountLocalization & RecoveryMfaLocalization;

package/Localizations/LoginBoxLocalization/login.d.ts

@@ -3,6 +3,10 @@ export interface LoginLocalization {
      * strings in login page
      */
     login: {
+        /**
+         * Login page title
+         */
+        title: string;
         /**
          * Go to signup message in Login page header
          */
@@ -56,10 +60,18 @@ export interface LoginLocalization {
          * Login page submit button if passwordless, sso or magicLink is enabled
          */
         continue: string;
+        /**
+         * String displayed as separator for sign in with social login
+         */
+        signInWithSocialLogin: string;
         /**
          * Button text to return to main login page
          */
         backToLogin: string;
+        /**
+         * Login with MFA title
+         */
+        mfaTitle: string;
         /**
          * Login with MFA six digits input label If MFA is enabled
          */
@@ -72,6 +84,14 @@ export interface LoginLocalization {
          * Error displayed if MFA code length less than 6 characters
          */
         mfaCodeLengthAtLeast6: string;
+        /**
+         * Error displayed if two factor code input is empty
+         */
+        twoFactorCodeIsRequired: string;
+        /**
+         * Error displayed if two code length less than 8 characters
+         */
+        twoFactorCodeLengthAtLeast8: string;
         /**
          * text of remember device CheckBox If MFA is enabled
          * EX: "Don't ask again on this device for {{count}} day"
@@ -85,6 +105,10 @@ export interface LoginLocalization {
          * Disable MFA message in MFA section if it's enabled
          */
         disableMultiFactorMessage: string;
+        /**
+         * Disable MFA page title after choose to recover mfa from login screen
+         */
+        recoverMfaTitle: string;
         /**
          * Disable MFA button click here text in MFA section if it's enabled
          */
@@ -97,6 +121,10 @@ export interface LoginLocalization {
          * Disable MFA button text in MFA section if it's enabled
          */
         disabledMultiFactorButton: string;
+        /**
+         * Error message shown when trying to login without public policy
+         */
+        missingPolicyErrorMessage: string;
         /**
          * Magic link title if login strategy is MagicLink
          */

package/Localizations/LoginBoxLocalization/resetPassword.d.ts

@@ -3,6 +3,14 @@ export interface ResetPasswordLocalization {
      * strings in forget password page
      */
     resetPassword: {
+        /**
+         * Reset password page title
+         */
+        title: string;
+        /**
+         * Text displayed in reset password form before password inputs
+         */
+        description: string;
         /**
          * New password input label
          */

package/Localizations/LoginBoxLocalization/signup.d.ts

@@ -3,6 +3,10 @@ export interface SignupLocalization {
      * strings in signup page
      */
     signup: {
+        /**
+         * Sign up page title
+         */
+        title: string;
         /**
          * Signup name input label
          */
@@ -65,6 +69,10 @@ export interface SignupLocalization {
          * error message displayed if name length less than 3
          */
         companyNameMinLengthIs3: string;
+        /**
+         * String displayed as separator for sign up with social login
+         */
+        signUpWithSocialLogin: string;
         /**
          * Go to login message in signup page header
          */

package/Metadata/index.d.ts

@@ -5,7 +5,7 @@ export declare class Metadata {
     static _instances: Record<string, Metadata>;
     static getInstance(name?: string): Metadata;
     static set(metadata?: FronteggMetadata, name?: string): Metadata;
-    get theme(): Required<FronteggMetadata>['theme'];
+    get theme(): Required<FronteggMetadata>['themeV2'];
     get navigation(): Required<FronteggMetadata>['navigation'];
     set(metadata?: FronteggMetadata): void;
 }

package/ThemeOptions/ComponentsOptions.d.ts

@@ -1,3 +1,66 @@
+import { CSSProperties, ExtendedCSSProperties } from '../Common';
+export declare type CustomComponent<T = {}> = null | string | ((props: T) => string | any);
+export interface InputThemeOptions {
+    /**
+     * Input label style
+     */
+    label?: ExtendedCSSProperties;
+    /**
+     * Input base style for standard state
+     */
+    base?: ExtendedCSSProperties & {
+        placeholderColor?: string;
+    };
+    /**
+     * Input style for hover state
+     */
+    hover?: ExtendedCSSProperties;
+    /**
+     * Input style for active state
+     */
+    active?: ExtendedCSSProperties;
+    /**
+     * Input style for focus state
+     */
+    focus?: ExtendedCSSProperties;
+    /**
+     * Input style for disabled state
+     */
+    disabled?: ExtendedCSSProperties;
+}
+export interface ButtonThemeOptions {
+    /**
+     * Button base style for standard state
+     */
+    base?: ExtendedCSSProperties;
+    /**
+     * Button style for hover state
+     */
+    hover?: ExtendedCSSProperties;
+    /**
+     * Button style for active state
+     */
+    active?: ExtendedCSSProperties;
+    /**
+     * Button style for focus state
+     */
+    focus?: ExtendedCSSProperties;
+    /**
+     * Button style for disabled state
+     */
+    disabled?: ExtendedCSSProperties;
+    /**
+     * Icon style displayed inside the button element
+     */
+    icon?: ExtendedCSSProperties;
+}
+export interface LoginBoxBackgroundTheme {
+    backgroundColor?: CSSProperties['backgroundColor'];
+    backgroundImage?: CSSProperties['backgroundImage'];
+    backgroundSize?: CSSProperties['backgroundSize'];
+    backgroundRepeat?: CSSProperties['backgroundRepeat'];
+    backgroundPosition?: CSSProperties['backgroundPosition'];
+}
 export interface ComponentsOptions {
     /**
      * Refer to Material UI theming guideline.

package/ThemeOptions/LoginBoxTheme/AcceptInvitationTheme.d.ts

@@ -0,0 +1,21 @@
+import { LoginBoxCommonTheme, LoginBoxCommonThemeOptions } from '../index';
+import { ExtendedCSSProperties } from '../../Common';
+interface AcceptInvitationComponentsTheme {
+    /**
+     * Accept invitation page container style
+     */
+    containerStyle?: ExtendedCSSProperties;
+    /**
+     * Accept invitation succeeded page container style
+     */
+    successContainerStyle?: ExtendedCSSProperties;
+    /**
+     * Accept invitation failed page container style
+     */
+    failedContainerStyle?: ExtendedCSSProperties;
+}
+export interface AcceptInvitationPageThemeOptions extends LoginBoxCommonThemeOptions, AcceptInvitationComponentsTheme {
+}
+export interface AcceptInvitationPageTheme extends LoginBoxCommonTheme, AcceptInvitationComponentsTheme {
+}
+export {};

package/ThemeOptions/LoginBoxTheme/ActivateAccountPageTheme.d.ts

@@ -0,0 +1,52 @@
+import { CustomComponent, LoginBoxCommonTheme, LoginBoxCommonThemeOptions } from '../index';
+import { ExtendedCSSProperties } from '../../Common';
+import { ReactNode } from 'react';
+interface TitleProps {
+    title: string;
+}
+interface MessageProps {
+    message: ReactNode;
+}
+interface ActivateAccountComponentsTheme {
+    /**
+     * Activate account page container style
+     */
+    containerStyle?: ExtendedCSSProperties;
+    /**
+     * Activate account form container style
+     */
+    formContainerStyle?: ExtendedCSSProperties;
+    /**
+     * Activate account succeeded page container style
+     */
+    successContainerStyle?: ExtendedCSSProperties;
+    /**
+     * Activate account failed page container style
+     */
+    failedContainerStyle?: ExtendedCSSProperties;
+    /**
+     * Activate account page title default is 'Activate Account'
+     * displayed in forgot password form screen
+     * passing 'null' will hide the title
+     */
+    title?: CustomComponent<TitleProps>;
+    /**
+     * Direct css style for Forgot password Page title
+     */
+    titleStyle?: ExtendedCSSProperties;
+    /**
+     * Activate account page message default is hidden
+     * displayed in forgot password form screen
+     * passing 'null' will hide the message
+     */
+    message?: CustomComponent<MessageProps>;
+    /**
+     * Direct css style for Forgot password Page message
+     */
+    messageStyle?: ExtendedCSSProperties;
+}
+export interface ActivateAccountPageThemeOptions extends LoginBoxCommonThemeOptions, ActivateAccountComponentsTheme {
+}
+export interface ActivateAccountPageTheme extends LoginBoxCommonTheme, ActivateAccountComponentsTheme {
+}
+export {};

package/ThemeOptions/LoginBoxTheme/CustomLoginComponents.d.ts

@@ -0,0 +1,12 @@
+export interface CustomLocalizationProps {
+    t: (key: string) => string;
+}
+export interface CustomContainerProps extends CustomLocalizationProps {
+    className: string;
+}
+export interface ComponentKeyRender {
+    'pageHeader': CustomContainerProps;
+    'pageFooter': CustomContainerProps;
+    'boxHeader': CustomContainerProps;
+    'boxFooter': CustomContainerProps;
+}

package/ThemeOptions/LoginBoxTheme/ForgotPasswordTheme.d.ts

@@ -0,0 +1,46 @@
+import { CustomComponent, LoginBoxCommonTheme, LoginBoxCommonThemeOptions } from '../index';
+import { ExtendedCSSProperties } from '../../Common';
+import { ReactNode } from 'react';
+interface TitleProps {
+    title: string;
+}
+interface MessageProps {
+    message: ReactNode;
+}
+interface ForgotPasswordComponentsTheme {
+    /**
+     * Forgot password page container style
+     */
+    containerStyle?: ExtendedCSSProperties;
+    /**
+     * Forgot password page form container style
+     */
+    formContainerStyle?: ExtendedCSSProperties;
+    successContainerStyle?: ExtendedCSSProperties;
+    /**
+     * Forgot password page title default is 'Forgot your password?'
+     * displayed in forgot password form screen
+     * passing 'null' will hide the title
+     */
+    title?: CustomComponent<TitleProps>;
+    /**
+     * Direct css style for Forgot password Page title
+     */
+    titleStyle?: ExtendedCSSProperties;
+    /**
+     * Forgot password page message default:
+     * 'Enter the email address associated with your account and we'll send you a link to reset your password'
+     * displayed in forgot password form screen
+     * passing 'null' will hide the message
+     */
+    message?: CustomComponent<MessageProps>;
+    /**
+     * Direct css style for Forgot password Page message
+     */
+    messageStyle?: ExtendedCSSProperties;
+}
+export interface ForgotPasswordPageThemeOptions extends LoginBoxCommonThemeOptions, ForgotPasswordComponentsTheme {
+}
+export interface ForgotPasswordPageTheme extends LoginBoxCommonTheme, ForgotPasswordComponentsTheme {
+}
+export {};

package/ThemeOptions/LoginBoxTheme/LoaderTheme.d.ts

@@ -0,0 +1,7 @@
+import { ExtendedCSSProperties } from '../../Common';
+export interface LoaderThemeOptions {
+    containerStyle?: ExtendedCSSProperties;
+}
+export interface LoaderTheme {
+    containerStyle?: ExtendedCSSProperties;
+}

package/ThemeOptions/LoginBoxTheme/LoginBoxCommon.d.ts

@@ -0,0 +1,148 @@
+import { ExtendedCSSProperties } from '../../Common';
+import { BaseTheme, BaseThemeOptions } from '../index';
+import { ButtonThemeOptions, CustomComponent, InputThemeOptions } from '../ComponentsOptions';
+/**
+ *   @RootElement
+ *   - @WrapperElement
+ *   | - Header
+ *   | - Box
+ *   |  | - Header
+ *   |  | - Content
+ *   |  | - SocialLogin
+ *   |  |  | - Header
+ *   |  |  | - Google
+ *   |  |  | - Microsoft
+ *   |  |  | - Footer
+ *   |  | - Footer
+ *   | - Footer
+ */
+interface LogoComponent {
+    /**
+     * Company logo Url or native html element as string
+     */
+    image?: string | any | CustomComponent;
+    /**
+     * Company logo placement in Login Pages
+     * box = inside the login box element
+     * page = displayed at the top of the page
+     */
+    placement?: 'box' | 'page';
+    alignment?: 'left' | 'right' | 'center';
+    /**
+     *  Direct css styling for Company Logo container component
+     */
+    style?: ExtendedCSSProperties;
+}
+interface LoginBoxOptionalCommon {
+    /**
+     * Header component placed in before section content.
+     * Mostly used for Company Logo or Page title
+     * Accepts:
+     *  - string as url for rendering image element with src='url'
+     *  - string as base64 for rendering image as base64 content
+     *  - ReactElement will be rendered inside LoginBox VirtualTree
+     */
+    pageHeader?: CustomComponent;
+    /**
+     * Footer component placed in before section content
+     * Mostly used for Disclaimers or Back buttons
+     * Accepts:
+     *  - string as url for rendering image element with src='url'
+     *  - string as base64 for rendering image as base64 content
+     *  - ReactElement will be rendered inside LoginBox VirtualTree
+     */
+    pageFooter?: CustomComponent;
+    /**
+     * Company logo Url or native html element as string
+     */
+    logo?: LogoComponent;
+    /**
+     * Powered by frontegg placement
+     * box = inside the login box element
+     * page = displayed at the bottom of the page
+     */
+    poweredByPlacement?: 'box' | 'page';
+    /**
+     * BoxElement
+     * It is a Card component placed inside the [WrapperElement]{@link pageStyle}
+     * The purpose of this element is to
+     * By default it's have flex display and justify content center
+     */
+    boxStyle?: ExtendedCSSProperties;
+    /**
+     * Header component placed in inside the login box and before login inputs.
+     * Accepts:
+     *  - string as url for rendering image element with src='url'
+     *  - string as base64 for rendering image as base64 content
+     *  - ReactElement will be rendered inside LoginBox VirtualTree  (should be pure component without hooks and HOC)
+     */
+    boxHeader?: CustomComponent;
+    /**
+     * Direct css styling for applying css for all (Box title) in LoginBox pages
+     */
+    boxTitleStyle?: ExtendedCSSProperties;
+    /**
+     * Direct css styling for applying css for all (Box message or Box subtitle) in LoginBox pages
+     */
+    boxMessageStyle?: ExtendedCSSProperties;
+    /**
+     * Footer component placed in inside the login box and after login inputs.
+     * Mostly used for Disclaimers or Back buttons
+     * Accepts:
+     *  - string as url for rendering image element with src='url'
+     *  - string as base64 for rendering image as base64 content
+     *  - ReactElement will be rendered inside LoginBox VirtualTree
+     */
+    boxFooter?: CustomComponent;
+    /**
+     * Option to customize login box inputs by providing
+     * css style for every state (base, hover, focus, disabled, etc...)
+     */
+    inputTheme?: InputThemeOptions;
+    /**
+     * Option to customize login box standard buttons by providing
+     * css style for every state (base, hover, focus, disabled, etc...)
+     */
+    buttonTheme?: ButtonThemeOptions;
+    /**
+     * Option to customize login box link buttons by providing
+     * css style for every state (base, hover, focus, disabled, etc...)
+     */
+    linkButtonTheme?: ButtonThemeOptions;
+    /**
+     * Option to customize login box submit buttons by providing
+     * css style for every state (base, hover, focus, disabled, etc...)
+     */
+    submitButtonTheme?: ButtonThemeOptions;
+}
+export interface LoginBoxCommonTheme extends BaseTheme, LoginBoxOptionalCommon {
+    /**
+     * RootElement
+     * The root DIV element of specific login box page
+     * By default it's have fixed and full width/height size
+     */
+    rootStyle: ExtendedCSSProperties;
+    /**
+     * PageElement
+     * It is DIV element placed inside the [RootElement]{@link rootStyle}
+     * The purpose of this element is to wrapper the Box Component and other custom components
+     * By default it's have flex display and justify content center
+     */
+    pageStyle: ExtendedCSSProperties;
+}
+export interface LoginBoxCommonThemeOptions extends BaseThemeOptions, LoginBoxOptionalCommon {
+    /**
+     * RootElement
+     * The root DIV element of specific login box page
+     * By default it's have fixed and full width/height size
+     */
+    rootStyle?: ExtendedCSSProperties;
+    /**
+     * PageElement
+     * It is DIV element placed inside the [RootElement]{@link rootStyle}
+     * The purpose of this element is to wrapper the Box Component and other custom components
+     * By default it's have flex display and justify content center
+     */
+    pageStyle?: ExtendedCSSProperties;
+}
+export {};