@bolttech/form-engine-core 1.0.2 → 1.0.4

package/index.d.ts

@@ -226,12 +226,21 @@ interface IFormSchema {
     stopEventsOnSubmit?: boolean;
 }
 
+/**
+ * @type TFieldBinding
+ * settings from the field's location and value when valid.
+ */
+type TFieldBinding = {
+    path?: string;
+    value?: unknown;
+};
 /**
  * @type TFormValues<T>
  * Represents the values and state of a form. It has a generic type that allows the importer to determine which type values key will return.
  *
  * @property {Generic Type} values - The current values of the form fields.
  * @property {string[]} erroredFields - A list of field names that have errors.
+ * @property {TFieldBinding} bindFields - A list of field names that have bind values with their path to submit.
  * @property {boolean} isValid - Indicates whether the form is valid.
  *
  * @example
@@ -239,6 +248,7 @@ interface IFormSchema {
  * const formValues: TFormValues = {
  *   values: { name: 'John', age: 30 },
  *   erroredFields: ['email'],
+ *   bindFields: { path: 'field/name', value: 'John' },
  *   isValid: false
  * };
  * ```
@@ -247,6 +257,7 @@ type TFormValues<T> = {
     values: T;
     metadata: unknown;
     erroredFields: string[];
+    bindFields?: TFieldBinding;
     isValid: boolean;
 };
 /**
@@ -1396,6 +1407,7 @@ declare class FormField {
     errorsString: string;
     errorsList: string[];
     private _props;
+    private _adapterProps;
     private _value;
     private _stateValue;
     private _metadata;
@@ -1455,7 +1467,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({ formIndex, schemaComponent, config, path, children, validateVisibility, resetValue, resetProperty, templateSubject$, fieldEventSubject$, dataSubject$, fieldValidNotification$, mountSubject$, mapper, getFormValues, submitEvent, visibility, persistValue, }: {
+    constructor({ formIndex, schemaComponent, config, children, validateVisibility, resetValue, resetProperty, templateSubject$, fieldEventSubject$, dataSubject$, fieldValidNotification$, mountSubject$, mapper, getFormValues, submitEvent, visibility, persistValue, }: {
         formIndex: string;
         schemaComponent: IComponentSchema;
         config?: TSchemaFormConfig;
@@ -1493,6 +1505,18 @@ declare class FormField {
      * emissions to unsubscribed fields
      */
     initializeObservers(): void;
+    /**
+     * Retrieves the raw props sent from the adapter.
+     *
+     * @returns {string} - raw props from the adapter
+     */
+    get adapterProps(): string;
+    /**
+     * compares adapter props changes and emits the change if they effectively changed
+     * preventing an emission from the adapter of the same props that can overwrite other prop
+     * changes via templating
+     */
+    set adapterProps(props: Record<string, unknown>);
     /**
      * Retrieves the properties associated with the form field.
      *
@@ -2006,10 +2030,7 @@ declare class FormCore {
      *
      * @param {(payload: { field: string; data: TFormValues }) => void} callback callback function to call onData
      */
-    subscribeData<T>(callback: (payload: {
-        field: string;
-        data: TFormValues<T>;
-    }) => void): Subscription;
+    subscribeData<T>(callback: (payload: TFormOnDataEventPayload<T>) => void): Subscription;
     /**
      * method to register a callback function to be called when the form is valid
      *
@@ -2296,6 +2317,14 @@ type TFormDataValues<T> = {
  * Form Group onData event emitted payload on callback function parameter
  */
 type TFormGroupOnDataEventPayload<T> = Record<string, TFormDataValues<T>>;
+/**
+ * @type TFormOnDataEventPayload
+ * Form onData event emitted payload on callback function parameter
+ */
+type TFormOnDataEventPayload<T> = {
+    field: string;
+    data: TFormValues<T>;
+};
 /**
  * @type TFormGroupOnValidEventPayload
  * Form Group onValid event emitted payload on callback function parameter
@@ -2311,4 +2340,4 @@ type TFormGroupOnValidEventPayload = {
 type TFormGroupOnSubmitEventPayload<T> = Record<string, TFormValues<T> | undefined>;
 
 export { FormCore, FormField, FormGroup, TMutationEnum };
-export type { AllowOnly, IComponentSchema, IComponentSchemaAsFormField, IFormField, IFormSchema, IState, OneOf, TAllowedResetPropsMutationsEnum, TApiConfig, TApiEvent, TApiResponse, TApiResponsePayload, TAvailableValidations, TBetweenDatesValidation, TBetweenValidation, TCallbackValidation, TComponentPropsMapping, TConditionsValidation, TConditionsValidationSet, TCreditCardMatch, TCurrencyMask, TDateFormatsValidation, TDateInterval, TDateOperatorsValidation, TDateValidation, TDocumentValidation, TErrorMessages, TEvent, TEventDataProps, TEventDataPropsEnum, TEventEnum, TEventMessages, TEventMessagesValidationMethods, TEventProps, TEventPropsEnum, TEvents, TFieldEvent, TFieldValidationPayload, TFormCore, TFormDataPayload, TFormDataValues, TFormEntry, TFormGroup, TFormGroupOnDataEventPayload, TFormGroupOnSubmitEventPayload, TFormGroupOnValidEventPayload, TFormSubmitPayload, TFormValidationPayload, TFormValues, TFormatters, TGenericValidationRule, TLengthValidation, TMapper, TMaskGeneric, TMasks, TMultipleValidation, TMutationEvents, TProps, TResetPathMethods, TResetValueMethods, TSchemaFormConfig, TSchemaValidation, TSplitterFormatterValue, TSubscribedTemplates, TTemplateAvaliableScopes, TTemplateAvaliableScopesEnum, TTemplateEvent, TValidationHandler, TValidationMethods, TValidations, TValueChangeEvent, TVisibility };
+export type { AllowOnly, IComponentSchema, IComponentSchemaAsFormField, IFormField, IFormSchema, IState, OneOf, TAllowedResetPropsMutationsEnum, TApiConfig, TApiEvent, TApiResponse, TApiResponsePayload, TAvailableValidations, TBetweenDatesValidation, TBetweenValidation, TCallbackValidation, TComponentPropsMapping, TConditionsValidation, TConditionsValidationSet, TCreditCardMatch, TCurrencyMask, TDateFormatsValidation, TDateInterval, TDateOperatorsValidation, TDateValidation, TDocumentValidation, TErrorMessages, TEvent, TEventDataProps, TEventDataPropsEnum, TEventEnum, TEventMessages, TEventMessagesValidationMethods, TEventProps, TEventPropsEnum, TEvents, TFieldEvent, TFieldValidationPayload, TFormCore, TFormDataPayload, TFormDataValues, TFormEntry, TFormGroup, TFormGroupOnDataEventPayload, TFormGroupOnSubmitEventPayload, TFormGroupOnValidEventPayload, TFormOnDataEventPayload, TFormSubmitPayload, TFormValidationPayload, TFormValues, TFormatters, TGenericValidationRule, TLengthValidation, TMapper, TMaskGeneric, TMasks, TMultipleValidation, TMutationEvents, TProps, TResetPathMethods, TResetValueMethods, TSchemaFormConfig, TSchemaValidation, TSplitterFormatterValue, TSubscribedTemplates, TTemplateAvaliableScopes, TTemplateAvaliableScopesEnum, TTemplateEvent, TValidationHandler, TValidationMethods, TValidations, TValueChangeEvent, TVisibility };

package/index.esm.js

@@ -2505,7 +2505,6 @@ class FormField {
     formIndex,
     schemaComponent,
     config,
-    path,
     children,
     validateVisibility,
     resetValue,
@@ -2556,6 +2555,7 @@ class FormField {
     this.fieldValidNotification$ = fieldValidNotification$;
     this.mountSubject$ = mountSubject$;
     this._props = FormField.filterProps(cloneDeep(schemaComponent.props || {}));
+    this._adapterProps = JSON.stringify(schemaComponent.props || {});
     this._metadata = '';
     this.errorsString = '';
     this.errorsList = [];
@@ -2615,6 +2615,28 @@ class FormField {
       });
     }
   }
+  /**
+   * Retrieves the raw props sent from the adapter.
+   *
+   * @returns {string} - raw props from the adapter
+   */
+  get adapterProps() {
+    return this._adapterProps;
+  }
+  /**
+   * compares adapter props changes and emits the change if they effectively changed
+   * preventing an emission from the adapter of the same props that can overwrite other prop
+   * changes via templating
+   */
+  set adapterProps(props) {
+    const currentProps = JSON.stringify(props || {});
+    // it's a very basic comparison to determine if props changed, 
+    // will need review if we need complex comparisons
+    if (currentProps !== this.adapterProps) {
+      this.props = FormField.filterProps(props);
+      this._adapterProps = currentProps;
+    }
+  }
   /**
    * Retrieves the properties associated with the form field.
    *
@@ -4088,7 +4110,9 @@ class FormCore {
     const values = {};
     const metadata = {};
     const erroredFields = [];
+    const bindFields = {};
     this.fields.forEach((val, key) => {
+      var _a;
       if (!(typeof val.value === 'string' && val.value.length === 0) && typeof val.value !== 'undefined' && val.value !== null) {
         set(values, val.nameToSubmit || key, val.value);
         metadata[key] = val.metadata;
@@ -4096,11 +4120,18 @@ class FormCore {
       if (!val.valid) {
         erroredFields.push(key);
       }
+      if (val.nameToSubmit) {
+        bindFields[key] = {
+          path: (_a = val.nameToSubmit) === null || _a === void 0 ? void 0 : _a.replace('.', '/'),
+          value: val.value
+        };
+      }
     });
     return {
       values,
       metadata,
       erroredFields,
+      bindFields,
       isValid: this.valid
     };
   }
@@ -4139,10 +4170,12 @@ class FormCore {
       formIndex
     }) => this.index === formIndex && this.submitChecker()), groupBy(payload => payload.event), mergeMap(group$ => group$.pipe(debounceTime(this.config.defaultStateRefreshTimeMS))), map(({
       fieldIndex
-    }) => ({
-      field: fieldIndex,
-      data: this.getFormValues()
-    }))).subscribe({
+    }) => {
+      return {
+        field: fieldIndex,
+        data: this.getFormValues()
+      };
+    })).subscribe({
       next: callback
     });
     return sub;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bolttech/form-engine-core",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "dependencies": {
     "@gaignoux/currency": "^1.1.0",
     "credit-card-type": "^10.0.0",