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

package/lib/refs.js

@@ -1,15 +1,14 @@
-"use strict";
+import { ono } from "@jsdevtools/ono";
+import $Ref from "./ref.js";
+import * as url from "./util/url.js";
 
-const { ono } = require("@jsdevtools/ono");
-const $Ref = require("./ref");
-const url = require("./util/url");
-
-module.exports = $Refs;
+const isWindows = /^win/.test(globalThis.process ? globalThis.process.platform : undefined);
+const getPathFromOs = filePath => isWindows ? filePath.replace(/\\/g, "/") : filePath;
 
 /**
  * This class is a map of JSON references and their resolved values.
  */
-function $Refs () {
+export default function $Refs () {
   /**
    * Indicates whether the schema contains any circular references.
    *
@@ -44,7 +43,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 +57,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/resolve-external.js

@@ -1,12 +1,10 @@
-"use strict";
+import $Ref from "./ref.js";
+import Pointer from "./pointer.js";
+import parse from "./parse.js";
+import * as url from "./util/url.js";
+import { isHandledError } from "./util/errors.js";
 
-const $Ref = require("./ref");
-const Pointer = require("./pointer");
-const parse = require("./parse");
-const url = require("./util/url");
-const { isHandledError } = require("./util/errors");
-
-module.exports = resolveExternal;
+export default resolveExternal;
 
 /**
  * Crawls the JSON schema, finds all external JSON references, and resolves their values.

package/lib/resolvers/file.js

@@ -1,10 +1,9 @@
-"use strict";
-const fs = require("fs");
-const { ono } = require("@jsdevtools/ono");
-const url = require("../util/url");
-const { ResolverError } = require("../util/errors");
+import fs from "fs";
+import { ono } from "@jsdevtools/ono";
+import * as url from "../util/url.js";
+import { ResolverError } from "../util/errors.js";
 
-module.exports = {
+export default {
   /**
    * The order that this resolver will run, in relation to other resolvers.
    *

package/lib/resolvers/http.js

@@ -1,12 +1,8 @@
-"use strict";
+import { ono } from "@jsdevtools/ono";
+import * as url from "../util/url.js";
+import { ResolverError } from "../util/errors.js";
 
-const http = require("http");
-const https = require("https");
-const { ono } = require("@jsdevtools/ono");
-const url = require("../util/url");
-const { ResolverError } = require("../util/errors");
-
-module.exports = {
+export default {
   /**
    * The order that this resolver will run, in relation to other resolvers.
    *
@@ -75,7 +71,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 +91,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 +133,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/errors.js

@@ -1,10 +1,8 @@
-"use strict";
+import { Ono } from "@jsdevtools/ono";
 
-const { Ono } = require("@jsdevtools/ono");
+import { stripHash, toFileSystemPath } from "./url.js";
 
-const { stripHash, toFileSystemPath } = require("./url");
-
-const JSONParserError = exports.JSONParserError = class JSONParserError extends Error {
+export const JSONParserError = class JSONParserError extends Error {
   constructor (message, source) {
     super();
 
@@ -23,7 +21,7 @@ const JSONParserError = exports.JSONParserError = class JSONParserError extends
 
 setErrorName(JSONParserError);
 
-const JSONParserErrorGroup = exports.JSONParserErrorGroup = class JSONParserErrorGroup extends Error {
+export const JSONParserErrorGroup = class JSONParserErrorGroup extends Error {
   constructor (parser) {
     super();
 
@@ -52,7 +50,7 @@ const JSONParserErrorGroup = exports.JSONParserErrorGroup = class JSONParserErro
 
 setErrorName(JSONParserErrorGroup);
 
-const ParserError = exports.ParserError = class ParserError extends JSONParserError {
+export const ParserError = class ParserError extends JSONParserError {
   constructor (message, source) {
     super(`Error parsing ${source}: ${message}`, source);
 
@@ -62,7 +60,7 @@ const ParserError = exports.ParserError = class ParserError extends JSONParserEr
 
 setErrorName(ParserError);
 
-const UnmatchedParserError = exports.UnmatchedParserError = class UnmatchedParserError extends JSONParserError {
+export const UnmatchedParserError = class UnmatchedParserError extends JSONParserError {
   constructor (source) {
     super(`Could not find parser for "${source}"`, source);
 
@@ -72,7 +70,7 @@ const UnmatchedParserError = exports.UnmatchedParserError = class UnmatchedParse
 
 setErrorName(UnmatchedParserError);
 
-const ResolverError = exports.ResolverError = class ResolverError extends JSONParserError {
+export const ResolverError = class ResolverError extends JSONParserError {
   constructor (ex, source) {
     super(ex.message || `Error reading file "${source}"`, source);
 
@@ -86,7 +84,7 @@ const ResolverError = exports.ResolverError = class ResolverError extends JSONPa
 
 setErrorName(ResolverError);
 
-const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedResolverError extends JSONParserError {
+export const UnmatchedResolverError = class UnmatchedResolverError extends JSONParserError {
   constructor (source) {
     super(`Could not find resolver for "${source}"`, source);
 
@@ -96,7 +94,7 @@ const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedR
 
 setErrorName(UnmatchedResolverError);
 
-const MissingPointerError = exports.MissingPointerError = class MissingPointerError extends JSONParserError {
+export const MissingPointerError = class MissingPointerError extends JSONParserError {
   constructor (token, path) {
     super(`Token "${token}" does not exist.`, stripHash(path));
 
@@ -106,7 +104,7 @@ const MissingPointerError = exports.MissingPointerError = class MissingPointerEr
 
 setErrorName(MissingPointerError);
 
-const InvalidPointerError = exports.InvalidPointerError = class InvalidPointerError extends JSONParserError {
+export const InvalidPointerError = class InvalidPointerError extends JSONParserError {
   constructor (pointer, path) {
     super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, stripHash(path));
 
@@ -123,14 +121,14 @@ function setErrorName (err) {
   });
 }
 
-exports.isHandledError = function (err) {
+export function isHandledError (err) {
   return err instanceof JSONParserError || err instanceof JSONParserErrorGroup;
-};
+}
 
-exports.normalizeError = function (err) {
+export function normalizeError (err) {
   if (err.path === null) {
     err.path = [];
   }
 
   return err;
-};
+}

package/lib/util/plugins.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Returns the given plugins as an array, rather than an object map.
  * All other methods in this module expect an array of plugins rather than an object map.
@@ -7,7 +5,7 @@
  * @param  {object} plugins - A map of plugin objects
  * @return {object[]}
  */
-exports.all = function (plugins) {
+export function all (plugins) {
   return Object.keys(plugins)
     .filter((key) => {
       return typeof plugins[key] === "object";
@@ -16,7 +14,7 @@ exports.all = function (plugins) {
       plugins[key].name = key;
       return plugins[key];
     });
-};
+}
 
 /**
  * Filters the given plugins, returning only the ones return `true` for the given method.
@@ -26,12 +24,12 @@ exports.all = function (plugins) {
  * @param  {object}   file    - A file info object, which will be passed to each method
  * @return {object[]}
  */
-exports.filter = function (plugins, method, file) {
+export function filter (plugins, method, file) {
   return plugins
     .filter((plugin) => {
       return !!getResult(plugin, method, file);
     });
-};
+}
 
 /**
  * Sorts the given plugins, in place, by their `order` property.
@@ -39,13 +37,13 @@ exports.filter = function (plugins, method, file) {
  * @param {object[]} plugins - An array of plugin objects
  * @returns {object[]}
  */
-exports.sort = function (plugins) {
+export function sort (plugins) {
   for (let plugin of plugins) {
     plugin.order = plugin.order || Number.MAX_SAFE_INTEGER;
   }
 
   return plugins.sort((a, b) => { return a.order - b.order; });
-};
+}
 
 /**
  * Runs the specified method of the given plugins, in order, until one of them returns a successful result.
@@ -60,7 +58,7 @@ exports.sort = function (plugins) {
  * @param {object}    file    - A file info object, which will be passed to each method
  * @returns {Promise}
  */
-exports.run = function (plugins, method, file, $refs) {
+export function run (plugins, method, file, $refs) {
   let plugin, lastError, index = 0;
 
   return new Promise(((resolve, reject) => {
@@ -119,7 +117,7 @@ exports.run = function (plugins, method, file, $refs) {
       runNextPlugin();
     }
   }));
-};
+}
 
 /**
  * Returns the value of the given property.

package/lib/util/projectDir.cjs

@@ -0,0 +1,6 @@
+const nodePath = require("path");
+
+// Webpack 4 (used by browser tests) can't transpile import.meta.url
+// So export the project directory using __dirname from a .cjs module
+const projectDir = nodePath.resolve(__dirname, "..", "..");
+module.exports = projectDir

package/lib/util/url.js

@@ -1,9 +1,8 @@
-"use strict";
+import projectDir from "./projectDir.cjs";
 
-let isWindows = /^win/.test(process.platform),
+let isWindows = /^win/.test(globalThis.process ? globalThis.process.platform : undefined),
     forwardSlashPattern = /\//g,
     protocolPattern = /^(\w{2,}):\/\//i,
-    url = module.exports,
     jsonPointerSlash = /~1/g,
     jsonPointerTilde = /~0/g;
 
@@ -22,16 +21,30 @@ let urlDecodePatterns = [
   /\%40/g, "@"
 ];
 
-exports.parse = require("url").parse;
-exports.resolve = require("url").resolve;
+export const 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}
+ */
+export 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).
  *
  * @returns {string}
  */
-exports.cwd = function cwd () {
-  if (process.browser) {
+export function cwd () {
+  if (typeof window !== "undefined") {
     return location.href;
   }
 
@@ -44,7 +57,7 @@ exports.cwd = function cwd () {
   else {
     return path + "/";
   }
-};
+}
 
 /**
  * Returns the protocol of the given URL, or `undefined` if it has no protocol.
@@ -52,12 +65,12 @@ exports.cwd = function cwd () {
  * @param   {string} path
  * @returns {?string}
  */
-exports.getProtocol = function getProtocol (path) {
+export function getProtocol (path) {
   let match = protocolPattern.exec(path);
   if (match) {
     return match[1].toLowerCase();
   }
-};
+}
 
 /**
  * Returns the lowercased file extension of the given URL,
@@ -66,13 +79,13 @@ exports.getProtocol = function getProtocol (path) {
  * @param   {string} path
  * @returns {string}
  */
-exports.getExtension = function getExtension (path) {
+export function getExtension (path) {
   let lastDot = path.lastIndexOf(".");
   if (lastDot >= 0) {
-    return url.stripQuery(path.substr(lastDot).toLowerCase());
+    return stripQuery(path.substr(lastDot).toLowerCase());
   }
   return "";
-};
+}
 
 /**
  * Removes the query, if any, from the given path.
@@ -80,13 +93,13 @@ exports.getExtension = function getExtension (path) {
  * @param   {string} path
  * @returns {string}
  */
-exports.stripQuery = function stripQuery (path) {
+export function stripQuery (path) {
   let queryIndex = path.indexOf("?");
   if (queryIndex >= 0) {
     path = path.substr(0, queryIndex);
   }
   return path;
-};
+}
 
 /**
  * Returns the hash (URL fragment), of the given path.
@@ -95,13 +108,13 @@ exports.stripQuery = function stripQuery (path) {
  * @param   {string} path
  * @returns {string}
  */
-exports.getHash = function getHash (path) {
+export function getHash (path) {
   let hashIndex = path.indexOf("#");
   if (hashIndex >= 0) {
     return path.substr(hashIndex);
   }
   return "#";
-};
+}
 
 /**
  * Removes the hash (URL fragment), if any, from the given path.
@@ -109,13 +122,13 @@ exports.getHash = function getHash (path) {
  * @param   {string} path
  * @returns {string}
  */
-exports.stripHash = function stripHash (path) {
+export function stripHash (path) {
   let hashIndex = path.indexOf("#");
   if (hashIndex >= 0) {
     path = path.substr(0, hashIndex);
   }
   return path;
-};
+}
 
 /**
  * Determines whether the given path is an HTTP(S) URL.
@@ -123,20 +136,20 @@ exports.stripHash = function stripHash (path) {
  * @param   {string} path
  * @returns {boolean}
  */
-exports.isHttp = function isHttp (path) {
-  let protocol = url.getProtocol(path);
+export function isHttp (path) {
+  let protocol = getProtocol(path);
   if (protocol === "http" || protocol === "https") {
     return true;
   }
   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.
     return false;
   }
-};
+}
 
 /**
  * Determines whether the given path is a filesystem path.
@@ -145,16 +158,16 @@ exports.isHttp = function isHttp (path) {
  * @param   {string} path
  * @returns {boolean}
  */
-exports.isFileSystemPath = function isFileSystemPath (path) {
+export function isFileSystemPath (path) {
   if (process.browser) {
     // We're running in a browser, so assume that all paths are URLs.
     // This way, even relative paths will be treated as URLs rather than as filesystem paths
     return false;
   }
 
-  let protocol = url.getProtocol(path);
+  let protocol = getProtocol(path);
   return protocol === undefined || protocol === "file";
-};
+}
 
 /**
  * Converts a filesystem path to a properly-encoded URL.
@@ -172,11 +185,18 @@ exports.isFileSystemPath = function isFileSystemPath (path) {
  * @param {string} path
  * @returns {string}
  */
-exports.fromFileSystemPath = function fromFileSystemPath (path) {
+export 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
@@ -190,7 +210,7 @@ exports.fromFileSystemPath = function fromFileSystemPath (path) {
   }
 
   return path;
-};
+}
 
 /**
  * Converts a URL to a local filesystem path.
@@ -199,7 +219,7 @@ exports.fromFileSystemPath = function fromFileSystemPath (path) {
  * @param {boolean} [keepFileProtocol] - If true, then "file://" will NOT be stripped
  * @returns {string}
  */
-exports.toFileSystemPath = function toFileSystemPath (path, keepFileProtocol) {
+export function toFileSystemPath (path, keepFileProtocol) {
   // Step 1: `decodeURI` will decode characters such as Cyrillic characters, spaces, etc.
   path = decodeURI(path);
 
@@ -247,7 +267,7 @@ exports.toFileSystemPath = function toFileSystemPath (path, keepFileProtocol) {
   }
 
   return path;
-};
+}
 
 /**
  * Converts a $ref pointer to a valid JSON Path.
@@ -255,7 +275,7 @@ exports.toFileSystemPath = function toFileSystemPath (path, keepFileProtocol) {
  * @param {string}  pointer
  * @returns {Array<number | string>}
  */
-exports.safePointerToPath = function safePointerToPath (pointer) {
+export function safePointerToPath (pointer) {
   if (pointer.length <= 1 || pointer[0] !== "#" || pointer[1] !== "/") {
     return [];
   }
@@ -268,4 +288,4 @@ exports.safePointerToPath = function safePointerToPath (pointer) {
         .replace(jsonPointerSlash, "/")
         .replace(jsonPointerTilde, "~");
     });
-};
+}