@bolttech/form-engine-core 1.1.0-beta.0 → 1.1.0

package/src/types/schema.d.ts

@@ -1,10 +1,23 @@
-/// <reference types="node" />
 /** @virtual */
 import { TCurrencyCode, TCurrencyLocalCode } from '@gaignoux/currency';
-import { OutgoingHttpHeaders } from 'http2';
 import { TEvents } from './event';
 import { TFormValues } from './form';
 import { ALLOWED_RESET_PROPS_MUTATIONS } from '../constants/constants';
+type TAllowedResetPropsMutations = (typeof ALLOWED_RESET_PROPS_MUTATIONS)[number];
+/**
+ * @type TAllowedResetPropsMutationsEnum
+ * Represents the allowed properties to be changed on resetPropertyValues.
+ *
+ * @property {never} api - api property
+ * @property {never} apiSchema - apiSchema property
+ * @property {never} props - props property
+ * @property {never} validations - validations property
+ * @property {never} visibilityConditions - visibilityConditions property
+ * @property {never} resetValues - resetValues property
+ *
+ * @interface
+ */
+type TAllowedResetPropsMutationsEnum = Record<TAllowedResetPropsMutations, never>;
 /**
  * @type TLengthValidation
  * Represents the validation rules based on the length of the input.
@@ -33,7 +46,7 @@ type TLengthValidation = {
  * const callbackValidation: TCallbackValidation = (value) => typeof value === 'string';
  * ```
  */
-type TCallbackValidation = (value: unknown) => boolean;
+type TCallbackValidation = (value: unknown, formValues: Pick<TFormValues<unknown>, 'values' | 'metadata'>) => boolean;
 /**
  * @type TBetweenValidation
  * Represents validation rules that check if a value is between a range.
@@ -536,19 +549,21 @@ type TSplitterFormatterValue = {
  * @property {number} [maxLength] - Truncates the input value to a specified maximum length if necessary.
  *
  * @example
- * ```typescript
- * const formatters: TFormatters = {
- *   dotEvery3chars: true,
- *   capitalize: true,
- *   uppercase: true,
- *   onlyNumbers: true,
- *   regex: '^[a-zA-Z0-9]+$',
- *   gapsCreditCard: [' ', ' '],
- *   callback: (value) => value.toString().toUpperCase(),
- *   splitter: [{ value: '-', position: 3 }],
- *   trim: true,
- *   maxLength: 15
- * };
+ * ```json
+ * {
+ *   formatters: {
+ *      dotEvery3chars: true,
+ *      capitalize: true,
+ *      uppercase: true,
+ *      onlyNumbers: true,
+ *      regex: '^[a-zA-Z0-9]+$',
+ *      gapsCreditCard: [' ', ' '],
+ *      callback: (value) => value.toString().toUpperCase(),
+ *      splitter: [{ value: '-', position: 3 }],
+ *      trim: true,
+ *      maxLength: 15
+ *   }
+ * }
  * ```
  */
 type TFormatters = {
@@ -712,7 +727,8 @@ type TVisibility = {
  * const resetValueMethods: TResetValueMethods = {
  *   validations: { required: true },
  *   fields: ['fieldName'],
- *   resettledValue: ['']
+ *   resettledValue: [''],
+ *   events: ['ON_FIELD_CHANGE]
  * };
  * ```
  * @interface
@@ -725,7 +741,7 @@ type TResetValueMethods = Omit<TVisibility, 'showOnlyIfTrue' | 'validations'> &
  * @type TResetPathMethods
  * Method to reset some field properties other than component props or field value
  *
- * @property {(typeof ALLOWED_RESET_PROPS_MUTATIONS)[number]} property property to be changed, ex: api, resetValues, etc..
+ * @property {TAllowedResetPropsMutations} property property to be changed, ex: api, resetValues, etc..
  * @property {string} path path where the property to be changed is located
  * @property {string} field field that will recieve the property change
  * @property {unknown} resettledValue value to be replaced onto the property
@@ -742,7 +758,7 @@ type TResetValueMethods = Omit<TVisibility, 'showOnlyIfTrue' | 'validations'> &
  * ```
  */
 type TResetPathMethods = {
-    property: (typeof ALLOWED_RESET_PROPS_MUTATIONS)[number];
+    property: TAllowedResetPropsMutations;
     path: string;
     field: string;
     resettledValue: unknown;
@@ -755,7 +771,7 @@ type TResetPathMethods = {
  *
  * @property {'GET' | 'POST'} method - The HTTP method for the request.
  * @property {string} url - The URL for the request.
- * @property {OutgoingHttpHeaders} [headers] - The headers for the request.
+ * @property {Record<string, string>} [headers] - The headers for the request.
  * @property {Record<string, string>} queryParams - query parameters for request.
  * @property {string} [resultPath] - The path to extract the result from the response.
  * @property {unknown} [fallbackValue] - The fallback value if the request fails.
@@ -785,7 +801,7 @@ type TApiConfig = {
     /** The body payload for the request. */
     body?: Record<string, unknown>;
     /** The headers for the request. */
-    headers?: OutgoingHttpHeaders;
+    headers?: Record<string, string>;
     /** Query parameters for the request. */
     queryParams?: Record<string, string>;
     /** The path to extract the result from the response. */
@@ -817,7 +833,10 @@ type TProps = Record<string, unknown>;
  * @property {Partial<Record<TEvents, string[]>>} eventMessages - The messages to be displayed for specific validation events.
  * @property {TErrorMessages} messages - The general error messages for validation methods.
  *
+ * @interface
+ *
  * @example
+ * ```typescript
  * const validations: TValidations = {
  *   methods: {
  *     max: 100,
@@ -835,7 +854,7 @@ type TProps = Record<string, unknown>;
  *     regex: 'Value does not match the pattern',
  *   },
  * };
- * @interface
+ * ```
  */
 type TValidations = {
     methods: TSchemaValidation;
@@ -979,4 +998,4 @@ type TSchemaFormConfig = {
     defaultStateRefreshTimeMS?: number;
     defaultLogVerbose?: boolean;
 };
-export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TResetPathMethods, 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, TEventMessages, TEventMessagesValidationMethods, };
+export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TResetPathMethods, 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, TEventMessages, TEventMessagesValidationMethods, TAllowedResetPropsMutationsEnum, };

package/src/types/utility.d.ts

@@ -1,9 +1,12 @@
+import { TFormValues } from './form';
 import { TValidationMethods } from './schema';
 export type AllowOnly<T, K extends keyof T> = Pick<T, K> & {
     [P in keyof Omit<T, K>]?: never;
 };
 export type OneOf<T, K = keyof T> = K extends keyof T ? AllowOnly<T, K> : never;
-export type TValidationHandler = Record<string, (value: unknown, validations: TValidationMethods) => boolean>;
-export type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
+export type TValidationPayload = [
+    unknown,
+    TValidationMethods,
+    TFormValues<unknown>?
+];
+export type TValidationHandler = Record<string, (...args: TValidationPayload) => boolean>;

package/src/validations/custom.d.ts

@@ -1,9 +1,11 @@
+import { TFormValues } from '../types/form';
 import { TValidationMethods } from '../types/schema';
 /**
  * Executes a custom callback validation function if provided.
  *
  * @param value - The value to be validated.
  * @param validations - An object containing validation methods, including a custom callback function.
+ * @param formValues - An object containing the form state, NOTE: validations might be dirty here
  * @returns `true` if the custom callback validation function returns `true`, otherwise `false`.
  *
  * @example
@@ -22,4 +24,4 @@ import { TValidationMethods } from '../types/schema';
  * };
  * ```
  */
-export declare const callback: (value: unknown, validations: TValidationMethods) => boolean;
+export declare const callback: (value: unknown, validations: TValidationMethods, { values, metadata }?: TFormValues<unknown>) => boolean;

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";