Merge pull request #146 from ajv-validator/keyword-types

define keyword error types

Author: epoberezkin

package.json

@@ -35,16 +35,17 @@
   },
   "homepage": "https://github.com/epoberezkin/ajv-keywords#readme",
   "peerDependencies": {
-    "ajv": "^7.0.0-beta.8"
+    "ajv": "^7.0.0-rc.1"
   },
   "devDependencies": {
     "@ajv-validator/config": "^0.2.3",
+    "@types/chai": "^4.2.14",
     "@types/jest": "^26.0.14",
     "@types/node": "^14.11.10",
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^4.4.1",
     "@typescript-eslint/parser": "^4.4.1",
-    "ajv": "^7.0.0-beta.8",
+    "ajv": "^7.0.0-rc.1",
     "ajv-formats": "^0.3.4",
     "chai": "^4.2.0",
     "dot": "^1.1.1",
@@ -69,8 +70,5 @@
   },
   "lint-staged": {
     "*.{md,json,yaml,js,ts}": "prettier --write"
-  },
-  "dependencies": {
-    "@types/chai": "^4.2.14"
   }
 }

src/definitions/index.ts

@@ -1,4 +1,4 @@
-import type {Vocabulary, KeywordDefinition} from "ajv"
+import type {Vocabulary, KeywordDefinition, ErrorNoParams} from "ajv"
 import type {DefinitionOptions, GetDefinition} from "./_types"
 import typeofDef from "./typeof"
 import instanceofDef from "./instanceof"
@@ -10,12 +10,12 @@ import uniqueItemProperties from "./uniqueItemProperties"
 import allRequired from "./allRequired"
 import anyRequired from "./anyRequired"
 import oneRequired from "./oneRequired"
-import patternRequired from "./patternRequired"
+import patternRequired, {PatternRequiredError} from "./patternRequired"
 import prohibited from "./prohibited"
 import deepProperties from "./deepProperties"
 import deepRequired from "./deepRequired"
 import dynamicDefaults from "./dynamicDefaults"
-import selectDef from "./select"
+import selectDef, {SelectError} from "./select"
 
 const definitions: GetDefinition<KeywordDefinition>[] = [
   typeofDef,
@@ -38,4 +38,24 @@ const definitions: GetDefinition<KeywordDefinition>[] = [
 export default function ajvKeywords(opts?: DefinitionOptions): Vocabulary {
   return definitions.map((d) => d(opts)).concat(selectDef(opts))
 }
+
+export type AjvKeywordsError =
+  | PatternRequiredError
+  | SelectError
+  | ErrorNoParams<
+      | "range"
+      | "exclusiveRange"
+      | "anyRequired"
+      | "oneRequired"
+      | "allRequired"
+      | "deepProperties"
+      | "deepRequired"
+      | "dynamicDefaults"
+      | "instanceof"
+      | "prohibited"
+      | "regexp"
+      | "transform"
+      | "uniqueItemProperties"
+    >
+
 module.exports = ajvKeywords

src/definitions/patternRequired.ts

@@ -1,7 +1,9 @@
-import type {CodeKeywordDefinition, KeywordCxt, KeywordErrorDefinition} from "ajv"
+import type {CodeKeywordDefinition, KeywordCxt, KeywordErrorDefinition, ErrorObject} from "ajv"
 import {_, str, and} from "ajv/dist/compile/codegen"
 import {usePattern} from "./_util"
 
+export type PatternRequiredError = ErrorObject<"patternRequired", {missingPattern: string}>
+
 const error: KeywordErrorDefinition = {
   message: ({params: {missingPattern}}) =>
     str`should have property matching pattern '${missingPattern}'`,

src/definitions/select.ts

@@ -1,8 +1,10 @@
-import type {KeywordDefinition, KeywordErrorDefinition, KeywordCxt} from "ajv"
+import type {KeywordDefinition, KeywordErrorDefinition, KeywordCxt, ErrorObject} from "ajv"
 import {_, str, nil, Name} from "ajv"
 import type {DefinitionOptions} from "./_types"
 import {metaSchemaRef} from "./_util"
 
+export type SelectError = ErrorObject<"select", {failingCase?: string; failingDefault?: true}>
+
 const error: KeywordErrorDefinition = {
   message: ({params: {schemaProp}}) =>
     schemaProp

src/definitions/transform.ts

@@ -59,7 +59,7 @@ function _getDef(): CodeKeywordDefinition {
         if (!(t in transform)) throw new Error(`transform: unknown transformation ${t}`)
         const func = gen.scopeValue("func", {
           ref: transform[t as TransformName],
-          code: _`require("ajv-keywords/dist/definitions/transform").transform${getProperty(t)}`
+          code: _`require("ajv-keywords/dist/definitions/transform").transform${getProperty(t)}`,
         })
         const arg = transformExpr(ts)
         return cfg && t === "toEnumCase" ? _`${func}(${arg}, ${cfg})` : _`${func}(${arg})`

src/index.ts

@@ -2,6 +2,8 @@ import Ajv from "ajv"
 import {Plugin} from "ajv"
 import plugins from "./keywords"
 
+export {AjvKeywordsError} from "./definitions"
+
 const ajvKeywords: Plugin<string | string[]> = (ajv: Ajv, keyword?: string | string[]): Ajv => {
   if (Array.isArray(keyword)) {
     for (const k of keyword) get(k)(ajv)