@bolttech/form-engine-core 0.0.1-beta.8 → 0.0.1-beta.9

package/index.esm.js

@@ -174,6 +174,53 @@ function traverseObject(obj, path) {
   }
   return result;
 }
+/**
+ * Recursively creates a nested object structure based on the given parts array,
+ * setting the specified value at the appropriate nested level.
+ *
+ * @param {string[]} parts - Array of strings representing the keys for the nested object.
+ * @param {Record<string, unknown>} subObject - The sub-object to be updated or used for recursion.
+ * @param {unknown} value - The value to be set at the final nested level.
+ * @returns {Record<string, unknown>} - The updated object with the new nested structure and value.
+ */
+const getNewPart = (parts, subObject, value) => {
+  const clonedParts = [...parts];
+  clonedParts.splice(0, 1);
+  const part = parts.length !== 1 ? getNewPart(clonedParts, subObject ? subObject[parts[0]] : {}, value) : value;
+  return Object.assign(Object.assign({}, subObject), {
+    [parts[0]]: part
+  });
+};
+/**
+ * Encapsulates in a given object, at a given path the provided value
+ *
+ * @example
+ * ORIGINAL object
+ *
+ * encapsulateIn({maintain: 'spread_me'}, 'a.b.c','test')
+ *
+ * RESULT
+ *
+ * {
+ *  maintain: 'spread_me',
+ *    c: 'test
+ *  }
+ * }
+ *
+ * @param origin - The original object where the new value will be appended
+ * @param path - The path at which the new value will be placed
+ * @param value - The new value
+ * @returns One new object with the new value at the provided path merged with the given object
+ */
+const encapsulateIn = (origin, path, value) => {
+  const parts = path.split('.');
+  if (parts.length === 1) {
+    return Object.assign(Object.assign({}, origin), {
+      [path]: value
+    });
+  }
+  return getNewPart(parts, origin, value);
+};
 
 /**
  * Splits a string by inserting specified values at given positions.
@@ -681,16 +728,9 @@ const currency = (value, masks) => {
   if (integerPart === '') {
     integerPart = '0';
   }
-  console.log('Before', {
-    convertedValue
-  });
   if (align === 'right' && String(value).endsWith(' ')) {
     convertedValue = convertedValue.slice(0, -1);
   }
-  console.log('After', {
-    value,
-    convertedValue
-  });
   let newRawValue = integerPart;
   let decimalPart = convertedValue.slice(convertedValue.length - precision);
   if (precision > 0) {
@@ -2297,6 +2337,7 @@ class FormField {
       defaultStateRefreshTimeMS: Number(config === null || config === void 0 ? void 0 : config.defaultStateRefreshTimeMS) ? Number(config === null || config === void 0 ? void 0 : config.defaultStateRefreshTimeMS) : DEFAULT_STATE_REFRESH_TIME
     };
     this.name = schemaComponent.name;
+    this.nameToSubmit = schemaComponent.nameToSubmit;
     this.component = schemaComponent.component;
     this.path = path;
     this.children = children;
@@ -2640,14 +2681,19 @@ class FormField {
     const errors = Object.assign({}, this.errors);
     const schemaValidations = (_a = this.validations) === null || _a === void 0 ? void 0 : _a.config;
     schemaValidations && Object.keys(schemaValidations).forEach(validationKey => {
-      var _a, _b;
+      var _a;
       const error = validations[validationKey](this.value, schemaValidations);
       // setting valid flag
       valid = !error && valid;
       // setting error messages
       if (((_a = this.validations) === null || _a === void 0 ? void 0 : _a.events.includes(event)) || event === 'ON_FORM_SUBMIT') {
-        if (error && ((_b = this.errorMessages) === null || _b === void 0 ? void 0 : _b[validationKey])) {
-          errors[validationKey] = this.errorMessages[validationKey];
+        if (error && this.errorMessages) {
+          if (validationKey in this.errorMessages) {
+            const messages = this.errorMessages;
+            errors[validationKey] = messages[validationKey];
+          } else if ('default' in this.errorMessages) {
+            errors[validationKey] = this.errorMessages.default;
+          }
         } else {
           delete errors[validationKey];
         }
@@ -3389,11 +3435,11 @@ class FormCore {
    * @returns {TFormValues} The current form values.
    */
   getFormValues() {
-    const values = {};
+    let values = {};
     const erroredFields = [];
     this.fields.forEach((val, key) => {
       if (val.value) {
-        values[key] = val.value;
+        values = Object.assign(Object.assign({}, values), encapsulateIn(values, val.nameToSubmit || key, val.value));
       }
       if (!val.valid) {
         erroredFields.push(key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bolttech/form-engine-core",
-  "version": "0.0.1-beta.8",
+  "version": "0.0.1-beta.9",
   "module": "./index.esm.js",
   "type": "module",
   "main": "./index.esm.js",

package/src/helpers/helpers.d.ts

@@ -61,4 +61,26 @@ declare function extractFieldKeys(expression: string): {
  * ```
  */
 declare function traverseObject(obj: any, path?: string): TSubscribedTemplates[];
-export { makeRequest, traverseObject, extractFieldKeys };
+/**
+ * Encapsulates in a given object, at a given path the provided value
+ *
+ * @example
+ * ORIGINAL object
+ *
+ * encapsulateIn({maintain: 'spread_me'}, 'a.b.c','test')
+ *
+ * RESULT
+ *
+ * {
+ *  maintain: 'spread_me',
+ *    c: 'test
+ *  }
+ * }
+ *
+ * @param origin - The original object where the new value will be appended
+ * @param path - The path at which the new value will be placed
+ * @param value - The new value
+ * @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: unknown) => Record<string, unknown>;
+export { makeRequest, traverseObject, extractFieldKeys, encapsulateIn };

package/src/interfaces/schema.d.ts

@@ -6,6 +6,7 @@ import { TApiEvent, TErrorMessages, TEvent, TFormatters, TMasks, TProps, TResetV
  * @property {string} component - The type of component (e.g., 'input', 'button').
  * @property {TProps} props - The properties of the component.
  * @property {string} name - The name of the component.
+ * @property {string} nameToSubmit - The name of the field when submit values (optional).
  * @property {TEvent<TValidationMethods>} [validations] - The validation methods for the component.
  * @property {TVisibility[]} [visibilityConditions] - The visibility conditions for the component.
  * @property {TResetValueMethods[]} [resetValues] - The reset value methods for the component.
@@ -21,6 +22,7 @@ import { TApiEvent, TErrorMessages, TEvent, TFormatters, TMasks, TProps, TResetV
  *   component: 'input',
  *   props: { type: 'text', placeholder: 'Enter your name' },
  *   name: 'name',
+ *   nameToSubmit: 'applicant.firstName',
  *   validations: { config: { required: true }, events: [{ eventName: 'ON_FIELD_BLUR' }] },
  *   visibilityConditions: [{ conditions: { field: 'age', value: 18 } }],
  *   resetValues: [{ field: 'age', resetTo: '' }],
@@ -36,6 +38,7 @@ interface IComponentSchema {
     component: string;
     props?: TProps;
     name: string;
+    nameToSubmit?: string;
     validations?: TEvent<TValidationMethods>;
     api?: TApiEvent;
     visibilityConditions?: TVisibility[];

package/src/managers/field.d.ts

@@ -9,6 +9,7 @@ import { TMapper } from '../types/mapper';
  */
 declare class FormField {
     name: string;
+    nameToSubmit?: string;
     component: string;
     path?: string;
     children?: string[];

package/src/managers/formGroup.d.ts

@@ -56,7 +56,7 @@ declare class FormGroup {
      * @param {string} options.formIndex
      * @param {string} options.fieldIndex
      */
-    removeField({ formIndex, fieldIndex }: {
+    removeField({ formIndex, fieldIndex, }: {
         formIndex: string;
         fieldIndex: string;
     }): void;
@@ -79,7 +79,7 @@ declare class FormGroup {
      * @param {string[]} indexes form indexes to be submitted
      * @returns
      */
-    submitMultipleFormsByIndex(indexes: string[]): TFormValues;
+    submitMultipleFormsByIndex<T>(indexes: string[]): TFormValues<T>;
 }
 type TFormGroup = FormGroup;
 export { TFormGroup, FormGroup };

package/src/types/schema.d.ts

@@ -700,10 +700,11 @@ type TResetValues = Partial<Record<TEvents, TResetValueMethods[]>>;
  * const errorMessages: TErrorMessages = {
  *   required: 'This field is required.',
  *   max: 'The value cannot exceed the maximum limit.'
+ *   default: 'Default error message'
  * };
  * ```
  */
-type TErrorMessages = Partial<Record<keyof TValidationMethods, string>>;
+type TErrorMessages = Partial<Record<keyof TValidationMethods & 'default', string>>;
 /**
  * Represents an event configuration with a specific type.
  *