fix: validation warning types

Fixes hapijs#2927
Nitro-N · Mar 14, 2023 · 6b530c8 · 6b530c8
1 parent 227e761
commit 6b530c8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -695,6 +695,12 @@ declare namespace Joi {
 
     type ValidationErrorFunction = (errors: ErrorReport[]) => string | ValidationErrorItem | Error;
 
+    interface ValidationWarning {
+        message: string;
+
+        details: ValidationErrorItem[];
+    }
+
     type ValidationResult<TSchema = any> = {
         error: undefined;
         warning?: ValidationError;
@@ -1258,7 +1264,7 @@ declare namespace Joi {
             ? { artifacts: Map<any, string[][]> }
             : {}) &
             (TOpts extends { warnings: true }
-              ? { warning: ValidationError[] }
+              ? { warning: ValidationWarning }
               : {})
             : TSchema
           >;

diff --git a/test/index.ts b/test/index.ts
@@ -1011,9 +1011,9 @@ schema = Joi.link(str);
 
         expect.type<Promise<TResult>>(schema.validateAsync(value));
         expect.type<Promise<{ value: TResult, artifacts: Map<any, string[][]> }>>(schema.validateAsync(value, { artifacts: true }));
-        expect.type<Promise<{ value: TResult, warning: Joi.ValidationError[] }>>(schema.validateAsync(value, { warnings: true }));
-        expect.type<Promise<{ value: TResult, artifacts: Map<any, string[][]>; warning: Joi.ValidationError[] }>>(schema.validateAsync(value, { artifacts: true, warnings: true }));
-        expect.error<Promise<{ value: TResult, warning: Joi.ValidationError[] }>>(schema.validateAsync(value, { artifacts: true }));
+        expect.type<Promise<{ value: TResult, warning: Joi.ValidationWarning }>>(schema.validateAsync(value, { warnings: true }));
+        expect.type<Promise<{ value: TResult, artifacts: Map<any, string[][]>; warning: Joi.ValidationWarning }>>(schema.validateAsync(value, { artifacts: true, warnings: true }));
+        expect.error<Promise<{ value: TResult, warning: Joi.ValidationWarning }>>(schema.validateAsync(value, { artifacts: true }));
         expect.error<Promise<{ value: TResult, artifacts: Map<any, string[][]> }>>(schema.validateAsync(value, { warnings: true }));
         expect.error<Promise<TResult>>(schema.validateAsync(value, { artifacts: true, warnings: true }));
         expect.type<Promise<TResult>>(schema.validateAsync(value, { artifacts: false }));