@bolttech/form-engine 0.10.7 → 0.11.0

package/src/adapters/react/asFormField.d.ts

@@ -1,14 +1,4 @@
-import React, { ReactElement } from 'react';
-import { TComponent } from '@core';
-interface HocProps {
-    Comp: (new () => React.Component) | any;
-    propsMapping: Record<string, string>;
-}
-declare type DecoratorProps<OriginalComponentProps = Record<string, unknown>> = OriginalComponentProps & Pick<TComponent, 'validations' | 'masks' | 'clearFields' | 'api' | 'errorMessages' | 'filter' | 'formatters' | 'visibilityConditions'> & {
-    formId?: string;
-    visibility?: boolean;
-    name: string;
-    value?: any;
-};
-declare const asFormField: <OriginalComponentProps>({ Comp, propsMapping }: HocProps) => ({ name, validations, errorMessages, masks, filter, formatters, visibilityConditions, formId, visibility, value, ...props }: DecoratorProps<OriginalComponentProps>) => ReactElement;
+import { ReactElement } from 'react';
+import { TAsFormFieldProps, TDecoratorProps } from '@react/types';
+declare const asFormField: <OriginalComponentProps>({ Comp, propsMapping }: TAsFormFieldProps) => ({ name, validations, errorMessages, masks, filter, formatters, visibilityConditions, formId, visibility, value, ...props }: TDecoratorProps<OriginalComponentProps>) => ReactElement;
 export default asFormField;

package/src/adapters/react/types.d.ts

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import React, { ReactElement } from 'react';
 import { TComponent, TErrorMessages, TSchemaValidation, TSchemaValidations, TSchema, THooks, TIVars, TFormValues, TField, TChildrenOptions, TPropsMapping, TComponentPropsMapping, TScope } from '@core/types';
 import { TLoggingEvent } from '@core/events/events.types';
 declare type TFormProps = {
@@ -206,4 +206,94 @@ declare type TFormRefActions = {
     validateForm(opts?: TChildrenOptions): TFormValues;
     values(opts: Pick<TChildrenOptions, 'scopeBlurredChildren' | 'scopeChangedChildren' | 'childrenScope'>): TFormValues;
 };
-export type { TComponent, TMapper, TChildrenOptions, TFormValues, TFormRefActions, TChildWrapperProps, TContext, TFormProps, TProvider, TErrorMessages, TSchemaValidation, TSchemaValidations, };
+declare type TUseFormProps = {
+    /**
+     * The if of the form you want to connect to
+     */
+    id?: string;
+    /**
+     * And array of ids of forms you want to connect to
+     */
+    ids?: string[];
+    /**
+     * Callback to be called when form validity toggled
+     * @param data All the available form data
+     * @param field
+     */
+    onValid?(data: TFormValues | Record<string, TFormValues>, field: TField): void;
+    /**
+     * Callback to be called when the form generates some new data
+     * @param data All the available form data
+     */
+    onData?(data: TFormValues | Record<string, TFormValues>): void;
+    /**
+     * Callback to be called when the form submits
+     * @param data All the available form data
+     */
+    onSubmit?(data: TFormValues | Record<string, TFormValues>): void;
+};
+declare type TUseFormGroupProps = {
+    /**
+     * And array of ids of forms you want to connect to
+     */
+    ids?: string[];
+    /**
+     * The if of the form group you want to merge
+     */
+    group?: string;
+    /**
+     * Callback to be called when the form generates some new data
+     * @param data All the available form data
+     */
+    onData?(data: Record<string, TFormValues>): void;
+    /**
+     * Callback to be called when the form submits
+     * @param data All the available form data
+     */
+    onSubmit?(data: Record<string, TFormValues>): void;
+};
+declare type THookReturn = {
+    /**
+     * A function that lets you start the form submission
+     */
+    submitForm(): void;
+    /**
+     * You can call this function to get all the updated form data.
+     *
+     * @param opts Options to configure your form data. The aggregate prop is only available on useFormGroup.
+     */
+    formData(opts?: TChildrenOptions & {
+        aggregate?: boolean;
+    }): TFormValues | Record<string, TFormValues>;
+};
+interface TAsFormFieldProps {
+    /**
+     * The component to be used as form field.
+     */
+    Comp: (new () => React.Component) | any;
+    /**
+     * Link for the TPropsMapping likely props mapper from default form.
+     */
+    propsMapping: TPropsMapping;
+}
+declare type TDecorator = {
+    /**
+     * Form id that you need to create and integrate the field.
+     */
+    formId?: string;
+    /**
+     * It's a prop that you can use to hide the component and control this state outside the component.
+     */
+    visibility?: boolean;
+    /**
+     * Name of the component similar to name prop name on TComponent type.
+     * This name will be used later to correlate the field with the value, and you will be able to read it.
+     */
+    name: string;
+    /**
+     * The value of the field that you can control outside the component.
+     */
+    value?: any;
+};
+declare type TDecoratorProps<OriginalComponentProps = Record<string, unknown>> = OriginalComponentProps & Pick<TComponent, 'validations' | 'masks' | 'clearFields' | 'api' | 'errorMessages' | 'filter' | 'formatters' | 'visibilityConditions'> & TDecorator;
+export type { TComponent, TMapper, TChildrenOptions, TFormValues, TFormRefActions, TChildWrapperProps, TContext, TFormProps, TProvider, TErrorMessages, TSchemaValidation, TSchemaValidations, TUseFormProps, TUseFormGroupProps, THookReturn, TAsFormFieldProps, TDecoratorProps, };

package/src/adapters/react/useForm.d.ts

@@ -1,45 +1,6 @@
-import { TChildrenOptions, TFormValues } from '@react/types';
-import { TField } from '@core';
-declare type TProps = {
-    /**
-     * The if of the form you want to connect to
-     */
-    id?: string;
-    /**
-     * And array of ids of forms you want to connect to
-     */
-    ids?: string[];
-    /**
-     * Callback to be called when form validity toggled
-     * @param data All the available form data
-     * @param field
-     */
-    onValid?(data: TFormValues, field: TField): void;
-    /**
-     * Callback to be called when the form generates some new data
-     * @param data All the available form data
-     */
-    onData?(data: TFormValues): void;
-    /**
-     * Callback to be called when the form submits
-     * @param data All the available form data
-     */
-    onSubmit?(data: TFormValues): void;
-};
-declare type THookReturn = {
-    /**
-     * A function that lets you start the form submission
-     */
-    submitForm(): void;
-    /**
-     * You can call this function to get all the updated form data
-     *
-     * @param opts Options to configure your form data
-     */
-    formData(opts?: TChildrenOptions): TFormValues;
-};
+import { THookReturn, TUseFormProps } from '@react/types';
 /**
- * This hooks lets you connect to your form/s in anywherer in your application. Even if you are outside the <FormProvider />
+ * This hooks lets you connect to your form/s in anywhere in your application. Even if you are outside the <FormProvider />
  *
  * You can connect to:
  * - A specific form
@@ -47,5 +8,5 @@ declare type THookReturn = {
  * - A group of forms
  *
  */
-declare const useForm: ({ onValid, onData, onSubmit, id, ids, }: TProps) => THookReturn;
+declare const useForm: ({ onValid, onData, onSubmit, id, ids, }: TUseFormProps) => THookReturn;
 export default useForm;

package/src/adapters/react/useFormGroup.d.ts

@@ -1,15 +1,3 @@
-import { TChildrenOptions, TFormValues } from '@react/types';
-declare type TProps = {
-    ids?: string[];
-    group?: string;
-    onData?(data: Record<string, TFormValues>): void;
-    onSubmit?(data: Record<string, TFormValues>): void;
-};
-declare type THookReturn = {
-    submitForm(): void;
-    formData(opts?: TChildrenOptions & {
-        aggregate?: boolean;
-    }): Record<string, TFormValues>;
-};
-declare const useFormGroup: ({ group, onData, onSubmit, ids, }: TProps) => THookReturn;
+import { THookReturn, TUseFormGroupProps } from '@react/types';
+declare const useFormGroup: ({ group, onData, onSubmit, ids, }: TUseFormGroupProps) => THookReturn;
 export { useFormGroup };

package/src/core/constants/events.d.ts

@@ -10,6 +10,7 @@ export declare const enum EEVents {
     ON_FIELD_CLICK = "ON_FIELD_CLICK",
     ON_FIELD_KEYUP = "ON_FIELD_KEYUP",
     ON_FIELD_KEYDOWN = "ON_FIELD_KEYDOWN",
+    ON_FIELD_BINDED = "ON_FIELD_BINDED",
     AFTER_FIELD_API_CALL = "AFTER_FIELD_API_CALL",
     RUN_FIELD_VALIDATIONS = "RUN_FIELD_VALIDATIONS",
     RUN_FIELD_MASKS = "RUN_FIELD_MASKS",
@@ -24,6 +25,7 @@ export declare const enum EEVents {
     NAVIGATE_STEP_FORWARD = "NAVIGATE_STEP_FORWARD",
     NAVIGATE_STEP_BACK = "NAVIGATE_STEP_BACK",
     VALIDATE_FORM = "VALIDATE_FORM",
+    BIND_FIELDS = "BIND_FIELDS",
     LOG = "LOG"
 }
 export declare const CoreEvents: Record<TEventsKeys, TEventsKeys>;

package/src/core/events/events.types.d.ts

@@ -6,7 +6,7 @@ export declare type TEventPublishPayload = {
 } & {
     [key in string]?: unknown;
 };
-export declare type TEventInformation = TObserverData & {
+export declare type TEventInformation<T> = TObserverData<T> & {
     eventReducedSchema: TEventReducedSchema;
     formEventDirectives: TFormEventDirectives;
     form: Form;

package/src/core/handlers/common/templating.d.ts

@@ -1,8 +1,2 @@
 import * as Events from '@core/events';
-export declare const template: {
-    BEGIN: string;
-    END: string;
-    DEFAULT_SPLITTER: string;
-};
-export declare const extractTargetString: (target: string, form: any, field?: any) => string | number | boolean | Record<string, unknown>;
-export declare const handler: ({ field, form, }: Pick<Events.TEventInformation, 'form' | 'field'>) => void;
+export declare const handler: ({ field, form, }: Pick<Events.TEventInformation<unknown>, 'form' | 'field'>) => void;

package/src/core/handlers/field/api.d.ts

@@ -1,4 +1,4 @@
 import { TComponent } from '@core';
 import * as Events from '@core/events';
-export declare const handler: ({ field, form, eventReducedSchema: { api }, }: Pick<Events.TEventInformation, 'form' | 'field' | 'eventReducedSchema'>) => void;
+export declare const handler: ({ field, form, eventReducedSchema: { api }, }: Pick<Events.TEventInformation<unknown>, 'form' | 'field' | 'eventReducedSchema'>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/field/blur.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field, }: Pick<Events.TEventInformation, 'field' | 'eventReducedSchema'>) => void;
+export declare const handler: ({ field, }: Pick<Events.TEventInformation<unknown>, 'field' | 'eventReducedSchema'>) => void;

package/src/core/handlers/field/change.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field, data, }: Pick<Events.TEventInformation, 'field' | 'data'>) => void;
+export declare const handler: ({ field, data, }: Pick<Events.TEventInformation<unknown>, 'field' | 'data'>) => void;

package/src/core/handlers/field/clearFields.d.ts

@@ -1,4 +1,4 @@
 import * as Events from '@core/events';
-import { TComponent } from "@core";
-export declare const handler: ({ field, form, eventReducedSchema, }: Pick<Events.TEventInformation, 'form' | 'eventReducedSchema' | 'field'>) => void;
+import { TComponent } from '@core';
+export declare const handler: ({ field, form, eventReducedSchema, }: Pick<Events.TEventInformation<unknown>, 'form' | 'eventReducedSchema' | 'field'>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/field/data.d.ts

@@ -1,3 +1,3 @@
 import { TFormValues } from '@core';
 import { TEventInformation } from '@core/events';
-export declare const handler: ({ form, field, }: Pick<TEventInformation, 'form' | 'field'>) => TFormValues;
+export declare const handler: ({ form, field, }: Pick<TEventInformation<unknown>, 'form' | 'field'>) => TFormValues;

package/src/core/handlers/field/filter.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field, data, eventReducedSchema: { formatters }, }: Events.TEventInformation) => void;
+export declare const handler: ({ field, data, eventReducedSchema: { formatters }, }: Events.TEventInformation<unknown>) => void;

package/src/core/handlers/field/focus.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field }: Pick<Events.TEventInformation, 'field'>) => void;
+export declare const handler: ({ field }: Pick<Events.TEventInformation<unknown>, 'field'>) => void;

package/src/core/handlers/field/formatters.d.ts

@@ -1,4 +1,4 @@
 import { TComponent } from '@core';
 import { TEventInformation } from '@core/events';
-export declare const handler: ({ data, field, eventReducedSchema: { formatters }, }: TEventInformation) => void;
+export declare const handler: ({ data, field, eventReducedSchema: { formatters }, }: TEventInformation<unknown>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/field/htmlEventParser.d.ts

@@ -1,5 +1,5 @@
 import { TEventInformation } from '@core/events';
-export declare const handler: ({ field, data: { event } }: TEventInformation) => {
+export declare const handler: ({ field, data: { event } }: TEventInformation<unknown>) => {
     parsedEventValue: any;
     metadata: any;
     isDeletingValue: boolean;

package/src/core/handlers/field/keydown.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field, data, }: Pick<Events.TEventInformation, 'field' | 'data'>) => void;
+export declare const handler: ({ field, data, }: Pick<Events.TEventInformation<unknown>, 'field' | 'data'>) => void;

package/src/core/handlers/field/keyup.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ field, data, }: Pick<Events.TEventInformation, 'field' | 'data'>) => void;
+export declare const handler: ({ field, data, }: Pick<Events.TEventInformation<unknown>, 'field' | 'data'>) => void;

package/src/core/handlers/field/masks.d.ts

@@ -1,4 +1,4 @@
 import { TComponent } from '@core';
 import * as Events from '@core/events';
-export declare const handler: ({ field, eventReducedSchema: { masks }, }: Events.TEventInformation) => void;
+export declare const handler: ({ field, eventReducedSchema: { masks }, }: Events.TEventInformation<unknown>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/field/mount.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ form, field, }: Pick<Events.TEventInformation, 'form' | 'field'>) => void;
+export declare const handler: ({ form, field, }: Pick<Events.TEventInformation<unknown>, 'form' | 'field'>) => void;

package/src/core/handlers/field/validations.d.ts

@@ -1,4 +1,4 @@
 import { TComponent } from '@core';
 import * as Events from '@core/events';
-export declare const handler: ({ field, eventReducedSchema: { validations }, form, }: Pick<Events.TEventInformation, 'field' | 'eventReducedSchema' | 'form'>) => void;
+export declare const handler: ({ field, eventReducedSchema: { validations }, form, }: Pick<Events.TEventInformation<unknown>, 'field' | 'eventReducedSchema' | 'form'>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/field/visibilityConditions.d.ts

@@ -1,4 +1,4 @@
 import { TComponent } from '@core';
 import * as Events from '@core/events';
-export declare const handler: ({ form, field, eventReducedSchema, }: Pick<Events.TEventInformation, 'form' | 'field' | 'eventReducedSchema'>) => void;
+export declare const handler: ({ form, field, eventReducedSchema, }: Pick<Events.TEventInformation<unknown>, 'form' | 'field' | 'eventReducedSchema'>) => void;
 export declare const events: (component: TComponent) => string[];

package/src/core/handlers/flows.d.ts

@@ -12,6 +12,7 @@ import * as validations from '@core/handlers/field/validations';
 import * as hooks from '@core/handlers/form/hooks';
 import * as steps from '@core/handlers/form/steps';
 import * as validate from '@core/handlers/form/validate';
+import * as bindFields from '@core/handlers/form/bindFields';
 import * as formLevelVisibilityConditions from '@core/handlers/form/visibilityConditions';
 import * as formTemplating from '@core/handlers/form/templating';
 declare const register: (observer: Events.Observer, flows: any, component?: any | TSchema) => void;
@@ -22,6 +23,7 @@ declare const fieldFlows: () => {
     ON_FIELD_KEYDOWN: (typeof filter)[];
     ON_FIELD_REHYDRATE: (typeof validations)[];
     ON_FIELD_CLEARED: (typeof filter)[];
+    ON_FIELD_BINDED: (typeof filter)[];
     ON_FIELD_CLICK: (typeof api)[];
     ON_FIELD_BLUR: (typeof blur | typeof data)[];
     ON_FIELD_FOCUS: (typeof focus)[];
@@ -39,5 +41,6 @@ declare const formFlows: () => {
     NAVIGATE_STEP_FORWARD: (typeof steps)[];
     ON_FORM_REHYDRATE: (typeof formLevelVisibilityConditions)[];
     ON_FIELD_CHANGE: (typeof formLevelVisibilityConditions)[];
+    BIND_FIELDS: (typeof bindFields)[];
 };
 export { register, fieldFlows, formFlows };

package/src/core/handlers/form/bindFields.d.ts

@@ -0,0 +1,3 @@
+import * as Events from '@core/events';
+import { TSubmitValueData } from '@core/types';
+export declare const handler: ({ form, payload, }: Pick<Events.TEventInformation<TSubmitValueData>, 'form' | 'payload'>) => void;

package/src/core/handlers/form/hooks.d.ts

@@ -1,3 +1,3 @@
 import { TEventInformation } from '@core/events';
 import { THookPayload } from '@core/types';
-export declare const handler: ({ form, }: Pick<TEventInformation, 'form'>) => THookPayload;
+export declare const handler: ({ form, }: Pick<TEventInformation<unknown>, 'form'>) => THookPayload;

package/src/core/handlers/form/steps.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ form, event, payload, }: Pick<Events.TEventInformation, 'form' | 'event' | 'payload'>) => void;
+export declare const handler: ({ form, event, payload, }: Pick<Events.TEventInformation<unknown>, 'form' | 'event' | 'payload'>) => void;

package/src/core/handlers/form/templating.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ form }: Pick<Events.TEventInformation, 'form'>) => void;
+export declare const handler: ({ form, }: Pick<Events.TEventInformation<unknown>, 'form'>) => void;

package/src/core/handlers/form/validate.d.ts

@@ -1,2 +1,2 @@
 import * as Events from '@core/events';
-export declare const handler: ({ form, payload, }: Pick<Events.TEventInformation, 'form' | 'payload'>) => void;
+export declare const handler: ({ form, payload, }: Pick<Events.TEventInformation<unknown>, 'form' | 'payload'>) => void;

package/src/core/handlers/form/visibilityConditions.d.ts

@@ -1,4 +1,4 @@
 import { TSchema } from '@core';
 import { TEventInformation } from '@core/events';
-export declare const handler: ({ form, formEventDirectives, }: Pick<TEventInformation, 'form' | 'formEventDirectives'>) => void;
+export declare const handler: ({ form, formEventDirectives, }: Pick<TEventInformation<unknown>, 'form' | 'formEventDirectives'>) => void;
 export declare const events: (schema: TSchema) => string[];

package/src/core/managers/Field.d.ts

@@ -9,6 +9,8 @@ declare class Field extends Base {
     get value(): any;
     set value(value: any);
     get component(): TComponent;
+    get componentProps(): Record<string, unknown>;
+    set componentProps(props: Record<string, unknown>);
     get data(): TField;
     set data(data: TField);
     set visibility(visible: boolean);

package/src/core/managers/Form.d.ts

@@ -2,7 +2,7 @@ import Field from '@core/managers/Field';
 import Scope from '@core/managers/Scope';
 import Base from '@core/managers/Base';
 import * as Events from '@core/events';
-import { TComponent, TFormValues, TSchema, TStepData, TComponentPropsMapping, TFormEventDirectives, TEventsKeys } from '@core/types';
+import { TComponent, TFormValues, TSchema, TStepData, TComponentPropsMapping, TFormEventDirectives, TEventsKeys, TFields } from '@core/types';
 declare class Form extends Base {
     #private;
     formData: TFormValues;
@@ -11,18 +11,14 @@ declare class Form extends Base {
     scopedSchema: TSchema;
     scope: Scope;
     initialValues: Record<string, unknown>;
-    steps: Record<number, {
-        [x in string]: Field;
-    }>;
+    steps: Record<number, TFields>;
     group: string;
     constructor(formId: string, observer: Events.Observer, scope: Scope, schema: TSchema, opts: {
         initialValues: Record<string, unknown>;
     }, group: any);
     get step(): TStepData;
     set step(step: TStepData);
-    get fields(): {
-        [x: string]: Field;
-    };
+    get fields(): TFields;
     eventReducedSchema(event: TEventsKeys): TFormEventDirectives;
     getFieldInstance(component: TComponent, propsMapping?: TComponentPropsMapping): Field;
     rehydrate(): void;

package/src/core/types/index.d.ts

@@ -2,11 +2,12 @@
 import { ICustomValidationValue } from '@core/apis/validations';
 import { EEVents } from '@core/constants';
 import { TEventInformation } from '@core/events';
-export declare type TObserverData = {
+import Field from "@core/managers/Field";
+export declare type TObserverData<T> = {
     data: any;
     event: TEventsKeys;
     namespace: string;
-    payload: any;
+    payload: T;
 };
 export declare type TObservable = (data: any, unsubscribe: () => void) => any;
 export declare type TEvents = Record<string, TObservable[]>;
@@ -64,12 +65,20 @@ export declare type TChildrenOptions = {
     scopeChangedChildren?: boolean;
 };
 export declare type TFieldData = Record<string, TField>;
+export declare type TFields = {
+    [x in string]: Field;
+};
+export declare type TSubmitValueData = Record<string, {
+    value?: unknown;
+    props?: Record<string, unknown>;
+}>;
 export declare type TFormRefActions = {
     submit(): void;
     step(index: number | string): TFormValues;
     stepForward(index?: number | string): TFormValues;
     stepBack(index?: number | string): TFormValues;
     validateForm(opts?: TChildrenOptions): Promise<TFormValues>;
+    bindFields(payload: TSubmitValueData): void;
     values(opts: Pick<TChildrenOptions, 'scopeBlurredChildren' | 'scopeChangedChildren' | 'childrenScope'>): TFormValues;
 };
 export declare type THookPayload = {
@@ -539,7 +548,7 @@ export declare type TErrors = Record<string, TError> | undefined;
 export declare type TErrorMessages = Record<string, string>;
 export declare type TSchemaValidations = TSchemaHandler<TSchemaValidation>;
 declare type TFormLevelSchemaHandler<T> = Partial<Record<EEVents.AFTER_FIELD_API_CALL | EEVents.ON_FIELD_CHANGE | EEVents.ON_FIELD_KEYUP | EEVents.ON_FIELD_KEYDOWN | EEVents.ON_FORM_REHYDRATE | EEVents.ON_FORM_MOUNT | EEVents.ON_SCOPE_CHANGE, T>>;
-declare type TSchemaHandler<T> = Partial<Record<EEVents.AFTER_FIELD_API_CALL | EEVents.ON_FIELD_REHYDRATE | EEVents.ON_FIELD_CLEARED | EEVents.ON_FIELD_CHANGE | EEVents.ON_FIELD_KEYUP | EEVents.ON_FIELD_KEYDOWN | EEVents.ON_FIELD_BLUR | EEVents.ON_FIELD_MOUNT | EEVents.ON_FIELD_FOCUS | EEVents.ON_FIELD_CLICK, T>>;
+declare type TSchemaHandler<T> = Partial<Record<EEVents.AFTER_FIELD_API_CALL | EEVents.ON_FIELD_REHYDRATE | EEVents.ON_FIELD_CLEARED | EEVents.ON_FIELD_BINDED | EEVents.ON_FIELD_CHANGE | EEVents.ON_FIELD_KEYUP | EEVents.ON_FIELD_KEYDOWN | EEVents.ON_FIELD_BLUR | EEVents.ON_FIELD_MOUNT | EEVents.ON_FIELD_FOCUS | EEVents.ON_FIELD_CLICK, T>>;
 export declare type TSchemaVisibilityConditions = {
     /**
      * Enables visibility of fields only if any or all validation conditions are positive.
@@ -570,6 +579,7 @@ export declare type TSchemaVisibilityConditions = {
      */
     fieldNames?: string[];
 }[];
+export declare type TClearFieldValue = string | number | boolean;
 export declare type TClearField = {
     /**
      * The clearValues runs validations on the target field and not on the field it is declaring.
@@ -585,9 +595,13 @@ export declare type TClearField = {
      */
     fields: string[];
     /**
-     * The cleared values on the fields in case they do no pass the validation
+     * The cleared values on the fields in case they do not pass the validation
      */
-    clearedValue: string | number | boolean;
+    clearedValue: TClearFieldValue | TClearFieldValue[];
+    /**
+     * The cleared props from each component field on target fields array
+     */
+    clearedProps?: Record<string, unknown> | Record<string, unknown>[];
 };
 export declare type TSchemaClearFields = TClearField[];
 export declare type TSchemaApi = {
@@ -613,7 +627,7 @@ export declare type TFormEventDirectives = {
 };
 export declare type TComponent = {
     /**
-     * This name will be used latter to corelate the field with the value and you will be able to read it
+     * This name will be used later to correlate the field with the value, and you will be able to read it.
      *
      * You can also mount here complex objects like
      *
@@ -628,7 +642,7 @@ export declare type TComponent = {
      */
     name: string;
     /**
-     * A component name that should map to the one you gave in the from mappings
+     * A component name that should map to the one you gave in the form mappings
      *
      * @example - For React
      * ```
@@ -723,6 +737,9 @@ export declare type TComponent = {
      * ```
      */
     validations?: TSchemaHandler<Pick<TEventReducedSchema, 'validations'>['validations']>;
+    /**
+     * Filters the component value based on a validation.
+     */
     filter?: Pick<TEventReducedSchema, 'validations'>['validations'];
     /**
      * Allows you to specify the conditions a given field will be visible
@@ -733,8 +750,17 @@ export declare type TComponent = {
      * Will clear target fields in case they do not pass with the specified validations
      */
     clearFields?: Omit<TSchemaHandler<Pick<TEventReducedSchema, 'clearFields'>['clearFields']>, 'ON_FIELD_REHYDRATE' | 'ON_FIELD_CLEARED' | 'ON_FIELD_FOCUS'>;
+    /**
+     * Allows you to make api calls using events emitted by the component.
+     */
     api?: Omit<TSchemaHandler<Pick<TEventReducedSchema, 'api'>['api']>, 'ON_FIELD_REHYDRATE' | 'ON_FIELD_FOCUS' | 'AFTER_FIELD_API_CALL'>;
+    /**
+    * Allows you to display the value of the masked component by events
+    */
     masks?: Partial<Record<EEVents.ON_FIELD_BLUR | EEVents.ON_FIELD_MOUNT | EEVents.ON_FIELD_FOCUS | EEVents.ON_FIELD_CHANGE | EEVents.ON_FIELD_KEYUP | EEVents.ON_FIELD_KEYDOWN, Pick<TEventReducedSchema, 'masks'>['masks']>>;
+    /**
+     * Allows you to format the value that the field will receive for each event issuance
+     */
     formatters?: Omit<TSchemaHandler<Pick<TEventReducedSchema, 'formatters'>['formatters']>, 'ON_FIELD_REHYDRATE' | 'ON_FIELD_FOCUS'>;
 };
 export declare type TEventReducedSchema = {
@@ -832,7 +858,7 @@ export declare type TConfigs = {
 export declare type TFlowType = {
     [x: string]: {
         events: (component?: TComponent) => EEVents[];
-        handler: (args: TEventInformation) => void;
+        handler: (args: TEventInformation<unknown>) => void;
     }[];
 };
 export {};

package/src/core/utils/common.d.ts

@@ -0,0 +1,9 @@
+import Scope from '@core/managers/Scope';
+declare const template: {
+    BEGIN: string;
+    END: string;
+    DEFAULT_SPLITTER: string;
+};
+declare const getScopedField: <T>(scope: T, childrenScope?: string[]) => T;
+declare const extractTargetString: <T>(target: string, formScope: Scope, scope?: Scope) => T;
+export { getScopedField, extractTargetString, template };

package/src/core/utils/index.d.ts

@@ -2,3 +2,5 @@ export * as object from '@core/utils/object';
 export * as creditCard from '@core/utils/credit-card';
 export type { ICreditCardType } from '@core/utils/credit-card';
 export * as string from '@core/utils/string';
+export * as common from '@core/utils/common';
+export * as value from '@core/utils/value';

package/src/core/utils/object.d.ts

@@ -1,5 +1,5 @@
-import Form from "@core/managers/Form";
-import Field from "@core/managers/Field";
+import Form from '@core/managers/Form';
+import Field from '@core/managers/Field';
 /**
  * Encapsulates in a given object, at a given path the provided value
  *
@@ -24,5 +24,4 @@ import Field from "@core/managers/Field";
  * @returns One new object with the new value at the provided path merged with the given object
  */
 declare const encapsulateIn: (origin: Record<string, unknown>, path: string, value: string, form: Form, field: Field) => Record<string, unknown>;
-declare const getValueByPath: (object?: Record<string, any>, path?: string) => string | number | boolean | Record<string, unknown>;
-export { encapsulateIn, getValueByPath };
+export { encapsulateIn };

package/src/core/utils/value.d.ts

@@ -0,0 +1,2 @@
+declare const getValueByPath: (object?: Record<string, any>, path?: string) => string | number | boolean | Record<string, unknown>;
+export { getValueByPath };