@bolttech/form-engine-core 0.0.2-beta.5 → 0.0.2-beta.6

package/src/types/event.d.ts

@@ -1,4 +1,5 @@
 import { IFormField } from '../managers';
+import { TFormValues } from './form';
 /**
  * @type TEvents
  * Represents the different types of events that can occur on form fields.
@@ -41,9 +42,38 @@ declare enum TMutationEnum {
 type TValueChangeEvent = (value: unknown, opts?: {
     props: Record<string, unknown>;
 }) => void;
+/**
+ * @type TFieldEvent
+ * Event emitted on all basic form events, except onData
+ */
 type TFieldEvent = {
     event: TEvents;
     fieldName: string;
     fieldInstance?: IFormField;
 };
-export { TEvents, TMutationEvents, TMutationEnum, TValueChangeEvent, TFieldEvent, };
+/**
+ * @type TFormValidationPayload
+ * Form onValid event emmited payload on callback function parameter
+ */
+type TFormValidationPayload = {
+    fieldTrigger: string;
+    valid: boolean;
+};
+/**
+ * @type TFormGroupOnDataEventPayload
+ * Form Group onData event emitted payload on callback function parameter
+ */
+type TFormGroupOnDataEventPayload<T> = Record<string, {
+    formId: string;
+    formField: string;
+    values?: TFormValues<T>;
+}>;
+/**
+ * @type TFormGroupOnValidEventPayload
+ * Form Group onValid event emitted payload on callback function parameter
+ */
+type TFormGroupOnValidEventPayload = {
+    groupValid: boolean;
+    forms: Record<string, boolean>;
+};
+export { TEvents, TMutationEvents, TMutationEnum, TValueChangeEvent, TFieldEvent, TFormGroupOnDataEventPayload, TFormGroupOnValidEventPayload, TFormValidationPayload, };

package/src/types/schema.d.ts

@@ -3,6 +3,7 @@
 import { TCurrencyCode, TCurrencyLocalCode } from '@gaignoux/currency';
 import { OutgoingHttpHeaders } from 'http2';
 import { TEvents } from './event';
+import { TFormValues } from './form';
 /**
  * @type TLengthValidation
  * Represents the validation rules based on the length of the input.
@@ -700,6 +701,12 @@ type TApiConfig = {
     fallbackValue?: unknown;
     preConditions?: TSchemaValidation;
     blockRequestWhenInvalid?: boolean;
+    transform?: {
+        callback(callbackPayload: {
+            payload: unknown;
+            formValues: TFormValues<unknown>;
+        }): unknown;
+    };
 };
 /**
  * @type TProps
@@ -735,7 +742,7 @@ type TProps = Record<string, unknown>;
  */
 type TValidations = {
     methods: TSchemaValidation;
-    eventMessages?: Partial<Record<TEvents, string[]>>;
+    eventMessages?: Partial<Record<TEvents, Partial<keyof TValidationMethods | (string & NonNullable<unknown>)>[]>>;
     messages?: TErrorMessages;
 };
 /**
@@ -751,7 +758,13 @@ type TValidations = {
  * };
  * ```
  */
-type TErrorMessages = Partial<Record<keyof TSchemaValidation & 'default', string>>;
+type TErrorMessages = {
+    [K in keyof TSchemaValidation]?: string;
+} & {
+    default?: string;
+} & {
+    [key: string]: string;
+};
 /**
  * Represents an event configuration with a specific type.
  *
@@ -773,19 +786,25 @@ type TApiEvent = {
     defaultConfig?: TEvent<TApiConfig>;
     configs?: Record<string, TEvent<TApiConfig>>;
 };
+/**
+ * Represents the API response return payload for handling.
+ *
+ * @property {unknown} response - The default response.
+ * @property {number | null} status - response http status number.
+ */
+type TApiResponsePayload = {
+    response: unknown;
+    status: number | null;
+};
 /**
  * Represents the API response structure.
  *
- * @property {{ response: unknown }} default - The default response.
- * @property {Record<string, { response: unknown }>} [named] - Named responses.
+ * @property {TApiResponsePayload} default - The default response.
+ * @property {Record<string, TApiResponsePayload>} [named] - Named responses.
  */
 type TApiResponse = {
-    default: {
-        response: unknown;
-    };
-    named?: Record<string, {
-        response: unknown;
-    }>;
+    default: TApiResponsePayload;
+    named?: Record<string, TApiResponsePayload>;
 };
 /**
  * Represents the schema config structure
@@ -797,4 +816,4 @@ type TSchemaFormConfig = {
     defaultAPIdebounceTimeMS?: number;
     defaultStateRefreshTimeMS?: number;
 };
-export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TFormatters, TValidationMethods, TGenericValidationRule, TSchemaValidation, TEvent, TVisibility, TApiEvent, TApiResponse, TSchemaFormConfig, TLengthValidation, TCreditCardMatch, TDocumentValidation, TCallbackValidation, TBetweenValidation, TMaskGeneric, TSplitterFormatterValue, TCurrencyMask, TDateOperatorsValidation, TConditionsValidationSet, TConditionsValidation, TMultipleValidation, TAvailableValidations, TDateValidation, TBetweenDatesValidation, TDateFormatsValidation, TDateInterval, };
+export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TFormatters, TValidationMethods, TGenericValidationRule, TSchemaValidation, TEvent, TVisibility, TApiEvent, TApiResponsePayload, TApiResponse, TSchemaFormConfig, TLengthValidation, TCreditCardMatch, TDocumentValidation, TCallbackValidation, TBetweenValidation, TMaskGeneric, TSplitterFormatterValue, TCurrencyMask, TDateOperatorsValidation, TConditionsValidationSet, TConditionsValidation, TMultipleValidation, TAvailableValidations, TDateValidation, TBetweenDatesValidation, TDateFormatsValidation, TDateInterval, };