@bolttech/form-engine 0.4.6 → 0.5.0

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.5.0](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.4.7...form-engine-0.5.0) (2023-10-24)
+
+
+### Features
+
+* create boolean validation function and update readme with all validation types description ([fd17418](http://bitbucket.org/gofrank/bolttech-frontend/commit/fd17418c80cb6b85fee27eefdfa479f43e2cd76b))
+
+## [0.4.7](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.4.6...form-engine-0.4.7) (2023-10-20)
+
+
+### Bug Fixes
+
+* add stage version on readme ([4fe3eff](http://bitbucket.org/gofrank/bolttech-frontend/commit/4fe3effbbf7f28b722e88ea5cd0f8ed4163d1103))
+* api call on mound event handler ([eca02f9](http://bitbucket.org/gofrank/bolttech-frontend/commit/eca02f980a1ee6cf8a35bae570f5ecba7f191bdf))
+
 ## [0.4.6](http://bitbucket.org/gofrank/bolttech-frontend/compare/form-engine-0.4.5...form-engine-0.4.6) (2023-09-28)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 Achieve form logic reusage with forms expressed in json format.
 
-> version 0.2.2
+> stable version 0.5.0
 
 ---
 
@@ -327,7 +327,400 @@ If you have a named validation, you can use its name in the error messages, havi
 
 ### Available validations (TBD)
 
-Refer to the types on `TSchema`
+Refer to the `TAvailableValidations` types here:
+
+````typescript
+{
+  /**
+   * The bool function is a validation function that checks if a given value indicating whether the validation has failed or not.
+   *
+   * @example - in a test environment
+   * ```
+   * const result = bool({
+   *   validationValue: false,
+   * });
+   * console.log(result); // { fail: false }
+   * ```
+   *
+   * @example - real json usage with field value
+   * ```
+   * {
+   *   validations: {
+   *      bool: '${fields.input.value}'
+   *   },
+   * },
+   * ```
+   *
+   * @example - real json usage with iVar value
+   * ```
+   * {
+   *   validations: {
+   *      bool: '${global.validation}'
+   *   },
+   * },
+   * ```
+   */
+  bool?: string | boolean;
+  /**
+   * Validation based on conditions
+   *
+   * @example - Compare own field to two. Origin and target default to field value
+   * ```
+   * conditions: {
+   *   rule: 'and',
+   *   set: [
+   *     {
+   *       condition: '===',
+   *       target: '2',
+   *     },
+   *     {
+   *       origin: '2',
+   *       condition: '===',
+   *     },
+   *   ],
+   * },
+   * ```
+   * @example - Binded to Postcode field value. Must be greater than or equal two
+   * ```
+   * conditions: {
+   *   rule: 'or',
+   *   set: [
+   *     {
+   *       origin: '${fields.postcode.value}',
+   *       condition: '>',
+   *       target: '2',
+   *     },
+   *     {
+   *       origin: '${fields.postcode.value}',
+   *       condition: '===',
+   *       target: '2',
+   *     },
+   *   ],
+   * },
+   * ```
+   * @example - Binded to Postcode field value. Must be equal to two
+   * ```
+   * conditions: {
+   *   rule: 'or',
+   *   set: [
+   *     {
+   *       origin: '${fields.postcode.value}',
+   *       condition: '===',
+   *       target: '2',
+   *     },
+   *   ],
+   * },
+   * ```
+   */
+  conditions?: TVAvailableValitationConditions;
+  /**
+   * Between validations
+   *
+   * @example - Between ages
+   * ```    type teste = Pick<TVAvailableValidations, 'date'>
+   * between: {
+   *   dates: [
+   *     {
+   *       operator: '>=',
+   *       origin: {
+   *         format: 'YYYYMMDD',
+   *         intervals: {
+   *           years: 18,
+   *         },
+   *       },
+   *     },
+   *     {
+   *       operator: '<=',
+   *       origin: {
+   *         format: 'YYYYMMDD',
+   *         intervals: {
+   *           years: 75,
+   *         },
+   *       },
+   *     }
+   *   ]
+   * }
+   * ```
+   *
+   * @example - Between numbers
+   * ```
+   *  between: {
+   *    start: '3',
+   *    end: '4',
+   *    isIncludedBoundaries: true
+   *  },
+   *  ```
+   *
+   */
+  between?: {
+    /**
+     * Array of date validations. To make it possible, ensure that the conditions is > and < in both date validations.
+     */
+    dates?: TVAvailableValidations['date'][];
+    /**
+     * The first number of the validation. If the current value is grater than this number, the validation will pass.
+     */
+    start?: number;
+    /**
+     * The second number of the validation. If the current value is lower than this number, the validation will pass.
+     */
+    end?: number;
+    /**
+     * If it's true, the comparision is transformed to >= and <=. So, the numbers that were passed are included in the validation.
+     */
+    isIncludedBoundaries?: boolean;
+  };
+  /**
+   * Dates validations
+   *
+   * @example - Dates should be different
+   * ```
+   * date: {
+   *   operator: '!==',
+   *   origin: {
+   *     format: 'DDMMYYYY',
+   *   },
+   *   target: {
+   *     format: 'DDMMYYYY',
+   *     value: '10/10/2001',
+   *   },
+   * },*
+   * ```
+   *
+   * @example - Compare only valid dates using intervals
+   * ```
+   *  date: {
+   *    onlyValidDate: true,
+   *    operator: '<',
+   *    origin: {
+   *      format: 'DD/MM/YYYY',
+   *      intervals: {
+   *        years: 1,
+   *      },
+   *    },
+   *  },
+   *  ```
+   *
+   * @example - Should have at max 85 years
+   * ```
+   * {
+   *    operator: '>',
+   *    origin: {
+   *      format: 'DDMMYYYY',
+   *      value: eightyFiveYearsDate,
+   *      intervals: {
+   *        years: 85,
+   *      },
+   *    },
+   *  }
+   * }
+   *
+   * ```
+   */
+  date?: {
+    /**
+     * Flag to force only valid dates. Valid dates must be of min length of 8
+     */
+    onlyValidDate?: boolean;
+    /**
+     * List of operations you can do
+     * - between origin and target dates
+     * - between origin and intervals
+     */
+    operator: TValidationDateOperators;
+    /**
+     *  The origin configurations
+     */
+    origin: {
+      /**
+       * Origin date value
+       */
+      value?: string | number;
+      /**
+       * The available date formats
+       */
+      format: TValidationDateFormats;
+      /**
+       * Intervals to compare with the original date.
+       *
+       * It will use todays date for comparison.
+       *
+       * @example
+       *
+       * origin date = 10/10/2022
+       * interval.year = 1
+       * operator = '==='
+       *
+       * It will compare (10/10/2022 + 1) with the current date and check if they are the same
+       */
+      intervals?: {
+        years?: number;
+        months?: number;
+        days?: number;
+      };
+    };
+    target?: {
+      value: string | number;
+      format: TValidationDateFormats;
+    };
+  };
+  /**
+   * Allow to define a maximum length for the input to have no error
+   */
+  length?: number;
+  /**
+   * Will look into the input length and send an error if if not greater than this value
+   */
+  greaterThan?: number | string;
+
+  /**
+   * Specifies a regular expression pattern that the value should match.
+   */
+  regex?: string;
+
+  /**
+   * Specifies the maximum length of the value (if it's a string).
+   */
+  maxLength?: number;
+
+  /**
+   * Specifies the minimum length of the value (if it's a string).
+   */
+  minLength?: number;
+
+  /**
+   * Specifies whether the field is required.
+   */
+  required?: boolean;
+
+  /**
+   * Specifies that the value should contain only letters.
+   */
+  onlyLetters?: boolean;
+
+  /**
+   * Specifies a value that the field should match.
+   */
+  value?: string | number | boolean;
+
+  /**
+   * Specifies that the field should not be empty.
+   */
+  notEmpty?: boolean;
+
+  /**
+   * A callback function that performs custom validation on the value.
+   * @param value - The value to be validated.
+   * @returns An object with validation results.
+   */
+  callback?(value: string | number): { fail: boolean; errorMessage?: string };
+
+  /**
+   * Specifies a numeric range for the value.
+   */
+  numericRange?: { start: number | string; end: number | string };
+
+  /**
+   * Specifies whether the value should be a number.
+   */
+  isNumber?: boolean;
+
+  /**
+   * Specifies that the field should not have extra spaces.
+   */
+  hasNoExtraSpaces?: boolean;
+
+  /**
+   * Specifies that the value should be an email address.
+   */
+  email?: boolean;
+
+  /**
+   * Specifies that the value should be less than a given number or string.
+   */
+  lessThan?: number | string;
+
+  /**
+   * Specifies that the value should be a sequential number.
+   */
+  sequentialNumber?: boolean;
+
+  /**
+   * Specifies that the value should not contain repeated numbers.
+   */
+  repeatedNumbers?: boolean;
+
+  /**
+   * Specifies that the value should be a URL.
+   */
+  url?: boolean;
+
+  /**
+   * Specifies a path error type.
+   */
+  path?: TPathError;
+
+  /**
+   * Specifies that the value should be a valid credit card number.
+   */
+  isCreditCard?: string[];
+
+  /**
+   * Specifies that the value should be a valid credit card number with a specific length.
+   */
+  isCreditCardAndLength?: string[];
+
+  /**
+   * Specifies that the value should match a credit card code with available options.
+   */
+  isCreditCodeMatch?: { numberCard: string; availableOptions: string[] };
+
+  /**
+   * Specifies custom validation options for the field.
+   */
+  customValidation?: ICustomValidationValue[];
+
+  /**
+   * Specifies that spaces are not allowed in the field.
+   */
+  notAllowSpaces?: true;
+
+  /**
+   * Specifies that the value should be in a predefined list of values.
+   */
+  isInTheList?: string[] | number[] | string;
+
+  /**
+   * Specifies field validation rules for nested fields.
+   */
+  fields?: {
+    /**
+     * The rule for validating nested fields (e.g., 'every').
+     */
+    rule: 'every';
+
+    /**
+     * An array of nested field validation configurations.
+     */
+    set: {
+      /**
+       * The binding for the nested field.
+       */
+      bind: string;
+
+      /**
+       * The field name for the nested field.
+       */
+      fieldName: string;
+
+      /**
+       * Validation options for the nested field, excluding the 'fields' property.
+       */
+      validations: Omit<TVAvailableValidations, 'fields'>;
+    }[];
+  };
+}
+````
 
 ## **Formatters**