feat: add support for pre-parsed schema

package.json

@@ -16,7 +16,7 @@
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
     "test": "node japaFile.js",
-    "lint": "eslint **/*.ts",
+    "lint": "eslint . --ext=.ts",
     "clean": "del build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
@@ -48,14 +48,14 @@
     "del-cli": "^3.0.0",
     "doctoc": "^1.4.0",
     "eslint": "^6.7.2",
-    "eslint-plugin-adonis": "^1.0.1",
+    "eslint-plugin-adonis": "^1.0.2",
     "husky": "^3.1.0",
     "japa": "^3.0.1",
     "mrm": "^2.0.0",
     "np": "^5.2.1",
     "reflect-metadata": "^0.1.13",
     "ts-node": "^8.5.4",
-    "typescript": "^3.7.2"
+    "typescript": "^3.7.3"
   },
   "nyc": {
     "exclude": [
@@ -81,9 +81,9 @@
     "publish": false
   },
   "dependencies": {
-    "indicative-compiler": "^7.1.0",
+    "indicative-compiler": "^7.2.0",
     "indicative-formatters": "^7.2.2",
-    "indicative-parser": "^7.0.3",
+    "indicative-parser": "^7.1.1",
     "indicative-rules": "^7.2.2"
   }
 }

src/Contracts.ts

@@ -11,9 +11,9 @@
 * file that was distributed with this source code.
 */
 
-import { Schema, Messages } from 'indicative-parser'
 import { ErrorFormatterContract } from 'indicative-compiler'
 import { ErrorCollectorFn } from 'indicative-compiler/build/src/contracts'
+import { Schema, Messages, TypedSchema, ParsedTypedSchema } from 'indicative-parser'
 
 /**
  * Shape of validator config
@@ -36,12 +36,12 @@ export type SanitizerConfig = {
 /**
  * Shape of `validate` and `validateAll` function.
  */
-export type ValidateFn = (
+export type ValidateFn = <T extends ParsedTypedSchema<TypedSchema> | Schema>(
   data: any,
-  schema: Schema,
+  schema: T,
   messages?: Messages,
   config?: Partial<ValidatorConfig>,
-) => Promise<any>
+) => T extends Schema ? Promise<any> : Promise<T['props']>
 
 /**
  * Shape of `sanitize` function.

src/Sanitizer/extend.ts

@@ -12,20 +12,21 @@
 */
 
 import { sanitizations } from 'indicative-rules'
+import { ParsedRule } from 'indicative-parser'
 import { SanitizationDefination } from 'indicative-compiler'
 import { sanitizations as sanitizationsList } from './sanitizations'
 
 /**
  * Extend validator by adding new rules
  */
-export function extend (name: string, definition: SanitizationDefination) {
+export function extend (name: string, definition: SanitizationDefination): void {
   sanitizations[name] = definition
 
   /**
    * Also adding it to the sanitizations list used to define
    * schema rules
    */
-  sanitizationsList[name] = function rule (args) {
+  sanitizationsList[name] = function rule (args): ParsedRule {
     return { name, args: args || [] }
   }
 }

src/Sanitizer/index.ts

@@ -23,7 +23,7 @@ const cacheManager = new CacheManager<ReturnType<SanitizerCompiler['compile']>>(
 /**
  * Returns executor by pre-compiling and optionally caching schema.
  */
-function getExecutor (schema: Schema, config: SanitizerConfig) {
+function getExecutor (schema: Schema, config: SanitizerConfig): SanitizerExecutor {
   /**
    * Always compile schema, when there is no cacheKey
    */

src/Validator/configure.ts

@@ -13,7 +13,7 @@ import { config as validatorConfig } from './config'
 /**
  * Configure global validation options
  */
-export function configure (config: Partial<ValidatorConfig>) {
+export function configure (config: Partial<ValidatorConfig>): void {
   Object.assign(validatorConfig, config)
 }
 

src/Validator/extend.ts

@@ -12,20 +12,21 @@
 */
 
 import { validations } from 'indicative-rules'
+import { ParsedRule } from 'indicative-parser'
 import { ValidationDefination } from 'indicative-compiler'
 import { validations as validationsList } from './validations'
 
 /**
  * Extend validator by adding new rules
  */
-export function extend (name: string, definition: ValidationDefination) {
+export function extend (name: string, definition: ValidationDefination): void {
   validations[name] = definition
 
   /**
    * Also adding it to the validations list used to define
    * schema rules
    */
-  validationsList[name] = function rule (args) {
+  validationsList[name] = function rule (args): ParsedRule {
     return { name, args: args || [] }
   }
 }

src/Validator/index.ts

@@ -12,8 +12,8 @@
 */
 
 import { validations } from 'indicative-rules'
-import { Schema, Messages } from 'indicative-parser'
 import { ValidatorCompiler, ValidatorExecutor } from 'indicative-compiler'
+import { Schema, Messages, ParsedTypedSchema, TypedSchema } from 'indicative-parser'
 
 import { CacheManager } from '../CacheManager'
 import { config as validatorConfig } from './config'
@@ -25,7 +25,7 @@ const cacheManager = new CacheManager<ReturnType<ValidatorCompiler['compile']>>(
  * Returns executor by pre-compiling and optionally caching schema.
  */
 function getExecutor (
-  schema: Schema,
+  schema: Schema | ParsedTypedSchema<TypedSchema>,
   messages: Messages,
   config: ValidatorConfig,
 ): ValidatorExecutor {
@@ -68,7 +68,7 @@ export const validate: ValidateFn = (data, schema, messages, config?) => {
     true,
     config.removeAdditional!,
     config.customErrorCollector,
-  )
+  ) as any
 }
 
 /**
@@ -89,5 +89,5 @@ export const validateAll: ValidateFn = (data, schema, messages, config?) => {
     false,
     config.removeAdditional!,
     config.customErrorCollector,
-  )
+  ) as any
 }

test/validator.spec.ts

@@ -8,6 +8,7 @@
 */
 
 import test from 'japa'
+import { t } from 'indicative-parser'
 import { validate, validateAll } from '../src/Validator'
 
 test.group('validate', () => {
@@ -47,6 +48,22 @@ test.group('validate', () => {
       }])
     }
   })
+
+  test('run validations on pre-parsed schema', async (assert) => {
+    assert.plan(1)
+
+    try {
+      await validate({}, t.schema({
+        username: t.string(),
+      }))
+    } catch (errors) {
+      assert.deepEqual(errors, [{
+        message: 'required validation failed on username',
+        validation: 'required',
+        field: 'username',
+      }])
+    }
+  })
 })
 
 test.group('validateAll', () => {
@@ -100,4 +117,20 @@ test.group('validateAll', () => {
       ])
     }
   })
+
+  test('run validations on pre-parsed schema', async (assert) => {
+    assert.plan(1)
+
+    try {
+      await validateAll({}, t.schema({
+        username: t.string(),
+      }))
+    } catch (errors) {
+      assert.deepEqual(errors, [{
+        message: 'required validation failed on username',
+        validation: 'required',
+        field: 'username',
+      }])
+    }
+  })
 })

validator.ts

@@ -11,8 +11,9 @@
 * file that was distributed with this source code.
 */
 
-export { validate, validateAll } from './src/Validator'
-export { configure } from './src/Validator/configure'
+export { t } from 'indicative-parser'
 export { extend } from './src/Validator/extend'
+export { configure } from './src/Validator/configure'
+export { validate, validateAll } from './src/Validator'
 export { validations } from './src/Validator/validations'
 export { ValidationRulesContract } from 'indicative-rules'