@bolttech/form-engine 0.14.3 → 3.0.0-beta.2

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@bolttech/form-engine",
-  "version": "0.14.3",
-  "description": "A form engine based on form events for react projects",
-  "type": "commonjs",
+  "version": "3.0.0-beta.2",
+  "description": "A react adapter for bolttech form engine",
+  "type": "module",
   "exports": {
     ".": {
-      "types": "./src/index.d.ts",
-      "import": "./index.js",
-      "require": "./index.js",
-      "default": "./index.js"
+      "types": "./src/index.esm.d.ts",
+      "import": "./index.esm.js",
+      "require": "./index.esm.js",
+      "default": "./index.esm.js"
     },
-    "./src/core": "./types.js",
-    "./src/adapters/react": "./react.js"
+    "./types": "./types.js"
   },
   "typesVersions": {
     "*": {
@@ -20,19 +19,19 @@
       ]
     }
   },
+  "dependencies": {
+    "@exchange-portal/form-engine-core": "dist/libs/form-engine-core/index.cjs.js"
+  },
   "keywords": [
     "bolttech",
     "edirect",
-    "form-engine",
+    "form-builder",
+    "react",
     "forms",
-    "reactjs",
     "low-code"
   ],
   "author": "bolttech",
   "license": "ISC",
-  "dependencies": {
-    "credit-card-type": "^9.1.0"
-  },
-  "main": "./index.cjs",
-  "types": "./src/index.d.ts"
+  "module": "./index.esm.js",
+  "main": "./index.esm.js"
 }

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

@@ -0,0 +1,4 @@
+import { IComponentSchema } from '@exchange-portal/form-engine-core';
+import { PropsWithChildren, ReactElement } from 'react';
+declare const AsFormField: (props: PropsWithChildren<Omit<IComponentSchema, 'children'>>) => ReactElement;
+export default AsFormField;

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

@@ -0,0 +1,4 @@
+import { PropsWithChildren, ReactElement } from 'react';
+import { TFieldWrapper } from '../../types';
+declare const FieldWrapper: ({ index, Component, formKey, children, events, }: PropsWithChildren<TFieldWrapper>) => ReactElement;
+export default FieldWrapper;

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

@@ -0,0 +1,4 @@
+import { TFormEntry } from '@exchange-portal/form-engine-core';
+import { PropsWithChildren } from 'react';
+declare const Form: ({ schema, index, initialValues, iVars, action, method, onSubmit, onData, children, }: PropsWithChildren<Omit<TFormEntry, 'mappers'>>) => import("react/jsx-runtime").JSX.Element;
+export default Form;

package/src/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Form/Form';
+export * from './AsFormField/AsFormField';

package/src/context/FormGroupContext.d.ts

@@ -0,0 +1,27 @@
+import { FormCore, TFormCore, TFormGroup, TFormValues, TMapper } from '@exchange-portal/form-engine-core';
+import { ElementType, PropsWithChildren, ReactElement } from 'react';
+type TFormContext = {
+    addForm: (payload: {
+        key: string;
+        formInstance: TFormCore;
+    }) => void;
+    getForm: (payload: {
+        key: string;
+    }) => FormCore | undefined;
+    removeForm: (payload: {
+        key: string;
+    }) => void;
+    formGroupInstance: TFormGroup;
+    mappers: TMapper<ElementType>[];
+    printFormGroupInstance: () => void;
+    submitMultipleFormsByIndex: (indexes: string[]) => TFormValues;
+    debugMode: boolean;
+};
+type TFormContextProvider = {
+    mappers: TMapper<ElementType>[];
+    debugMode?: boolean;
+};
+declare const FormGroupContext: import("react").Context<TFormContext>;
+declare const FormGroupContextProvider: ({ children, mappers, debugMode, }: PropsWithChildren<TFormContextProvider>) => ReactElement;
+declare const useFormGroupContext: () => TFormContext;
+export { FormGroupContext, FormGroupContextProvider, useFormGroupContext };

package/src/generators/formBuilder.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from 'react';
+import { IFormField, IComponentSchema } from '@exchange-portal/form-engine-core';
+declare const BuildTree: ({ fields, prevPath, formKey, }: {
+    fields: Map<string, IFormField>;
+    prevPath?: string | undefined;
+    formKey: string;
+}) => ReactNode;
+declare const BuildAsFormFieldTree: ({ children, }: {
+    children?: ReactNode;
+}) => IComponentSchema[] | null | undefined;
+export { BuildTree, BuildAsFormFieldTree };

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export type { TComponent, TField, TSchema, TFormRefActions, TFormValues, THookPayload, TEventsKeys, TObserverData, TScope, } from './core/types';
-export { TAvailableHooks, CoreEvents, ALL_NAMESPACE_EVENTS, BUILD_EVENT, } from './core';
-export { Form, FormProvider, useForm, asFormField } from './adapters/react';
+export * from './components';
+export * from './context/FormGroupContext';
+export * from './types';

package/src/types/index.d.ts

@@ -0,0 +1,47 @@
+import { TComponentPropsMapping } from '@exchange-portal/form-engine-core';
+import { ElementType } from 'react';
+/**
+ * @type TFieldWrapper
+ * Represents the wrapper for a form field, including the component,
+ * event handlers, and other properties related to form management.
+ *
+ * @property {string} index - The index of the field in the form.
+ * @property {ElementType} Component - The component to be rendered.
+ * @property {(event: unknown) => unknown} [valueChangeEvent] - Function to handle value change events.
+ * @property {string} formKey - The key of the form.
+ * @property {string} [onBlur] - Function to handle the blur event.
+ * @property {string} [onChange] - Function to handle the change event.
+ * @property {string} [onFocus] - Function to handle the focus event.
+ * @property {string} [onClick] - Function to handle the click event.
+ * @property {string} [onKeyUp] - Function to handle the keyup event.
+ * @property {string} [onKeyDown] - Function to handle the keydown event.
+ * @property {unknown} [onValue] - The current value of the field.
+ * @property {string} [onErrorMessage] - error message prop name to set message string
+ *
+ * @example
+ * ```typescript
+ * const fieldWrapper: TFieldWrapper = {
+ *   index: '1',
+ *   Component: MyComponent,
+ *   valueChangeEvent: (event) => {
+ *     const newValue = (event as React.ChangeEvent<HTMLInputElement>).target.value;
+ *     return newValue;
+ *   },
+ *   formKey: 'myForm',
+ *   onBlur: 'handleBlur',
+ *   onChange: 'handleChange',
+ *   onFocus: 'handleFocus',
+ *   onClick: 'handleClick',
+ *   onKeyUp: 'handleKeyUp',
+ *   onKeyDown: 'handleKeyDown',
+ *   onValue: 'value'
+ * };
+ * ```
+ */
+type TFieldWrapper = {
+    index: string;
+    Component: ElementType;
+    formKey: string;
+    events?: TComponentPropsMapping;
+};
+export { TFieldWrapper };