@nhtio/validation 1.20250911.0 → 1.20251028.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhtio/validation",
-  "version": "1.20250911.0",
+  "version": "1.20251028.0",
   "description": "A powerful schema description language and data validator",
   "keywords": [],
   "author": "Jak Giveon <jak@nht.io>",

package/private/core/root.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Modern ES6 + TypeScript reimplementation of Joi's root factory.
+ *
+ * Based on: https://github.com/hapijs/joi/blob/master/lib/index.js
+ *
+ * This module recreates Joi's internal root factory to enable deeper
+ * customization through schema type modifiers and shortcuts modifiers.
+ */
+import type { Root } from 'joi';
+import type { Schema } from '../index';
+export type SchemaTypeDefinition = Schema;
+export type SchemaTypeDefinititionMiddlewareFn = (ctx: SchemaTypeDefinition, root: Root, args: any[]) => SchemaTypeDefinition;
+export type ShortcutsMiddlewareFn = (ctx: string[]) => string[];
+export interface RootFactoryOptions {
+    schemaTypeModifiers?: SchemaTypeDefinititionMiddlewareFn[];
+    shortcutsModifiers?: ShortcutsMiddlewareFn[];
+}
+export declare class RootFactory {
+    static readonly types: {
+        alternatives: any;
+        any: any;
+        array: any;
+        boolean: any;
+        date: any;
+        function: any;
+        link: any;
+        number: any;
+        object: any;
+        string: any;
+        symbol: any;
+        binary: any;
+    };
+    static readonly aliases: {
+        alt: string;
+        bool: string;
+        func: string;
+    };
+    static assertValue(value: any, schema: any, annotate: boolean, args: any[]): any;
+    static generate(root: any, schema: any, args: any[]): any;
+    static expandExtension(extension: any, joi: any): any[];
+    static getMethods(): {
+        ValidationError: any;
+        version: any;
+        cache: any;
+        assert(value: any, schema: any, ...args: any[]): void;
+        attempt(value: any, schema: any, ...args: any[]): any;
+        build(this: Root, desc: any): any;
+        checkPreferences(prefs: any): void;
+        compile(this: Root, schema: any, options: any): any;
+        defaults(this: Root, modifier: any): Root;
+        expression(...args: any[]): any;
+        extend(this: Root, ...extensions: any[]): Root;
+        isError: any;
+        isExpression: any;
+        isRef: any;
+        isSchema: any;
+        in(...args: any[]): any;
+        override: any;
+        ref(...args: any[]): any;
+        types(this: any): any;
+    };
+    static create(options?: RootFactoryOptions): Root;
+}

package/private/index.d.ts

@@ -1,12 +1,14 @@
-import { default as Joi } from 'joi';
 import type { DateTime } from 'luxon';
 import type { PhoneSchema } from './schemas/phone';
 import type { BigIntSchema } from './schemas/bigint';
 import type { DatetimeSchema } from './schemas/datetime';
 import type { CountryOrUnknown } from '@nhtio/phone-object';
-import type { Root, Reference, SchemaMap, SchemaLike } from 'joi';
 import type { I18nCallback, SetI18nCallback } from './patches/i18n';
+import type { ValidationOptions, Root, Reference as JoiReference, SchemaMap, SchemaLike, WhenSchemaOptions, WhenOptions, State, ReferenceOptions } from 'joi';
 import type { AnySchema, StringSchema, BinarySchema, NumberSchema, BooleanSchema, ObjectSchema, ArraySchema, DateSchema, AlternativesSchema, FunctionSchema, LinkSchema, SymbolSchema, Schema } from './schemas';
+export type Reference = JoiReference & {
+    resolve: (value: any, state: State, prefs: ValidationOptions, local?: any, options?: ReferenceOptions) => any;
+};
 /**
  * Extended Joi root interface that includes custom schema types for
  * additional validation scenarios.
@@ -26,7 +28,7 @@ import type { AnySchema, StringSchema, BinarySchema, NumberSchema, BooleanSchema
  *
  * @public
  */
-export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternatives' | 'any' | 'array' | 'binary' | 'bool' | 'boolean' | 'date' | 'disallow' | 'equal' | 'exist' | 'forbidden' | 'func' | 'function' | 'invalid' | 'link' | 'not' | 'number' | 'object' | 'optional' | 'preferences' | 'prefs' | 'required' | 'string' | 'symbol' | 'types' | 'valid' | 'when'> {
+export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternatives' | 'any' | 'array' | 'binary' | 'bool' | 'boolean' | 'date' | 'disallow' | 'equal' | 'exist' | 'forbidden' | 'func' | 'function' | 'invalid' | 'link' | 'not' | 'number' | 'object' | 'optional' | 'preferences' | 'prefs' | 'required' | 'string' | 'symbol' | 'types' | 'valid' | 'when' | 'ref'> {
     /**
      * Generates a schema object that matches any data type.
      */
@@ -165,16 +167,20 @@ export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternativ
     /**
      * Overrides the global validate() options for the current key and any sub-key.
      */
-    preferences(options: Joi.ValidationOptions): Schema;
+    preferences(options: ValidationOptions): Schema;
     /**
      * Overrides the global validate() options for the current key and any sub-key.
      */
-    prefs(options: Joi.ValidationOptions): Schema;
+    prefs(options: ValidationOptions): Schema;
     /**
      * Converts the type into an alternatives type where the conditions are merged into the type definition where:
      */
-    when(ref: string | Reference, options: Joi.WhenOptions | Joi.WhenOptions[]): AlternativesSchema;
-    when(ref: Schema, options: Joi.WhenSchemaOptions): AlternativesSchema;
+    when(ref: string | Reference, options: WhenOptions | WhenOptions[]): AlternativesSchema;
+    when(ref: Schema, options: WhenSchemaOptions): AlternativesSchema;
+    /**
+     * Creates a reference to another schema key.
+     */
+    ref(key: string, options?: ReferenceOptions): Reference;
     /**
      * Sets a global internationalization callback that applies to all validator instances.
      *
@@ -232,27 +238,8 @@ export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternativ
     $clearI18n: () => ValidationRoot;
     $i18n: I18nCallback;
 }
-/**
- * Extended Joi instance with custom schema types.
- *
- * This instance includes all standard Joi functionality plus additional
- * schema types for additional validation scenarios.
- *
- * @example
- * ```typescript
- * import { validator } from '@nhtio/validation'
- *
- * // Standard Joi usage
- * const userSchema = validator.object({
- *   name: validator.string().required(),
- *   age: validator.number().min(0),
- *   balance: validator.bigint().positive() // Custom BigInt type
- * })
- * ```
- *
- * @public
- */
 export declare const validator: ValidationRoot;
 export type { BigIntSchema, DatetimeSchema, PhoneSchema, SetI18nCallback, I18nCallback };
 export type * from './schemas';
 export { encode, decode } from './utils';
+export type { Knex } from 'knex';

package/private/patches/knex.d.ts

@@ -0,0 +1,10 @@
+import type { SchemaTypeDefinititionMiddlewareFn } from '../core/root';
+export declare const knexMessages: {
+    'knex.unique': string;
+    'knex.exists': string;
+    'knex.missingConnection': string;
+    'knex.invalidTable': string;
+    'knex.invalidColumn': string;
+    'knex.internal': string;
+};
+export declare const knex: SchemaTypeDefinititionMiddlewareFn;

package/private/schemas/datetime.d.ts

@@ -1,9 +1,10 @@
 import { DateTime } from 'luxon';
-import { Dayjs } from 'dayjs';
+import type { Dayjs } from 'dayjs';
 import type { Tokens } from '../types';
 import type { AnySchema } from '../schemas';
-import type { ExtensionFactory, Reference } from 'joi';
+import type { ExtensionFactory, CustomHelpers, Reference } from 'joi';
 import type { Zone, LocaleOptions, DateObjectUnits, ZoneOptions, ToISOTimeOptions, ToISODateOptions, ToSQLOptions, ToRelativeOptions } from 'luxon';
+type CallbackOrValue<T> = T | ((dt: DateTime, helpers: CustomHelpers) => T);
 export declare const messages: {
     'datetime.base': string;
     'datetime.exactly': string;
@@ -251,59 +252,90 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
     /**
      * Formats the datetime using a custom format string during validation.
      *
-     * @param format - The format string (Luxon format tokens)
+     * @param format - The format string (Luxon format tokens) or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static format
      * ```typescript
      * const schema = joi.datetime().toFormat('yyyy-MM-dd HH:mm:ss')
      * const result = schema.validate('2023-07-15T15:30:00Z')
      * // Returns: "2023-07-15 15:30:00"
      * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toFormat((dt, helpers) =>
+     *   dt.year > 2000 ? 'yyyy-MM-dd' : 'MM/dd/yy'
+     * )
+     * ```
      */
-    toFormat(format: Tokens): this;
+    toFormat(format: CallbackOrValue<Tokens>): this;
     /**
      * Formats the datetime using locale-specific formatting during validation.
      *
-     * @param formatOpts - Locale formatting options
+     * @param formatOpts - Locale formatting options or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toLocaleString({ month: 'long', day: 'numeric' })
+     * const schema = joi.datetime().toLocalizedString({ month: 'long', day: 'numeric' })
      * const result = schema.validate('2023-07-15T15:30:00Z')
      * // Returns: "July 15" (or localized equivalent)
      * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toLocalizedString((dt, helpers) => ({
+     *   month: dt.month > 6 ? 'long' : 'short',
+     *   day: 'numeric'
+     * }))
+     * ```
      */
-    toLocalizedString(formatOpts: LocaleOptions): this;
+    toLocalizedString(formatOpts: CallbackOrValue<LocaleOptions>): this;
     /**
      * Converts the datetime to ISO 8601 string format during validation.
      *
-     * @param opts - Options for ISO string formatting
+     * @param opts - Options for ISO string formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toISO()
+     * const schema = joi.datetime().toISO({ suppressMilliseconds: true })
      * const result = schema.validate('July 15, 2023 3:30 PM')
-     * // Returns: "2023-07-15T15:30:00.000Z"
+     * // Returns: "2023-07-15T15:30:00Z"
+     * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toISO((dt, helpers) => ({
+     *   suppressMilliseconds: true,
+     *   extendedZone: dt.year > 1970,
+     *   precision: 'seconds'
+     * }))
      * ```
      */
-    toISO(opts?: ToISOTimeOptions): this;
+    toISO(opts?: CallbackOrValue<ToISOTimeOptions>): this;
     /**
      * Converts the datetime to ISO date format (YYYY-MM-DD) during validation.
      *
-     * @param opts - Options for ISO date formatting
+     * @param opts - Options for ISO date formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
      * const schema = joi.datetime().toISODate()
      * const result = schema.validate('July 15, 2023 3:30 PM')
      * // Returns: "2023-07-15"
      * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toISODate((dt, helpers) => ({
+     *   format: dt.year > 2000 ? 'extended' : 'basic'
+     * }))
+     * ```
      */
-    toISODate(opts?: ToISODateOptions): this;
+    toISODate(opts?: CallbackOrValue<ToISODateOptions>): this;
     /**
      * Converts the datetime to ISO week date format during validation.
      *
@@ -320,17 +352,24 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
     /**
      * Converts the datetime to ISO time format during validation.
      *
-     * @param opts - Options for ISO time formatting
+     * @param opts - Options for ISO time formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toISOTime()
+     * const schema = joi.datetime().toISOTime({ suppressMilliseconds: true })
      * const result = schema.validate('2023-07-15T15:30:00Z')
-     * // Returns: "15:30:00.000Z"
+     * // Returns: "15:30:00Z"
+     * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toISOTime((dt, helpers) => ({
+     *   suppressMilliseconds: dt.millisecond === 0
+     * }))
      * ```
      */
-    toISOTime(opts?: ToISOTimeOptions): this;
+    toISOTime(opts?: CallbackOrValue<ToISOTimeOptions>): this;
     /**
      * Converts the datetime to RFC 2822 format during validation.
      *
@@ -373,31 +412,45 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
     /**
      * Converts the datetime to SQL time format (HH:mm:ss.SSS) during validation.
      *
-     * @param opts - Options for SQL time formatting
+     * @param opts - Options for SQL time formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toSQLTime()
+     * const schema = joi.datetime().toSQLTime({ includeZone: true })
      * const result = schema.validate('2023-07-15T15:30:45.123Z')
-     * // Returns: "15:30:45.123"
+     * // Returns: "15:30:45.123 Z"
+     * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toSQLTime((dt, helpers) => ({
+     *   includeZone: dt.zone.name !== 'UTC'
+     * }))
      * ```
      */
-    toSQLTime(opts?: ToSQLOptions): this;
+    toSQLTime(opts?: CallbackOrValue<ToSQLOptions>): this;
     /**
      * Converts the datetime to SQL datetime format during validation.
      *
-     * @param opts - Options for SQL formatting
+     * @param opts - Options for SQL formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toSQL()
+     * const schema = joi.datetime().toSQL({ includeZone: false })
      * const result = schema.validate('2023-07-15T15:30:45.123Z')
-     * // Returns: "2023-07-15 15:30:45.123 Z"
+     * // Returns: "2023-07-15 15:30:45.123"
+     * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toSQL((dt, helpers) => ({
+     *   includeZone: dt.zone.name !== 'UTC'
+     * }))
      * ```
      */
-    toSQL(opts?: ToSQLOptions): this;
+    toSQL(opts?: CallbackOrValue<ToSQLOptions>): this;
     /**
      * Converts the datetime to milliseconds since Unix epoch during validation.
      *
@@ -466,19 +519,26 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
     /**
      * Converts the datetime to a plain object representation during validation.
      *
-     * @param opts - Options for object conversion
+     * @param opts - Options for object conversion or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toObject()
+     * const schema = joi.datetime().toObject({ includeConfig: true })
      * const result = schema.validate('2023-07-15T15:30:00Z')
      * // Returns: { year: 2023, month: 7, day: 15, hour: 15, minute: 30, second: 0, millisecond: 0 }
      * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toObject((dt, helpers) => ({
+     *   includeConfig: dt.year > 2000
+     * }))
+     * ```
      */
-    toObject(opts?: {
+    toObject(opts?: CallbackOrValue<{
         includeConfig?: boolean;
-    }): this;
+    }>): this;
     /**
      * Converts the datetime to a JavaScript Date object during validation.
      *
@@ -495,17 +555,24 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
     /**
      * Converts the datetime to a relative time string during validation.
      *
-     * @param opts - Options for relative time formatting
+     * @param opts - Options for relative time formatting or callback function
      * @returns The schema instance for method chaining
      *
-     * @example
+     * @example Static options
      * ```typescript
-     * const schema = joi.datetime().toRelative()
+     * const schema = joi.datetime().toRelative({ base: DateTime.now() })
      * const result = schema.validate('2023-07-15T15:30:00Z')
      * // Returns: "2 hours ago" (relative to current time)
      * ```
+     *
+     * @example Callback function (serializable)
+     * ```typescript
+     * const schema = joi.datetime().toRelative((dt, helpers) => ({
+     *   base: dt.year > 2020 ? DateTime.now() : DateTime.fromISO('2020-01-01')
+     * }))
+     * ```
      */
-    toRelative(opts?: ToRelativeOptions): this;
+    toRelative(opts?: CallbackOrValue<ToRelativeOptions>): this;
     /**
      * Sets the locale for the datetime during validation.
      *
@@ -584,3 +651,4 @@ export interface DatetimeSchema<TSchema = DateTime> extends AnySchema<TSchema> {
  * ```
  */
 export declare const datetime: ExtensionFactory;
+export {};

package/private/schemas.d.ts

@@ -1,9 +1,40 @@
+import type { Knex } from 'knex';
+import type { Reference } from '..';
 import type { DateTime } from 'luxon';
 import type { PhoneSchema } from './schemas/phone';
 import type { BigIntSchema } from './schemas/bigint';
 import type { DatetimeSchema } from './schemas/datetime';
-import type { default as Joi, AnySchema as JoiAnySchema, Reference, BasicType, CustomHelpers } from 'joi';
+import type { QueryClientContract } from '@adonisjs/lucid/types/database';
+import type { DatabaseQueryBuilderContract } from '@adonisjs/lucid/types/querybuilder';
+import type { default as Joi, AnySchema as JoiAnySchema, BasicType, CustomHelpers, ExternalHelpers } from 'joi';
+export type { Knex, QueryClientContract, DatabaseQueryBuilderContract };
+export type KnexTransaction = Knex.Transaction;
+export type KnexQueryBuilder = Knex.QueryBuilder;
+export type QueryClient = Knex | KnexTransaction | QueryClientContract;
+export type QueryBuilder = KnexQueryBuilder | DatabaseQueryBuilderContract;
+export interface KnexConnectionConfigurations {
+    client: NonNullable<Knex.Config['client']>;
+    connection: NonNullable<Knex.Config['connection']>;
+    [key: string | number | symbol]: any;
+}
+export type KnexSchemaConnection = QueryClient | KnexConnectionConfigurations;
 export type DefaultableValue = Reference | BasicType | DateTime | bigint | ((parent: any, helpers: CustomHelpers) => Reference | BasicType | DateTime | bigint);
+/**
+ * Options for database-backed validation helpers such as `uniqueInDb` and `existsInDb`.
+ */
+export interface DbValidationOptions {
+    /**
+     * Perform case-insensitive comparisons when querying the database.
+     * Defaults to `false`.
+     */
+    caseInsensitive?: boolean;
+    /**
+     * Optional function that receives the Knex query builder (or equivalent) so
+     * the caller can append additional WHERE clauses (or joins). Can be async.
+     * Example: `async (query, value, column, helpers) => query.where('tenant_id', tenantId)`
+     */
+    filter?: (queryBuilder: QueryBuilder, value: any, column: string, helpers: Omit<ExternalHelpers, 'warn' | 'error' | 'message'>) => void | Promise<void>;
+}
 /**
  * Base schema type for all validation schemas.
  *
@@ -100,6 +131,70 @@ export interface AnySchema<TSchema = any> extends Omit<JoiAnySchema<TSchema>, '$
     warning(code: string, context: Joi.Context): this;
     when(ref: string | Reference, options: Joi.WhenOptions | Joi.WhenOptions[]): this;
     when(ref: Schema, options: Joi.WhenSchemaOptions): this;
+    $_knex: KnexSchemaConnection | undefined;
+    /**
+     * Sets the database connection for database validation rules.
+     * This must be called before using `.uniqueInDb()` or `.existsInDb()`.
+     *
+     * @param connection - A Knex instance, transaction, or connection configuration
+     *
+     * @example
+     * ```typescript
+     * import knex from 'knex'
+     * const db = knex({ client: 'pg', connection: {...} })
+     * const schema = joi.string().knex(db).uniqueInDb('users', 'email')
+     * ```
+     */
+    knex(connection: KnexSchemaConnection): this;
+    /**
+     * Alias for `.knex()`. Sets the database connection for database validation rules.
+     *
+     * @param connection - A Knex instance, transaction, or connection configuration
+     */
+    db(connection: KnexSchemaConnection): this;
+    /**
+     * Validates that the value is unique in the specified database table and column.
+     * Requires `.knex()` or `.db()` to be called first to set the database connection.
+     *
+     * @param table - The database table name (can be a Joi reference)
+     * @param column - The column name to check (can be a Joi reference)
+     * @param options - Optional configuration:
+     *   - `caseInsensitive`: Perform case-insensitive comparison (default: false)
+     *   - `filter`: Async function to add additional WHERE clauses to the query
+     *
+     * @example
+     * ```typescript
+     * const schema = joi.object({
+     *   email: joi.string().email().knex(db).uniqueInDb('users', 'email'),
+     *   username: joi.string().knex(db).uniqueInDb('users', 'username', {
+     *     caseInsensitive: true,
+     *     filter: async (query) => query.where('tenant_id', tenantId)
+     *   })
+     * })
+     * ```
+     */
+    uniqueInDb(table: string | Reference, column: string | Reference, options?: DbValidationOptions): this;
+    /**
+     * Validates that the value exists in the specified database table and column.
+     * Requires `.knex()` or `.db()` to be called first to set the database connection.
+     *
+     * @param table - The database table name (can be a Joi reference)
+     * @param column - The column name to check (can be a Joi reference)
+     * @param options - Optional configuration:
+     *   - `caseInsensitive`: Perform case-insensitive comparison (default: false)
+     *   - `filter`: Async function to add additional WHERE clauses to the query
+     *
+     * @example
+     * ```typescript
+     * const schema = joi.object({
+     *   country_id: joi.number().knex(db).existsInDb('countries', 'id'),
+     *   category: joi.string().knex(db).existsInDb('categories', 'name', {
+     *     caseInsensitive: true
+     *   })
+     * })
+     * ```
+     */
+    existsInDb(table: string | Reference, column: string | Reference, options?: DbValidationOptions): this;
     /**
      * Sets a default value if the original value is `undefined`.
      *