@takeshape/json-schema 9.80.3 → 9.81.0

package/dist/index.js

@@ -3,9 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-
 var _schemaValidator = require("./schema-validator");
-
 Object.keys(_schemaValidator).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _schemaValidator[key]) return;

package/dist/schema-validator.js

@@ -17,155 +17,115 @@ exports.isInvalidPropertyRequired = isInvalidPropertyRequired;
 exports.parseDataPath = parseDataPath;
 exports.refToPath = refToPath;
 exports.validate = validate;
-
 var _ajv = _interopRequireDefault(require("ajv"));
-
 var _ajvFormats = _interopRequireDefault(require("ajv-formats"));
-
 var _get = _interopRequireDefault(require("lodash/get"));
-
 var _unset = _interopRequireDefault(require("lodash/unset"));
-
 var _isString = _interopRequireDefault(require("lodash/isString"));
-
 var _util = require("@takeshape/util");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function parseDataPath(instancePath) {
   return instancePath.substr(1).split('/');
 }
-
 function getData(error, data) {
   return (0, _get.default)(data, parseDataPath(error.instancePath));
 }
-
 function ignoreMissing(error) {
   // ignore top level missing errors
   return !(error.instancePath === '' && error.keyword === 'required');
 }
-
 function ignoreNull(error, data, topLevelSchema) {
   return !((error.keyword === 'type' || error.keyword === 'oneOf') && getData(error, data) === null && !isInvalidPropertyRequired(topLevelSchema, error));
 }
-
 function getErrorFilter(params, data, schema) {
   return error => (!params.ignoreMissing || ignoreMissing(error)) && (!params.ignoreNulls || ignoreNull(error, data, schema));
 }
-
 function isInvalidPropertyRequired(topLevelSchema, error) {
   const instancePath = parseDataPath(error.instancePath);
   const parentDataPath = instancePath.slice(0, instancePath.length - 1);
   const parentSchema = followSchemaPath(topLevelSchema, parentDataPath);
   const name = getName(error.instancePath);
-
   if (!parentSchema) {
     throw new Error('Unexpected error cannot find parent schema');
   }
-
   return isRequired(topLevelSchema, parentSchema, name);
 }
-
 function isRequired(topLevelSchema, schema, name) {
   const schemas = schema.allOf || schema.anyOf || schema.oneOf || [schema];
   return schemas.some(childSchema => {
     var _followRef, _followRef$required;
-
     return (_followRef = followRef(topLevelSchema, childSchema)) === null || _followRef === void 0 ? void 0 : (_followRef$required = _followRef.required) === null || _followRef$required === void 0 ? void 0 : _followRef$required.includes(name);
   });
 }
-
 function getName(path) {
   const parts = parseDataPath(path);
   return parts[parts.length - 1];
 }
-
 function refToPath(ref) {
   return ref.substring(2).split('/');
 }
-
 function followRef(topLevelSchema, schema) {
   if (schema.$ref) {
     const referencedSchema = (0, _get.default)(topLevelSchema, refToPath(schema.$ref));
-
     if (!referencedSchema) {
       throw new Error(`Could not resolve ${schema.$ref}`);
     }
-
     return referencedSchema;
   }
-
   return schema;
 }
+
 /**
  * Given a schema object traverse it using a "instancePath" and return the schema at that path
  */
-
-
 function followSchemaPath(topLevelSchema, instancePath) {
   const followPath = (schema, path) => {
     var _schema, _schema$properties;
-
     schema = followRef(topLevelSchema, schema);
-
     if (path.length === 0) {
       return schema;
     }
-
     const combinedSchemas = schema.allOf || schema.anyOf || schema.oneOf;
-
     if (combinedSchemas) {
       for (const childSchema of combinedSchemas) {
         const result = followPath(childSchema, path);
-
         if (result) {
           return result;
         }
       }
     }
-
     const [first, ...rest] = path;
-
     if (schema.items && /^\d+$/.exec(first)) {
       return followPath(schema.items, rest);
     }
-
     const prop = (_schema = schema) === null || _schema === void 0 ? void 0 : (_schema$properties = _schema.properties) === null || _schema$properties === void 0 ? void 0 : _schema$properties[first];
-
     if (prop) {
       return rest.length ? followPath(prop, rest) : prop;
     }
   };
-
   return followPath(topLevelSchema, instancePath);
 }
-
 function isSchemaObject(schema) {
   return typeof schema === 'object';
 }
-
 function getSchemaWithDefinitions(ajv, id) {
   var _ajv$getSchema2;
-
   if (id.startsWith('#')) {
     var _ajv$getSchema;
-
     const rootSchema = (_ajv$getSchema = ajv.getSchema('#')) === null || _ajv$getSchema === void 0 ? void 0 : _ajv$getSchema.schema;
-
     if (isSchemaObject(rootSchema)) {
       const path = refToPath(id);
       const {
         definitions
       } = rootSchema;
-      return { ...(0, _get.default)(rootSchema, path),
+      return {
+        ...(0, _get.default)(rootSchema, path),
         definitions
       };
     }
   }
-
   return (_ajv$getSchema2 = ajv.getSchema(id)) === null || _ajv$getSchema2 === void 0 ? void 0 : _ajv$getSchema2.schema;
 }
-
 function validate(ajv, id, data, options) {
   const params = {
     ignoreMissing: false,
@@ -175,22 +135,18 @@ function validate(ajv, id, data, options) {
   };
   let valid = ajv.validate(id, data);
   let errors;
-
   if (valid) {
     errors = [];
   } else {
     errors = ajv.errors;
-
     if (params.ignoreNulls || params.ignoreMissing) {
       const schema = getSchemaWithDefinitions(ajv, id);
-
       if (isSchemaObject(schema)) {
         errors = errors.filter(getErrorFilter(params, data, schema));
         valid = errors.length === 0;
       }
     }
   }
-
   const errorsText = params.errorsText && !valid ? ajv.errorsText(errors) : '';
   return {
     valid,
@@ -198,7 +154,6 @@ function validate(ajv, id, data, options) {
     errorsText
   };
 }
-
 function createAjv(options) {
   const ajv = new _ajv.default({
     discriminator: true,
@@ -208,20 +163,19 @@ function createAjv(options) {
     ...options
   });
   (0, _ajvFormats.default)(ajv);
+
   /**
    * Formats ingested by Stripe OpenAPI and possibly other — trigger warnings
    * in the client when Stripe types are loaded.
    */
-
   ajv.addFormat('unix-time', /^[0-9]{10}$/);
   ajv.addFormat('decimal', /^[0-9]+\.[0-9]{1,12}$/);
   return ajv;
 }
+
 /**
  * Determine whether a string is a valid regular expression
  */
-
-
 function isValidRegex(str) {
   try {
     // eslint-disable-next-line no-new,security-node/non-literal-reg-expr
@@ -231,23 +185,22 @@ function isValidRegex(str) {
     return false;
   }
 }
+
 /**
  * Apply various fixes to the schema to work around AJV issues and bugs.
  * See inline comments for more.
  */
-
-
 function fixSchema(schema) {
   (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);
@@ -256,25 +209,20 @@ function fixSchema(schema) {
   });
   return schema;
 }
-
 function createSchemaValidator(schema, metaSchemas = [], options = {}) {
   const schemas = Array.isArray(schema) ? schema : [schema];
   const ajv = createAjv({
     removeAdditional: true,
     ...options
   });
-
   if (metaSchemas) {
     metaSchemas.forEach(metaSchema => ajv.addMetaSchema(metaSchema));
   }
-
   schemas.forEach(schema => ajv.addSchema(fixSchema(schema)));
   const defaultRef = schemas[0].$id;
-
   if (!defaultRef) {
     throw Error('Failed to create schema validator: schema is missing $id');
   }
-
   return (data, options) => {
     return validate(ajv, defaultRef, data, options);
   };

package/es/schema-validator.js

@@ -7,137 +7,105 @@ import { visit } from '@takeshape/util';
 export function parseDataPath(instancePath) {
   return instancePath.substr(1).split('/');
 }
-
 function getData(error, data) {
   return get(data, parseDataPath(error.instancePath));
 }
-
 function ignoreMissing(error) {
   // ignore top level missing errors
   return !(error.instancePath === '' && error.keyword === 'required');
 }
-
 function ignoreNull(error, data, topLevelSchema) {
   return !((error.keyword === 'type' || error.keyword === 'oneOf') && getData(error, data) === null && !isInvalidPropertyRequired(topLevelSchema, error));
 }
-
 function getErrorFilter(params, data, schema) {
   return error => (!params.ignoreMissing || ignoreMissing(error)) && (!params.ignoreNulls || ignoreNull(error, data, schema));
 }
-
 export function isInvalidPropertyRequired(topLevelSchema, error) {
   const instancePath = parseDataPath(error.instancePath);
   const parentDataPath = instancePath.slice(0, instancePath.length - 1);
   const parentSchema = followSchemaPath(topLevelSchema, parentDataPath);
   const name = getName(error.instancePath);
-
   if (!parentSchema) {
     throw new Error('Unexpected error cannot find parent schema');
   }
-
   return isRequired(topLevelSchema, parentSchema, name);
 }
-
 function isRequired(topLevelSchema, schema, name) {
   const schemas = schema.allOf || schema.anyOf || schema.oneOf || [schema];
   return schemas.some(childSchema => {
     var _followRef, _followRef$required;
-
     return (_followRef = followRef(topLevelSchema, childSchema)) === null || _followRef === void 0 ? void 0 : (_followRef$required = _followRef.required) === null || _followRef$required === void 0 ? void 0 : _followRef$required.includes(name);
   });
 }
-
 function getName(path) {
   const parts = parseDataPath(path);
   return parts[parts.length - 1];
 }
-
 export function refToPath(ref) {
   return ref.substring(2).split('/');
 }
-
 function followRef(topLevelSchema, schema) {
   if (schema.$ref) {
     const referencedSchema = get(topLevelSchema, refToPath(schema.$ref));
-
     if (!referencedSchema) {
       throw new Error(`Could not resolve ${schema.$ref}`);
     }
-
     return referencedSchema;
   }
-
   return schema;
 }
+
 /**
  * Given a schema object traverse it using a "instancePath" and return the schema at that path
  */
-
-
 export function followSchemaPath(topLevelSchema, instancePath) {
   const followPath = (schema, path) => {
     var _schema, _schema$properties;
-
     schema = followRef(topLevelSchema, schema);
-
     if (path.length === 0) {
       return schema;
     }
-
     const combinedSchemas = schema.allOf || schema.anyOf || schema.oneOf;
-
     if (combinedSchemas) {
       for (const childSchema of combinedSchemas) {
         const result = followPath(childSchema, path);
-
         if (result) {
           return result;
         }
       }
     }
-
     const [first, ...rest] = path;
-
     if (schema.items && /^\d+$/.exec(first)) {
       return followPath(schema.items, rest);
     }
-
     const prop = (_schema = schema) === null || _schema === void 0 ? void 0 : (_schema$properties = _schema.properties) === null || _schema$properties === void 0 ? void 0 : _schema$properties[first];
-
     if (prop) {
       return rest.length ? followPath(prop, rest) : prop;
     }
   };
-
   return followPath(topLevelSchema, instancePath);
 }
-
 function isSchemaObject(schema) {
   return typeof schema === 'object';
 }
-
 function getSchemaWithDefinitions(ajv, id) {
   var _ajv$getSchema2;
-
   if (id.startsWith('#')) {
     var _ajv$getSchema;
-
     const rootSchema = (_ajv$getSchema = ajv.getSchema('#')) === null || _ajv$getSchema === void 0 ? void 0 : _ajv$getSchema.schema;
-
     if (isSchemaObject(rootSchema)) {
       const path = refToPath(id);
       const {
         definitions
       } = rootSchema;
-      return { ...get(rootSchema, path),
+      return {
+        ...get(rootSchema, path),
         definitions
       };
     }
   }
-
   return (_ajv$getSchema2 = ajv.getSchema(id)) === null || _ajv$getSchema2 === void 0 ? void 0 : _ajv$getSchema2.schema;
 }
-
 export function validate(ajv, id, data, options) {
   const params = {
     ignoreMissing: false,
@@ -147,22 +115,18 @@ export function validate(ajv, id, data, options) {
   };
   let valid = ajv.validate(id, data);
   let errors;
-
   if (valid) {
     errors = [];
   } else {
     errors = ajv.errors;
-
     if (params.ignoreNulls || params.ignoreMissing) {
       const schema = getSchemaWithDefinitions(ajv, id);
-
       if (isSchemaObject(schema)) {
         errors = errors.filter(getErrorFilter(params, data, schema));
         valid = errors.length === 0;
       }
     }
   }
-
   const errorsText = params.errorsText && !valid ? ajv.errorsText(errors) : '';
   return {
     valid,
@@ -180,19 +144,19 @@ export function createAjv(options) {
     ...options
   });
   addFormats(ajv);
+
   /**
    * Formats ingested by Stripe OpenAPI and possibly other — trigger warnings
    * in the client when Stripe types are loaded.
    */
-
   ajv.addFormat('unix-time', /^[0-9]{10}$/);
   ajv.addFormat('decimal', /^[0-9]+\.[0-9]{1,12}$/);
   return ajv;
 }
+
 /**
  * Determine whether a string is a valid regular expression
  */
-
 function isValidRegex(str) {
   try {
     // eslint-disable-next-line no-new,security-node/non-literal-reg-expr
@@ -202,23 +166,22 @@ function isValidRegex(str) {
     return false;
   }
 }
+
 /**
  * Apply various fixes to the schema to work around AJV issues and bugs.
  * See inline comments for more.
  */
-
-
 export function fixSchema(schema) {
   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);
@@ -233,18 +196,14 @@ export function createSchemaValidator(schema, metaSchemas = [], options = {}) {
     removeAdditional: true,
     ...options
   });
-
   if (metaSchemas) {
     metaSchemas.forEach(metaSchema => ajv.addMetaSchema(metaSchema));
   }
-
   schemas.forEach(schema => ajv.addSchema(fixSchema(schema)));
   const defaultRef = schemas[0].$id;
-
   if (!defaultRef) {
     throw Error('Failed to create schema validator: schema is missing $id');
   }
-
   return (data, options) => {
     return validate(ajv, defaultRef, data, options);
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/json-schema",
-  "version": "9.80.3",
+  "version": "9.81.0",
   "description": "JSON Schema validator",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -20,11 +20,11 @@
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
     "lodash": "^4.17.21",
-    "@takeshape/util": "9.80.3"
+    "@takeshape/util": "9.81.0"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.165",
-    "@takeshape/typescript-jest-junit-reporter": "9.80.3"
+    "@takeshape/typescript-jest-junit-reporter": "9.81.0"
   },
   "engines": {
     "node": ">=16"