@decaf-ts/decorator-validation 1.14.0 → 1.16.0

package/lib/types/overrides/Metadata.d.cts

@@ -0,0 +1,132 @@
+import { Model } from "../model/Model.cjs";
+import "@decaf-ts/decoration";
+import { Constructor } from "@decaf-ts/decoration";
+import { designTypeReturn, ExtendedMetadata } from "./types.cjs";
+import { ValidationMetadata } from "../validation/types.cjs";
+declare module "@decaf-ts/decoration" {
+    namespace Metadata {
+        /**
+         * @description Retrieves validation metadata for a specific property of a model
+         * @summary Fetches validation rules and constraints that were applied to a property
+         * via decorators. The optional key parameter allows drilling down to specific
+         * validation types (e.g., 'required', 'min', 'max').
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @param {string} [key] - Optional specific validation key to retrieve (e.g., 'required', 'pattern')
+         * @return {any} The validation metadata object or value at the specified key
+         *
+         * @example
+         * class User extends Model {
+         *   @required()
+         *   @maxLength(100)
+         *   name!: string;
+         * }
+         *
+         * // Get all validation metadata for 'name'
+         * const validations = Metadata.validationFor(User, 'name');
+         *
+         * // Get specific validation metadata
+         * const required = Metadata.validationFor(User, 'name', 'required');
+         */
+        function validationFor<M extends Model, P extends keyof M = keyof M, K extends string = string>(this: Metadata, model: Constructor<M>, property?: keyof M, key?: string): (K extends string ? ValidationMetadata : P extends keyof M ? Record<string, ValidationMetadata> : Record<keyof M, Record<string, ValidationMetadata>>) | undefined;
+        /**
+         * @description Retrieves all validatable for a model
+         * @param model
+         */
+        function validatableProperties<M extends Model>(model: Constructor<M>, ...propsToIgnore: string[]): string[];
+        /**
+         * @description Retrieves extended metadata for a model or a specific key within it
+         * @summary When called with a constructor only, returns the entire metadata object
+         * associated with the model, including validation rules, property types, relationships,
+         * and other decorator-applied metadata. This override extends the base Metadata.get
+         * method with type-safe support for ExtendedMetadata.
+         *
+         * @template M - The model type
+         * @template META - The extended metadata type, defaults to ExtendedMetadata<M>
+         * @param {Constructor<M>} model - The target constructor used to locate the metadata record
+         * @param {keyof M} prop - Optional property of the model.
+         * @return {META|undefined} The complete metadata object for the model, or undefined if no metadata exists
+         *
+         * @example
+         * class Article extends Model {
+         *   @pk()
+         *   @type(Number)
+         *   id!: number;
+         *
+         *   @required()
+         *   @maxLength(200)
+         *   title!: string;
+         *
+         *   @oneToMany(() => Comment, { update: true, delete: true }, true)
+         *   comments!: Comment[];
+         * }
+         *
+         * // Get all metadata for the Article model
+         * const metadata = Metadata.get<Article>(Article);
+         * // metadata contains:
+         * // - property definitions
+         * // - validation rules
+         * // - relationship mappings
+         * // - primary key information
+         * // - column mappings
+         *
+         * @remarks
+         * The @ts-expect-error directive is used because this declaration intentionally
+         * overrides the signature from the base module to provide enhanced type information
+         * specific to the decorator-validation system.
+         */
+        function get<M, META extends ExtendedMetadata<M> = ExtendedMetadata<M>>(model: Constructor<M>, prop?: keyof M): META | undefined;
+        /**
+         * @description Retrieves the original constructor name for a model
+         * @summary Fetches the original constructor name for a model from the metadata of a model.
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @return {string} The metadata object or value
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get the constructor name for 'User'
+         * const constName = Metadata.modelName(User);
+         */
+        function modelName<M>(model: Constructor<M>): string;
+        /**
+         * @description Retrieves all allowed types for a model or a property
+         * @summary Retrieves all allowed types for a model or a property from it's metadata.
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @return {any[]} An array of the allowed types
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get all validation metadata for 'User'
+         * const allowedTypes = Metadata.meallowedTypestadata(User);
+         */
+        function allowedTypes<M>(model: Constructor<M>, property?: keyof M): any[];
+        /**
+         * @description Retrieves all allowed types for a model or a property
+         * @summary Retrieves all allowed types for a model or a property from it's metadata.
+         *
+         * @template model - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @return {designTypeReturn} An object of the designtypes
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get the designtypes for property name
+         * const { designTypes, designType } = Metadata.getPropDesignTypes(User.constructor, 'name');
+         */
+        function getPropDesignTypes<M>(model: Constructor<M>, property: keyof M): designTypeReturn;
+        function isModel(target: Record<string, any>): boolean;
+        function isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
+        function getAttributes<V extends Model>(model: Constructor<V> | V): string[];
+    }
+}

package/lib/types/overrides/Metadata.d.mts

@@ -0,0 +1,132 @@
+import { Model } from "../model/Model.js";
+import "@decaf-ts/decoration";
+import { Constructor } from "@decaf-ts/decoration";
+import { designTypeReturn, ExtendedMetadata } from "./types.js";
+import { ValidationMetadata } from "../validation/types.js";
+declare module "@decaf-ts/decoration" {
+    namespace Metadata {
+        /**
+         * @description Retrieves validation metadata for a specific property of a model
+         * @summary Fetches validation rules and constraints that were applied to a property
+         * via decorators. The optional key parameter allows drilling down to specific
+         * validation types (e.g., 'required', 'min', 'max').
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @param {string} [key] - Optional specific validation key to retrieve (e.g., 'required', 'pattern')
+         * @return {any} The validation metadata object or value at the specified key
+         *
+         * @example
+         * class User extends Model {
+         *   @required()
+         *   @maxLength(100)
+         *   name!: string;
+         * }
+         *
+         * // Get all validation metadata for 'name'
+         * const validations = Metadata.validationFor(User, 'name');
+         *
+         * // Get specific validation metadata
+         * const required = Metadata.validationFor(User, 'name', 'required');
+         */
+        function validationFor<M extends Model, P extends keyof M = keyof M, K extends string = string>(this: Metadata, model: Constructor<M>, property?: keyof M, key?: string): (K extends string ? ValidationMetadata : P extends keyof M ? Record<string, ValidationMetadata> : Record<keyof M, Record<string, ValidationMetadata>>) | undefined;
+        /**
+         * @description Retrieves all validatable for a model
+         * @param model
+         */
+        function validatableProperties<M extends Model>(model: Constructor<M>, ...propsToIgnore: string[]): string[];
+        /**
+         * @description Retrieves extended metadata for a model or a specific key within it
+         * @summary When called with a constructor only, returns the entire metadata object
+         * associated with the model, including validation rules, property types, relationships,
+         * and other decorator-applied metadata. This override extends the base Metadata.get
+         * method with type-safe support for ExtendedMetadata.
+         *
+         * @template M - The model type
+         * @template META - The extended metadata type, defaults to ExtendedMetadata<M>
+         * @param {Constructor<M>} model - The target constructor used to locate the metadata record
+         * @param {keyof M} prop - Optional property of the model.
+         * @return {META|undefined} The complete metadata object for the model, or undefined if no metadata exists
+         *
+         * @example
+         * class Article extends Model {
+         *   @pk()
+         *   @type(Number)
+         *   id!: number;
+         *
+         *   @required()
+         *   @maxLength(200)
+         *   title!: string;
+         *
+         *   @oneToMany(() => Comment, { update: true, delete: true }, true)
+         *   comments!: Comment[];
+         * }
+         *
+         * // Get all metadata for the Article model
+         * const metadata = Metadata.get<Article>(Article);
+         * // metadata contains:
+         * // - property definitions
+         * // - validation rules
+         * // - relationship mappings
+         * // - primary key information
+         * // - column mappings
+         *
+         * @remarks
+         * The @ts-expect-error directive is used because this declaration intentionally
+         * overrides the signature from the base module to provide enhanced type information
+         * specific to the decorator-validation system.
+         */
+        function get<M, META extends ExtendedMetadata<M> = ExtendedMetadata<M>>(model: Constructor<M>, prop?: keyof M): META | undefined;
+        /**
+         * @description Retrieves the original constructor name for a model
+         * @summary Fetches the original constructor name for a model from the metadata of a model.
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @return {string} The metadata object or value
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get the constructor name for 'User'
+         * const constName = Metadata.modelName(User);
+         */
+        function modelName<M>(model: Constructor<M>): string;
+        /**
+         * @description Retrieves all allowed types for a model or a property
+         * @summary Retrieves all allowed types for a model or a property from it's metadata.
+         *
+         * @template M - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @return {any[]} An array of the allowed types
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get all validation metadata for 'User'
+         * const allowedTypes = Metadata.meallowedTypestadata(User);
+         */
+        function allowedTypes<M>(model: Constructor<M>, property?: keyof M): any[];
+        /**
+         * @description Retrieves all allowed types for a model or a property
+         * @summary Retrieves all allowed types for a model or a property from it's metadata.
+         *
+         * @template model - The model type extending from Model
+         * @param {Constructor<M>} model - The constructor of the target model class
+         * @param {keyof M} property - The property name to retrieve validation for
+         * @return {designTypeReturn} An object of the designtypes
+         *
+         * @example
+         * class User extends Model {
+         *
+         * // Get the designtypes for property name
+         * const { designTypes, designType } = Metadata.getPropDesignTypes(User.constructor, 'name');
+         */
+        function getPropDesignTypes<M>(model: Constructor<M>, property: keyof M): designTypeReturn;
+        function isModel(target: Record<string, any>): boolean;
+        function isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
+        function getAttributes<V extends Model>(model: Constructor<V> | V): string[];
+    }
+}

package/lib/types/overrides/index.d.cts

@@ -0,0 +1,4 @@
+import "./overrides";
+export * from "./Metadata.cjs";
+export * from "./overrides.cjs";
+export * from "./types.cjs";

package/lib/types/overrides/index.d.mts

@@ -0,0 +1,4 @@
+import "./overrides";
+export * from "./Metadata.js";
+export * from "./overrides.js";
+export * from "./types.js";

package/lib/types/overrides/overrides.d.cts

@@ -0,0 +1 @@
+import "./Metadata";

package/lib/types/overrides/overrides.d.mts

@@ -0,0 +1 @@
+import "./Metadata";

package/lib/types/overrides/types.d.cts

@@ -0,0 +1,17 @@
+import { BasicMetadata } from "@decaf-ts/decoration";
+import { ValidatorOptions } from "../validation/types.cjs";
+export type ExtendedMetadata<M> = BasicMetadata<M> & {
+    validation: Record<keyof M, ValidatorOptions>;
+};
+/**
+ * @description Return type for design type information.
+ * @summary Defines the structure of the return type for functions that provide design type information.
+ * @property {any[]} designTypes An array of design types.
+ * @property {any} designType The primary design type.
+ * @typedef {object} designTypeReturn
+ * @memberOf module:decorator-validation
+ */
+export type designTypeReturn = {
+    designTypes: any[];
+    designType: any;
+};

package/lib/types/overrides/types.d.mts

@@ -0,0 +1,17 @@
+import { BasicMetadata } from "@decaf-ts/decoration";
+import { ValidatorOptions } from "../validation/types.js";
+export type ExtendedMetadata<M> = BasicMetadata<M> & {
+    validation: Record<keyof M, ValidatorOptions>;
+};
+/**
+ * @description Return type for design type information.
+ * @summary Defines the structure of the return type for functions that provide design type information.
+ * @property {any[]} designTypes An array of design types.
+ * @property {any} designType The primary design type.
+ * @typedef {object} designTypeReturn
+ * @memberOf module:decorator-validation
+ */
+export type designTypeReturn = {
+    designTypes: any[];
+    designType: any;
+};

package/lib/types/types/index.d.cts

@@ -0,0 +1 @@
+export * from "./validation.cjs";

package/lib/types/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./validation.js";

package/lib/types/types/validation.d.cts

@@ -0,0 +1,28 @@
+import { Model } from "../model/Model.cjs";
+import { ModelErrorDefinition } from "../model/ModelErrorDefinition.cjs";
+/**
+ * @description Conditionally wraps a type in a `Promise` based on the `Async` flag.
+ * @summary Utility type that resolves to `T` if `Async` is `false`, or to `Promise<T>` if `Async` is `true`.
+ * Used to abstract the return type of functions that may be either synchronous or asynchronous depending on a flag.
+ *
+ * @template Async A boolean flag indicating whether the result should be asynchronous (`true`) or synchronous (`false`).
+ * @template T The base type to return directly or to wrap in a `Promise`.
+ *
+ * @example
+ * ```typescript
+ * // Synchronous result
+ * type SyncResult: string | number = ConditionalAsync<false, string | number>;
+ *
+ * // Asynchronous result
+ * type AsyncResult: Promise<string | number> = ConditionalAsync<true, string | number>;
+ * ```
+ * @memberOf module:decorator-validation
+ */
+export type ConditionalAsync<Async extends boolean, T> = Async extends true ? Promise<T> : T;
+export type DecoratorMetadataAsync = {
+    async?: boolean;
+};
+/**
+ * @deprecated
+ */
+export type ModelConditionalAsync<M> = M extends Model<true> ? Promise<ModelErrorDefinition | undefined> : ModelErrorDefinition | undefined;

package/lib/types/types/validation.d.mts

@@ -0,0 +1,28 @@
+import { Model } from "../model/Model.js";
+import { ModelErrorDefinition } from "../model/ModelErrorDefinition.js";
+/**
+ * @description Conditionally wraps a type in a `Promise` based on the `Async` flag.
+ * @summary Utility type that resolves to `T` if `Async` is `false`, or to `Promise<T>` if `Async` is `true`.
+ * Used to abstract the return type of functions that may be either synchronous or asynchronous depending on a flag.
+ *
+ * @template Async A boolean flag indicating whether the result should be asynchronous (`true`) or synchronous (`false`).
+ * @template T The base type to return directly or to wrap in a `Promise`.
+ *
+ * @example
+ * ```typescript
+ * // Synchronous result
+ * type SyncResult: string | number = ConditionalAsync<false, string | number>;
+ *
+ * // Asynchronous result
+ * type AsyncResult: Promise<string | number> = ConditionalAsync<true, string | number>;
+ * ```
+ * @memberOf module:decorator-validation
+ */
+export type ConditionalAsync<Async extends boolean, T> = Async extends true ? Promise<T> : T;
+export type DecoratorMetadataAsync = {
+    async?: boolean;
+};
+/**
+ * @deprecated
+ */
+export type ModelConditionalAsync<M> = M extends Model<true> ? Promise<ModelErrorDefinition | undefined> : ModelErrorDefinition | undefined;

package/lib/types/utils/DateBuilder.d.cts

@@ -0,0 +1,121 @@
+type DateBuilderField = "Years" | "Months" | "Days" | "Hours" | "Minutes" | "Seconds";
+export type DateBuilderInstance = DateBuilder<DateBuilderField>;
+export type DateTarget = Date | DateBuilderInstance;
+export type OffsetValues = {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare function offsetDate(date: Date, direction: 1 | -1, values: OffsetValues): Date;
+type RemoveField<Input extends DateBuilderField, Field extends DateBuilderField> = Input extends Field ? never : Input;
+interface DateBuilderUtilityMethods {
+    Now(): Date;
+    Tomorrow(): Date;
+    Yesterday(): Date;
+    DaysAgo(count: number): Date;
+    NextDays(count: number): Date;
+    YearsAgo(count: number): Date;
+    NextYears(count: number): Date;
+    MonthsAgo(count: number): Date;
+    NextMonths(count: number): Date;
+    HoursAgo(count: number): Date;
+    NextHours(count: number): Date;
+    MinutesAgo(count: number): Date;
+    NextMinutes(count: number): Date;
+    SecondsAgo(count: number): Date;
+    NextSeconds(count: number): Date;
+}
+interface DateBuilderCoreMethods extends DateBuilderUtilityMethods {
+    build(reference?: DateTarget): Date;
+    from(reference: DateTarget): Date;
+    past(reference: DateTarget): Date;
+    after(reference: DateTarget): Date;
+    until(reference: DateTarget): Date;
+    before(reference: DateTarget): Date;
+    ago(reference?: DateTarget): Date;
+}
+export type DateBuilderChain<Remaining extends DateBuilderField = DateBuilderField> = DateBuilderCoreMethods & {
+    [Field in Remaining]: (value: number) => DateBuilderChain<RemoveField<Remaining, Field>>;
+};
+/**
+ * Fluent builder for producing dates relative to a reference point.
+ */
+export declare class DateBuilder<Remaining extends DateBuilderField = DateBuilderField> implements DateBuilderCoreMethods {
+    private years;
+    private months;
+    private days;
+    private hours;
+    private minutes;
+    private seconds;
+    private constructor();
+    static Years(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Years">>;
+    static Months(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Months">>;
+    static Days(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Days">>;
+    static Hours(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Hours">>;
+    static Minutes(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Minutes">>;
+    static Seconds(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Seconds">>;
+    static Now(): Date;
+    static Tomorrow(): Date;
+    static Yesterday(): Date;
+    static DaysAgo(count: number): Date;
+    static NextDays(count: number): Date;
+    static YearsAgo(count: number): Date;
+    static NextYears(count: number): Date;
+    static MonthsAgo(count: number): Date;
+    static NextMonths(count: number): Date;
+    static HoursAgo(count: number): Date;
+    static NextHours(count: number): Date;
+    static MinutesAgo(count: number): Date;
+    static NextMinutes(count: number): Date;
+    static SecondsAgo(count: number): Date;
+    static NextSeconds(count: number): Date;
+    Years(value: number): DateBuilderChain<RemoveField<Remaining, "Years">>;
+    Months(value: number): DateBuilderChain<RemoveField<Remaining, "Months">>;
+    Days(value: number): DateBuilderChain<RemoveField<Remaining, "Days">>;
+    Hours(value: number): DateBuilderChain<RemoveField<Remaining, "Hours">>;
+    Minutes(value: number): DateBuilderChain<RemoveField<Remaining, "Minutes">>;
+    Seconds(value: number): DateBuilderChain<RemoveField<Remaining, "Seconds">>;
+    build(reference?: DateTarget): Date;
+    from(reference: DateTarget): Date;
+    past(reference: DateTarget): Date;
+    after(reference: DateTarget): Date;
+    until(reference: DateTarget): Date;
+    before(reference: DateTarget): Date;
+    ago(reference?: DateTarget): Date;
+    Now(): Date;
+    Tomorrow(): Date;
+    Yesterday(): Date;
+    DaysAgo(count: number): Date;
+    NextDays(count: number): Date;
+    YearsAgo(count: number): Date;
+    NextYears(count: number): Date;
+    MonthsAgo(count: number): Date;
+    NextMonths(count: number): Date;
+    HoursAgo(count: number): Date;
+    NextHours(count: number): Date;
+    MinutesAgo(count: number): Date;
+    NextMinutes(count: number): Date;
+    SecondsAgo(count: number): Date;
+    NextSeconds(count: number): Date;
+    private offsets;
+}
+export declare const Dates: typeof DateBuilder;
+export declare const Now: () => Date;
+export declare const Tomorrow: () => Date;
+export declare const Yesterday: () => Date;
+export declare const DaysAgo: (count: number) => Date;
+export declare const NextDays: (count: number) => Date;
+export declare const YearsAgo: (count: number) => Date;
+export declare const NextYears: (count: number) => Date;
+export declare const MonthsAgo: (count: number) => Date;
+export declare const NextMonths: (count: number) => Date;
+export declare const HoursAgo: (count: number) => Date;
+export declare const NextHours: (count: number) => Date;
+export declare const MinutesAgo: (count: number) => Date;
+export declare const NextMinutes: (count: number) => Date;
+export declare const SecondsAgo: (count: number) => Date;
+export declare const NextSeconds: (count: number) => Date;
+export {};

package/lib/types/utils/DateBuilder.d.mts

@@ -0,0 +1,121 @@
+type DateBuilderField = "Years" | "Months" | "Days" | "Hours" | "Minutes" | "Seconds";
+export type DateBuilderInstance = DateBuilder<DateBuilderField>;
+export type DateTarget = Date | DateBuilderInstance;
+export type OffsetValues = {
+    years: number;
+    months: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare function offsetDate(date: Date, direction: 1 | -1, values: OffsetValues): Date;
+type RemoveField<Input extends DateBuilderField, Field extends DateBuilderField> = Input extends Field ? never : Input;
+interface DateBuilderUtilityMethods {
+    Now(): Date;
+    Tomorrow(): Date;
+    Yesterday(): Date;
+    DaysAgo(count: number): Date;
+    NextDays(count: number): Date;
+    YearsAgo(count: number): Date;
+    NextYears(count: number): Date;
+    MonthsAgo(count: number): Date;
+    NextMonths(count: number): Date;
+    HoursAgo(count: number): Date;
+    NextHours(count: number): Date;
+    MinutesAgo(count: number): Date;
+    NextMinutes(count: number): Date;
+    SecondsAgo(count: number): Date;
+    NextSeconds(count: number): Date;
+}
+interface DateBuilderCoreMethods extends DateBuilderUtilityMethods {
+    build(reference?: DateTarget): Date;
+    from(reference: DateTarget): Date;
+    past(reference: DateTarget): Date;
+    after(reference: DateTarget): Date;
+    until(reference: DateTarget): Date;
+    before(reference: DateTarget): Date;
+    ago(reference?: DateTarget): Date;
+}
+export type DateBuilderChain<Remaining extends DateBuilderField = DateBuilderField> = DateBuilderCoreMethods & {
+    [Field in Remaining]: (value: number) => DateBuilderChain<RemoveField<Remaining, Field>>;
+};
+/**
+ * Fluent builder for producing dates relative to a reference point.
+ */
+export declare class DateBuilder<Remaining extends DateBuilderField = DateBuilderField> implements DateBuilderCoreMethods {
+    private years;
+    private months;
+    private days;
+    private hours;
+    private minutes;
+    private seconds;
+    private constructor();
+    static Years(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Years">>;
+    static Months(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Months">>;
+    static Days(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Days">>;
+    static Hours(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Hours">>;
+    static Minutes(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Minutes">>;
+    static Seconds(value: number): DateBuilderChain<RemoveField<DateBuilderField, "Seconds">>;
+    static Now(): Date;
+    static Tomorrow(): Date;
+    static Yesterday(): Date;
+    static DaysAgo(count: number): Date;
+    static NextDays(count: number): Date;
+    static YearsAgo(count: number): Date;
+    static NextYears(count: number): Date;
+    static MonthsAgo(count: number): Date;
+    static NextMonths(count: number): Date;
+    static HoursAgo(count: number): Date;
+    static NextHours(count: number): Date;
+    static MinutesAgo(count: number): Date;
+    static NextMinutes(count: number): Date;
+    static SecondsAgo(count: number): Date;
+    static NextSeconds(count: number): Date;
+    Years(value: number): DateBuilderChain<RemoveField<Remaining, "Years">>;
+    Months(value: number): DateBuilderChain<RemoveField<Remaining, "Months">>;
+    Days(value: number): DateBuilderChain<RemoveField<Remaining, "Days">>;
+    Hours(value: number): DateBuilderChain<RemoveField<Remaining, "Hours">>;
+    Minutes(value: number): DateBuilderChain<RemoveField<Remaining, "Minutes">>;
+    Seconds(value: number): DateBuilderChain<RemoveField<Remaining, "Seconds">>;
+    build(reference?: DateTarget): Date;
+    from(reference: DateTarget): Date;
+    past(reference: DateTarget): Date;
+    after(reference: DateTarget): Date;
+    until(reference: DateTarget): Date;
+    before(reference: DateTarget): Date;
+    ago(reference?: DateTarget): Date;
+    Now(): Date;
+    Tomorrow(): Date;
+    Yesterday(): Date;
+    DaysAgo(count: number): Date;
+    NextDays(count: number): Date;
+    YearsAgo(count: number): Date;
+    NextYears(count: number): Date;
+    MonthsAgo(count: number): Date;
+    NextMonths(count: number): Date;
+    HoursAgo(count: number): Date;
+    NextHours(count: number): Date;
+    MinutesAgo(count: number): Date;
+    NextMinutes(count: number): Date;
+    SecondsAgo(count: number): Date;
+    NextSeconds(count: number): Date;
+    private offsets;
+}
+export declare const Dates: typeof DateBuilder;
+export declare const Now: () => Date;
+export declare const Tomorrow: () => Date;
+export declare const Yesterday: () => Date;
+export declare const DaysAgo: (count: number) => Date;
+export declare const NextDays: (count: number) => Date;
+export declare const YearsAgo: (count: number) => Date;
+export declare const NextYears: (count: number) => Date;
+export declare const MonthsAgo: (count: number) => Date;
+export declare const NextMonths: (count: number) => Date;
+export declare const HoursAgo: (count: number) => Date;
+export declare const NextHours: (count: number) => Date;
+export declare const MinutesAgo: (count: number) => Date;
+export declare const NextMinutes: (count: number) => Date;
+export declare const SecondsAgo: (count: number) => Date;
+export declare const NextSeconds: (count: number) => Date;
+export {};