@apidevtools/json-schema-ref-parser 9.0.8 → 9.1.0

package/lib/dereference.js

@@ -41,8 +41,10 @@ function crawl (obj, path, pathFromRoot, parents, processedObjects, dereferenced
     circular: false
   };
 
+  let isExcludedPath = options.dereference.excludedPathMatcher;
+
   if (options.dereference.circular === "ignore" || !processedObjects.has(obj)) {
-    if (obj && typeof obj === "object" && !ArrayBuffer.isView(obj)) {
+    if (obj && typeof obj === "object" && !ArrayBuffer.isView(obj) && !isExcludedPath(pathFromRoot)) {
       parents.add(obj);
       processedObjects.add(obj);
 
@@ -55,6 +57,11 @@ function crawl (obj, path, pathFromRoot, parents, processedObjects, dereferenced
         for (const key of Object.keys(obj)) {
           let keyPath = Pointer.join(path, key);
           let keyPathFromRoot = Pointer.join(pathFromRoot, key);
+
+          if (isExcludedPath(keyPathFromRoot)) {
+            continue;
+          }
+
           let value = obj[key];
           let circular = false;
 

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema4, JSONSchema4Type, JSONSchema6, JSONSchema6Type } from "json-schema";
+import { JSONSchema4, JSONSchema4Type, JSONSchema6, JSONSchema6Type, JSONSchema7, JSONSchema7Type } from "json-schema";
 
 export = $RefParser;
 
@@ -173,7 +173,7 @@ declare class $RefParser {
 // eslint-disable-next-line no-redeclare
 declare namespace $RefParser {
 
-  export type JSONSchema = JSONSchema4 | JSONSchema6;
+  export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
   export type SchemaCallback = (err: Error | null, schema?: JSONSchema) => any;
   export type $RefsCallback = (err: Error | null, $refs?: $Refs) => any;
 
@@ -208,7 +208,7 @@ declare namespace $RefParser {
       file?: Partial<ResolverOptions> | boolean;
       http?: HTTPResolverOptions | boolean;
     } & {
-      [key: string]: Partial<ResolverOptions> | boolean;
+      [key: string]: Partial<ResolverOptions> | HTTPResolverOptions | boolean | undefined;
     };
 
     /**
@@ -231,6 +231,13 @@ declare namespace $RefParser {
        * If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the `$Refs.circular` property will still be set to `true`.
        */
       circular?: boolean | "ignore";
+
+      /**
+       * A function, called for each path, which can return true to stop this path and all
+       * subpaths from being dereferenced further. This is useful in schemas where some
+       * subpaths contain literal $ref keys that should not be dereferenced.
+       */
+      excludedPathMatcher?(path: string): boolean;
     };
   }
 
@@ -284,7 +291,7 @@ declare namespace $RefParser {
     read(
       file: FileInfo,
       callback?: (error: Error | null, data: string | null) => any
-    ): string | Buffer | Promise<string | Buffer>;
+    ): string | Buffer | JSONSchema | Promise<string | Buffer | JSONSchema>;
   }
 
   export interface ParserOptions {
@@ -395,7 +402,7 @@ declare namespace $RefParser {
      *
      * @param $ref The JSON Reference path, optionally with a JSON Pointer in the hash
      */
-    public get($ref: string): JSONSchema4Type | JSONSchema6Type
+    public get($ref: string): JSONSchema4Type | JSONSchema6Type | JSONSchema7Type
 
     /**
      * Sets the value at the given path in the schema. If the property, or any of its parents, don't exist, they will be created.
@@ -403,7 +410,7 @@ declare namespace $RefParser {
      * @param $ref The JSON Reference path, optionally with a JSON Pointer in the hash
      * @param value The value to assign. Can be anything (object, string, number, etc.)
      */
-    public set($ref: string, value: JSONSchema4Type | JSONSchema6Type): void
+    public set($ref: string, value: JSONSchema4Type | JSONSchema6Type | JSONSchema7Type): void
   }
 
   export type JSONParserErrorType = "EUNKNOWN" | "EPARSER" | "EUNMATCHEDPARSER" | "ERESOLVER" | "EUNMATCHEDRESOLVER" | "EMISSINGPOINTER" | "EINVALIDPOINTER";

package/lib/options.js

@@ -73,7 +73,16 @@ $RefParserOptions.defaults = {
      *
      * @type {boolean|string}
      */
-    circular: true
+    circular: true,
+
+    /**
+     * A function, called for each path, which can return true to stop this path and all
+     * subpaths from being dereferenced further. This is useful in schemas where some
+     * subpaths contain literal $ref keys that should not be dereferenced.
+     *
+     * @type {function}
+     */
+    excludedPathMatcher: () => false
   },
 };
 

package/lib/parsers/yaml.js

@@ -2,6 +2,7 @@
 
 const { ParserError } = require("../util/errors");
 const yaml = require("js-yaml");
+const { JSON_SCHEMA } = require("js-yaml");
 
 module.exports = {
   /**
@@ -45,7 +46,7 @@ module.exports = {
 
     if (typeof data === "string") {
       try {
-        return yaml.safeLoad(data);
+        return yaml.load(data, { schema: JSON_SCHEMA });
       }
       catch (e) {
         throw new ParserError(e.message, file.url);

package/lib/pointer.js

@@ -91,7 +91,7 @@ Pointer.prototype.resolve = function (obj, options, pathFromRoot) {
     let token = tokens[i];
     if (this.value[token] === undefined || this.value[token] === null) {
       this.value = null;
-      throw new MissingPointerError(token, this.originalPath);
+      throw new MissingPointerError(token, decodeURI(this.originalPath));
     }
     else {
       this.value = this.value[token];

package/lib/ref.js

@@ -135,7 +135,7 @@ $Ref.prototype.resolve = function (path, options, friendlyPath, pathFromRoot) {
     if (err instanceof InvalidPointerError) {
       // this is a special case - InvalidPointerError is thrown when dereferencing external file,
       // but the issue is caused by the source file that referenced the file that undergoes dereferencing
-      err.source = stripHash(pathFromRoot);
+      err.source = decodeURI(stripHash(pathFromRoot));
     }
 
     this.addError(err);

package/lib/resolve-external.js

@@ -120,7 +120,7 @@ async function resolve$Ref ($ref, path, $refs, options) {
     }
 
     if ($refs._$refs[withoutHash]) {
-      err.source = url.stripHash(path);
+      err.source = decodeURI(url.stripHash(path));
       err.path = url.safePointerToPath(url.getHash(path));
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "9.0.8",
+  "version": "9.1.0",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",
@@ -76,9 +76,13 @@
     "@jsdevtools/ono": "^7.1.3",
     "@types/json-schema": "^7.0.6",
     "call-me-maybe": "^1.0.1",
-    "js-yaml": "^3.13.1"
+    "js-yaml": "^4.1.0"
   },
   "release": {
+    "branches": [
+      "main",
+      "v9"
+    ],
     "plugins": [
       "@semantic-release/commit-analyzer",
       "@semantic-release/release-notes-generator",

package/CHANGELOG.md

@@ -1,182 +0,0 @@
-Change Log
-==========
-
-See [GitHub Releases](https://github.com/APIDevTools/json-schema-ref-parser/releases) for more information on newer releases.
-
-[v9.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v9.0.0) (2020-04-21)
-----------------------------------------------------------------------------------------------------
-
-#### Breaking Changes
-
-- Removed the `YAML` export. We recommend using [`@stoplight/yaml`](https://www.npmjs.com/package/@stoplight/yaml) instead
-
-
-#### Other Changes
-
-- Added a new [`continueOnError` option](https://apitools.dev/json-schema-ref-parser/docs/options) that allows you to get all errors rather than just the first one
-
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v8.0.0...v9.0.0)
-
-
-
-[v8.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v8.0.0) (2020-03-13)
-----------------------------------------------------------------------------------------------------
-
-- Moved JSON Schema $Ref Parser to the [@APIDevTools scope](https://www.npmjs.com/org/apidevtools) on NPM
-
-- The "json-schema-ref-parser" NPM package is now just a wrapper around the scoped "@apidevtools/json-schema-ref-parser" package
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v7.1.4...v8.0.0)
-
-
-
-[v7.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.1.0) (2019-06-21)
-----------------------------------------------------------------------------------------------------
-
-- Merged [PR #124](https://github.com/APIDevTools/json-schema-ref-parser/pull/124/), which provides more context to [custom resolvers](https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html).
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v7.0.1...v7.1.0)
-
-
-
-[v7.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v7.0.0) (2019-06-11)
-----------------------------------------------------------------------------------------------------
-
-- Dropped support for Node 6
-
-- Updated all code to ES6+ syntax (async/await, template literals, arrow functions, etc.)
-
-- No longer including a pre-built bundle in the package. such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/) to include JSON Schema $Ref Parser in your app
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v6.1.0...v7.0.0)
-
-
-
-[v6.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v6.0.0) (2018-10-04)
-----------------------------------------------------------------------------------------------------
-
-- Dropped support for [Bower](https://www.npmjs.com/package/bower), since it has been deprecated
-
-- Removed the [`debug`](https://npmjs.com/package/debug) dependency
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v5.1.0...v6.0.0)
-
-
-
-[v5.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.1.0) (2018-07-11)
-----------------------------------------------------------------------------------------------------
-
-- Improved the logic of the [`bundle()` method](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback) to produce shorter reference paths when possible.  This is not a breaking change, since both the old reference paths and the new reference paths are valid.  The new ones are just shorter.  Big thanks to [@hipstersmoothie](https://github.com/hipstersmoothie) for [PR #68](https://github.com/APIDevTools/json-schema-ref-parser/pull/68), which helped a lot with this.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v5.0.0...v5.1.0)
-
-
-
-[v5.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v5.0.0) (2018-03-18)
-----------------------------------------------------------------------------------------------------
-
-This release contains two bug fixes related to file paths.  They are _technically_ breaking changes — hence the major version bump — but they're both edge cases that probably won't affect most users.
-
-- Fixed a bug in the [`$refs.paths()`](docs/refs.md#pathstypes) and [`$refs.values()`](docs/refs.md#valuestypes) methods that caused the path of the root schema file to always be represented as a URL, rather than a filesystem path (see [this commit](https://github.com/APIDevTools/json-schema-ref-parser/commit/a95cf50fdf16c864cc1c18d2021d9ce3ec35f5de))
-
-- Merged [PR #75](https://github.com/APIDevTools/json-schema-ref-parser/pull/75), which resolves [issue #76](https://github.com/APIDevTools/swagger-parser/issues/76).  Error messages no longer include the current working directory path when there is no file path.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v4.1.1...v5.0.0)
-
-
-
-[v4.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.1.0) (2018-01-17)
-----------------------------------------------------------------------------------------------------
-
-- Updated dependencies
-
-- Improved the `bundle()` algorithm to favor direct references rather than indirect references (see [PR #62](https://github.com/APIDevTools/json-schema-ref-parser/pull/62) for details).  This will produce different bundled output than previous versions for some schemas. Both the old output and the new output are valid, but the new output is arguably better.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v4.0.0...v4.1.0)
-
-
-
-[v4.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v4.0.0) (2017-10-13)
-----------------------------------------------------------------------------------------------------
-
-#### Breaking Changes
-
-- To reduce the size of this library, it no longer includes polyfills for [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) and [TypedArrays](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), which are natively supported in the latest versions of Node and web browsers.  If you need to support older browsers (such as IE9), then just use [this `Promise` polyfill](https://github.com/stefanpenner/es6-promise) and [this `TypedArray` polyfill](https://github.com/inexorabletash/polyfill/blob/master/typedarray.js).
-
-#### Minor Changes
-
-- Updated dependencies
-
-- [PR #53](https://github.com/APIDevTools/json-schema-ref-parser/pull/53) - Fixes [an edge-case bug](https://github.com/APIDevTools/json-schema-ref-parser/issues/52) with the `bundle()` method
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v3.3.0...v4.0.0)
-
-
-
-[v3.3.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.3.0) (2017-08-09)
-----------------------------------------------------------------------------------------------------
-
-- Updated dependencies
-
-- [PR #30](https://github.com/APIDevTools/json-schema-ref-parser/pull/30) - Added a `browser` field to the `package.json` file to support bundlers such as Browserify, Rollup, and Webpack
-
-- [PR #45](https://github.com/APIDevTools/json-schema-ref-parser/pull/45) - Implemented a temporary workaround for [issue #42](https://github.com/APIDevTools/json-schema-ref-parser/issues/42). JSON Schema $Ref Parser does _not_ currently support [named internal references](http://json-schema.org/latest/json-schema-core.html#id-keyword), but support will be added in the next major release.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v3.0.0...v3.3.0)
-
-
-
-[v3.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v3.0.0) (2016-04-03)
-----------------------------------------------------------------------------------------------------
-
-#### Plug-ins !!!
-That's the major new feature in this version. Originally requested in [PR #8](https://github.com/APIDevTools/json-schema-ref-parser/pull/8), and refined a few times over the past few months, the plug-in API is now finalized and ready to use. You can now define your own [resolvers](https://github.com/APIDevTools/json-schema-ref-parser/blob/v3.0.0/docs/plugins/resolvers.md) and [parsers](https://github.com/APIDevTools/json-schema-ref-parser/blob/v3.0.0/docs/plugins/parsers.md).
-
-#### Breaking Changes
-The available [options have changed](https://github.com/APIDevTools/json-schema-ref-parser/blob/v3.0.0/docs/options.md), mostly due to the new plug-in API.  There's not a one-to-one mapping of old options to new options, so you'll have to read the docs and determine which options you need to set. If any. The out-of-the-box configuration works for most people.
-
-All of the [caching options have been removed](https://github.com/APIDevTools/json-schema-ref-parser/commit/1f4260184bfd370e9cd385b523fb08c098fac6db). Instead, all files are now cached, and the entire cache is reset for each new parse operation. Caching options may come back in a future release, if there is enough demand for it. If you used the old caching options, please open an issue and explain your use-case and requirements.  I need a better understanding of what caching functionality is actually needed by users.
-
-#### Bug Fixes
-Lots of little bug fixes.  The only major bug fix is to [support root-level `$ref`s](https://github.com/APIDevTools/json-schema-ref-parser/issues/16)
-
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v2.2.0...v3.0.0)
-
-
-
-[v2.2.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.2.0) (2016-01-03)
-----------------------------------------------------------------------------------------------------
-
-This version includes a **complete rewrite** of the [`bundle` method](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#bundleschema-options-callback) method, mostly to fix [this bug](https://github.com/APIDevTools/swagger-parser/issues/16), but also to address a few [edge-cases](https://github.com/APIDevTools/json-schema-ref-parser/commit/ca9b322879519e4bcb2dcf6e63f08ac254b90868) that weren't handled before.  As a side-effect of this rewrite, there was also some pretty significant refactoring and code-cleanup done throughout the codebase.
-
-Despite the significant code changes, there were no changes to any public-facing APIs, and [all tests are passing](https://apitools.dev/json-schema-ref-parser/test/) as expected.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v2.1.0...v2.2.0)
-
-
-
-[v2.1.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.1.0) (2015-12-31)
-----------------------------------------------------------------------------------------------------
-
-JSON Schema $Ref Parser now automatically follows HTTP redirects. This is especially great for servers that automatically "ugrade" your connection from HTTP to HTTPS via a 301 redirect. Now that won't break your code.
-
-There are a few [new options](https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/options.md) that allow you to set the number of redirects (default is 5) and a few other HTTP request properties.
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v2.0.0...v2.1.0)
-
-
-
-[v2.0.0](https://github.com/APIDevTools/json-schema-ref-parser/tree/v2.0.0) (2015-12-31)
-----------------------------------------------------------------------------------------------------
-
-Bumping the major version number because [this change](https://github.com/APIDevTools/json-schema-ref-parser/pull/5) technically breaks backward-compatibility — although I doubt it will actually affect many people.  Basically, if you're using JSON Schema $Ref Parser to download files from a CORS-enabled server that requires authentication, then you'll need to set the `http.withCredentials` option to `true`.
-
-```javascript
-$RefParser.dereference('http://some.server.com/file.json', {
-    http: { withCredentials: true }
-});
-```
-
-[Full Changelog](https://github.com/APIDevTools/json-schema-ref-parser/compare/v1.4.1...v2.0.0)