@bolttech/form-engine-core 1.0.10 → 1.1.0

package/src/validations/regex.d.ts

@@ -0,0 +1,217 @@
+import { TValidationMethods } from '../types/schema';
+/**
+ * Validates if a value matches a given regular expression.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the regex pattern for validation.
+ * @returns `true` if the value does not match the regex, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { regex } from './path/to/validationFunctions';
+ *
+ * const validations = { regex: '^[a-zA-Z0-9]*$' };
+ *
+ * const isValid = regex('abc123', validations);
+ * console.log(isValid); // Output: false
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: 'abc123',
+ *   validations: { regex: '^[a-zA-Z0-9]*$' }
+ * };
+ *
+ * const isValid = regex(config.inputValue, config.validations);
+ * console.log(isValid); // Output: false
+ * ```
+ */
+export declare const regex: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value is a valid email address.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the email validation flag.
+ * @returns `true` if the value is not a valid email, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { email } from './path/to/validationFunctions';
+ *
+ * const validations = { email: true };
+ *
+ * const isValid = email('test@example.com', validations);
+ * console.log(isValid); // Output: false
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: 'invalid-email',
+ *   validations: { email: true }
+ * };
+ *
+ * const isValid = email(config.inputValue, config.validations);
+ * console.log(isValid); // Output: true
+ * ```
+ */
+export declare const email: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value is a valid URL.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the URL validation flag.
+ * @returns `true` if the value is not a valid URL, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { url } from './path/to/validationFunctions';
+ *
+ * const validations = { url: true };
+ *
+ * const isValid = url('https://example.com', validations);
+ * console.log(isValid); // Output: false
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: 'invalid-url',
+ *   validations: { url: true }
+ * };
+ *
+ * const isValid = url(config.inputValue, config.validations);
+ * console.log(isValid); // Output: true
+ * ```
+ */
+export declare const url: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value contains only letters.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the onlyLetters validation flag.
+ * @returns `true` if the value contains non-letter characters, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { onlyLetters } from './path/to/validationFunctions';
+ *
+ * const validations = { onlyLetters: true };
+ *
+ * const isValid = onlyLetters('abc', validations);
+ * console.log(isValid); // Output: false
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: '123',
+ *   validations: { onlyLetters: true }
+ * };
+ *
+ * const isValid = onlyLetters(config.inputValue, config.validations);
+ * console.log(isValid); // Output: true
+ * ```
+ */
+export declare const onlyLetters: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value does not contain spaces.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the notAllowSpaces validation flag.
+ * @returns `true` if the value contains spaces, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { notAllowSpaces } from './path/to/validationFunctions';
+ *
+ * const validations = { notAllowSpaces: true };
+ *
+ * const isValid = notAllowSpaces('no spaces', validations);
+ * console.log(isValid); // Output: true
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: 'nospaces',
+ *   validations: { notAllowSpaces: true }
+ * };
+ *
+ * const isValid = notAllowSpaces(config.inputValue, config.validations);
+ * console.log(isValid); // Output: false
+ * ```
+ */
+export declare const notAllowSpaces: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value is a number.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the isNumber validation flag.
+ * @returns `true` if the value is not a number, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { isNumber } from './path/to/validationFunctions';
+ *
+ * const validations = { isNumber: true };
+ *
+ * const isValid = isNumber('123', validations);
+ * console.log(isValid); // Output: false
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: 'abc',
+ *   validations: { isNumber: true }
+ * };
+ *
+ * const isValid = isNumber(config.inputValue, config.validations);
+ * console.log(isValid); // Output: true
+ * ```
+ */
+export declare const isNumber: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value has no trailing or leading spaces.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the hasNoExtraSpaces validation flag.
+ * @returns `true` if the value has trailing or leading spaces, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { hasNoExtraSpaces } from './path/to/validationFunctions';
+ *
+ * const validations = { hasNoExtraSpaces: true };
+ *
+ * const isValid = hasNoExtraSpaces('Hello', validations);
+ * console.log(isValid); // Output: true
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: ' Hello ',
+ *   validations: { hasNoExtraSpaces: true }
+ * };
+ *
+ * const isValid = hasNoExtraSpaces(config.inputValue, config.validations);
+ * console.log(isValid); // Output: false
+ * ```
+ */
+export declare const hasNoExtraSpaces: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates if a value contains repeated digits.
+ *
+ * @param value - The value to be checked.
+ * @param validations - An object containing the repeated validation flag.
+ * @returns `true` if the value contains repeated digits, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * import { repeated } from './path/to/validationFunctions';
+ *
+ * const validations = { repeated: true };
+ *
+ * const isValid = repeated('1231', validations);
+ * console.log(isValid); // Output: true
+ *
+ * // Using from a JSON config
+ * const config = {
+ *   inputValue: '1234',
+ *   validations: { repeated: true }
+ * };
+ *
+ * const isValid = repeated(config.inputValue, config.validations);
+ * console.log(isValid); // Output: false
+ * ```
+ */
+export declare const repeated: (value: unknown, validations: TValidationMethods) => boolean;

package/src/validations/string.d.ts

@@ -0,0 +1,53 @@
+import { TValidationMethods } from '../types/schema';
+/**
+ * Validates that a string value is not empty.
+ *
+ * @param {string} value - The value to be validated.
+ * @param {TValidationMethods} validations - The validation methods object containing the notEmpty validation rule.
+ * @returns {boolean} - Returns `true` if the value is empty and the notEmpty validation rule is set, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * // Assume validations is an object with a notEmpty property
+ * const validations = { notEmpty: true };
+ *
+ * // Returns true because the string is empty
+ * const result1 = notEmpty('', validations);
+ * console.log(result1); // true
+ *
+ * // Returns false because the string is not empty
+ * const result2 = notEmpty('hello', validations);
+ * console.log(result2); // false
+ *
+ * // Returns false because the notEmpty validation rule is not set
+ * const result3 = notEmpty('', { notEmpty: false });
+ * console.log(result3); // false
+ * ```
+ */
+export declare const notEmpty: (value: unknown, validations: TValidationMethods) => boolean;
+/**
+ * Validates that a value matches a specified value.
+ *
+ * @param {unknown} value - The value to be validated.
+ * @param {TValidationMethods} validations - The validation methods object containing the value validation rule.
+ * @returns {boolean} - Returns `true` if the value does not match the specified validation value, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * // Assume validations is an object with a value property
+ * const validations = { value: 42 };
+ *
+ * // Returns true because the value does not match the validation value
+ * const result1 = value(10, validations);
+ * console.log(result1); // true
+ *
+ * // Returns false because the value matches the validation value
+ * const result2 = value(42, validations);
+ * console.log(result2); // false
+ *
+ * // Returns false because the value validation rule is not set
+ * const result3 = value(10, { value: undefined });
+ * console.log(result3); // false
+ * ```
+ */
+export declare const value: (value: unknown, validations?: TValidationMethods) => boolean;