@bolttech/form-engine-core 1.0.0-beta.1 → 1.0.0-beta.10

package/index.esm.js

@@ -1,6 +1,6 @@
 import { Subject, Subscription, combineLatest, startWith, groupBy, mergeMap, debounceTime, filter, map, distinctUntilKeyChanged, distinctUntilChanged, skip } from 'rxjs';
 import creditCardType from 'credit-card-type';
-import { isNumber as isNumber$1, isFunction, cloneDeep, isEqual, get, isNil, set } from 'lodash';
+import { isNumber as isNumber$1, isFunction, cloneDeep, merge, isEqual, get, isNil, set } from 'lodash';
 import { getCurrencySymbol } from '@gaignoux/currency';
 
 var TMutationEnum;
@@ -2496,9 +2496,11 @@ class FormField {
     fieldEventSubject$,
     dataSubject$,
     formValidNotification$,
+    mountSubject$,
     mapper,
     getFormValues,
-    submitEvent
+    submitEvent,
+    visibility
   }) {
     var _a, _b, _c, _d, _e, _f, _g;
     this.valueSubscription$ = new Subscription();
@@ -2534,11 +2536,12 @@ class FormField {
     this.fieldEventSubject$ = fieldEventSubject$;
     this.dataSubject$ = dataSubject$;
     this.formValidNotification$ = formValidNotification$;
-    this._props = cloneDeep(schemaComponent.props || {});
+    this.mountSubject$ = mountSubject$;
+    this._props = FormField.filterProps(cloneDeep(schemaComponent.props || {}));
     this._metadata = '';
     this.errorsString = '';
     this.errorsList = [];
-    this._visibility = true;
+    this._visibility = typeof visibility === 'boolean' ? visibility : true;
     this._api = {
       default: {
         response: ((_e = (_d = (_c = this.apiSchema) === null || _c === void 0 ? void 0 : _c.defaultConfig) === null || _d === void 0 ? void 0 : _d.config) === null || _e === void 0 ? void 0 : _e.fallbackValue) || '',
@@ -2554,35 +2557,37 @@ class FormField {
       }, {})
     };
     this._errors = {};
-    this._mounted = true;
-    this._valid = false;
+    this._mounted = false;
+    this._valid = true;
     this.initializeObservers();
   }
   /**
    * method to initialize all recycled Subjects and initialize Observers on field instance creation or rerender
+   * due to some visibility conditions unmounts the field from the adapter if they are children of it and avoid
+   * emissions to unsubscribed fields
    */
   initializeObservers() {
     var _a;
     if (!this.valueSubject$ || this.valueSubject$.closed) {
-      this.valueSubject$ = new SafeSubject(() => this._mounted);
+      this.valueSubject$ = new SafeSubject(() => this.mounted);
     }
     if (!this.errorSubject$ || this.errorSubject$.closed) {
-      this.errorSubject$ = new SafeSubject(() => this._mounted);
+      this.errorSubject$ = new SafeSubject(() => this.mounted);
     }
     if (!this.visibilitySubject$ || this.visibilitySubject$.closed) {
-      this.visibilitySubject$ = new SafeSubject(() => this._mounted);
+      this.visibilitySubject$ = new SafeSubject(() => this.mounted);
     }
     if (!this.apiSubject$ || this.apiSubject$.closed) {
-      this.apiSubject$ = new SafeSubject(() => this._mounted);
+      this.apiSubject$ = new SafeSubject(() => this.mounted);
     }
     if (!this.propsSubject$ || this.propsSubject$.closed) {
-      this.propsSubject$ = new SafeSubject(() => this._mounted);
+      this.propsSubject$ = new SafeSubject(() => this.mounted);
     }
     if (!this.fieldStateSubscription$ || this.fieldStateSubscription$.closed) {
       this.fieldStateSubscription$ = new Subscription();
     }
     if (!this.apiEventQueueSubject$ || this.apiEventQueueSubject$.closed) {
-      this.apiEventQueueSubject$ = new SafeSubject(() => this._mounted);
+      this.apiEventQueueSubject$ = new SafeSubject(() => this.mounted);
     }
     this.fieldState$ = combineLatest({
       visibility: this.visibilitySubject$.pipe(startWith(this._visibility)),
@@ -2611,8 +2616,9 @@ class FormField {
    * @param {Record<string, unknown>} props - The new properties to be set.
    */
   set props(props) {
-    if (typeof props === 'undefined' || isEqual(props, this.props)) return;
-    this._props = props;
+    const diffProps = merge(cloneDeep(this.props), props);
+    if (typeof diffProps === 'undefined' || isEqual(diffProps, this.props)) return;
+    this._props = diffProps;
     this.propsSubject$.next(this.props);
     this.templateSubject$.next({
       scope: 'fields',
@@ -2620,6 +2626,28 @@ class FormField {
       event: 'ON_PROPS'
     });
   }
+  /**
+   * Static function to remove templates form the component props that will be shown when
+   * the field mounts and the template routine executes, to be used on the adapter
+   *
+   * @param {unknown} props - the properties from the adapter components.
+   */
+  static filterProps(props) {
+    if (Array.isArray(props)) {
+      return props.filter(el => typeof el === 'string' && el.includes('${') ? false : true).map(el => FormField.filterProps(el));
+    }
+    if (typeof props === 'object' && props !== null) {
+      return Object.keys(props).reduce((acc, curr) => {
+        const propValue = props[curr];
+        if (typeof propValue === 'string' && propValue.includes('${')) {
+          return acc;
+        }
+        acc[curr] = FormField.filterProps(props[curr]);
+        return acc;
+      }, {});
+    }
+    return props;
+  }
   /**
    * Retrieves the current state value of the form field.
    *
@@ -2784,6 +2812,29 @@ class FormField {
       event: 'ON_API_FIELD_RESPONSE'
     });
   }
+  /**
+   * Retrieves the mounted status of the field.
+   *
+   * @returns {boolean} - the mounted status of the field.
+   */
+  get mounted() {
+    return this._mounted;
+  }
+  /**
+   * sets the mountedStatus and notifies the form that the field was mounted on the adapter
+   * and it's ready to be handled by the form instance
+   *
+   * @param {boolean} mountedStatus - the mounted status to be set from the mountField function.
+   */
+  set mounted(mountedStatus) {
+    if (typeof mountedStatus === 'undefined' || mountedStatus === this.mounted) return;
+    this._mounted = mountedStatus;
+    this.initializeObservers();
+    this.mountSubject$.next({
+      key: this.name,
+      status: this.mounted
+    });
+  }
   /**
    * Mounts the form field by initializing necessary subjects and combining their streams.
    *
@@ -2796,10 +2847,15 @@ class FormField {
     valueSubscription,
     propsSubscription
   }) {
-    this.initializeObservers();
+    this.mounted = true;
     this.subscribeValue(valueSubscription);
     this.subscribeState(propsSubscription);
-    this._mounted = true;
+    this.valueSubject$.next(this.stateValue);
+    this.propsSubject$.next(this.props);
+    this.visibilitySubject$.next(this.visibility);
+    this.setFieldValidity({
+      event: 'ON_FIELD_MOUNT'
+    });
   }
   /**
    * Sets the value of the form field and emits associated events.
@@ -2809,7 +2865,7 @@ class FormField {
    * @returns {void}
    */
   emitValue(prop) {
-    if (!this.visibility) return;
+    if (!this.visibility || !this.mounted) return;
     this.value = prop.value;
     this.emitEvents({
       event: prop.event
@@ -2831,13 +2887,13 @@ class FormField {
     if (event === 'ON_FORM_SUBMIT') {
       return this.submitEvent();
     }
-    this.setFieldValidity({
-      event
-    });
     this.validateVisibility({
       event,
       key: this.name
     });
+    this.setFieldValidity({
+      event
+    });
     this.resetValue({
       event,
       key: this.name
@@ -3037,7 +3093,7 @@ class FormField {
    * @returns {void}
    */
   destroyField() {
-    this._mounted = false;
+    this.mounted = false;
     this.valueSubscription$.unsubscribe();
     this.visibilitySubject$.unsubscribe();
     this.fieldStateSubscription$.unsubscribe();
@@ -3100,13 +3156,12 @@ class FormCore {
     this.fields = new Map();
     this.action = entry.action || ((_a = entry.schema) === null || _a === void 0 ? void 0 : _a.action);
     this.method = entry.method || ((_b = entry.schema) === null || _b === void 0 ? void 0 : _b.method);
-    this._iVars = entry.iVars || ((_c = entry.schema) === null || _c === void 0 ? void 0 : _c.iVars) || {};
     this.config = {
-      defaultAPIdebounceTimeMS: Number((_d = entry.config) === null || _d === void 0 ? void 0 : _d.defaultAPIdebounceTimeMS) ? Number((_e = entry.config) === null || _e === void 0 ? void 0 : _e.defaultAPIdebounceTimeMS) : DEFAULT_API_DEBOUNCE_TIME,
-      defaultStateRefreshTimeMS: Number((_f = entry.config) === null || _f === void 0 ? void 0 : _f.defaultStateRefreshTimeMS) ? Number((_g = entry.config) === null || _g === void 0 ? void 0 : _g.defaultStateRefreshTimeMS) : DEFAULT_STATE_REFRESH_TIME,
-      defaultLogVerbose: ((_h = entry.config) === null || _h === void 0 ? void 0 : _h.defaultLogVerbose) ? entry.config.defaultLogVerbose : DEFAULT_LOG_VERBOSE
+      defaultAPIdebounceTimeMS: Number((_c = entry.config) === null || _c === void 0 ? void 0 : _c.defaultAPIdebounceTimeMS) ? Number((_d = entry.config) === null || _d === void 0 ? void 0 : _d.defaultAPIdebounceTimeMS) : DEFAULT_API_DEBOUNCE_TIME,
+      defaultStateRefreshTimeMS: Number((_e = entry.config) === null || _e === void 0 ? void 0 : _e.defaultStateRefreshTimeMS) ? Number((_f = entry.config) === null || _f === void 0 ? void 0 : _f.defaultStateRefreshTimeMS) : DEFAULT_STATE_REFRESH_TIME,
+      defaultLogVerbose: ((_g = entry.config) === null || _g === void 0 ? void 0 : _g.defaultLogVerbose) ? entry.config.defaultLogVerbose : DEFAULT_LOG_VERBOSE
     };
-    (_j = entry.mappers) === null || _j === void 0 ? void 0 : _j.map(mapper => {
+    (_h = entry.mappers) === null || _h === void 0 ? void 0 : _h.map(mapper => {
       this.mappers.set(mapper.componentName, mapper);
     });
     this.schema && FormCore.checkIndexes(this.schema.components);
@@ -3117,40 +3172,77 @@ class FormCore {
     this.mountSubject$ = new Subject();
     this.formValidNotification$ = new Subject();
     this.subscribedTemplates = [];
-    this.schema && this.serializeStructure(this.schema.components);
-    this.schema && this.subscribeTemplates();
     this.templateSubscription$ = this.templateSubject$.subscribe(this.refreshTemplates.bind(this));
-    this.templateSubject$.next({
-      scope: 'iVars',
-      event: 'ON_IVARS'
+    this.mountSubject$.subscribe(this.mountActions.bind(this));
+    this.initialValues = entry.initialValues || ((_j = entry.schema) === null || _j === void 0 ? void 0 : _j.initialValues);
+    this.iVars = entry.iVars || ((_k = entry.schema) === null || _k === void 0 ? void 0 : _k.iVars) || {};
+  }
+  /**
+   * mock function to simulate form mount onto the adapter
+   */
+  generateFields() {
+    this.schema && this.serializeStructure(this.schema.components);
+    this.fields.forEach(field => {
+      field.mountField({
+        valueSubscription: () => null,
+        propsSubscription: () => null
+      });
     });
-    /*
-    only emits event ON_FIELD_MOUNT if does not have initialValue, if has initialValue, initialValues class property setter will
-    emit the value along with ON_FIELD_MOUNT event
-    */
-    const initialValues = entry.initialValues || ((_k = entry.schema) === null || _k === void 0 ? void 0 : _k.initialValues);
-    this.fields.forEach((field, key) => {
-      var _a;
-      if (!initialValues || initialValues && !Object.keys(initialValues).includes(key)) {
-        const propValue = (_a = field === null || field === void 0 ? void 0 : field.props) === null || _a === void 0 ? void 0 : _a[(field === null || field === void 0 ? void 0 : field.valuePropName) || ''];
-        !(field === null || field === void 0 ? void 0 : field.value) && (field === null || field === void 0 ? void 0 : field.emitValue({
-          value: typeof propValue === 'string' && !propValue.includes('${') ? propValue : '',
-          event: 'ON_FIELD_MOUNT'
-        }));
+  }
+  /**
+   * callback function passed to field instance to notify field adapter mount status
+   * once the field has all field instance properties set, this function will handle all
+   * field routines
+   *
+   * @param { string } entry.key field unique identifier
+   * @param { boolean } entry.status mount status notified from field
+   */
+  mountActions({
+    key,
+    status
+  }) {
+    var _a;
+    if (status) {
+      const field = this.fields.get(key);
+      if (!field) {
+        /*
+        @TODO check a better way to handle nested fields unmounted by visiblity conditions from a parent
+        since they are dependent on adapter field recycling runtimes
+        */
+        this.config.defaultLogVerbose && console.log(`field ${key} was mounted but since it's parent has some visibility condition the field was already removed`);
+        return;
       }
+      this.subscribeTemplates();
       this.refreshTemplates({
         scope: 'fields',
-        key,
         event: 'ON_FIELDS'
       });
-    });
-    this.setInitialValues(initialValues);
+      this.templateSubject$.next({
+        scope: 'iVars',
+        event: 'ON_IVARS'
+      });
+      if (!this.queuedInitialValues.has(key)) {
+        const propValue = (_a = field === null || field === void 0 ? void 0 : field.props) === null || _a === void 0 ? void 0 : _a[(field === null || field === void 0 ? void 0 : field.valuePropName) || ''];
+        !(field === null || field === void 0 ? void 0 : field.value) ? field.emitValue({
+          value: typeof propValue === 'string' && !propValue.includes('${') ? propValue : '',
+          event: 'ON_FIELD_MOUNT'
+        }) : field.emitEvents({
+          event: 'ON_FIELD_MOUNT'
+        });
+      }
+      this.checkFieldEventQueues(key);
+    }
   }
-  setInitialValues(payload) {
+  /**
+   * initialValues setter to handle field values set externally from the adapter
+   *
+   * @param { Record<string, unknown> | undefined } payload initialValues to set onto fields
+   */
+  set initialValues(payload) {
     if (payload) {
       Object.keys(payload).forEach(key => {
         const field = this.fields.get(key);
-        if (!field || !(field === null || field === void 0 ? void 0 : field.visibility)) {
+        if (!field || !(field === null || field === void 0 ? void 0 : field.visibility) || !(field === null || field === void 0 ? void 0 : field.mounted)) {
           this.queuedInitialValues.set(key, payload === null || payload === void 0 ? void 0 : payload[key]);
         } else {
           field.emitValue({
@@ -3187,6 +3279,7 @@ class FormCore {
    * @returns {boolean} True if the form is valid; otherwise, false.
    */
   get isValid() {
+    if (this.fields.size === 0) return false;
     for (const [, field] of this.fields) {
       if (!field.valid) return false;
     }
@@ -3293,10 +3386,8 @@ class FormCore {
       }
       const fieldProp = field[property];
       let propState;
-      if (Array.isArray(fieldProp)) {
-        propState = [...fieldProp];
-      } else if (typeof fieldProp === 'object' && !isNil(fieldProp)) {
-        propState = Object.assign({}, fieldProp);
+      if (Array.isArray(fieldProp) || typeof fieldProp === 'object' && !isNil(fieldProp)) {
+        propState = cloneDeep(fieldProp);
       } else {
         this.config.defaultLogVerbose && console.warn(`invalid template property, skipping evaluation of ${field.name} with ${fieldProp}`);
         return;
@@ -3466,6 +3557,8 @@ class FormCore {
    * @param {string} field field to check
    */
   checkFieldEventQueues(field) {
+    var _a;
+    if (!((_a = this.fields.get(field)) === null || _a === void 0 ? void 0 : _a.mounted)) return;
     if (this.queuedFieldVisibilityEvents.has(field)) {
       this.setFieldVisibility(Object.assign({
         field: field
@@ -3473,10 +3566,11 @@ class FormCore {
       this.queuedFieldVisibilityEvents.delete(field);
     }
     if (this.queuedInitialValues.has(field)) {
-      this.setInitialValues({
-        [field]: this.queuedInitialValues.get(field)
-      });
+      const value = this.queuedInitialValues.get(field);
       this.queuedInitialValues.delete(field);
+      this.initialValues = {
+        [field]: value
+      };
     }
     if (this.queuedFieldResetValuesEvents.has(field)) {
       this.setResetFieldValue(Object.assign({
@@ -3506,14 +3600,16 @@ class FormCore {
     showOnlyIfTrue
   }) {
     const fieldInstance = this.fields.get(field);
-    if (!fieldInstance) {
+    if (!fieldInstance || !fieldInstance.mounted) {
       this.queuedFieldVisibilityEvents.set(field, {
         hasError,
         showOnlyIfTrue
       });
     } else {
+      const currentVisibility = fieldInstance.visibility;
       const visibility = showOnlyIfTrue ? hasError : !hasError;
       fieldInstance.visibility = visibility;
+      if (currentVisibility === visibility) return;
       /**
        * I was sure I would not require to gambiarra, but..
        * in order to ignore an hidden value on a form submit
@@ -3585,12 +3681,12 @@ class FormCore {
     key,
     value
   }) {
-    if (!this.fields.has(key)) {
+    const field = this.fields.get(key);
+    if (!field || !(field === null || field === void 0 ? void 0 : field.mounted)) {
       this.queuedFieldResetValuesEvents.set(key, {
         value
       });
     } else {
-      const field = this.fields.get(key);
       field.emitValue({
         value: value,
         event: 'ON_FIELD_CLEARED'
@@ -3656,7 +3752,8 @@ class FormCore {
     path,
     value
   }) {
-    if (!this.fields.has(key)) {
+    const field = this.fields.get(key);
+    if (!field || field.mounted) {
       this.queuedFieldResetPropertyEvents.set(key, {
         property,
         path,
@@ -3720,7 +3817,7 @@ class FormCore {
     fieldSchema,
     mapperElement
   }) {
-    var _a, _b;
+    var _a;
     if (this.fields.has(fieldSchema.name)) {
       throw new Error(`field name ${fieldSchema.name} already defined`);
     }
@@ -3738,24 +3835,17 @@ class FormCore {
       fieldEventSubject$: this.fieldEventSubject$,
       dataSubject$: this.dataSubject$,
       formValidNotification$: this.formValidNotification$,
+      mountSubject$: this.mountSubject$,
       config: this.config,
-      submitEvent: this.submit.bind(this)
+      submitEvent: this.submit.bind(this),
+      visibility: fieldSchema.visibility
     }));
-    this.subscribeTemplates();
-    this.refreshTemplates({
-      scope: 'fields',
-      event: 'ON_FIELDS'
-    });
-    if (!this.queuedInitialValues.has(fieldSchema.name)) {
-      const field = this.fields.get(fieldSchema.name);
-      const propValue = (_b = field === null || field === void 0 ? void 0 : field.props) === null || _b === void 0 ? void 0 : _b[(field === null || field === void 0 ? void 0 : field.valuePropName) || ''];
-      !(field === null || field === void 0 ? void 0 : field.value) && (field === null || field === void 0 ? void 0 : field.emitValue({
-        value: typeof propValue === 'string' && !propValue.includes('${') ? propValue : '',
-        event: 'ON_FIELD_MOUNT'
-      }));
-    }
-    this.checkFieldEventQueues(fieldSchema.name);
   }
+  /**
+   * function to be called from the adapter to remove a field when a field is removed from it
+   *
+   * @param {{ key: string }} entry.key
+   */
   removeField({
     key
   }) {
@@ -3800,9 +3890,11 @@ class FormCore {
           fieldEventSubject$: this.fieldEventSubject$,
           dataSubject$: this.dataSubject$,
           formValidNotification$: this.formValidNotification$,
+          mountSubject$: this.mountSubject$,
           config: this.config,
           getFormValues: this.getFormValues.bind(this),
-          submitEvent: this.submit.bind(this)
+          submitEvent: this.submit.bind(this),
+          visibility: structElement.visibility
         }));
       } else {
         currField.children = ((_b = structElement === null || structElement === void 0 ? void 0 : structElement.children) === null || _b === void 0 ? void 0 : _b.map(el => el.name)) || (currField === null || currField === void 0 ? void 0 : currField.children) || [];
@@ -3882,10 +3974,12 @@ class FormCore {
    */
   getFormValues() {
     const values = {};
+    const metadata = {};
     const erroredFields = [];
     this.fields.forEach((val, key) => {
       if (val.value) {
         set(values, val.nameToSubmit || key, val.value);
+        metadata[key] = val.metadata;
       }
       if (!val.valid) {
         erroredFields.push(key);
@@ -3893,10 +3987,17 @@ class FormCore {
     });
     return {
       values,
+      metadata,
       erroredFields,
       isValid: this.isValid
     };
   }
+  /**
+   * function to be called to events sent from the adapter
+   *
+   * @param {{callback: (payload: TFieldEvent) => void}} entry.callback callback function from the adapter
+   * @returns
+   */
   subscribeFieldEvent({
     callback
   }) {
@@ -3905,6 +4006,12 @@ class FormCore {
     });
     return sub;
   }
+  /**
+   * to be called from the adapter when the form mounts
+   *
+   * @param {(payload: TFormValues<T>) => void} callback
+   * @returns Subscription
+   */
   subscribeOnMount(callback) {
     const sub = this.mountSubject$.pipe(map(() => this.getFormValues())).subscribe({
       next: callback
@@ -3926,13 +4033,19 @@ class FormCore {
     });
     return sub;
   }
+  /**
+   * method to register a callback function to be called when the form is valid
+   *
+   * @param {(payload: TFormValues<T>) => void} callback callback function to call when the submit action occurs
+   */
   subscribeOnSubmit(callback) {
-    const sub = this.submitSubject$.pipe(map(() => this.getFormValues())).subscribe({
+    const sub = this.submitSubject$.subscribe({
       next: callback
     });
     return sub;
   }
   /**
+   * method to check whenever the validity status of the form changes, only emits on status change
    *
    * @param {(payload: TFormValidationPayload) => void} callback callback function to call onValid
    */
@@ -3947,18 +4060,6 @@ class FormCore {
     });
     return sub;
   }
-  /**
-   * Submits the form by triggering form field events and invoking the onSubmit callback.
-   */
-  mounted() {
-    this.fields.forEach(field => {
-      field.emitEvents({
-        event: 'ON_FORM_MOUNT'
-      });
-    });
-    const values = this.getFormValues();
-    this.mountSubject$.next(values);
-  }
   /**
    * Submits the form by triggering form field events and invoking the onSubmit callback.
    */
@@ -3972,6 +4073,9 @@ class FormCore {
     const values = this.getFormValues();
     this.submitSubject$.next(values);
   }
+  /**
+   * recycles all the Suscriptions, to be called from the adapter when the form leaves the page
+   */
   destroy() {
     this.submitSubject$.unsubscribe();
     this.templateSubscription$.unsubscribe();
@@ -4103,9 +4207,15 @@ class FormGroup {
     formIndex,
     fieldIndex
   }) {
-    var _a, _b, _c;
-    (_b = (_a = this.forms.get(formIndex)) === null || _a === void 0 ? void 0 : _a.fields.get(fieldIndex)) === null || _b === void 0 ? void 0 : _b.destroyField();
-    (_c = this.forms.get(formIndex)) === null || _c === void 0 ? void 0 : _c.fields.delete(fieldIndex);
+    var _a;
+    const form = this.forms.get(formIndex);
+    (_a = form === null || form === void 0 ? void 0 : form.fields.get(fieldIndex)) === null || _a === void 0 ? void 0 : _a.destroyField();
+    form === null || form === void 0 ? void 0 : form.fields.delete(fieldIndex);
+    if ((form === null || form === void 0 ? void 0 : form.fields.size) === 0) {
+      this.removeForm({
+        key: formIndex
+      });
+    }
   }
   /**
    * Checks if the specified key already exists in the form group.
@@ -4136,6 +4246,7 @@ class FormGroup {
   submitMultipleFormsByIndex(indexes, callback) {
     let isValid = true;
     let values = {};
+    let metadata = {};
     let erroredFields = [];
     indexes.forEach(index => {
       var _a, _b;
@@ -4143,12 +4254,14 @@ class FormGroup {
       const res = (_b = this.forms.get(index)) === null || _b === void 0 ? void 0 : _b.getFormValues();
       isValid = isValid && ((res === null || res === void 0 ? void 0 : res.isValid) || false);
       values = Object.assign(Object.assign({}, values), (res === null || res === void 0 ? void 0 : res.values) || {});
+      metadata = Object.assign(Object.assign({}, metadata), (res === null || res === void 0 ? void 0 : res.metadata) || {});
       erroredFields = [...erroredFields, ...((res === null || res === void 0 ? void 0 : res.erroredFields) || [])];
     });
     isValid && callback && callback({
       erroredFields,
       isValid,
-      values
+      values,
+      metadata
     });
   }
   onDataSubscription({

package/package.json

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

package/src/interfaces/schema.d.ts

@@ -62,6 +62,7 @@ interface IComponentSchema {
     formatters?: TFormatters;
     masks?: TMasks;
     children?: IComponentSchema[];
+    visibility?: boolean;
 }
 interface IComponentSchemaAsFormField<T> extends IComponentSchema {
     mapper?: TMapper<T>;

package/src/managers/field.d.ts

@@ -57,6 +57,10 @@ declare class FormField {
         event: TEvents;
     }>;
     formValidNotification$: Subject<Pick<TFormValidationPayload, 'fieldTrigger'>>;
+    mountSubject$: Subject<{
+        key: string;
+        status: boolean;
+    }>;
     validateVisibility: (payload: {
         event: TEvents;
         key: string;
@@ -90,7 +94,7 @@ declare class FormField {
      * @param {TMapper<unknown>} options.mapper, - component generic mapper containing render parameters for adapters
      * @param {() => TFormValues<unknown>} options.getFormValues, - form instance function that builds onData parameter payload from fields
      */
-    constructor({ schemaComponent, config, path, children, validateVisibility, resetValue, resetProperty, templateSubject$, fieldEventSubject$, dataSubject$, formValidNotification$, mapper, getFormValues, submitEvent, }: {
+    constructor({ schemaComponent, config, path, children, validateVisibility, resetValue, resetProperty, templateSubject$, fieldEventSubject$, dataSubject$, formValidNotification$, mountSubject$, mapper, getFormValues, submitEvent, visibility, }: {
         schemaComponent: IComponentSchema;
         config?: TSchemaFormConfig;
         path?: string;
@@ -115,11 +119,18 @@ declare class FormField {
             event: TEvents;
         }>;
         formValidNotification$: Subject<Pick<TFormValidationPayload, 'fieldTrigger'>>;
+        mountSubject$: Subject<{
+            key: string;
+            status: boolean;
+        }>;
         mapper: TMapper<unknown>;
         getFormValues: () => TFormValues<unknown>;
+        visibility?: boolean;
     });
     /**
      * method to initialize all recycled Subjects and initialize Observers on field instance creation or rerender
+     * due to some visibility conditions unmounts the field from the adapter if they are children of it and avoid
+     * emissions to unsubscribed fields
      */
     initializeObservers(): void;
     /**
@@ -134,6 +145,13 @@ declare class FormField {
      * @param {Record<string, unknown>} props - The new properties to be set.
      */
     set props(props: Record<string, unknown>);
+    /**
+     * Static function to remove templates form the component props that will be shown when
+     * the field mounts and the template routine executes, to be used on the adapter
+     *
+     * @param {unknown} props - the properties from the adapter components.
+     */
+    static filterProps(props: unknown): unknown;
     /**
      * Retrieves the current state value of the form field.
      *
@@ -199,6 +217,19 @@ declare class FormField {
      * @param {TApiResponse} response - The new API response data to be set.
      */
     set api(response: TApiResponse);
+    /**
+     * Retrieves the mounted status of the field.
+     *
+     * @returns {boolean} - the mounted status of the field.
+     */
+    get mounted(): boolean;
+    /**
+     * sets the mountedStatus and notifies the form that the field was mounted on the adapter
+     * and it's ready to be handled by the form instance
+     *
+     * @param {boolean} mountedStatus - the mounted status to be set from the mountField function.
+     */
+    set mounted(mountedStatus: boolean);
     /**
      * Mounts the form field by initializing necessary subjects and combining their streams.
      *

package/src/managers/form.d.ts

@@ -17,7 +17,10 @@ declare class FormCore {
     templateSubject$: Subject<TTemplateEvent>;
     templateSubscription$: Subscription;
     submitSubject$: Subject<TFormValues<any>>;
-    mountSubject$: Subject<TFormValues<any>>;
+    mountSubject$: Subject<{
+        key: string;
+        status: boolean;
+    }>;
     fieldEventSubject$: Subject<TFieldEvent>;
     dataSubject$: Subject<{
         key: string;
@@ -54,7 +57,28 @@ declare class FormCore {
      * @param {((payload: {field: string;data: TFormValues;}) => void) | undefined} [entry.onData] - A callback function to handle data emission.
      */
     constructor(entry: TFormEntry & Omit<IFormSchema, 'components'>);
-    setInitialValues(payload: Record<string, unknown> | undefined): void;
+    /**
+     * mock function to simulate form mount onto the adapter
+     */
+    generateFields(): void;
+    /**
+     * callback function passed to field instance to notify field adapter mount status
+     * once the field has all field instance properties set, this function will handle all
+     * field routines
+     *
+     * @param { string } entry.key field unique identifier
+     * @param { boolean } entry.status mount status notified from field
+     */
+    mountActions({ key, status }: {
+        key: string;
+        status: boolean;
+    }): void;
+    /**
+     * initialValues setter to handle field values set externally from the adapter
+     *
+     * @param { Record<string, unknown> | undefined } payload initialValues to set onto fields
+     */
+    set initialValues(payload: Record<string, unknown> | undefined);
     /**
      * Retrieves the internal variables (iVars) of the form.
      *
@@ -230,6 +254,11 @@ declare class FormCore {
         fieldSchema: IComponentSchema;
         mapperElement?: TMapper<unknown>;
     }): void;
+    /**
+     * function to be called from the adapter to remove a field when a field is removed from it
+     *
+     * @param {{ key: string }} entry.key
+     */
     removeField({ key }: {
         key: string;
     }): void;
@@ -266,9 +295,21 @@ declare class FormCore {
      * @returns {TFormValues} The current form values.
      */
     getFormValues<T>(): TFormValues<T>;
+    /**
+     * function to be called to events sent from the adapter
+     *
+     * @param {{callback: (payload: TFieldEvent) => void}} entry.callback callback function from the adapter
+     * @returns
+     */
     subscribeFieldEvent({ callback, }: {
         callback: (payload: TFieldEvent) => void;
     }): Subscription;
+    /**
+     * to be called from the adapter when the form mounts
+     *
+     * @param {(payload: TFormValues<T>) => void} callback
+     * @returns Subscription
+     */
     subscribeOnMount<T>(callback: (payload: TFormValues<T>) => void): Subscription;
     /**
      *
@@ -278,8 +319,14 @@ declare class FormCore {
         field: string;
         data: TFormValues<T>;
     }) => void): Subscription;
+    /**
+     * method to register a callback function to be called when the form is valid
+     *
+     * @param {(payload: TFormValues<T>) => void} callback callback function to call when the submit action occurs
+     */
     subscribeOnSubmit<T>(callback: (payload: TFormValues<T>) => void): Subscription;
     /**
+     * method to check whenever the validity status of the form changes, only emits on status change
      *
      * @param {(payload: TFormValidationPayload) => void} callback callback function to call onValid
      */
@@ -287,11 +334,10 @@ declare class FormCore {
     /**
      * Submits the form by triggering form field events and invoking the onSubmit callback.
      */
-    mounted<T>(): void;
+    submit<T>(): void;
     /**
-     * Submits the form by triggering form field events and invoking the onSubmit callback.
+     * recycles all the Suscriptions, to be called from the adapter when the form leaves the page
      */
-    submit<T>(): void;
     destroy(): void;
 }
 type TFormCore = FormCore;

package/src/types/form.d.ts

@@ -19,6 +19,7 @@ import { TMapper } from './mapper';
  */
 type TFormValues<T> = {
     values: T;
+    metadata: unknown;
     erroredFields: string[];
     isValid: boolean;
 };