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

package/README.md

@@ -1,5 +1,7 @@
-JSON Schema $Ref Parser
-============================
+# JSON Schema $Ref Parser
+
+_**This package needs [a new maintainer](https://github.com/APIDevTools/json-schema-ref-parser/issues/285) or at least some contributors, or a decent number of sponsors so I can hire contractors to do the work. For more information [please read this article](https://phil.tech/2022/bundling-openapi-with-javascript/). I'll mark the repo as read-only and unmaintained on January 15th 2023 along with a bunch of other @apidevtools packages like swagger-parser, so I can focus on scaling up my [reforestation charity](https://protect.earth/) instead of burning myself out trying to maintain a whole load of OSS projects I don't use in my vanishingly small spare time.** - [Phil Sturgeon](https://github.com/philsturgeon)_
+
 #### Parse, Resolve, and Dereference JSON Schema $ref pointers
 
 [![Build Status](https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/json-schema-ref-parser/actions)
@@ -111,6 +113,13 @@ When using a transpiler such as [Babel](https://babeljs.io/) or [TypeScript](htt
 import $RefParser from "@apidevtools/json-schema-ref-parser";
 ```
 
+If you are using Node.js < 18, you'll need a polyfill for `fetch`, like [node-fetch](https://github.com/node-fetch/node-fetch):
+```javascript
+import fetch from "node-fetch";
+
+globalThis.fetch = fetch;
+```
+
 
 
 Browser support

package/lib/bundle.js

@@ -135,7 +135,7 @@ function inventory$Ref ($refParent, $refKey, path, pathFromRoot, indirections, i
   });
 
   // Recursively crawl the resolved value
-  if (!existingEntry) {
+  if (!existingEntry || external) {
     crawl(pointer.value, null, pointer.path, pathFromRoot, indirections + 1, inventory, $refs, options);
   }
 }

package/lib/dereference.js

@@ -71,6 +71,9 @@ function crawl (obj, path, pathFromRoot, parents, processedObjects, dereferenced
             // Avoid pointless mutations; breaks frozen objects to no profit
             if (obj[key] !== dereferenced.value) {
               obj[key] = dereferenced.value;
+              if (options.dereference.onDereference) {
+                options.dereference.onDereference(value.$ref, obj[key]);
+              }
             }
           }
           else {

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema4, JSONSchema4Type, JSONSchema6, JSONSchema6Type, JSONSchema7, JSONSchema7Type } from "json-schema";
+import { JSONSchema4, JSONSchema4Object, JSONSchema4Type, JSONSchema6, JSONSchema6Object, JSONSchema6Type, JSONSchema7, JSONSchema7Object, JSONSchema7Type } from "json-schema";
 
 export = $RefParser;
 
@@ -174,6 +174,7 @@ declare class $RefParser {
 declare namespace $RefParser {
 
   export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+  export type JSONSchemaObject = JSONSchema4Object | JSONSchema6Object | JSONSchema7Object;
   export type SchemaCallback = (err: Error | null, schema?: JSONSchema) => any;
   export type $RefsCallback = (err: Error | null, $refs?: $Refs) => any;
 
@@ -238,6 +239,14 @@ declare namespace $RefParser {
        * subpaths contain literal $ref keys that should not be dereferenced.
        */
       excludedPathMatcher?(path: string): boolean;
+
+      /**
+       * Callback invoked during dereferencing.
+       *
+       * @argument {string} path The path being dereferenced (ie. the `$ref` string).
+       * @argument {JSONSchemaObject} object The JSON-Schema that the `$ref` resolved to.
+       */
+      onDereference(path: string, value: JSONSchemaObject): void;
     };
   }
 

package/lib/refs.js

@@ -4,6 +4,9 @@ const { ono } = require("@jsdevtools/ono");
 const $Ref = require("./ref");
 const url = require("./util/url");
 
+const isWindows = /^win/.test(globalThis.process ? globalThis.process.platform : undefined);
+const getPathFromOs = filePath => isWindows ? filePath.replace(/\\/g, "/") : filePath;
+
 module.exports = $Refs;
 
 /**
@@ -44,7 +47,7 @@ function $Refs () {
 $Refs.prototype.paths = function (types) {    // eslint-disable-line no-unused-vars
   let paths = getPaths(this._$refs, arguments);
   return paths.map((path) => {
-    return path.decoded;
+    return getPathFromOs(path.decoded);
   });
 };
 
@@ -58,7 +61,7 @@ $Refs.prototype.values = function (types) {   // eslint-disable-line no-unused-v
   let $refs = this._$refs;
   let paths = getPaths($refs, arguments);
   return paths.reduce((obj, path) => {
-    obj[path.decoded] = $refs[path.encoded].value;
+    obj[getPathFromOs(path.decoded)] = $refs[path.encoded].value;
     return obj;
   }, {});
 };

package/lib/resolvers/http.js

@@ -1,7 +1,5 @@
 "use strict";
 
-const http = require("http");
-const https = require("https");
 const { ono } = require("@jsdevtools/ono");
 const url = require("../util/url");
 const { ResolverError } = require("../util/errors");
@@ -75,7 +73,7 @@ module.exports = {
   read (file) {
     let u = url.parse(file.url);
 
-    if (process.browser && !u.protocol) {
+    if (typeof window !== "undefined" && !u.protocol) {
       // Use the protocol of the current page
       u.protocol = url.parse(location.href).protocol;
     }
@@ -95,38 +93,36 @@ module.exports = {
  * The promise resolves with the raw downloaded data, or rejects if there is an HTTP error.
  */
 function download (u, httpOptions, redirects) {
-  return new Promise(((resolve, reject) => {
-    u = url.parse(u);
-    redirects = redirects || [];
-    redirects.push(u.href);
-
-    get(u, httpOptions)
-      .then((res) => {
-        if (res.statusCode >= 400) {
-          throw ono({ status: res.statusCode }, `HTTP ERROR ${res.statusCode}`);
+  u = url.parse(u);
+  redirects = redirects || [];
+  redirects.push(u.href);
+
+  return get(u, httpOptions)
+    .then((res) => {
+      if (res.status >= 400) {
+        throw ono({ status: res.statusCode }, `HTTP ERROR ${res.status}`);
+      }
+      else if (res.status >= 300) {
+        if (redirects.length > httpOptions.redirects) {
+          throw new ResolverError(ono({ status: res.status },
+            `Error downloading ${redirects[0]}. \nToo many redirects: \n  ${redirects.join(" \n  ")}`));
         }
-        else if (res.statusCode >= 300) {
-          if (redirects.length > httpOptions.redirects) {
-            reject(new ResolverError(ono({ status: res.statusCode },
-              `Error downloading ${redirects[0]}. \nToo many redirects: \n  ${redirects.join(" \n  ")}`)));
-          }
-          else if (!res.headers.location) {
-            throw ono({ status: res.statusCode }, `HTTP ${res.statusCode} redirect with no location header`);
-          }
-          else {
-            // console.log('HTTP %d redirect %s -> %s', res.statusCode, u.href, res.headers.location);
-            let redirectTo = url.resolve(u, res.headers.location);
-            download(redirectTo, httpOptions, redirects).then(resolve, reject);
-          }
+        else if (!res.headers.location) {
+          throw ono({ status: res.status }, `HTTP ${res.status} redirect with no location header`);
         }
         else {
-          resolve(res.body || Buffer.alloc(0));
+          // console.log('HTTP %d redirect %s -> %s', res.status, u.href, res.headers.location);
+          let redirectTo = url.resolve(u, res.headers.location);
+          return download(redirectTo, httpOptions, redirects);
         }
-      })
-      .catch((err) => {
-        reject(new ResolverError(ono(err, `Error downloading ${u.href}`), u.href));
-      });
-  }));
+      }
+      else {
+        return res.body ? res.arrayBuffer().then(buf => Buffer.from(buf)) : Buffer.alloc(0);
+      }
+    })
+    .catch((err) => {
+      throw new ResolverError(ono(err, `Error downloading ${u.href}`), u.href);
+    });
 }
 
 /**
@@ -139,42 +135,23 @@ function download (u, httpOptions, redirects) {
  * The promise resolves with the HTTP Response object.
  */
 function get (u, httpOptions) {
-  return new Promise(((resolve, reject) => {
-    // console.log('GET', u.href);
-
-    let protocol = u.protocol === "https:" ? https : http;
-    let req = protocol.get({
-      hostname: u.hostname,
-      port: u.port,
-      path: u.path,
-      auth: u.auth,
-      protocol: u.protocol,
-      headers: httpOptions.headers || {},
-      withCredentials: httpOptions.withCredentials
-    });
+  let controller;
+  let timeoutId;
+  if (httpOptions.timeout) {
+    controller = new AbortController();
+    timeoutId = setTimeout(() => controller.abort(), httpOptions.timeout);
+  }
 
-    if (typeof req.setTimeout === "function") {
-      req.setTimeout(httpOptions.timeout);
+  return fetch(u, {
+    method: "GET",
+    headers: httpOptions.headers || {},
+    credentials: httpOptions.withCredentials ? "include" : "same-origin",
+    signal: controller ? controller.signal : null,
+  }).then(response => {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
     }
 
-    req.on("timeout", () => {
-      req.abort();
-    });
-
-    req.on("error", reject);
-
-    req.once("response", (res) => {
-      res.body = Buffer.alloc(0);
-
-      res.on("data", (data) => {
-        res.body = Buffer.concat([res.body, Buffer.from(data)]);
-      });
-
-      res.on("error", reject);
-
-      res.on("end", () => {
-        resolve(res);
-      });
-    });
-  }));
+    return response;
+  });
 }

package/lib/util/url.js

@@ -1,6 +1,9 @@
 "use strict";
 
-let isWindows = /^win/.test(process.platform),
+const nodePath = require("path");
+const projectDir = nodePath.resolve(__dirname, "..", "..");
+
+let isWindows = /^win/.test(globalThis.process ? globalThis.process.platform : undefined),
     forwardSlashPattern = /\//g,
     protocolPattern = /^(\w{2,}):\/\//i,
     url = module.exports,
@@ -22,8 +25,22 @@ let urlDecodePatterns = [
   /\%40/g, "@"
 ];
 
-exports.parse = require("url").parse;
-exports.resolve = require("url").resolve;
+exports.parse = (u) => new URL(u);
+
+/**
+ * Returns resolved target URL relative to a base URL in a manner similar to that of a Web browser resolving an anchor tag HREF.
+ *
+ * @return {string}
+ */
+exports.resolve = function resolve (from, to) {
+  let resolvedUrl = new URL(to, new URL(from, "resolve://"));
+  if (resolvedUrl.protocol === "resolve:") {
+    // `from` is a relative URL.
+    let { pathname, search, hash } = resolvedUrl;
+    return pathname + search + hash;
+  }
+  return resolvedUrl.toString();
+};
 
 /**
  * Returns the current working directory (in Node) or the current page URL (in browsers).
@@ -31,7 +48,7 @@ exports.resolve = require("url").resolve;
  * @returns {string}
  */
 exports.cwd = function cwd () {
-  if (process.browser) {
+  if (typeof window !== "undefined") {
     return location.href;
   }
 
@@ -130,7 +147,7 @@ exports.isHttp = function isHttp (path) {
   }
   else if (protocol === undefined) {
     // There is no protocol.  If we're running in a browser, then assume it's HTTP.
-    return process.browser;
+    return typeof window !== "undefined";
   }
   else {
     // It's some other protocol, such as "ftp://", "mongodb://", etc.
@@ -176,7 +193,14 @@ exports.fromFileSystemPath = function fromFileSystemPath (path) {
   // Step 1: On Windows, replace backslashes with forward slashes,
   // rather than encoding them as "%5C"
   if (isWindows) {
-    path = path.replace(/\\/g, "/");
+    const hasProjectDir = path.toUpperCase().includes(projectDir.replace(/\\/g, "\\").toUpperCase());
+    const hasProjectUri = path.toUpperCase().includes(projectDir.replace(/\\/g, "/").toUpperCase());
+    if (hasProjectDir || hasProjectUri) {
+      path = path.replace(/\\/g, "/");
+    }
+    else {
+      path = `${projectDir}/${path}`.replace(/\\/g, "/");
+    }
   }
 
   // Step 2: `encodeURI` will take care of MOST characters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "9.1.0",
+  "version": "9.1.1",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",
@@ -21,6 +21,10 @@
       "name": "Boris Cherny",
       "email": "boris@performancejs.com"
     },
+    {
+      "name": "Phil Sturgeon",
+      "email": "phil@apisyouwonthate.com"
+    },
     {
       "name": "Jakub Rożek",
       "email": "jakub@stoplight.io"
@@ -32,11 +36,15 @@
     "url": "https://github.com/APIDevTools/json-schema-ref-parser.git"
   },
   "license": "MIT",
+  "funding": "https://github.com/sponsors/philsturgeon",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "browser": {
     "fs": false
   },
+  "engines": {
+    "node": ">= 17"
+  },
   "files": [
     "lib"
   ],
@@ -46,7 +54,7 @@
     "lint": "eslint lib test/fixtures test/specs",
     "test": "npm run test:node && npm run test:typescript && npm run test:browser && npm run lint",
     "test:node": "mocha",
-    "test:browser": "karma start --single-run",
+    "test:browser": "cross-env NODE_OPTIONS=--openssl-legacy-provider karma start --single-run",
     "test:typescript": "tsc --noEmit --strict --lib esnext,dom test/specs/typescript-definition.spec.ts",
     "coverage": "npm run coverage:node && npm run coverage:browser",
     "coverage:node": "nyc node_modules/mocha/bin/mocha",
@@ -54,18 +62,22 @@
     "upgrade": "npm-check -u && npm audit fix"
   },
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "^2.5.0",
     "@babel/polyfill": "^7.12.1",
+    "@chiragrupani/karma-chromium-edge-launcher": "^2.2.2",
     "@jsdevtools/eslint-config": "^1.0.7",
     "@jsdevtools/host-environment": "^2.1.2",
     "@jsdevtools/karma-config": "^3.1.7",
     "@types/node": "^14.14.21",
-    "chai-subset": "^1.6.0",
     "chai": "^4.2.0",
+    "chai-subset": "^1.6.0",
+    "chokidar": "^3.5.3",
+    "cross-env": "^7.0.3",
     "eslint": "^7.18.0",
-    "karma-cli": "^2.0.0",
+    "isomorphic-fetch": "^3.0.0",
     "karma": "^5.0.2",
+    "karma-cli": "^2.0.0",
     "mocha": "^8.2.1",
+    "node-abort-controller": "^3.0.1",
     "npm-check": "^5.9.0",
     "nyc": "^15.0.1",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
@@ -80,8 +92,7 @@
   },
   "release": {
     "branches": [
-      "main",
-      "v9"
+      "main"
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",
@@ -95,19 +106,7 @@
           "placeholder": "X.X.X"
         }
       ],
-      [
-        "@amanda-mitchell/semantic-release-npm-multiple",
-        {
-          "registries": {
-            "scoped": {
-              "pkgRoot": "."
-            },
-            "unscoped": {
-              "pkgRoot": "dist"
-            }
-          }
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github"
     ]
   }