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

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,10 +1,8 @@
-"use strict";
+import { ono } from "@jsdevtools/ono";
+import * as url from "../util/url.js";
+import { ResolverError } from "../util/errors.js";
 
-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.
    *

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,12 +1,8 @@
-"use strict";
-
-const nodePath = require("path");
-const projectDir = nodePath.resolve(__dirname, "..", "..");
+import projectDir from "./projectDir.cjs";
 
 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;
 
@@ -25,14 +21,14 @@ let urlDecodePatterns = [
   /\%40/g, "@"
 ];
 
-exports.parse = (u) => new URL(u);
+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}
  */
-exports.resolve = function resolve (from, to) {
+export function resolve (from, to) {
   let resolvedUrl = new URL(to, new URL(from, "resolve://"));
   if (resolvedUrl.protocol === "resolve:") {
     // `from` is a relative URL.
@@ -40,14 +36,14 @@ exports.resolve = function resolve (from, to) {
     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 () {
+export function cwd () {
   if (typeof window !== "undefined") {
     return location.href;
   }
@@ -61,7 +57,7 @@ exports.cwd = function cwd () {
   else {
     return path + "/";
   }
-};
+}
 
 /**
  * Returns the protocol of the given URL, or `undefined` if it has no protocol.
@@ -69,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,
@@ -83,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.
@@ -97,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.
@@ -112,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.
@@ -126,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.
@@ -140,8 +136,8 @@ 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;
   }
@@ -153,7 +149,7 @@ exports.isHttp = function isHttp (path) {
     // It's some other protocol, such as "ftp://", "mongodb://", etc.
     return false;
   }
-};
+}
 
 /**
  * Determines whether the given path is a filesystem path.
@@ -162,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.
@@ -189,7 +185,7 @@ 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) {
@@ -214,7 +210,7 @@ exports.fromFileSystemPath = function fromFileSystemPath (path) {
   }
 
   return path;
-};
+}
 
 /**
  * Converts a URL to a local filesystem path.
@@ -223,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);
 
@@ -271,7 +267,7 @@ exports.toFileSystemPath = function toFileSystemPath (path, keepFileProtocol) {
   }
 
   return path;
-};
+}
 
 /**
  * Converts a $ref pointer to a valid JSON Path.
@@ -279,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 [];
   }
@@ -292,4 +288,4 @@ exports.safePointerToPath = function safePointerToPath (pointer) {
         .replace(jsonPointerSlash, "/")
         .replace(jsonPointerTilde, "~");
     });
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "9.1.1",
+  "version": "10.0.0",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",
@@ -39,6 +39,11 @@
   "funding": "https://github.com/sponsors/philsturgeon",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
+  "exports": {
+    "types": "./lib/index.d.ts",
+    "require": "./cjs/index.js",
+    "default": "./lib/index.js"
+  },
   "browser": {
     "fs": false
   },
@@ -46,18 +51,20 @@
     "node": ">= 17"
   },
   "files": [
-    "lib"
+    "lib",
+    "cjs"
   ],
+  "type": "module",
   "scripts": {
-    "build": "cp LICENSE *.md dist",
-    "clean": "shx rm -rf .nyc_output coverage",
+    "build": "swc ./lib/*.js -d ./cjs && swc ./lib/**/*.js -d ./cjs && copyfiles ./lib/**/*.cjs -u 1 ./cjs && node ./scripts/writeCJSPackageJSON.cjs",
+    "clean": "shx rm -rf coverage cjs",
     "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": "cross-env NODE_OPTIONS=--openssl-legacy-provider karma start --single-run",
+    "test:browser": "cross-env NODE_OPTIONS=--openssl-legacy-provider karma start karma.conf.cjs --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",
+    "coverage:node": "c8 node_modules/mocha/bin/mocha",
     "coverage:browser": "npm run test:browser -- --coverage",
     "upgrade": "npm-check -u && npm audit fix"
   },
@@ -67,10 +74,14 @@
     "@jsdevtools/eslint-config": "^1.0.7",
     "@jsdevtools/host-environment": "^2.1.2",
     "@jsdevtools/karma-config": "^3.1.7",
+    "@swc/cli": "^0.1.59",
+    "@swc/core": "^1.3.25",
     "@types/node": "^14.14.21",
+    "c8": "^7.12.0",
     "chai": "^4.2.0",
     "chai-subset": "^1.6.0",
     "chokidar": "^3.5.3",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "^7.18.0",
     "isomorphic-fetch": "^3.0.0",
@@ -79,8 +90,6 @@
     "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",
     "shx": "^0.3.2",
     "typescript": "^4.0.5"
   },
@@ -97,15 +106,6 @@
     "plugins": [
       "@semantic-release/commit-analyzer",
       "@semantic-release/release-notes-generator",
-      [
-        "semantic-release-plugin-update-version-in-files",
-        {
-          "files": [
-            "dist/package.json"
-          ],
-          "placeholder": "X.X.X"
-        }
-      ],
       "@semantic-release/npm",
       "@semantic-release/github"
     ]