ajv-keywords - npm Package Compare versions

Comparing version 4.0.0-beta.3 to 4.0.0-rc.0

dist/definitions/index.d.ts

@@ -1,3 +0,6 @@
-import type { Vocabulary } from "ajv";
+import type { Vocabulary, ErrorNoParams } from "ajv";
 import type { DefinitionOptions } from "./_types";
+import { PatternRequiredError } from "./patternRequired";
+import { SelectError } from "./select";
 export default function ajvKeywords(opts?: DefinitionOptions): Vocabulary;
+export declare type AjvKeywordsError = PatternRequiredError | SelectError | ErrorNoParams<"range" | "exclusiveRange" | "anyRequired" | "oneRequired" | "allRequired" | "deepProperties" | "deepRequired" | "dynamicDefaults" | "instanceof" | "prohibited" | "regexp" | "transform" | "uniqueItemProperties">;

dist/definitions/patternRequired.d.ts

@@ -1,2 +0,5 @@
-import type { CodeKeywordDefinition } from "ajv";
+import type { CodeKeywordDefinition, ErrorObject } from "ajv";
+export declare type PatternRequiredError = ErrorObject<"patternRequired", {
+    missingPattern: string;
+}>;
 export default function getDef(): CodeKeywordDefinition;

dist/definitions/select.d.ts

@@ -1,3 +0,7 @@
-import type { KeywordDefinition } from "ajv";
+import type { KeywordDefinition, ErrorObject } from "ajv";
 import type { DefinitionOptions } from "./_types";
+export declare type SelectError = ErrorObject<"select", {
+    failingCase?: string;
+    failingDefault?: true;
+}>;
 export default function getDef(opts?: DefinitionOptions): KeywordDefinition[];

dist/definitions/transform.js

@@ -44,3 +44,3 @@ "use strict";
                     ref: transform[t],
-                    code: ajv_1._ `require("ajv-keywords/dist/definitions/transform").transform${codegen_1.getProperty(t)}`
+                    code: ajv_1._ `require("ajv-keywords/dist/definitions/transform").transform${codegen_1.getProperty(t)}`,
                 });
@@ -47,0 +47,0 @@ const arg = transformExpr(ts);

dist/index.d.ts

 import { Plugin } from "ajv";
+export { AjvKeywordsError } from "./definitions";
 declare const ajvKeywords: Plugin<string | string[]>;
 export default ajvKeywords;

package.json

 {
   "name": "ajv-keywords",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-rc.0",
   "description": "Custom JSON-Schema keywords for Ajv validator",
@@ -38,6 +38,7 @@ "main": "dist/index.js",
   "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",
@@ -48,12 +49,9 @@ "@types/node": "^14.11.10",
     "@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",
     "eslint": "^7.2.0",
     "eslint-config-prettier": "^6.13.0",
-    "glob": "^7.1.3",
     "husky": "^4.3.0",
     "jest": "^26.5.3",
-    "js-beautify": "^1.8.9",
     "json-schema-test": "^2.0.0",
@@ -74,6 +72,3 @@ "lint-staged": "^10.4.2",
     "*.{md,json,yaml,js,ts}": "prettier --write"
-  },
-  "dependencies": {
-    "@types/chai": "^4.2.14"
   }
 }

README.md

@@ -7,3 +7,3 @@ # ajv-keywords
 [![npm](https://img.shields.io/npm/v/ajv-keywords.svg)](https://www.npmjs.com/package/ajv-keywords)
-[![npm (beta)](https://img.shields.io/npm/v/ajv-keywords/beta)](https://www.npmjs.com/package/ajv-keywords/v/4.0.0-beta.3)
+[![npm (beta)](https://img.shields.io/npm/v/ajv-keywords/beta)](https://www.npmjs.com/package/ajv-keywords/v/4.0.0-rc.0)
 [![npm downloads](https://img.shields.io/npm/dm/ajv-keywords.svg)](https://www.npmjs.com/package/ajv-keywords)
@@ -13,4 +13,6 @@ [![Coverage Status](https://coveralls.io/repos/github/ajv-validator/ajv-keywords/badge.svg?branch=master)](https://coveralls.io/github/ajv-validator/ajv-keywords?branch=master)
 
-**Please note**: [ajv-keywords v4.0.0-beta](https://github.com/ajv-validator/ajv-keywords/releases/tag/v4.0.0-beta.0) should be used with [ajv v7 (beta)](https://github.com/ajv-validator/ajv/tree/v7-beta)
+**Please note**: This readme file is for [ajv-keywords v4.0.0-beta](https://github.com/ajv-validator/ajv-keywords/releases/tag/v4.0.0-beta.0) that should be used with [ajv v7 (beta)](https://github.com/ajv-validator/ajv).
 
+[ajv-keywords v3](https://github.com/ajv-validator/ajv-keywords/tree/v3) should be used with [ajv v6](https://github.com/ajv-validator/ajv/tree/v6).
+
 ## Contents
@@ -580,4 +582,4 @@
 const invalidDataList = [
-  { kind: 'foo' }, // no propery foo
-  { kind: 'bar' }, // no propery bar
+  { kind: 'foo' }, // no property foo
+  { kind: 'bar' }, // no property bar
   { kind: 'foo', foo: 'any', another: 'any value' }, // additional property
@@ -584,0 +586,0 @@ { kind: 'bar', bar: 1, another: 'any value' }, // additional property

src/definitions/index.ts

@@ -1,2 +0,2 @@
-import type {Vocabulary, KeywordDefinition} from "ajv"
+import type {Vocabulary, KeywordDefinition, ErrorNoParams} from "ajv"
 import type {DefinitionOptions, GetDefinition} from "./_types"
@@ -13,3 +13,3 @@ import typeofDef from "./typeof"
 import oneRequired from "./oneRequired"
-import patternRequired from "./patternRequired"
+import patternRequired, {PatternRequiredError} from "./patternRequired"
 import prohibited from "./prohibited"
@@ -19,3 +19,3 @@ import deepProperties from "./deepProperties"
 import dynamicDefaults from "./dynamicDefaults"
-import selectDef from "./select"
+import selectDef, {SelectError} from "./select"
 
@@ -43,2 +43,22 @@ const definitions: GetDefinition<KeywordDefinition>[] = [
 }
+
+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,5 +0,7 @@
-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 = {
@@ -6,0 +8,0 @@ message: ({params: {missingPattern}}) =>

src/definitions/select.ts

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

src/definitions/transform.ts

@@ -62,3 +62,3 @@ import type {CodeKeywordDefinition, AnySchemaObject, KeywordCxt, Code, Name} from "ajv"
           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)}`,
         })
@@ -65,0 +65,0 @@ const arg = transformExpr(ts)

src/index.ts

@@ -5,2 +5,4 @@ import Ajv from "ajv"
 
+export {AjvKeywordsError} from "./definitions"
+
 const ajvKeywords: Plugin<string | string[]> = (ajv: Ajv, keyword?: string | string[]): Ajv => {
@@ -7,0 +9,0 @@ if (Array.isArray(keyword)) {

No alert changes

Improved metrics

Total package byte prevSize

130581

increased by1.15%

Dependency count

1

decreased by-50%

Dev dependency count

20

decreased by-9.09%

Lines of code

1944

increased by1.73%

Number of lines in readme file

749

increased by0.27%

Dependency changes

• - Removed@types/chai@^4.2.14

• - Removed@types/chai@4.3.14(transitive)