@nhtio/validation 0.1.0-master-bc86d1b4 → 0.1.0-master-fb686bf1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhtio/validation",
-  "version": "0.1.0-master-bc86d1b4",
+  "version": "0.1.0-master-fb686bf1",
   "description": "A powerful schema description language and data validator",
   "keywords": [],
   "author": "Jak Giveon <jak@nht.io>",
@@ -21,9 +21,13 @@
     },
     "onlyBuiltDependencies": [
       "es5-ext",
-      "esbuild"
+      "esbuild",
+      "sqlite3"
     ]
   },
+  "peerDependencies": {
+    "@adonisjs/lucid": "^21.8.0"
+  },
   "packageManager": "pnpm@10.8.0+sha512.0e82714d1b5b43c74610193cb20734897c1d00de89d0e18420aebc5977fa13d780a9cb05734624e81ebd81cc876cd464794850641c48b9544326b5622ca29971",
   "type": "module",
   "dependencies": {}

package/private/index.d.ts

@@ -1,4 +1,4 @@
-import { default as Joi } from 'joi';
+import type * as Joi from 'joi';
 import type { DateTime } from 'luxon';
 import type { PhoneSchema } from './schemas/phone';
 import type { BigIntSchema } from './schemas/bigint';
@@ -6,6 +6,7 @@ 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 { KnexSchema, KnexSchemaConnection, KnexSchemaSearchRuleOptions } from './schemas/knex';
 import type { AnySchema, StringSchema, BinarySchema, NumberSchema, BooleanSchema, ObjectSchema, ArraySchema, DateSchema, AlternativesSchema, FunctionSchema, LinkSchema, SymbolSchema, Schema } from './schemas';
 /**
  * Extended Joi root interface that includes custom schema types for
@@ -109,6 +110,11 @@ export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternativ
      * @param country - Optional country code or reference for phone validation
      */
     phone<TSchema = string>(country?: CountryOrUnknown | Reference | null): PhoneSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a database record using a Knex.js connection or Adonis Lucid Database connection for validation.
+     * @param connection - The database connection or QueryClientContract to use for validation
+     */
+    knex<TSchema = any>(connection: KnexSchemaConnection): KnexSchema<TSchema>;
     /**
      * Returns an object where each key is a plain joi schema type.
      * Useful for creating type shortcuts using deconstruction.
@@ -130,6 +136,7 @@ export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternativ
         bigint: BigIntSchema;
         datetime: DatetimeSchema;
         phone: PhoneSchema;
+        knex: KnexSchema;
     };
     /**
      * Whitelists a value
@@ -253,6 +260,6 @@ export interface ValidationRoot extends Omit<Root, 'allow' | 'alt' | 'alternativ
  * @public
  */
 export declare const validator: ValidationRoot;
-export type { BigIntSchema, DatetimeSchema, PhoneSchema, SetI18nCallback, I18nCallback };
+export type { BigIntSchema, DatetimeSchema, PhoneSchema, KnexSchema, SetI18nCallback, I18nCallback, KnexSchemaConnection, KnexSchemaSearchRuleOptions, };
 export type * from './schemas';
 export { encode, decode } from './utils';

package/private/monkeypatches/index.d.ts

@@ -0,0 +1,2 @@
+import type { SchemaTypeDefinititionMiddlewareFn } from '../root';
+export declare const monkeyPatches: SchemaTypeDefinititionMiddlewareFn;

package/private/monkeypatches/validate_async.d.ts

@@ -0,0 +1,23 @@
+import type { Schema } from '../';
+import type { AsyncValidationOptions, ValidationWarning, Context } from 'joi';
+export declare const doValidation: (value: any, schema: any, state: any, prefs: any, overrides?: any) => Promise<any>;
+export declare const validateAsync: <TOpts extends AsyncValidationOptions, TSchema = any>(this: Schema, value: any, options?: TOpts) => Promise<TOpts extends {
+    artifacts: true;
+} | {
+    warnings: true;
+} ? {
+    value: TSchema;
+} & (TOpts extends {
+    artifacts: true;
+} ? {
+    artifacts: Map<any, string[][]>;
+} : {}) & (TOpts extends {
+    warnings: true;
+} ? {
+    warning: ValidationWarning;
+} : {}) : TSchema>;
+export declare const doAsyncValidateForKeysSchema: (value: any, { schema, error, state, prefs }: Context) => Promise<{
+    value: any;
+    errors: any;
+} | undefined>;
+export declare const doAsyncValidationForAlternativesSchema: (value: any, helpers: Context) => Promise<any>;

package/private/patches/i18n.d.ts

@@ -1,4 +1,7 @@
 import type { Root } from 'joi';
+export declare const knownMessages: {
+    [k: string]: string;
+};
 /**
  * Callback function type for internationalization translation.
  *

package/private/patches/index.d.ts

@@ -1,3 +1,4 @@
 import type { Root } from 'joi';
 import type { ValidationRoot } from '../index';
-export declare const patch: (root: Root) => ValidationRoot;
+export declare const root: any;
+export declare const patch: (patchable: Root) => ValidationRoot;

package/private/patches/knex.d.ts

@@ -0,0 +1,2 @@
+import type { SchemaTypeDefinititionMiddlewareFn } from '../root';
+export declare const knex: SchemaTypeDefinititionMiddlewareFn;

package/private/root.d.ts

@@ -0,0 +1,17 @@
+/**
+ * In order to create a better DX, and to allow for deeper
+ * patching of root instances of Joi, we are going to completely
+ * recreate the Joi default export here based on:
+ * https://github.com/hapijs/joi/blob/master/lib/index.js
+ * Due to the lack of type definitions for the internal parts of Joi,
+ * this file will be mainly untyped.
+ */
+import type { Schema } from '../index';
+export type SchemaTypeDefinition = Schema;
+export type SchemaTypeDefinititionMiddlewareFn = (ctx: SchemaTypeDefinition) => SchemaTypeDefinition;
+export type ShortcutsMiddlewareFn = (ctx: string[]) => string[];
+export type RootFactoryOptions = {
+    schemaTypeModifiers?: SchemaTypeDefinititionMiddlewareFn[];
+    shortcutsModifiers?: ShortcutsMiddlewareFn[];
+};
+export declare const internals: any;

package/private/schemas/knex.d.ts

@@ -0,0 +1,32 @@
+import type { Knex } from 'knex';
+import type { AnySchema } from '../../index';
+import type { QueryClientContract } from '@adonisjs/lucid/types/database';
+import type { ExtensionFactory, Reference } from 'joi';
+import type { DatabaseQueryBuilderContract } from '@adonisjs/lucid/types/querybuilder';
+export type QueryClient = Knex | Knex.Transaction | QueryClientContract;
+export type QueryBuilder = Knex.QueryBuilder | 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 KnexSchemaSearchRuleOptions = {
+    caseInsensitive: boolean;
+    filter: (queryBuilder: QueryBuilder, value: any, column: string) => void | Promise<void>;
+};
+export type KnexSchemaSearchRule<TSchema = any> = (table: string | Reference, column: string | Reference, options?: Partial<KnexSchemaSearchRuleOptions>) => KnexSchema<TSchema>;
+export interface KnexSchema<TSchema = any> extends Omit<AnySchema<TSchema>, 'cast'> {
+    unique: KnexSchemaSearchRule<TSchema>;
+    exists: KnexSchemaSearchRule<TSchema>;
+    db: (connection: KnexSchemaConnection) => KnexSchema<TSchema>;
+}
+export declare const messages: {
+    'knex.unique': string;
+    'knex.exists': string;
+    'knex.missingConnection': string;
+    'knex.invalidTable': string;
+    'knex.invalidColumn': string;
+    'knex.internal': string;
+};
+export declare const knex: ExtensionFactory;

package/private/schemas.d.ts

@@ -2,6 +2,7 @@ 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 { KnexSchema, KnexSchemaConnection } from './schemas/knex';
 import type { default as Joi, AnySchema as JoiAnySchema, Reference, BasicType, CustomHelpers } from 'joi';
 export type DefaultableValue = Reference | BasicType | DateTime | bigint | ((parent: any, helpers: CustomHelpers) => Reference | BasicType | DateTime | bigint);
 /**
@@ -118,6 +119,10 @@ export interface AnySchema<TSchema = any> extends Omit<JoiAnySchema<TSchema>, '$
      */
     default(value?: DefaultableValue): this;
     cast(to: 'map' | 'number' | 'set' | 'string' | 'object'): this;
+    /**
+     * Add the Knex.js extension methods to a string schema.
+     */
+    knex(connection: KnexSchemaConnection): KnexSchema<TSchema>;
 }
 /**
  * Schema type for string validation.