@frontegg/types 7.67.0 → 7.68.0-alpha.1

package/Localizations/AdminPortalLocalizations/provisioning.d.ts

@@ -170,5 +170,9 @@ export interface ProvisioningLocalization {
          * Text Pt.2
          */
         textPartTwo: string;
+        /**
+         * Checkbox label
+         */
+        checkboxLabel: string;
     };
 }

package/Localizations/LocalizationOverrides.d.ts

@@ -16,7 +16,7 @@ export interface LocalizationOverrides {
     validations?: ValidationLocalizationOverrides;
     loginBox?: LoginBoxLocalizationOverrides;
     adminPortal?: AdminPortalLocalizationOverrides;
-    errors: Partial<Localization['errors']>;
+    errors?: Partial<Localization['errors']>;
     custom?: Record<string, string>;
 }
 export {};

package/Localizations/LoginBoxLocalization/activateAccount.d.ts

@@ -87,7 +87,20 @@ export interface ActivateAccountLocalization {
          * Consts for terms and conditions & privacy for activate account page
          */
         disclaimerText: string;
+        /**
+         * Signup disclaimer checkbox label
+         * this text is optional
+         */
         disclaimerCheckboxLabel: string;
+        /**
+         * Signup disclaimer checkbox suffix label
+         * this text is optional
+         */
+        disclaimerCheckboxSuffixLabel: string;
+        /**
+         * Signup disclaimer checkbox suffix label
+         * this text is optional
+         */
         disclaimerTextRequired: string;
         termsLinkText: string;
         termsLink: string;

package/Localizations/LoginBoxLocalization/signup.d.ts

@@ -48,6 +48,22 @@ export interface SignupLocalizationOptions {
      * error message displayed if password is empty
      */
     passwordIsRequired: string;
+    /**
+     * Confirm password input label
+     */
+    confirmPasswordInputLabel: string;
+    /**
+     * String displayed as placeholder when confirm password field is empty
+     */
+    confirmPasswordInputPlaceholder: string;
+    /**
+     * Error displayed when confirm password is empty
+     */
+    confirmPasswordIsRequired: string;
+    /**
+     * Error displayed when passwords does not match
+     */
+    confirmPasswordMustMatch: string;
     /**
      * Signup phone input label
      */
@@ -93,6 +109,11 @@ export interface SignupLocalizationOptions {
      * this text is optional
      */
     disclaimerCheckboxLabel: string;
+    /**
+     * Signup disclaimer checkbox suffix label
+     * this text is optional
+     */
+    disclaimerCheckboxSuffixLabel: string;
     /**
      * error message displayed if disclaimer is not acceppted
      */
@@ -200,7 +221,11 @@ export interface SignupLocalization {
      * strings in signup page
      */
     signup: {
-        account: SignupLocalizationOptions;
-        user: SignupLocalizationOptions;
+        account: Omit<SignupLocalizationOptions, 'title'> & {
+            title?: string;
+        };
+        user: Omit<SignupLocalizationOptions, 'title'> & {
+            title?: string;
+        };
     } & SignupLocalizationOptions;
 }

package/ThemeOptions/LoginBoxTheme/DynamicFields/OverrideSignupFields.d.ts

@@ -0,0 +1,175 @@
+import { i18nTranslation, ValidationSchema, YupInstance } from './helpers';
+/**
+ * A minimal FC (Functional Component) type.
+ * This avoids importing React while still allowing you to type component props.
+ */
+type FC<P = {}> = (props: P) => any;
+interface CommonFieldConfig {
+    /**
+     * used to override input grid size (12 columns), default is 12
+     * 6 is half, in smaller screens it will force to 12
+     */
+    flex?: number;
+    /**
+     * The order of the field in the form.
+     * If not specified, the order will be determined by the order of the fields in the object.
+     */
+    order?: number;
+    /**
+     * Whether to show the field or not.
+     */
+    hide?: boolean;
+    /**
+     * Whether to autofocus on first appear
+     * make sure you have only one field with this prop
+     */
+    autoFocus?: boolean;
+}
+/**
+ * Config for a custom field.
+ */
+interface BaseCustomFieldConfig extends CommonFieldConfig {
+    type: 'custom';
+    initialValue?: any;
+    validationSchema?: ValidationSchema;
+}
+/**
+ * Config for a custom input field.
+ */
+interface InputCustomFieldConfig extends BaseCustomFieldConfig {
+    fieldType: 'input';
+    initialValue?: string;
+    fieldProps?: {
+        /**
+         * The label to be displayed before the input.
+         */
+        label?: string;
+        /**
+         * The placeholder to be displayed inside the input.
+         */
+        placeholder?: string;
+        /**
+         * The tooltip to be displayed on hover '?'.
+         */
+        tip?: string;
+        /**
+         * Whether to show the required '*' sign or not.
+         */
+        addRequiredAsterisk?: boolean;
+        /**
+         * The data test id to be injected to the input element.
+         */
+        'data-test-id'?: string;
+        /**
+         * the autocomplete attribute for the input
+         */
+        autoComplete?: string;
+        /**
+         * if true, the input will be multiline
+         */
+        multiline?: boolean;
+        /**
+         * the html input type default: text
+         */
+        type?: string;
+    };
+}
+/**
+ * Config for a custom select field.
+ */
+interface SelectCustomFieldConfig extends BaseCustomFieldConfig {
+    fieldType: 'select';
+    fieldProps?: {
+        /**
+         * The label to be displayed before the select.
+         */
+        label?: string;
+        /**
+         * The tooltip to be displayed on hover '?'.
+         */
+        tip?: string;
+        /**
+         * The data test id to be injected to the select element.
+         */
+        'data-test-id'?: string;
+        /**
+         * If true, you can select multiple options
+         */
+        multi?: boolean;
+        /**
+         * The options to be displayed in the select.
+         */
+        options: {
+            label: string;
+            value: string | number;
+        }[];
+        /**
+         * If true, will show a clear button to clear the selected value.
+         */
+        clearable?: boolean;
+        /**
+         * If true, the select popup will close when an option is selected.
+         */
+        closeOnSelect?: boolean;
+    };
+}
+/**
+ * Config for a custom select field.
+ */
+interface DisclaimerCustomFieldConfig extends BaseCustomFieldConfig {
+    fieldType: 'disclaimer';
+    fieldProps: {
+        name: string;
+        /**
+         * The label of the field that will be shown beside the checkbox.
+         */
+        label: string;
+    };
+}
+export type CustomFieldConfig = InputCustomFieldConfig | SelectCustomFieldConfig | DisclaimerCustomFieldConfig;
+/**
+ * Config for a standard field.
+ */
+interface StandardFieldConfig extends CommonFieldConfig {
+    type: 'email' | 'name' | 'firstName' | 'lastName' | 'password' | 'confirmPassword' | 'companyName' | 'disclaimer' | 'phoneNumber';
+    initialValue?: any;
+    Component?: FC<any>;
+    validationSchema?: any;
+}
+export interface FronteggFields {
+    email: StandardFieldConfig;
+    name: StandardFieldConfig;
+    firstName: StandardFieldConfig;
+    lastName: StandardFieldConfig;
+    password: StandardFieldConfig;
+    confirmPassword: StandardFieldConfig;
+    companyName: StandardFieldConfig;
+    disclaimer: StandardFieldConfig;
+    phoneNumber: StandardFieldConfig;
+}
+/**
+ * Union type for any form field configuration.
+ * Every field must have a unique key.
+ */
+export type SignupFormFieldConfig = StandardFieldConfig | CustomFieldConfig;
+export type SignupFormFieldConfigWithKey = SignupFormFieldConfig & {
+    key: string;
+};
+export type SignupFormFields = Record<string, SignupFormFieldConfig>;
+export type OverrideSignupFieldsParams = {
+    fields: FronteggFields;
+    Yup: YupInstance;
+    t: i18nTranslation;
+};
+/**
+ * Function type for customers to override or extend the signup fields.
+ * It receives:
+ *  - fields: An array of form field configurations.
+ *  - yup: An instance of our minimal Yup builder.
+ *  - t: A translation function.
+ *
+ * The function should return a modified array of form field configurations.
+ */
+type OverrideSignupFieldsFunction = (params: OverrideSignupFieldsParams) => SignupFormFields;
+export type OverrideSignupFields = OverrideSignupFieldsFunction;
+export {};

package/ThemeOptions/LoginBoxTheme/DynamicFields/OverrideSignupFields.js

@@ -0,0 +1 @@
+export {};

package/ThemeOptions/LoginBoxTheme/DynamicFields/helpers.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A basic i18n translation function type.
+ */
+export type i18nTranslation = (key: string, options?: Record<string, any>) => string;
+/**
+ * Minimal Yup instance interface exposing basic builders.
+ */
+export interface YupInstance {
+    string: () => YupString;
+    number: () => YupNumber;
+    boolean: () => YupBoolean;
+    email: () => YupString;
+    object: <T extends Record<string, any>>(schema: T) => YupObject<T>;
+}
+/**
+ * Minimal Yup string schema.
+ */
+export interface YupString {
+    required: (message?: string) => YupString;
+    email: (message?: string) => YupString;
+}
+/**
+ * Minimal Yup number schema.
+ */
+export interface YupNumber {
+    required: (message?: string) => YupNumber;
+}
+/**
+ * Minimal Yup boolean schema.
+ */
+export interface YupBoolean {
+    required: (message?: string) => YupBoolean;
+}
+/**
+ * Minimal Yup object schema.
+ */
+export interface YupObject<T> {
+    shape: (fields: T) => YupObject<T>;
+}
+export type ValidationSchema = YupObject<any> | YupString | YupNumber | YupBoolean;
+export interface ValidationSchemaObj {
+    type?: 'string' | 'number' | 'boolean' | 'object';
+    length?: {
+        min?: number;
+        max?: number;
+    };
+    required?: {
+        enabled: boolean;
+        message: string;
+    };
+    regex?: {
+        enabled: boolean;
+        message: string;
+    };
+}

package/ThemeOptions/LoginBoxTheme/DynamicFields/helpers.js

@@ -0,0 +1 @@
+export {};

package/ThemeOptions/LoginBoxTheme/DynamicFields/index.d.ts

@@ -0,0 +1 @@
+export * from './OverrideSignupFields';

package/ThemeOptions/LoginBoxTheme/DynamicFields/index.js

@@ -0,0 +1 @@
+export * from './OverrideSignupFields';

package/ThemeOptions/LoginBoxTheme/SignupPageTheme.d.ts

@@ -2,6 +2,7 @@ import { LoginBoxCommonTheme, LoginBoxCommonThemeOptions } from '../index';
 import { ExtendedCSSProperties } from '../../Common';
 import { CustomComponent } from '../ComponentsOptions';
 import { DisclaimerOptions } from '../DisclaimerOptions';
+import { OverrideSignupFields } from './DynamicFields';
 interface TitleProps {
     title: string;
 }
@@ -117,6 +118,18 @@ export interface SignupPageComponentsTheme {
      * by default: false.
      */
     splitFullName?: boolean;
+    /**
+     * Use this options to override the default signup fields
+     * This function will be called before rendering the signup form
+     * and will receive the default signup fields, the Yup instance and the translation function
+     * The function should return the modified array of form field configurations
+     */
+    overrideSignupFields?: OverrideSignupFields;
+    /**
+     * If true, beside the  password field will be displayed a confirmation password field
+     * Default is false
+     */
+    requirePasswordConfirmation?: boolean;
 }
 export interface SignupPageThemeOptions extends LoginBoxCommonThemeOptions, SignupPageComponentsTheme {
 }

package/ThemeOptions/LoginBoxTheme/index.d.ts

@@ -24,6 +24,7 @@ export * from './ResetPasswordTheme';
 export * from './ActivateAccountPageTheme';
 export * from './AcceptInvitationTheme';
 export * from './OpenAppPageTheme';
+export * from './DynamicFields';
 export interface AuthPageThemeOptions extends BaseThemeOptions, AuthPageCustomComponents {
     style?: ExtendedCSSProperties;
     layout?: {

package/ThemeOptions/LoginBoxTheme/index.js

@@ -10,4 +10,5 @@ export * from './ResetPasswordTheme';
 export * from './ActivateAccountPageTheme';
 export * from './AcceptInvitationTheme';
 export * from './OpenAppPageTheme';
+export * from './DynamicFields';
 export {};

package/index.js

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

package/node/ThemeOptions/LoginBoxTheme/DynamicFields/OverrideSignupFields.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/node/ThemeOptions/LoginBoxTheme/DynamicFields/helpers.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/node/ThemeOptions/LoginBoxTheme/DynamicFields/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _OverrideSignupFields = require("./OverrideSignupFields");
+Object.keys(_OverrideSignupFields).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _OverrideSignupFields[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _OverrideSignupFields[key];
+    }
+  });
+});

package/node/ThemeOptions/LoginBoxTheme/index.js

@@ -134,4 +134,15 @@ Object.keys(_OpenAppPageTheme).forEach(function (key) {
       return _OpenAppPageTheme[key];
     }
   });
+});
+var _DynamicFields = require("./DynamicFields");
+Object.keys(_DynamicFields).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _DynamicFields[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _DynamicFields[key];
+    }
+  });
 });

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v7.67.0
+/** @license Frontegg v7.68.0-alpha.1
  *
  * 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,12 +1,12 @@
 {
   "name": "@frontegg/types",
-  "version": "7.67.0",
+  "version": "7.68.0-alpha.1",
   "main": "./node/index.js",
   "author": "Frontegg LTD",
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/redux-store": "7.67.0",
+    "@frontegg/redux-store": "7.68.0-alpha.1",
     "csstype": "^3.0.9",
     "deepmerge": "^4.2.2"
   },