@bolttech/form-engine-core 1.0.2-beta.2 → 1.0.2

package/src/managers/formGroup.d.ts

@@ -1,110 +0,0 @@
-import { Subject } from 'rxjs';
-import { TFormEntry, TFormValues } from '../types/form';
-import { TMapper } from '../types/mapper';
-import { TFormCore } from './form';
-import { TSchemaFormConfig } from '../types/schema';
-import { TFormDataPayload, TFormGroupOnDataEventPayload, TFormGroupOnSubmitEventPayload, TFormGroupOnValidEventPayload, TFormSubmitPayload, TFormValidationPayload } from '../types/event';
-/**
- * Represents a group that manages multiple forms.
- */
-declare class FormGroup<ComponentElementType> {
-    forms: Map<string, TFormCore>;
-    config: Required<TSchemaFormConfig>;
-    dataSubject$: Subject<TFormDataPayload>;
-    formValidSubject$: Subject<TFormValidationPayload>;
-    submitSubject$: Subject<TFormSubmitPayload<unknown>>;
-    mappers?: TMapper<ComponentElementType>[];
-    /**
-     * Creates an instance of FormGroup.
-     */
-    constructor(entry?: {
-        mappers?: TMapper<ComponentElementType>[];
-        config?: TSchemaFormConfig;
-    });
-    /**
-     * Creates an empty form with given index
-     *
-     * @param {string} options.index
-     * @param {TMapper<unknown>} options.mappers
-     */
-    createFormWithIndex({ index, mappers, }: {
-        index: string;
-        mappers?: TMapper<unknown>[];
-    }): void;
-    /**
-     * Adds a form instance to the form group.
-     *
-     * @param {object} options - Options for adding a form.
-     * @param {string} options.key - The key associated with the form instance.
-     * @param {TFormCore} options.formInstance - The instance of the form to add.
-     */
-    addForm({ key, params }: {
-        key: string;
-        params: TFormEntry;
-    }): void;
-    /**
-     * Retrieves a form instance from the form group.
-     *
-     * @param {object} options - Options for retrieving a form.
-     * @param {string} options.key - The key associated with the form instance.
-     * @returns {TFormCore | undefined} The instance of the form, if found; otherwise, undefined.
-     */
-    getForm({ key }: {
-        key: string;
-    }): TFormCore | undefined;
-    /**
-     * Removes a form instance from the form group.
-     *
-     * @param {object} options - Options for removing a form.
-     * @param {string} options.key - The key associated with the form instance to remove.
-     */
-    removeForm({ key }: {
-        key: string;
-    }): void;
-    /**
-     * removes a field given a form and field index
-     *
-     * @param {string} options.formIndex
-     * @param {string} options.fieldIndex
-     */
-    removeField({ formIndex, fieldIndex, }: {
-        formIndex: string;
-        fieldIndex: string;
-    }): void;
-    /**
-     * Checks if the specified key already exists in the form group.
-     *
-     * @param {object} options - Options for checking the key.
-     * @param {string} options.key - The key to check.
-     * @throws {Error} Throws an error if the key already exists in the form group.
-     */
-    checkIndexes({ key }: {
-        key: string;
-    }): void;
-    /**
-     * Prints the form group instance to the console.
-     */
-    printFormGroupInstance(): void;
-    /**
-     * Prototype submit function to multiple forms
-     * @param {string[]} indexes form indexes to be submitted
-     * @param callback
-     * @returns
-     */
-    submitMultipleFormsByIndex<T>(indexes: string[], callback?: (payload: TFormValues<T>) => void): void;
-    onDataSubscription<T>({ ids, callback, }: {
-        ids: string[];
-        callback: (payload: TFormGroupOnDataEventPayload<T>) => void;
-    }): import("rxjs").Subscription;
-    onValidSubscription({ ids, callback, }: {
-        ids: string[];
-        callback: (payload: TFormGroupOnValidEventPayload) => void;
-    }): import("rxjs").Subscription;
-    onSubmitSubscription<T>({ ids, callback, }: {
-        ids: string[];
-        callback: (payload: TFormGroupOnSubmitEventPayload<T>) => void;
-    }): import("rxjs").Subscription;
-    destroy: () => void;
-}
-type TFormGroup<T> = FormGroup<T>;
-export { TFormGroup, FormGroup };

package/src/managers/index.d.ts

@@ -1,3 +0,0 @@
-export * from './form';
-export * from './field';
-export * from './formGroup';

package/src/masks/creditCard.d.ts

@@ -1,60 +0,0 @@
-/**
- * Applies a secure mask to a credit card number, hiding most of its digits.
- *
- * @param value - The credit card number to be masked.
- * @returns The masked credit card number.
- *
- * @example
- * ```typescript
- * import { secureCreditCard } from './path/to/creditCardFunctions';
- *
- * const maskedCardNumber = secureCreditCard('1234567890123456');
- * console.log(maskedCardNumber); // Output: '1xxxxxxxxxxxx456'
- * ```
- */
-export declare const secureCreditCard: (value: string) => string;
-/**
- * Formats a credit card number by inserting spaces every four characters.
- *
- * @param value - The credit card number to be formatted.
- * @returns The formatted credit card number.
- *
- * @example
- * ```typescript
- * import { card } from './path/to/creditCardFunctions';
- *
- * const formattedCardNumber = card('1234567890123456');
- * console.log(formattedCardNumber); // Output: '1234 5678 9012 3456'
- * ```
- */
-export declare const card: (value: string) => string;
-/**
- * Formats a credit card expiration date (MM/YY).
- *
- * @param value - The expiration date to be formatted (in MMYY or MM/YY format).
- * @returns The formatted expiration date.
- *
- * @example
- * ```typescript
- * import { cardDate } from './path/to/creditCardFunctions';
- *
- * const formattedCardDate = cardDate('1223');
- * console.log(formattedCardDate); // Output: '12/23'
- * ```
- */
-export declare const cardDate: (value: string) => string;
-/**
- * Formats a credit card FEIN (Federal Employer Identification Number) in a specific format.
- *
- * @param value - The FEIN to be formatted.
- * @returns The formatted FEIN.
- *
- * @example
- * ```typescript
- * import { fein } from './path/to/creditCardFunctions';
- *
- * const formattedFEIN = fein('123456789');
- * console.log(formattedFEIN); // Output: '12-3456789'
- * ```
- */
-export declare const fein: (value: string) => string;

package/src/masks/generic.d.ts

@@ -1,39 +0,0 @@
-import { TMasks } from '../types/schema';
-/**
- * Applies multiple generic masks to a string based on the provided mask configuration.
- *
- * @param value - The value to be masked.
- * @param masks - An object containing the mask configuration.
- * @returns The masked value.
- *
- * @example
- * ```typescript
- * import maskValue from './path/to/maskFunctions';
- *
- * const masks = {
- *   generic: [
- *     { from: 2, to: 4, mask: '*' },
- *     { from: 7, to: 9, mask: '#' }
- *   ]
- * };
- *
- * const maskedValue = maskValue('123456789', masks);
- * console.log(maskedValue); // Output: '1**45###9'
- *
- * // Using from a JSON config
- * const config = {
- *   value: 'abcdefghij',
- *   masks: {
- *     generic: [
- *       { from: 3, to: 6, mask: '*' },
- *       { from: 8, to: 10, mask: '#' }
- *     ]
- *   }
- * };
- *
- * const maskedValue = maskValue(config.value, config.masks);
- * console.log(maskedValue); // Output: 'ab***gh###'
- * ```
- */
-declare const _default: (value: string, masks: TMasks) => string;
-export default _default;

package/src/masks/handler.d.ts

@@ -1,2 +0,0 @@
-import { TMasks } from '../types/schema';
-export declare const masks: Record<keyof TMasks, (value: unknown, masks?: TMasks) => unknown>;

package/src/masks/string.d.ts

@@ -1,99 +0,0 @@
-import { TMasks } from '../types/schema';
-/**
- * Replaces all characters in a string with a specified replacement string or character.
- *
- * @param value - The value to be masked.
- * @param masks - An object containing the mask configuration.
- * @returns The masked value.
- *
- * @example
- * ```typescript
- * import { replaceAll } from './path/to/maskFunctions';
- *
- * const masks = { replaceAll: '*' };
- *
- * const maskedValue = replaceAll('12345', masks);
- * console.log(maskedValue); // Output: '*****'
- *
- * // Using from a JSON config
- * const config = {
- *   value: 'hello',
- *   masks: { replaceAll: '*' }
- * };
- *
- * const maskedValue = replaceAll(config.value, config.masks);
- * console.log(maskedValue); // Output: '*****'
- * ```
- */
-export declare const replaceAll: (value: string | number, masks: TMasks) => unknown;
-/**
- * Formats a numeric value as a currency string based on the provided mask configuration.
- *
- * @param value - The numeric value to be formatted.
- * @param masks - An object containing the mask configuration.
- * @returns The formatted currency string.
- *
- * @example
- * ```typescript
- * import { currency } from './path/to/maskFunctions';
- *
- * const masks = {
- *   currency: {
- *     align: 'right',
- *     decimal: ',',
- *     precision: 2,
- *     prefix: 'USD',
- *     thousands: '.'
- *   }
- * };
- *
- * const formattedValue = currency(12345.67, masks);
- * console.log(formattedValue); // Output: '12.345,67 $'
- *
- * // Using from a JSON config
- * const config = {
- *   value: 9876.54,
- *   masks: {
- *     currency: {
- *       align: 'right',
- *       decimal: ',',
- *       precision: 2,
- *       prefix: 'EUR',
- *       thousands: '.'
- *     }
- *   }
- * };
- *
- * const formattedValue = currency(config.value, config.masks);
- * console.log(formattedValue); // Output: '9.876,54 €'
- *
- * PS: To unCurrency this value, usage onlyFloatNumber formatter
- * ```
- */
-export declare const currency: (value: string | number, masks: TMasks) => unknown;
-/**
- * Applies a custom mask to a string based on the provided mask configuration.
- *
- * @param value - The value to be masked.
- * @param masks - An object containing the mask configuration.
- * @returns The masked value.
- *
- * @example
- * ```typescript
- * import { custom } from './path/to/maskFunctions';
- *
- * const masks = { custom: '##-##' };
- *
- * const maskedValue = custom('123456', masks);
- * console.log(maskedValue); // Output: '12-34'
- *
- * // Using from a JSON config
- * const config = {
- *   masks: { custom: '###-###' }
- * };
- *
- * const maskedValue = custom(config.value, config.masks);
- * console.log(maskedValue); // Output: '987-654'
- * ```
- */
-export declare const custom: (value: string, masks: TMasks) => string;

package/src/types/event.d.ts

@@ -1,109 +0,0 @@
-import { IFormField } from '../managers';
-import { TFormValues } from './form';
-/**
- * @type TEvents
- * Represents the different types of events that can occur on form fields.
- *
- * @example
- * ```typescript
- * const event: TEvents = 'ON_FIELD_CHANGE';
- * ```
- */
-type TEvents = 'ON_FIELD_MOUNT' | 'ON_FIELD_UNMOUNT' | 'ON_FIELD_CHANGE' | 'ON_FIELD_BLUR' | 'ON_FIELD_FOCUS' | 'ON_FIELD_CLICK' | 'ON_FIELD_KEYUP' | 'ON_FIELD_KEYDOWN' | 'ON_FIELD_CLEARED' | 'ON_FORM_SUBMIT' | 'ON_FIELD_VALIDATION' | 'ON_FORM_MOUNT' | 'ON_API_FIELD_REQUEST' | 'ON_API_FIELD_RESPONSE';
-/**
- * @type TMutationEvents
- * Represents the different types of events that can occur internally that triggers templating.
- *
- * @example
- * ```typescript
- * const event: TMutationEvents = 'ON_VALUE';
- * ```
- */
-type TMutationEvents = 'ON_VALUE' | 'ON_PROPS' | 'ON_VISIBILITY' | 'ON_API_REQUEST' | 'ON_API_RESPONSE' | 'ON_IVARS' | 'ON_FIELDS' | 'ON_RESET' | 'ON_FORM';
-declare enum TMutationEnum {
-    ON_VALUE = "value",
-    ON_PROPS = "props",
-    ON_VISIBILITY = "visibility",
-    ON_API = "api",
-    ON_IVARS = "iVars",
-    ON_FIELDS = "fields"
-}
-/**
- * @type TValueChangeEvent
- * Represents the custom change handle function to perform value changes.
- *
- * @example
- * ```typescript
- * handleChangeEvent (value, opts) {
- *   return value
- * }
- * ```
- */
-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;
-};
-/**
- * @type TFormDataPayload
- * Event emitted to formGroup instance to capture onData form events
- */
-type TFormDataPayload = {
-    formIndex: string;
-    fieldIndex: string;
-    event: TEvents;
-};
-/**
- * @type TFormSubmitPayload
- * Event emitted to formGroup instance to capture onSubmit form events
- */
-type TFormSubmitPayload<T> = {
-    formIndex: string;
-    values: TFormValues<T>;
-};
-/**
- * @type TFormValidationPayload
- * Form onValid event emmited payload on callback function parameter
- */
-type TFormValidationPayload = {
-    formIndex: string;
-    valid: boolean;
-};
-/**
- * @type TFieldValidationPayload
- * field event emmited payload on field validation
- */
-type TFieldValidationPayload = {
-    fieldTrigger: string;
-};
-type TFormDataValues<T> = {
-    formId: string;
-    formField: string;
-    values?: TFormValues<T>;
-};
-/**
- * @type TFormGroupOnDataEventPayload
- * Form Group onData event emitted payload on callback function parameter
- */
-type TFormGroupOnDataEventPayload<T> = Record<string, TFormDataValues<T>>;
-/**
- * @type TFormGroupOnValidEventPayload
- * Form Group onValid event emitted payload on callback function parameter
- */
-type TFormGroupOnValidEventPayload = {
-    groupValid: boolean;
-    forms: Record<string, boolean>;
-};
-/**
- * @type TFormGroupOnSubmitEventPayload
- * Form Group onSubmit event emitted payload on callback function parameter
- */
-type TFormGroupOnSubmitEventPayload<T> = Record<string, TFormValues<T> | undefined>;
-export { TEvents, TMutationEvents, TMutationEnum, TValueChangeEvent, TFieldEvent, TFormDataPayload, TFormDataValues, TFormSubmitPayload, TFormGroupOnDataEventPayload, TFormGroupOnValidEventPayload, TFormGroupOnSubmitEventPayload, TFormValidationPayload, TFieldValidationPayload, };

package/src/types/form.d.ts

@@ -1,55 +0,0 @@
-import { Subject } from 'rxjs';
-import { IFormSchema } from '../interfaces/schema';
-import { TMapper } from './mapper';
-import { TFormDataPayload, TFormSubmitPayload, TFormValidationPayload } from './event';
-/**
- * @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 {boolean} isValid - Indicates whether the form is valid.
- *
- * @example
- * ```typescript
- * const formValues: TFormValues = {
- *   values: { name: 'John', age: 30 },
- *   erroredFields: ['email'],
- *   isValid: false
- * };
- * ```
- */
-type TFormValues<T> = {
-    values: T;
-    metadata: unknown;
-    erroredFields: string[];
-    isValid: boolean;
-};
-/**
- * @type TFormEntry
- * Represents the entry configuration for a form.
- *
- * @property {IFormSchema} [schema] - The schema defining the structure and behavior of the form.
- * @property {Record<string, unknown>} [initialValues] - The initial values for the form fields.
- * @property {(data: TFormValues) => void} [onSubmit] - Callback function to handle form submission.
- * @property {Subject<TFormDataPayload>} [dataSubject$] - data subject passed from formGroup instance
- * @property {Subject<TFormValidationPayload>} [formValidSubject$] - formValid subject passed from formGroup instance
- * @property {Subject<TFormSubmitPayload<unknown>>} [submitSubject$] - submit subject passed from formGroup instance
- *
- * @example
- * ```typescript
- * const formEntry: TFormEntry = {
- *   schema: [{ component: 'input', props: {}, name: 'name' }],
- *   initialValues: { name: 'John' },
- *   onSubmit: (data) => { console.log(data); }
- * };
- * ```
- */
-type TFormEntry = Omit<IFormSchema, 'components'> & {
-    schema?: IFormSchema;
-    mappers?: TMapper<unknown>[];
-    dataSubject$?: Subject<TFormDataPayload>;
-    formValidSubject$?: Subject<TFormValidationPayload>;
-    submitSubject$?: Subject<TFormSubmitPayload<unknown>>;
-};
-export { TFormValues, TFormEntry };

package/src/types/mapper.d.ts

@@ -1,95 +0,0 @@
-import { TValueChangeEvent } from './event';
-import { OneOf } from './utility';
-/**
- * @type TComponentPropsMapping
- * Represents the mapping of component properties for various events and actions.
- *
- * @property {string} [getValue] - Function to get the value.
- * @property {string} [setValue] - Function to set the value.
- * @property {string} [onBlur] - Function to handle the blur event.
- * @property {string} [onClick] - Function to handle the click event.
- * @property {string} [onFocus] - Function to handle the focus event.
- * @property {string} [onKeyUp] - Function to handle the keyup event.
- * @property {string} [onKeyDown] - Function to handle the keydown event.
- * @property {string} [setErrorMessage] - Function to set the error message.
- * @property {string} [setErrorState] - Function to set the error state.
- *
- * @example
- * ```typescript
- * const componentProps: TComponentPropsMapping = {
- *   getValue: 'getValueFunction',
- *   setValue: 'setValueFunction',
- *   onBlur: 'handleBlur',
- *   onClick: 'handleClick',
- *   onFocus: 'handleFocus',
- *   onKeyUp: 'handleKeyUp',
- *   onKeyDown: 'handleKeyDown',
- *   setErrorMessage: 'setErrorMessageFunction',
- *   setErrorState: 'setErrorStateFunction'
- * };
- * ```
- */
-type TComponentPropsMapping = {
-    getValue?: string;
-    setValue?: string;
-    onBlur?: string;
-    onClick?: string;
-    onSubmit?: string;
-    onFocus?: string;
-    onKeyUp?: string;
-    onKeyDown?: string;
-    setErrorMessage?: string;
-    setErrorState?: string;
-};
-/**
- * @type TMapper
- * Represents the mapping of a component, including the component type,
- * name, events, and an optional function to handle value changes.
- *
- * @property {ElementType} component - The type of the component.
- * @property {string} componentName - The name of the component.
- * @property {TComponentPropsMapping} [events] - Mapping event properties for the component.
- * @property {TValueChangeEvent} [valueChangeEvent] - Optional function to handle value changes.
- *
- * @example
- * ```typescript
- * const mappers: TMapper[] = [
- *  {
- *    component: InputElement,
- *    componentName: 'input',
- *    events: {
- *      getValue: 'onChange2',
- *      onBlur: 'onBlur2',
- *      onFocus: 'onFocus2',
- *    }
- *  },
- *  {
- *    component: Container,
- *    componentName: 'row',
- *  },
- *  {
- *    component: Dropdown,
- *    componentName: 'dropdown',
- *    valueChangeEvent: (event: {
- *      id: string;
- *      label: string;
- *      value: string;
- *    }) => ({ _value: event.value, _stateValue: event.id }),
- *  },
- *  {
- *    component: DatePicker,
- *    componentName: 'datepicker',
- *    valueChangeEvent: (event: string) => event,
- *  },
- * ];
- * ```
- */
-type TMapper<T> = {
-    componentName: string;
-    events?: TComponentPropsMapping;
-    valueChangeEvent?: TValueChangeEvent;
-} & OneOf<{
-    component: T;
-    asynccomponent: T;
-}>;
-export { TMapper, TComponentPropsMapping };