@cleverbrush/schema 1.1.11 → 3.0.0

package/dist/builders/DateSchemaBuilder.d.ts

@@ -1,5 +1,5 @@
-import { Preprocessor, SchemaBuilder, ValidationResult, ValidationContext, Validator } from './SchemaBuilder.js';
-type DateSchemaBuilderCreateProps<T = Date, R extends boolean = true> = Partial<ReturnType<DateSchemaBuilder<T, R>['introspect']>>;
+import { type BRAND, type PreprocessorEntry, SchemaBuilder, type ValidationContext, type ValidationErrorMessageProvider, type ValidationResult, type ValidatorEntry } from './SchemaBuilder.js';
+type DateSchemaBuilderCreateProps<T = Date, R extends boolean = true> = Partial<ReturnType<DateSchemaBuilder<T, R, any>['introspect']>>;
 /**
  * Allows to create Date schema. It can be required or optional.
  * It can be restricted to be: equal to a certain value, in future, in past, in a certain range.
@@ -12,59 +12,87 @@ type DateSchemaBuilderCreateProps<T = Date, R extends boolean = true> = Partial<
  * @example ```ts
  * const date = new Date(2020, 0, 2);
  * const schema = date().min(new Date(2020, 0, 1));
- * const result = await schema.validate(date);
+ * const result = schema.validate(date);
  * // result.valid === true
  * // result.object === date
  * ```
  *
  * @example ```ts
  * const schema = date();
- * const result = await schema.validate('2020-01-01');
+ * const result = schema.validate('2020-01-01');
  * // result.valid === false
  * // result.errors[0].message === 'is expected to be a date'
  * ```
  *
  * @example ```ts
  * const schema = date().parseFromJson();
- * const result = await schema.validate('2020-01-01T00:00:00.000Z');
+ * const result = schema.validate('2020-01-01T00:00:00.000Z');
  * // result.valid === true
  * // result.object is equal to corresponding Date object
  * ```
  *
  * @example ```ts
  * const schema = date().parseFromEpoch();
- * const result = await schema.validate(1577836800000);
+ * const result = schema.validate(1577836800000);
  * // result.valid === true
  * // result.object is equal to corresponding Date object
  * ```
  *
  * @see {@link date}
  */
-export declare class DateSchemaBuilder<TResult = Date, TRequired extends boolean = true> extends SchemaBuilder<TResult, TRequired> {
+export declare class DateSchemaBuilder<TResult = Date, TRequired extends boolean = true, TNullable extends boolean = false, THasDefault extends boolean = false, TExtensions = {}> extends SchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> {
     #private;
-    static create(props: DateSchemaBuilderCreateProps): DateSchemaBuilder<Date, true>;
-    private constructor();
+    /**
+     * @hidden
+     */
+    static create(props: DateSchemaBuilderCreateProps): DateSchemaBuilder<Date, true, false, false, {}>;
+    protected constructor(props: DateSchemaBuilderCreateProps);
     introspect(): {
         /**
          * Min valid value (if defined).
          */
         min: Date | undefined;
+        /**
+         * Min value validation error message provider.
+         * If not provided, default error message will be used.
+         */
+        minValidationErrorMessageProvider: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired, false, false, {}>>;
         /**
          * Max valid value (if defined).
          */
         max: Date | undefined;
+        /**
+         * Max value validation error message provider.
+         * If not provided, default error message will be used.
+         */
+        maxValidationErrorMessageProvider: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired, false, false, {}>>;
         /**
          * Make sure that date is in future. `false` by default.
          */
         ensureIsInFuture: boolean;
+        /**
+         * Ensure in future validation error message provider.
+         * If not provided, default error message will be used.
+         */
+        ensureIsInFutureValidationErrorMessageProvider: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired, false, false, {}>>;
         /**
          * Make sure that date is in past. `false` by default.
          */
         ensureIsInPast: boolean;
+        /**
+         * Ensure in past validation error message provider.
+         * If not provided, default error message will be used.
+         */
+        ensureIsInPastValidationErrorMessageProvider: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired, false, false, {}>>;
         /**
          * If set, restrict date to be equal to a certain value.
          */
         equalsTo: Date | undefined;
+        /**
+         * Equals to validation error message provider.
+         * If not provided, default error message will be used.
+         */
+        equalsToValidationErrorMessageProvider: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired, false, false, {}>>;
         /**
          * If set, schema will try to parse date from the UNIX epoch (number).
          * `false` by default.
@@ -78,27 +106,51 @@ export declare class DateSchemaBuilder<TResult = Date, TRequired extends boolean
         /**
          * Array of preprocessor functions
          */
-        preprocessors: Preprocessor<TResult>[];
+        preprocessors: PreprocessorEntry<TResult>[];
         /**
          * Array of validator functions
          */
-        validators: Validator<TResult>[];
+        validators: ValidatorEntry<TResult>[];
         type: string;
         isRequired: boolean;
+        isNullable: boolean;
+        isReadonly: boolean;
+        requiredValidationErrorMessageProvider: ValidationErrorMessageProvider<SchemaBuilder<any, any, any, any, any>>;
+        extensions: {
+            [x: string]: unknown;
+        };
+        hasDefault: boolean;
+        defaultValue: TResult | (() => TResult) | undefined;
+        description: string | undefined;
+        schemaName: string | undefined;
+        hasCatch: boolean;
+        catchValue: TResult | (() => TResult) | undefined;
+        example: unknown;
     };
     /**
-     * @hidden
+     * @inheritdoc
      */
-    hasType<T>(notUsed?: T): DateSchemaBuilder<T, true>;
+    hasType<T>(_notUsed?: T): DateSchemaBuilder<T, true, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
-     * @hidden
+     * @inheritdoc
+     */
+    clearHasType(): DateSchemaBuilder<Date, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
+    /** {@inheritDoc SchemaBuilder.validate} */
+    validate(object: TResult, context?: ValidationContext): ValidationResult<TResult>;
+    /** {@inheritDoc SchemaBuilder.validateAsync} */
+    validateAsync(object: TResult, context?: ValidationContext): Promise<ValidationResult<TResult>>;
+    /**
+     * Performs synchronous validation of Date schema over `object`.
+     * Throws if any preprocessor, validator, or error message provider returns a Promise.
+     * @param context Optional `ValidationContext` settings.
      */
-    clearHasType(): DateSchemaBuilder<Date, TRequired>;
+    protected _validate(object: TResult, context?: ValidationContext): ValidationResult<TResult>;
     /**
-     * Performs validion of Date schema over `object`.
+     * Performs async validation of Date schema over `object`.
+     * Supports async preprocessors, validators, and error message providers.
      * @param context Optional `ValidationContext` settings.
      */
-    validate(object: TResult, context?: ValidationContext): Promise<ValidationResult<TResult>>;
+    protected _validateAsync(object: TResult, context?: ValidationContext): Promise<ValidationResult<TResult>>;
     /**
      * @hidden
      */
@@ -106,72 +158,140 @@ export declare class DateSchemaBuilder<TResult = Date, TRequired extends boolean
     /**
      * Restricts Date to be equal to `value`.
      */
-    equals<T extends Date>(value: T): DateSchemaBuilder<T, TRequired>;
+    equals<T extends Date>(value: T, 
+    /**
+     * Custom error message provider.
+     */
+    errorMessage?: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired>>): DateSchemaBuilder<T, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Clears `equals()` call.
      */
-    clearEquals(): DateSchemaBuilder<Date, TRequired>;
+    clearEquals(): DateSchemaBuilder<Date, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
+    /**
+     * @hidden
+     */
+    required(errorMessage?: ValidationErrorMessageProvider): DateSchemaBuilder<TResult, true, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * @hidden
      */
-    required(): DateSchemaBuilder<TResult, true>;
+    optional(): DateSchemaBuilder<TResult, false, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * @hidden
      */
-    optional(): DateSchemaBuilder<TResult, false>;
+    default(value: TResult | (() => TResult)): DateSchemaBuilder<TResult, true, TNullable, true, TExtensions> & TExtensions;
+    /**
+     * @hidden
+     */
+    clearDefault(): DateSchemaBuilder<TResult, TRequired, TNullable, false, TExtensions> & TExtensions;
+    /**
+     * @hidden
+     */
+    brand<TBrand extends string | symbol>(_name?: TBrand): DateSchemaBuilder<TResult & {
+        readonly [K in BRAND]: TBrand;
+    }, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
+    /**
+     * Marks the inferred type as `Readonly<Date>` — prevents mutation of
+     * Date methods like `setFullYear()` at the type level. Validation
+     * behaviour is unchanged.
+     *
+     * @see {@link SchemaBuilder.readonly}
+     */
+    readonly(): DateSchemaBuilder<Readonly<TResult>, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Accept only dates in the future.
      */
-    isInFuture(): DateSchemaBuilder<TResult, TRequired>;
+    isInFuture(
+    /**
+     * Custom error message provider.
+     */
+    errorMessage?: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired>>): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Cancel `isInFuture()` call.
      */
-    clearIsInFuture(): DateSchemaBuilder<TResult, TRequired>;
+    clearIsInFuture(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Accept only dates in the past.
      */
-    isInPast(): DateSchemaBuilder<TResult, TRequired>;
+    isInPast(
+    /**
+     * Custom error message provider.
+     */
+    errorMessage?: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired>>): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Cancel `isInPast()` call.
      */
-    clearIsInPast(): DateSchemaBuilder<TResult, TRequired>;
+    clearIsInPast(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Set minimal valid Date value for schema.
      */
-    min(minValue: Date): DateSchemaBuilder<TResult, TRequired>;
+    min(minValue: Date, 
+    /**
+     * Custom error message provider.
+     */
+    errorMessage?: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired>>): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Clear `min()` call.
      */
-    clearMin(): DateSchemaBuilder<TResult, TRequired>;
+    clearMin(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Set maximal valid Date value for schema.
      */
-    max(maxValue: Date): DateSchemaBuilder<TResult, TRequired>;
+    max(maxValue: Date, 
+    /**
+     * Custom error message provider.
+     */
+    errorMessage?: ValidationErrorMessageProvider<DateSchemaBuilder<TResult, TRequired>>): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Clear `max()` call.
      */
-    clearMax(): DateSchemaBuilder<TResult, TRequired>;
+    clearMax(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
+    /**
+     * Adds a preprocessor that coerces a string value to a Date
+     * using `new Date(value)`. If the string does not represent a
+     * valid date the original value is left unchanged so the date
+     * schema rejects it.
+     *
+     * This is a convenient alias for common string→Date coercion.
+     * For more specific parsing, see {@link acceptJsonString} and
+     * {@link acceptEpoch}.
+     *
+     * @example ```ts
+     * const schema = date().coerce();
+     * const result = schema.validate('2024-01-15');
+     * // result.valid === true
+     * // result.object instanceof Date === true
+     * ```
+     */
+    coerce(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Accepts JSON string as a valid Date.
      * String must be in ISO format and will be parsed using `JSON.parse()`.
      */
-    acceptJsonString(): DateSchemaBuilder<TResult, TRequired>;
+    acceptJsonString(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Cancel `acceptJsonString()` call.
      */
-    doNotAcceptJsonString(): DateSchemaBuilder<TResult, TRequired>;
+    doNotAcceptJsonString(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Accepts epoch number as a valid Date.
      * Epoch number will be parsed using `new Date(epoch)`.
      */
-    acceptEpoch(): DateSchemaBuilder<TResult, TRequired>;
+    acceptEpoch(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
     /**
      * Cancel `acceptEpoch()` call.
      */
-    doNotAcceptEpoch(): DateSchemaBuilder<TResult, TRequired>;
+    doNotAcceptEpoch(): DateSchemaBuilder<TResult, TRequired, TNullable, THasDefault, TExtensions> & TExtensions;
+    /**
+     * @hidden
+     */
+    nullable(): DateSchemaBuilder<TResult, TRequired, true, THasDefault, TExtensions> & TExtensions;
+    /**
+     * @hidden
+     */
+    notNullable(): DateSchemaBuilder<TResult, TRequired, false, THasDefault, TExtensions> & TExtensions;
 }
 /**
  * Creates a Date schema.
  */
-export declare const date: () => DateSchemaBuilder<Date, true>;
+export declare const date: () => DateSchemaBuilder<Date, true, false, false, {}>;
 export {};