@takeshape/json-schema 8.86.3 → 8.87.3

package/es/schema-validator.js

@@ -1,17 +1,23 @@
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
 import get from 'lodash/get';
-export function parseDataPath(dataPath) {
-  return dataPath.substr(1).split('/');
+import set from 'lodash/set';
+import unset from 'lodash/unset';
+import isObject from 'lodash/isObject';
+import isString from 'lodash/isString';
+import isArray from 'lodash/isArray';
+import { visit } from '@takeshape/util';
+export function parseDataPath(instancePath) {
+  return instancePath.substr(1).split('/');
 }
 
 function getData(error, data) {
-  return get(data, parseDataPath(error.dataPath));
+  return get(data, parseDataPath(error.instancePath));
 }
 
 function ignoreMissing(error) {
   // ignore top level missing errors
-  return !(error.dataPath === '' && error.keyword === 'required');
+  return !(error.instancePath === '' && error.keyword === 'required');
 }
 
 function ignoreNull(error, data, schema) {
@@ -23,10 +29,10 @@ function getErrorFilter(params, data, schema) {
 }
 
 export function isInvalidPropertyRequired(schema, error) {
-  const dataPath = parseDataPath(error.dataPath);
-  const parentDataPath = dataPath.slice(0, dataPath.length - 1);
+  const instancePath = parseDataPath(error.instancePath);
+  const parentDataPath = instancePath.slice(0, instancePath.length - 1);
   const parentSchema = followSchemaPath(schema, parentDataPath);
-  const name = getName(error.dataPath);
+  const name = getName(error.instancePath);
 
   if (!parentSchema) {
     throw new Error('Unexpected error cannot find parent schema');
@@ -57,11 +63,11 @@ function followRef(topLevelSchema, schema) {
   return schema.$ref ? get(topLevelSchema, refToPath(schema.$ref)) : schema;
 }
 /**
- * Given a schema object traverse it using a "dataPath" and return the schema at that path
+ * Given a schema object traverse it using a "instancePath" and return the schema at that path
  */
 
 
-export function followSchemaPath(topLevelSchema, dataPath) {
+export function followSchemaPath(topLevelSchema, instancePath) {
   const followPath = (schema, path) => {
     var _schema, _schema$properties;
 
@@ -96,7 +102,7 @@ export function followSchemaPath(topLevelSchema, dataPath) {
     }
   };
 
-  return followPath(topLevelSchema, dataPath);
+  return followPath(topLevelSchema, instancePath);
 }
 
 function isSchemaObject(schema) {
@@ -140,6 +146,7 @@ export function validate(ajv, id, data, options) {
 export { Ajv };
 export function createAjv(options) {
   const ajv = new Ajv({
+    discriminator: true,
     allErrors: true,
     unevaluated: true,
     strict: false,
@@ -169,35 +176,41 @@ function isValidRegex(str) {
   }
 }
 /**
- * Fix schema by removing any broken regexes that will cause ajv to throw a compile error.
- * It is better to remove the invalid regex rather than forgo validation altogether
- * This should be fixed in ajv see the comment here
- * https://github.com/ajv-validator/ajv/blob/9f1c3eaa4b91ca17b72b122cdac9b108d1ac30cb/lib/vocabularies/validation/pattern.ts#L21
+ * Apply various fixes to the schema to work around AJV issues and bugs.
+ * See inline comments for more.
  */
 
 
 export function fixSchema(schema) {
-  const normalize = obj => {
-    if (Array.isArray(obj)) {
-      return obj.map(normalize);
-    }
+  visit(schema, ['pattern', 'oneOf'], (value, path) => {
+    const key = path.slice(-1)[0];
+    const parent = get(schema, path.slice(0, -1));
+    /**
+     * Fix schema by removing any broken regexes that will cause ajv to throw a compile error.
+     * It is better to remove the invalid regex rather than forgo validation altogether
+     * This should be fixed in ajv see the comment here
+     * https://github.com/ajv-validator/ajv/blob/9f1c3eaa4b91ca17b72b122cdac9b108d1ac30cb/lib/vocabularies/validation/pattern.ts#L21
+     */
+
+    if (key === 'pattern') {
+      if (parent.type === 'string' && (!isString(value) || !isValidRegex(value))) {
+        unset(schema, path);
+      }
+    } // Inline $refs inside definitions that use discriminator
+    // https://github.com/ajv-validator/ajv/issues/1899
 
-    if (obj && typeof obj === 'object') {
-      const result = {};
 
-      for (const key of Object.keys(obj)) {
-        if (key !== 'pattern' || obj.type !== 'string' || isValidRegex(obj[key])) {
-          result[key] = normalize(obj[key]);
+    if (key === 'oneOf' && isArray(value)) {
+      if (isObject(parent.discriminator) && path[0] === 'definitions') {
+        for (const [index, subschema] of value.entries()) {
+          if (subschema.$ref) {
+            set(schema, [...path, index], get(schema, subschema.$ref.substr(2).split('/')));
+          }
         }
       }
-
-      return result;
     }
-
-    return obj;
-  };
-
-  return normalize(schema);
+  });
+  return schema;
 }
 export function createSchemaValidator(schema, metaSchemas = [], options = {}) {
   const schemas = Array.isArray(schema) ? schema : [schema];

package/lib/schema-validator.d.ts

@@ -12,22 +12,20 @@ export interface ValidateResult {
     errors: ErrorObject[];
 }
 export declare type Validator = (data: Data, options?: Partial<ValidateParams>) => ValidateResult;
-export declare function parseDataPath(dataPath: string): string[];
+export declare function parseDataPath(instancePath: string): string[];
 export declare function isInvalidPropertyRequired(schema: SchemaObject, error: ErrorObject): boolean;
 export declare function refToPath(ref: string): string[];
 /**
- * Given a schema object traverse it using a "dataPath" and return the schema at that path
+ * Given a schema object traverse it using a "instancePath" and return the schema at that path
  */
-export declare function followSchemaPath(topLevelSchema: SchemaObject, dataPath: string[]): SchemaObject | undefined;
+export declare function followSchemaPath(topLevelSchema: SchemaObject, instancePath: string[]): SchemaObject | undefined;
 export declare type MinimalAjv = Pick<Ajv, 'validate' | 'errors' | 'getSchema' | 'errorsText'>;
 export declare function validate(ajv: MinimalAjv, id: string, data: Data, options?: Partial<ValidateParams>): ValidateResult;
 export { Ajv, ErrorObject };
 export declare function createAjv(options?: Options): Ajv;
 /**
- * Fix schema by removing any broken regexes that will cause ajv to throw a compile error.
- * It is better to remove the invalid regex rather than forgo validation altogether
- * This should be fixed in ajv see the comment here
- * https://github.com/ajv-validator/ajv/blob/9f1c3eaa4b91ca17b72b122cdac9b108d1ac30cb/lib/vocabularies/validation/pattern.ts#L21
+ * Apply various fixes to the schema to work around AJV issues and bugs.
+ * See inline comments for more.
  */
 export declare function fixSchema(schema: SchemaObject): SchemaObject;
 export declare function createSchemaValidator(schema: SchemaObject | SchemaObject[], metaSchemas?: SchemaObject[], options?: Options): Validator;

package/lib/schema-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-validator.d.ts","sourceRoot":"","sources":["../../src/schema-validator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAE,OAAO,EAAE,YAAY,EAAC,MAAM,KAAK,CAAC;AAC5D,OAAO,GAAG,MAAM,KAAK,CAAC;AAItB,oBAAY,IAAI,GAAG,GAAG,CAAC;AAEvB,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,oBAAY,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC;AAE1F,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAExD;AAwBD,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAW3F;AAcD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAE/C;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,YAAY,GAAG,SAAS,CA6B3G;AAED,oBAAY,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC;AAMvF,wBAAgB,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,CA2BnH;AAED,OAAO,EAAC,GAAG,EAAE,WAAW,EAAC,CAAC;AAC1B,wBAAgB,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,GAAG,CAkBhD;AAeD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAqB5D;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,EACrC,WAAW,GAAE,YAAY,EAAO,EAChC,OAAO,GAAE,OAAY,GACpB,SAAS,CAqBX"}
+{"version":3,"file":"schema-validator.d.ts","sourceRoot":"","sources":["../../src/schema-validator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAE,OAAO,EAAE,YAAY,EAAC,MAAM,KAAK,CAAC;AAC5D,OAAO,GAAG,MAAM,KAAK,CAAC;AAUtB,oBAAY,IAAI,GAAG,GAAG,CAAC;AAEvB,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,oBAAY,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC;AAE1F,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,CAE5D;AAwBD,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAW3F;AAcD,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAE/C;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,YAAY,GAAG,SAAS,CA6B/G;AAED,oBAAY,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC;AAMvF,wBAAgB,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,CA2BnH;AAED,OAAO,EAAC,GAAG,EAAE,WAAW,EAAC,CAAC;AAC1B,wBAAgB,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,GAAG,CAmBhD;AAeD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CA+B5D;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,EACrC,WAAW,GAAE,YAAY,EAAO,EAChC,OAAO,GAAE,OAAY,GACpB,SAAS,CAqBX"}

package/lib/schema-validator.js

@@ -24,19 +24,31 @@ var _ajvFormats = _interopRequireDefault(require("ajv-formats"));
 
 var _get = _interopRequireDefault(require("lodash/get"));
 
+var _set = _interopRequireDefault(require("lodash/set"));
+
+var _unset = _interopRequireDefault(require("lodash/unset"));
+
+var _isObject = _interopRequireDefault(require("lodash/isObject"));
+
+var _isString = _interopRequireDefault(require("lodash/isString"));
+
+var _isArray = _interopRequireDefault(require("lodash/isArray"));
+
+var _util = require("@takeshape/util");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function parseDataPath(dataPath) {
-  return dataPath.substr(1).split('/');
+function parseDataPath(instancePath) {
+  return instancePath.substr(1).split('/');
 }
 
 function getData(error, data) {
-  return (0, _get.default)(data, parseDataPath(error.dataPath));
+  return (0, _get.default)(data, parseDataPath(error.instancePath));
 }
 
 function ignoreMissing(error) {
   // ignore top level missing errors
-  return !(error.dataPath === '' && error.keyword === 'required');
+  return !(error.instancePath === '' && error.keyword === 'required');
 }
 
 function ignoreNull(error, data, schema) {
@@ -48,10 +60,10 @@ function getErrorFilter(params, data, schema) {
 }
 
 function isInvalidPropertyRequired(schema, error) {
-  const dataPath = parseDataPath(error.dataPath);
-  const parentDataPath = dataPath.slice(0, dataPath.length - 1);
+  const instancePath = parseDataPath(error.instancePath);
+  const parentDataPath = instancePath.slice(0, instancePath.length - 1);
   const parentSchema = followSchemaPath(schema, parentDataPath);
-  const name = getName(error.dataPath);
+  const name = getName(error.instancePath);
 
   if (!parentSchema) {
     throw new Error('Unexpected error cannot find parent schema');
@@ -82,11 +94,11 @@ function followRef(topLevelSchema, schema) {
   return schema.$ref ? (0, _get.default)(topLevelSchema, refToPath(schema.$ref)) : schema;
 }
 /**
- * Given a schema object traverse it using a "dataPath" and return the schema at that path
+ * Given a schema object traverse it using a "instancePath" and return the schema at that path
  */
 
 
-function followSchemaPath(topLevelSchema, dataPath) {
+function followSchemaPath(topLevelSchema, instancePath) {
   const followPath = (schema, path) => {
     var _schema, _schema$properties;
 
@@ -121,7 +133,7 @@ function followSchemaPath(topLevelSchema, dataPath) {
     }
   };
 
-  return followPath(topLevelSchema, dataPath);
+  return followPath(topLevelSchema, instancePath);
 }
 
 function isSchemaObject(schema) {
@@ -165,6 +177,7 @@ function validate(ajv, id, data, options) {
 
 function createAjv(options) {
   const ajv = new _ajv.default({
+    discriminator: true,
     allErrors: true,
     unevaluated: true,
     strict: false,
@@ -195,35 +208,41 @@ function isValidRegex(str) {
   }
 }
 /**
- * Fix schema by removing any broken regexes that will cause ajv to throw a compile error.
- * It is better to remove the invalid regex rather than forgo validation altogether
- * This should be fixed in ajv see the comment here
- * https://github.com/ajv-validator/ajv/blob/9f1c3eaa4b91ca17b72b122cdac9b108d1ac30cb/lib/vocabularies/validation/pattern.ts#L21
+ * Apply various fixes to the schema to work around AJV issues and bugs.
+ * See inline comments for more.
  */
 
 
 function fixSchema(schema) {
-  const normalize = obj => {
-    if (Array.isArray(obj)) {
-      return obj.map(normalize);
-    }
+  (0, _util.visit)(schema, ['pattern', 'oneOf'], (value, path) => {
+    const key = path.slice(-1)[0];
+    const parent = (0, _get.default)(schema, path.slice(0, -1));
+    /**
+     * Fix schema by removing any broken regexes that will cause ajv to throw a compile error.
+     * It is better to remove the invalid regex rather than forgo validation altogether
+     * This should be fixed in ajv see the comment here
+     * https://github.com/ajv-validator/ajv/blob/9f1c3eaa4b91ca17b72b122cdac9b108d1ac30cb/lib/vocabularies/validation/pattern.ts#L21
+     */
+
+    if (key === 'pattern') {
+      if (parent.type === 'string' && (!(0, _isString.default)(value) || !isValidRegex(value))) {
+        (0, _unset.default)(schema, path);
+      }
+    } // Inline $refs inside definitions that use discriminator
+    // https://github.com/ajv-validator/ajv/issues/1899
 
-    if (obj && typeof obj === 'object') {
-      const result = {};
 
-      for (const key of Object.keys(obj)) {
-        if (key !== 'pattern' || obj.type !== 'string' || isValidRegex(obj[key])) {
-          result[key] = normalize(obj[key]);
+    if (key === 'oneOf' && (0, _isArray.default)(value)) {
+      if ((0, _isObject.default)(parent.discriminator) && path[0] === 'definitions') {
+        for (const [index, subschema] of value.entries()) {
+          if (subschema.$ref) {
+            (0, _set.default)(schema, [...path, index], (0, _get.default)(schema, subschema.$ref.substr(2).split('/')));
+          }
         }
       }
-
-      return result;
     }
-
-    return obj;
-  };
-
-  return normalize(schema);
+  });
+  return schema;
 }
 
 function createSchemaValidator(schema, metaSchemas = [], options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/json-schema",
-  "version": "8.86.3",
+  "version": "8.87.3",
   "description": "JSON Schema validator",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -20,8 +20,9 @@
     "es"
   ],
   "dependencies": {
-    "ajv": "^7.0.4",
-    "ajv-formats": "^1.5.1",
+    "@takeshape/util": "8.87.3",
+    "ajv": "^8.10.0",
+    "ajv-formats": "^2.1.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {