@bolttech/form-engine 3.1.1-beta.3 → 3.1.1

package/package.json

@@ -1,13 +1,24 @@
 {
   "name": "@bolttech/form-engine",
-  "version": "3.1.1-beta.3",
+  "version": "3.1.1",
   "description": "A react adapter for bolttech form engine",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.esm.js",
+      "default": "./index.esm.js"
+    }
+  },
+  "dependencies": {
+    "@bolttech/form-engine-core": "1.1.0"
+  },
+  "peerDependencies": {
+    "react": "19.1.2",
+    "react-dom": "19.1.2"
+  },
   "module": "./index.esm.js",
   "type": "module",
   "main": "./index.esm.js",
-  "dependencies": {
-    "@bolttech/form-engine-core": "1.0.1-beta.3",
-    "react": "18.2.0"
-  },
-  "peerDependencies": {}
-}
+  "types": "./index.d.ts"
+}

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";

package/src/components/AsFormField/AsFormField.d.ts

@@ -1,13 +0,0 @@
-import { ReactNode } from 'react';
-import { TAsFormFieldProps } from './AsFormField.type';
-/**
- * Component wrapper to aid building schemas with react without writting a JSON schema
- * along with BuildAsFormFieldTree inside a Form component, FieldWrapper gets this props
- * to build the component as it does with a JSON schema, this component only works inside
- * the Form component
- *
- * @param {TAsFormFieldProps} props JSON schema props
- * @returns {ReactNode}
- */
-declare const AsFormField: (props: TAsFormFieldProps) => ReactNode;
-export default AsFormField;

package/src/components/AsFormField/AsFormField.type.d.ts

@@ -1,9 +0,0 @@
-import { IComponentSchemaAsFormField } from '@bolttech/form-engine-core';
-import { ElementType, PropsWithChildren } from 'react';
-/**
- * AsFormField props, inherits all schema field implementation except the children
- * property and has mappers property to pass a custom component, that will be a ReactNode
- * @see {@link IComponentSchemaWithMapper}
- */
-type TAsFormFieldProps = PropsWithChildren<Omit<IComponentSchemaAsFormField<ElementType>, 'children'>>;
-export type { TAsFormFieldProps };

package/src/components/AsFormFieldBuilder/AsFormFieldBuilder.d.ts

@@ -1,11 +0,0 @@
-import { ReactElement } from 'react';
-import { TAsFormFieldBuilderProps } from './AsFormFieldBuilder.type';
-/**
- * Component Wrapper to render form fields without the Form component, gets additional formId and mapper since
- * it won't rely on them and needs to be manually declared
- *
- * @param {TAsFormFieldBuilderProps} props JSON schema props along with FieldWrapper props and mapper props
- * @returns {ReactElement}
- */
-declare const AsFormFieldBuilder: (props: TAsFormFieldBuilderProps) => ReactElement;
-export default AsFormFieldBuilder;

package/src/components/AsFormFieldBuilder/AsFormFieldBuilder.type.d.ts

@@ -1,21 +0,0 @@
-import { IComponentSchema, TFieldEvent, TMapper } from '@bolttech/form-engine-core';
-import { ElementType, PropsWithChildren } from 'react';
-import { TFieldWrapper } from '../../types';
-/**
- * AsFormField props, inherits all schema field implementation except the children
- * property, that will be a ReactNode
- * also gets the formIndex for form identification and the mapper to build the component
- * @property {TMapper} mapper element mapper to use
- * @property {boolean} visibility element controlled visibility
- * @property {(data: TFieldEvent) => void} onSelected element callback on selected option
- * @see {@link TMapper}
- * @see {@link IComponentSchema}
- * @see {@link TFieldWrapper}
- */
-type TAsFormFieldBuilderProps = PropsWithChildren<Omit<IComponentSchema, 'children' | 'component' | 'name'> & Required<TFieldWrapper> & {
-    mapper: TMapper<ElementType>;
-    visibility?: boolean;
-    onSelected?: (data: TFieldEvent) => void;
-    formMounted?: boolean;
-}>;
-export type { TAsFormFieldBuilderProps };

package/src/components/FieldWrapper/FieldWrapper.d.ts

@@ -1,11 +0,0 @@
-import { ReactElement } from 'react';
-import { TFieldWrapperProps } from './FieldWrapper.type';
-/**
- * Base field Wrapper to render the component with the necessary configurations from the schema
- * and mapper configuration
- *
- * @param {TFieldWrapperProps} param FieldWrapper params
- * @returns {ReactElement}
- */
-declare const FieldWrapper: ({ name, formIndex, children, props, context, mounted, mapper, visibility, }: TFieldWrapperProps) => ReactElement;
-export default FieldWrapper;

package/src/components/FieldWrapper/FieldWrapper.type.d.ts

@@ -1,32 +0,0 @@
-import { ElementType, PropsWithChildren } from 'react';
-import { TFieldWrapper } from '../../types';
-import { TFormContext } from '../../context/FormGroupContext';
-import { FormField, TMapper } from '@bolttech/form-engine-core';
-/**
- * Represents the props for a field wrapper component, including children.
- *
- * @property {Record<string, unknown>} [props] - Additional properties for the field.
- * @property {TFormContext | null} [context] - The context of the form, which may be null.
- * @property {React.ReactNode} children - The child elements of the component.
- * @see {@link TFieldWrapper}
- */
-type TFieldWrapperProps = PropsWithChildren<TFieldWrapper & {
-    props?: Record<string, unknown>;
-    context?: TFormContext | null;
-    mounted?: boolean;
-    mapper?: TMapper<ElementType>;
-    visibility?: boolean;
-}>;
-/**
- * Represents the props for rendering a field wrapper component, including children.
- *
- * @property {Record<string, unknown>} props - Additional properties for the field.
- * @property {FormField} [fieldInstance] - The instance of the form field, which may be undefined.
- * @property {React.ReactNode} children - The child elements of the component.
- */
-type TFieldWrapperComponentRenderProps = PropsWithChildren<{
-    props: Record<string, unknown>;
-    fieldInstance?: FormField;
-    mapper?: TMapper<ElementType>;
-}>;
-export type { TFieldWrapperProps, TFieldWrapperComponentRenderProps };

package/src/components/Form/Form.d.ts

@@ -1,9 +0,0 @@
-import { ReactElement } from 'react';
-import { TFormProps } from './Form.type';
-/**
- *
- * @param {TFormProps} param form properties initializor
- * @returns {ReactElement}
- */
-declare function Form<T>({ schema, index, initialValues, iVars, action, method, config, onSubmit, onFormMount, onData, onBlur, onChange, onApiResponse, onClick, onFocus, onKeyDown, onKeyUp, onMount, onValid, children, }: TFormProps<T>): ReactElement;
-export default Form;

package/src/components/Form/Form.type.d.ts

@@ -1,11 +0,0 @@
-import { TFormEntry } from '@bolttech/form-engine-core';
-import { PropsWithChildren } from 'react';
-import { TEventsCallbackProps } from '../../types';
-/**
- * Form props, inherits the form instance constructor implementation except the mapper
- * along with all event callback register props shared with other implementations
- * @see {@link TFormEntry}
- * @see {@link TEventsCallbackProps}
- */
-type TFormProps<T> = PropsWithChildren<Omit<TFormEntry, 'mappers'> & TEventsCallbackProps<T>>;
-export type { TFormProps };

package/src/components/index.d.ts

@@ -1,3 +0,0 @@
-export { default as Form } from './Form/Form';
-export { default as AsFormField } from './AsFormField/AsFormField';
-export { default as AsFormFieldBuilder } from './AsFormFieldBuilder/AsFormFieldBuilder';

package/src/context/FormGroupContext.d.ts

@@ -1,19 +0,0 @@
-import { PropsWithChildren, ReactElement } from 'react';
-import { TFormContext, TFormContextProvider } from './FormGroupContext.type';
-declare const FormGroupContext: import("react").Context<TFormContext>;
-/**
- * context provider to wrap form-engine adapter elements
- *
- * @param {PropsWithChildren<TFormContextProvider>} param context parameters
- * @returns {ReactElement}
- */
-declare const FormGroupContextProvider: ({ children, mappers, debugMode, config, }: PropsWithChildren<TFormContextProvider>) => ReactElement;
-/**
- * FormGroup context hook to handle context or isolated context implementations
- *
- * @param {TFormContextProvider} props form group context parameters
- * @returns {TFormContext}
- */
-declare const useFormGroupContext: (props?: TFormContextProvider) => TFormContext;
-export { FormGroupContext, FormGroupContextProvider, useFormGroupContext };
-export type { TFormContext };

package/src/context/FormGroupContext.type.d.ts

@@ -1,48 +0,0 @@
-import { FormCore, TFormEntry, TFormGroup, TFormValues, TMapper, TSchemaFormConfig } from '@bolttech/form-engine-core';
-import { ElementType } from 'react';
-/**
- * Represents the context for managing forms within a form group.
- *
- * @property {function(string): void} addFormWithIndex - Adds a form to the form group by its index.
- * @property {function({ key: string, formInstance: TFormCore }): void} addForm - Adds a form to the form group using a payload containing the key and form instance.
- * @property {function({ key: string }): (FormCore | undefined)} getForm - Retrieves a form from the form group using a payload containing the key.
- * @property {function({ key: string }): void} removeForm - Removes a form from the form group using a payload containing the key.
- * @property {TFormGroup} formGroupInstance - The instance of the form group.
- * @property {TMapper<ElementType>[]} [mappers] - Optional array of mappers for elements.
- * @property {function(): void} printFormGroupInstance - Prints the form group instance.
- * @property {function(string[]): TFormValues} submitMultipleFormsByIndex - Submits multiple forms by their indexes and returns the form values.
- * @property {boolean} debugMode - Indicates if debug mode is active.
- * @property {boolean} active - Indicates if the form context is active.
- */
-type TFormContext = {
-    addFormWithIndex: (index: string) => void;
-    addForm: (payload: {
-        key: string;
-        params: TFormEntry;
-    }) => void;
-    getForm: (payload: {
-        key: string;
-    }) => FormCore | undefined;
-    removeForm: (payload: {
-        key: string;
-    }) => void;
-    formGroupInstance: TFormGroup;
-    mappers?: TMapper<ElementType>[];
-    printFormGroupInstance: () => void;
-    submitMultipleFormsByIndex: <T>(indexes: string[], callback?: (payload: TFormValues<T>) => void) => void;
-    debugMode: boolean;
-    active: boolean;
-    config?: TSchemaFormConfig;
-};
-/**
- * Represents the props for a form context provider.
- *
- * @property {TMapper<ElementType>[]} [mappers] - Optional array of mappers for elements.
- * @property {boolean} [debugMode] - Optional flag indicating if debug mode should be enabled.
- */
-type TFormContextProvider = {
-    mappers?: TMapper<ElementType>[];
-    debugMode?: boolean;
-    config?: TSchemaFormConfig;
-};
-export type { TFormContext, TFormContextProvider };

package/src/generators/formBuilder.d.ts

@@ -1,9 +0,0 @@
-import { ElementType } from 'react';
-import { TMapper, IComponentSchema } from '@bolttech/form-engine-core';
-declare const BuildSchemaAsFields: ({ components, mappers, formIndex, mountedForm, }: {
-    components?: IComponentSchema[] | undefined;
-    mappers?: TMapper<ElementType>[] | undefined;
-    formIndex: string;
-    mountedForm: boolean;
-}) => import("react/jsx-runtime").JSX.Element[] | undefined;
-export { BuildSchemaAsFields };

package/src/helpers/helpers.d.ts

@@ -1,7 +0,0 @@
-import { TEvents } from '@bolttech/form-engine-core';
-import { TEventProps } from '../types';
-/**
- * events mapping to aid function callback binding
- */
-declare const eventsMapping: Partial<Record<TEvents, TEventProps>>;
-export { eventsMapping };

package/src/helpers/mapper.d.ts

@@ -1,8 +0,0 @@
-import { TValueChangeEvent } from '@bolttech/form-engine-core';
-declare const defaultChangeEvent: TValueChangeEvent;
-declare const checkedChangeEvent: TValueChangeEvent;
-declare const valueChangeEvent: TValueChangeEvent;
-declare const numberInputChangeEvent: TValueChangeEvent;
-declare const datepickerChangeEvent: TValueChangeEvent;
-declare const dropdownChangeEvent: TValueChangeEvent;
-export { defaultChangeEvent, checkedChangeEvent, valueChangeEvent, numberInputChangeEvent, datepickerChangeEvent, dropdownChangeEvent, };

package/src/hooks/index.d.ts

@@ -1,2 +0,0 @@
-export { default as useForm } from './useForm/useForm';
-export { default as useFormGroup } from './useFormGroup/useFormGroup';

package/src/hooks/useForm/useForm.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import { TUseFormProps } from './useForm.type';
-/**
- * Hook to register events callback functions
- */
-declare function useForm<T>({ id, onData, onSubmit, onFormMount, onValid, ...rest }: TUseFormProps<T>, deps?: React.DependencyList): void;
-export default useForm;

package/src/hooks/useForm/useForm.type.d.ts

@@ -1,12 +0,0 @@
-import { TEventsCallbackProps } from '../../types';
-/**
- * Represents the properties for the useForm hook, including an ID and event callback properties.
- *
- * @property {string} id - The unique identifier for the form.
- *
- * @see {@link TEventsCallbackProps}
- */
-type TUseFormProps<T> = {
-    id: string;
-} & TEventsCallbackProps<T>;
-export type { TUseFormProps };

package/src/hooks/useFormGroup/useFormGroup.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="react" />
-import { TUseFormGroup } from './useFormGroup.type';
-declare function useFormGroup<T>({ ids, onData, onValid, onSubmit }: TUseFormGroup<T>, deps?: React.DependencyList): void;
-export default useFormGroup;

package/src/hooks/useFormGroup/useFormGroup.type.d.ts

@@ -1,17 +0,0 @@
-import { TFormGroupOnDataEventPayload, TFormGroupOnSubmitEventPayload, TFormGroupOnValidEventPayload } from '@bolttech/form-engine-core';
-/**
- * Represents the properties for the useFormGroup hook, including a list of ID's and event callback properties.
- *
- * @property {string} ids - The unique identifier for the forms.
- * @property {payload: TFormGroupOnDataEventPayload<T>} onData - callback event occurring when a value is changing via input or logic.
- * @property {payload: TFormGroupOnValidEventPayload} onData - callback event occurring when validation status changes on the form.
- * @property {payload: TFormGroupOnSubmitEventPayload<T>} onData - event occurring when form submission is trigger.
- *
- */
-type TUseFormGroup<T> = {
-    ids: string[];
-    onData?: (payload: TFormGroupOnDataEventPayload<T>) => void;
-    onValid?: (payload: TFormGroupOnValidEventPayload) => void;
-    onSubmit?: (payload: TFormGroupOnSubmitEventPayload<T>) => void;
-};
-export type { TUseFormGroup };

package/src/index.d.ts

@@ -1,5 +0,0 @@
-export * from './components';
-export * from './hooks';
-export * from './context/FormGroupContext';
-export * from './types';
-export * from './helpers/mapper';

package/src/types/index.d.ts

@@ -1,32 +0,0 @@
-import { TFieldEvent, TFormValidationPayload, TFormValues } from '@bolttech/form-engine-core';
-/**
- * Represents a field wrapper containing the name of the field and its index in the form.
- *
- * @property {string} name - The name of the field.
- * @property {string} formIndex - The index of the field within the form.
- */
-type TFieldWrapper = {
-    name: string;
-    formIndex: string;
-};
-/**
- * Represents the possible event properties for form fields callbacks.
- */
-type TEventProps = 'onChange' | 'onBlur' | 'onFocus' | 'onKeyDown' | 'onKeyUp' | 'onMount' | 'onApiResponse' | 'onApiRequest' | 'onClick' | 'onFieldCleared';
-/**
- * Represents the content inside onData payload action.
- */
-type TFormData<T> = {
-    field: string;
-    data: TFormValues<T>;
-};
-/**
- * Represents a mapping of event properties to their corresponding callback functions.
- */
-type TEventsCallbackProps<T> = Partial<Record<TEventProps, ((payload: TFieldEvent) => void) | null | undefined>> & {
-    onFormMount?: (payload: TFormValues<T>) => void;
-    onData?: (payload: TFormData<T>) => void;
-    onSubmit?: (payload: TFormValues<T>) => void;
-    onValid?: (payload: TFormValidationPayload) => void;
-};
-export { TFieldWrapper, TEventProps, TEventsCallbackProps, TFormData };