@cleverbrush/schema 1.0.0-beta.4 → 1.0.0

package/dist/builders/NumberSchemaBuilder.d.ts

@@ -1,61 +1,161 @@
-import { ISchemaBuilder, SchemaBuilder } from './SchemaBuilder.js';
-import { Schema, Validator } from '../schema.js';
-export interface INumberSchemaBuilder<TRequired extends boolean = true, TNullable extends boolean = false, TMin extends number | undefined = undefined, TMax extends number | undefined = undefined, TIsInteger extends boolean | undefined = undefined, TEnsureNotNaN extends boolean = true, TEnsureIsFinite extends boolean = true, TEqualsTo extends number | undefined = undefined> extends ISchemaBuilder<TRequired, TNullable> {
-    min<K extends number>(val: K): INumberSchemaBuilder<TRequired, TNullable, K, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    clearMin(): INumberSchemaBuilder<TRequired, TNullable, undefined, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    max<K extends number>(val: K): INumberSchemaBuilder<TRequired, TNullable, TMin, K, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    clearMax(): INumberSchemaBuilder<TRequired, TNullable, TMin, undefined, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    optional(): INumberSchemaBuilder<false, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    required(): INumberSchemaBuilder<true, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    nullable(): INumberSchemaBuilder<TRequired, true, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    notNullable(): INumberSchemaBuilder<TRequired, false, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    equals<T extends number>(val: T): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, T>;
-    clearEquals(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, undefined>;
-    isInteger(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, true, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    canBeNotInteger(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, undefined, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    notNaN(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, true, TEnsureIsFinite, TEqualsTo>;
-    canBeNaN(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, false, TEnsureIsFinite, TEqualsTo>;
-    isFinite(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, true, TEqualsTo>;
-    canBeInfinite(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, false, TEqualsTo>;
-}
-export declare class NumberSchemaBuilder<TRequired extends boolean = true, TNullable extends boolean = false, TMin extends number | undefined = undefined, TMax extends number | undefined = undefined, TIsInteger extends boolean | undefined = undefined, TEnsureNotNaN extends boolean = true, TEnsureIsFinite extends boolean = true, TEqualsTo extends number | undefined = undefined> extends SchemaBuilder<TRequired, TNullable> implements INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo> {
-    clone(): this;
-    get _schema(): Schema;
-    static create<TRequired extends boolean = true, TNullable extends boolean = false, TMin extends number | undefined = undefined, TMax extends number | undefined = undefined, TIsInteger extends boolean | undefined = undefined, TEnsureNotNaN extends boolean = true, TEnsureIsFinite extends boolean = true, TEqualsTo extends number | undefined = undefined>(obj?: {
-        isRequired: TRequired;
-        isNullable: TNullable;
-        min: TMin;
-        max: TMax;
-        isInteger: TIsInteger;
-        ensureNotNaN: TEnsureNotNaN;
-        ensureIsFinite: TEnsureIsFinite;
-        equals: TEqualsTo;
-        validators?: Validator[];
-        preprocessor?: ((value: unknown) => unknown | Promise<unknown>) | string;
-    }): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
+import { Preprocessor, SchemaBuilder, ValidationResult, ValidationContext, Validator } from './SchemaBuilder.js';
+type NumberSchemaBuilderCreateProps<T = number, R extends boolean = true> = Partial<ReturnType<NumberSchemaBuilder<T, R>['introspect']>>;
+/**
+ * Number schema builder class. Allows to create Number schemas.
+ * Can be required or optional, can be restricted to be equal to a certain value,
+ * can be restricted to be in a certain range, can be restricted to be integer.
+ *
+ * **NOTE** this class is exported only to give opportunity to extend it
+ * by inheriting. It is not recommended to create an instance of this class
+ * directly. Use {@link number | number()} function instead.
+ *
+ * @example ```ts
+ * const schema = number().equals(42);
+ * const result = await schema.validate(42);
+ * // result.valid === true
+ * // result.object === 42
+ * ```
+ * @example ```ts
+ * const schema = number();
+ * const result = await schema.validate('42');
+ * // result.valid === false
+ * // result.errors[0].message === 'is expected to be a number'
+ * ```
+ * @example ```ts
+ * const schema = number().min(0).max(100);
+ * const result = await schema.validate(42);
+ * // result.valid === true
+ * // result.object === 42
+ * ```
+ *
+ * @example ```ts
+ * const schema = number().min(0).max(100);
+ * const result = await schema.validate(142.5);
+ * // result.valid === false
+ * // result.errors[0].message === 'is expected to be less than or equal to 100'
+ * ```
+ *
+ * @see {@link number}
+ */
+export declare class NumberSchemaBuilder<TResult = number, TRequired extends boolean = true> extends SchemaBuilder<TResult, TRequired> {
+    #private;
+    static create(props: NumberSchemaBuilderCreateProps): NumberSchemaBuilder<number, true>;
     private constructor();
-    protected readonly type = "number";
-    _min?: TMin;
-    _max?: TMax;
-    _isInteger?: TIsInteger;
-    _ensureNotNaN: TEnsureNotNaN;
-    _ensureIsFinite: TEnsureIsFinite;
-    _equals?: TEqualsTo;
-    min<K extends number>(val: K): INumberSchemaBuilder<TRequired, TNullable, K, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    clearMin(): INumberSchemaBuilder<TRequired, TNullable, undefined, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    max<K extends number>(val: K): INumberSchemaBuilder<TRequired, TNullable, TMin, K, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    clearMax(): INumberSchemaBuilder<TRequired, TNullable, TMin, undefined, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    optional(): INumberSchemaBuilder<false, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    required(): INumberSchemaBuilder<true, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    nullable(): INumberSchemaBuilder<TRequired, true, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    notNullable(): INumberSchemaBuilder<TRequired, false, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    equals<T extends number>(val: T): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, T>;
-    clearEquals(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, TEnsureIsFinite, undefined>;
-    isInteger(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, true, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    canBeNotInteger(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, undefined, TEnsureNotNaN, TEnsureIsFinite, TEqualsTo>;
-    notNaN(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, true, TEnsureIsFinite, TEqualsTo>;
-    canBeNaN(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, false, TEnsureIsFinite, TEqualsTo>;
-    isFinite(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, true, TEqualsTo>;
-    canBeInfinite(): INumberSchemaBuilder<TRequired, TNullable, TMin, TMax, TIsInteger, TEnsureNotNaN, false, TEqualsTo>;
+    introspect(): {
+        /**
+         * Min valid value (if defined).
+         */
+        min: number | undefined;
+        /**
+         * Max valid value (if defined).
+         */
+        max: number | undefined;
+        /**
+         * Make sure that object is not `NaN`. `true` by default.
+         */
+        ensureNotNaN: boolean;
+        /**
+         * Make sure that object is not different kinds of `infinity`. `true` by default.
+         */
+        ensureIsFinite: boolean;
+        /**
+         * If set, restrict object to be equal to a certain value.
+         */
+        equalsTo: number | undefined;
+        /**
+         * Allow only integer values (floating point values will be rejected
+         * as invalid)
+         */
+        isInteger: boolean;
+        /**
+         * Array of preprocessor functions
+         */
+        preprocessors: Preprocessor<TResult>[];
+        /**
+         * Array of validator functions
+         */
+        validators: Validator<TResult>[];
+        type: string;
+        isRequired: boolean;
+    };
+    /**
+     * @hidden
+     */
+    hasType<T>(notUsed?: T): NumberSchemaBuilder<T, true>;
+    /**
+     * @hidden
+     */
+    clearHasType(): NumberSchemaBuilder<number, TRequired>;
+    /**
+     * Performs validion of number schema over `object`.
+     * @param context Optional `ValidationContext` settings.
+     */
+    validate(object: TResult, context?: ValidationContext): Promise<ValidationResult<TResult>>;
+    protected createFromProps<T, TReq extends boolean>(props: NumberSchemaBuilderCreateProps<T, TReq>): this;
+    /**
+     * Restricts number to be equal to `value`.
+     */
+    equals<T extends number>(value: T): NumberSchemaBuilder<T, TRequired>;
+    /**
+     * Clear `equals()` call.
+     */
+    clearEquals(): NumberSchemaBuilder<number, TRequired>;
+    /**
+     * Float values will be considered as valid after this call.
+     */
+    isFloat(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Only integer values will be considered as valid after this call.
+     */
+    isInteger(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * @hidden
+     */
+    required(): NumberSchemaBuilder<TResult, true>;
+    /**
+     * @hidden
+     */
+    optional(): NumberSchemaBuilder<TResult, false>;
+    /**
+     * Do not accept NaN value
+     */
+    notNaN(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Consider NaN value as valid
+     */
+    canBeNaN(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Do not accept `Infinity`.
+     */
+    isFinite(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Consider `Infinity` as valid.
+     */
+    canBeInfinite(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Restrict number to be at least `minValue`.
+     */
+    min(minValue: number): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Clear `min()` call.
+     */
+    clearMin(): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Restrict number to be no more than `maxValue`.
+     */
+    max(maxValue: number): NumberSchemaBuilder<TResult, TRequired>;
+    /**
+     * Clear `max()` call.
+     */
+    clearMax(): NumberSchemaBuilder<TResult, TRequired>;
 }
-export declare const number: () => INumberSchemaBuilder<true, false, undefined, undefined, undefined, true, true, undefined>;
+/**
+ * Creates a number schema restricted to `equals` value.
+ * @param equals string value
+ */
+export declare function number<T extends number>(equals: T): NumberSchemaBuilder<T, true>;
+/**
+ * Creates a number schema.
+ */
+export declare function number(): NumberSchemaBuilder<number, true>;
+export {};