personal_site/frontend/node_modules/@aws-amplify/data-schema/dist/esm/Validate.d.ts

import { ModelFieldType } from './ModelField';
/**
 * The types of validations supported
 */
export declare enum ValidationType {
    GT = "gt",
    LT = "lt",
    GTE = "gte",
    LTE = "lte",
    MIN_LENGTH = "minLength",
    MAX_LENGTH = "maxLength",
    STARTS_WITH = "startsWith",
    ENDS_WITH = "endsWith",
    MATCHES = "matches"
}
/**
 * Represents a validation rule to be applied to a field
 */
export interface ValidationRule {
    type: ValidationType;
    value: string | number;
    errorMessage?: string;
}
/**
 * Interface for string validation methods without any exclusions
 */
export interface StringValidationBuilderBase<T, ExcludedMethods extends string = never> {
    /**
     * Validates that a string field has at least the specified length
     *
     * ⚠️ Only applicable to string fields
     *
     * @example
     * // String field example
     * a.string().validate(v => v.minLength(5, 'String must be at least 5 characters'))
     *
     * @param length - The minimum length required
     * @param errorMessage - Optional custom error message
     */
    minLength(length: number, errorMessage?: string): StringValidationBuilder<T, ExcludedMethods | 'minLength'>;
    /**
     * Validates that a string field does not exceed the specified length
     *
     * ⚠️ Only applicable to string fields
     *
     * @example
     * // String field example
     * a.string().validate(v => v.maxLength(100, 'String must be at most 100 characters'))
     *
     * @param length - The maximum length allowed
     * @param errorMessage - Optional custom error message
     */
    maxLength(length: number, errorMessage?: string): StringValidationBuilder<T, ExcludedMethods | 'maxLength'>;
    /**
     * Validates that a string field starts with the specified prefix
     *
     * ⚠️ Only applicable to string fields
     *
     * @example
     * // String field example
     * a.string().validate(v => v.startsWith("prefix-", 'String must start with prefix-'))
     *
     * @param prefix - The prefix the string must start with
     * @param errorMessage - Optional custom error message
     */
    startsWith(prefix: string, errorMessage?: string): StringValidationBuilder<T, ExcludedMethods | 'startsWith'>;
    /**
     * Validates that a string field ends with the specified suffix
     *
     * ⚠️ Only applicable to string fields
     * @example
     * // String field example
     * a.string().validate(v => v.endsWith("-suffix", 'String must end with -suffix'))
     *
     * @param suffix - The suffix the string must end with
     * @param errorMessage - Optional custom error message
     */
    endsWith(suffix: string, errorMessage?: string): StringValidationBuilder<T, ExcludedMethods | 'endsWith'>;
    /**
     * Validates that a string field matches the specified regular expression pattern
     *
     * ⚠️ Only applicable to string fields
     * @example
     * // String field example
     * a.string().validate(v => v.matches("^[a-zA-Z0-9]+$", 'String must match the regex pattern'))
     *
     * @param pattern - The regex pattern the string must match
     * @param errorMessage - Optional custom error message
     */
    matches(pattern: string, errorMessage?: string): StringValidationBuilder<T, ExcludedMethods | 'matches'>;
}
/**
 * Interface for string validation methods with specific validators excluded
 *
 * This is to disallow duplicate validation operators on the same field, which is not supported in the Validate Transformer.
 */
export type StringValidationBuilder<T, ExcludedMethods extends string = never> = Omit<StringValidationBuilderBase<T, ExcludedMethods>, ExcludedMethods & keyof StringValidationBuilderBase<T, ExcludedMethods>>;
/**
 * Interface for numeric validation methods without any exclusions
 */
export interface NumericValidationBuilderBase<T, ExcludedMethods extends string = never> {
    /**
     * Validates that a numeric field is greater than the specified value
     *
     * ⚠️ Only applicable for integer or float fields
     *
     * @example
     * // Integer field example
     * a.integer().validate(v => v.gt(10, 'Integer must be greater than 10'))
     *
     * // Float field example
     * a.float().validate(v => v.gt(3.14, 'Float must be greater than 3.14'))
     *
     * @param value - The value that the field must be greater than
     * @param errorMessage - Optional custom error message
     */
    gt(value: number, errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'gt' | 'positive'>;
    /**
     * Validates that a numeric field is less than the specified value
     *
     * ⚠️ Only applicable for integer or float fields
     * @example
     * // Integer field example
     * a.integer().validate(v => v.lt(10, 'Integer must be less than 10'))
     *
     * // Float field example
     * a.float().validate(v => v.lt(3.14, 'Float must be less than 3.14'))
     *
     * @param value - The value that the field must be less than
     * @param errorMessage - Optional custom error message
     */
    lt(value: number, errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'lt' | 'negative'>;
    /**
     * Validates that a numeric field is greater than or equal to the specified value
     *
     * ⚠️ Only applicable for integer or float fields
     *
     * @example
     * // Integer field example
     * a.integer().validate(v => v.gte(10, 'Integer must be greater than or equal to 10'))
     *
     * // Float field example
     * a.float().validate(v => v.gte(3.14, 'Float must be greater than or equal to 3.14'))
     *
     * @param value - The value that the field must be greater than or equal to
     * @param errorMessage - Optional custom error message
     */
    gte(value: number, errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'gte'>;
    /**
     * Validates that a numeric field is less than or equal to the specified value
     *
     * ⚠️ Only applicable for integer or float fields
     * @example
     * // Integer field example
     * a.integer().validate(v => v.lte(10, 'Integer must be less than or equal to 10'))
     *
     * // Float field example
     * a.float().validate(v => v.lte(3.14, 'Float must be less than or equal to 3.14'))
     *
     * @param value - The value that the field must be less than or equal to
     * @param errorMessage - Optional custom error message
     */
    lte(value: number, errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'lte'>;
    /**
     * Validates that a numeric field is positive
     *
     * ⚠️ Only applicable for integer or float fields
     *
     * @example
     * // Integer field example
     * a.integer().validate(v => v.positive('Integer must be positive'))
     *
     * // Float field example
     * a.float().validate(v => v.positive('Float must be positive'))
     *
     * @param errorMessage - Optional custom error message
     */
    positive(errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'positive' | 'gt'>;
    /**
     * Validates that a numeric field is negative
     *
     * ⚠️ Only applicable for integer or float fields
     * @example
     * // Integer field example
     * a.integer().validate(v => v.negative('Integer must be negative'))
     *
     * // Float field example
     * a.float().validate(v => v.negative('Float must be negative'))
     *
     * @param errorMessage - Optional custom error message
     */
    negative(errorMessage?: string): NumericValidationBuilder<T, ExcludedMethods | 'negative' | 'lt'>;
}
/**
 * Interface for numeric validation methods with specific validators excluded
 *
 * This is to disallow duplicate validation operators on the same field, which is not supported in the Validate Transformer.
 */
export type NumericValidationBuilder<T, ExcludedMethods extends string = never> = Omit<NumericValidationBuilderBase<T, ExcludedMethods>, ExcludedMethods & keyof NumericValidationBuilderBase<T, ExcludedMethods>>;
/**
 * Maps a ModelFieldType to the appropriate validation builder type
 *
 * Note: This type intentionally uses the public interfaces which don't expose the getRules method
 */
export type FieldTypeToValidationBuilder<T, FT extends ModelFieldType> = FT extends ModelFieldType.String ? StringValidationBuilder<T, never> : FT extends ModelFieldType.Integer | ModelFieldType.Float ? NumericValidationBuilder<T, never> : never;
/**
 * A builder for creating field validation rules
 * @typeParam T - The type of the field being validated
 */
export type ValidationBuilder<T> = StringValidationBuilderBase<T> & NumericValidationBuilderBase<T>;
/**
 * Creates a type-safe validation builder for a specific field type with access to get the rules
 * @returns An object containing the validation builder and a function to get the rules
 */
export declare function createValidationBuilder<T, FT extends ModelFieldType>(): {
    builder: FieldTypeToValidationBuilder<T, FT>;
    getRules: () => ValidationRule[];
};