@apidevtools/json-schema-ref-parser 14.2.1 → 15.0.1

package/dist/lib/parse.js

@@ -1,41 +1,6 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const url = __importStar(require("./util/url.js"));
-const plugins = __importStar(require("./util/plugins.js"));
-const errors_js_1 = require("./util/errors.js");
+import * as url from "./util/url.js";
+import * as plugins from "./util/plugins.js";
+import { ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError, isHandledError, } from "./util/errors.js";
 /**
  * Reads and parses the specified file path or URL.
  */
@@ -67,7 +32,7 @@ async function parse(path, $refs, options) {
         return parser.result;
     }
     catch (err) {
-        if ((0, errors_js_1.isHandledError)(err)) {
+        if (isHandledError(err)) {
             $ref.value = err;
         }
         throw err;
@@ -98,18 +63,18 @@ async function readFile(file, options, $refs) {
     catch (err) {
         if (!err && options.continueOnError) {
             // No resolver could be matched
-            throw new errors_js_1.UnmatchedResolverError(file.url);
+            throw new UnmatchedResolverError(file.url);
         }
         else if (!err || !("error" in err)) {
             // Throw a generic, friendly error.
             throw new SyntaxError(`Unable to resolve $ref pointer "${file.url}"`);
         }
         // Throw the original error, if it's one of our own (user-friendly) errors.
-        else if (err.error instanceof errors_js_1.ResolverError) {
+        else if (err.error instanceof ResolverError) {
             throw err.error;
         }
         else {
-            throw new errors_js_1.ResolverError(err, file.url);
+            throw new ResolverError(err, file.url);
         }
     }
 }
@@ -147,7 +112,7 @@ async function parseFile(file, options, $refs) {
     catch (err) {
         if (!err && options.continueOnError) {
             // No resolver could be matched
-            throw new errors_js_1.UnmatchedParserError(file.url);
+            throw new UnmatchedParserError(file.url);
         }
         else if (err && err.message && err.message.startsWith("Error parsing")) {
             throw err;
@@ -155,11 +120,11 @@ async function parseFile(file, options, $refs) {
         else if (!err || !("error" in err)) {
             throw new SyntaxError(`Unable to parse ${file.url}`);
         }
-        else if (err.error instanceof errors_js_1.ParserError) {
+        else if (err.error instanceof ParserError) {
             throw err.error;
         }
         else {
-            throw new errors_js_1.ParserError(err.error.message, file.url);
+            throw new ParserError(err.error.message, file.url);
         }
     }
 }
@@ -175,4 +140,4 @@ function isEmpty(value) {
         (typeof value === "string" && value.trim().length === 0) ||
         (Buffer.isBuffer(value) && value.length === 0));
 }
-exports.default = parse;
+export default parse;

package/dist/lib/parsers/binary.js

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 const BINARY_REGEXP = /\.(jpeg|jpg|gif|png|bmp|ico)$/i;
-exports.default = {
+export default {
     /**
      * The order that this parser will run, in relation to other parsers.
      */

package/dist/lib/parsers/json.js

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_js_1 = require("../util/errors.js");
-exports.default = {
+import { ParserError } from "../util/errors.js";
+export default {
     /**
      * The order that this parser will run, in relation to other parsers.
      */
@@ -47,10 +45,10 @@ exports.default = {
                             return JSON.parse(data);
                         }
                         catch (e) {
-                            throw new errors_js_1.ParserError(e.message, file.url);
+                            throw new ParserError(e.message, file.url);
                         }
                     }
-                    throw new errors_js_1.ParserError(e.message, file.url);
+                    throw new ParserError(e.message, file.url);
                 }
             }
         }

package/dist/lib/parsers/text.js

@@ -1,8 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_js_1 = require("../util/errors.js");
+import { ParserError } from "../util/errors.js";
 const TEXT_REGEXP = /\.(txt|htm|html|md|xml|js|min|map|css|scss|less|svg)$/i;
-exports.default = {
+export default {
     /**
      * The order that this parser will run, in relation to other parsers.
      */
@@ -36,7 +34,7 @@ exports.default = {
             return file.data.toString(this.encoding);
         }
         else {
-            throw new errors_js_1.ParserError("data is not text", file.url);
+            throw new ParserError("data is not text", file.url);
         }
     },
 };

package/dist/lib/parsers/yaml.js

@@ -1,12 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_js_1 = require("../util/errors.js");
-const js_yaml_1 = __importDefault(require("js-yaml"));
-const js_yaml_2 = require("js-yaml");
-exports.default = {
+import { ParserError } from "../util/errors.js";
+import yaml from "js-yaml";
+import { JSON_SCHEMA } from "js-yaml";
+export default {
     /**
      * The order that this parser will run, in relation to other parsers.
      */
@@ -38,15 +33,15 @@ exports.default = {
         }
         if (typeof data === "string") {
             try {
-                return js_yaml_1.default.load(data, { schema: js_yaml_2.JSON_SCHEMA });
+                return yaml.load(data, { schema: JSON_SCHEMA });
             }
             catch (e) {
                 try {
                     // fallback to non JSON_SCHEMA
-                    return js_yaml_1.default.load(data);
+                    return yaml.load(data);
                 }
                 catch (e) {
-                    throw new errors_js_1.ParserError(e?.message || "Parser Error", file.url);
+                    throw new ParserError(e?.message || "Parser Error", file.url);
                 }
             }
         }

package/dist/lib/pointer.d.ts

@@ -1,6 +1,7 @@
 import type { ParserOptions } from "./options.js";
 import $Ref from "./ref.js";
-import type { JSONSchema } from "./types";
+import type { JSONSchema } from "./index.js";
+import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 export declare const nullSymbol: unique symbol;
 /**
  * This class represents a single JSON pointer and its resolved value.
@@ -63,7 +64,7 @@ declare class Pointer<S extends object = JSONSchema, O extends ParserOptions<S>
      * @returns
      * Returns the modified object, or an entirely new object if the entire object is overwritten.
      */
-    set(obj: S, value: any, options?: O): any;
+    set(obj: S, value: JSONSchema4Type | JSONSchema6Type | JSONSchema7Type, options?: O): string | number | boolean | import("json-schema").JSONSchema4Object | import("json-schema").JSONSchema4Array | S | null;
     /**
      * Parses a JSON pointer (or a path containing a JSON pointer in the hash)
      * and returns an array of the pointer's tokens.

package/dist/lib/pointer.js

@@ -1,58 +1,11 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nullSymbol = void 0;
-const ref_js_1 = __importDefault(require("./ref.js"));
-const url = __importStar(require("./util/url.js"));
-const errors_js_1 = require("./util/errors.js");
-exports.nullSymbol = Symbol("null");
+import $Ref from "./ref.js";
+import * as url from "./util/url.js";
+import { JSONParserError, InvalidPointerError, MissingPointerError, isHandledError } from "./util/errors.js";
+export const nullSymbol = Symbol("null");
 const slashes = /\//g;
 const tildes = /~/g;
 const escapedSlash = /~1/g;
 const escapedTilde = /~0/g;
-const safeDecodeURIComponent = (encodedURIComponent) => {
-    try {
-        return decodeURIComponent(encodedURIComponent);
-    }
-    catch {
-        return encodedURIComponent;
-    }
-};
 /**
  * This class represents a single JSON pointer and its resolved value.
  *
@@ -140,9 +93,9 @@ class Pointer {
                 // actually instead pointing to an existing `null` value then we should use that
                 // `null` value.
                 if (token in this.value && this.value[token] === null) {
-                    // We use a `null` symbol for internal tracking to differntiate between a general `null`
+                    // We use a `null` symbol for internal tracking to differentiate between a general `null`
                     // value and our expected `null` value.
-                    this.value = exports.nullSymbol;
+                    this.value = nullSymbol;
                     continue;
                 }
                 this.value = null;
@@ -150,7 +103,7 @@ class Pointer {
                 const targetRef = this.path.replace(path, "");
                 const targetFound = Pointer.join("", found);
                 const parentPath = pathFromRoot?.replace(path, "");
-                throw new errors_js_1.MissingPointerError(token, decodeURI(this.originalPath), targetRef, targetFound, parentPath);
+                throw new MissingPointerError(token, decodeURI(this.originalPath), targetRef, targetFound, parentPath);
             }
             else {
                 this.value = this.value[token];
@@ -226,10 +179,10 @@ class Pointer {
         const split = pointer.split("/");
         // Decode each part, according to RFC 6901
         for (let i = 0; i < split.length; i++) {
-            split[i] = safeDecodeURIComponent(split[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
+            split[i] = split[i].replace(escapedSlash, "/").replace(escapedTilde, "~");
         }
         if (split[0] !== "") {
-            throw new errors_js_1.InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
+            throw new InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
         }
         return split.slice(1);
     }
@@ -250,7 +203,9 @@ class Pointer {
         for (let i = 0; i < tokens.length; i++) {
             const token = tokens[i];
             // Encode the token, according to RFC 6901
-            base += "/" + encodeURIComponent(token.replace(tildes, "~0").replace(slashes, "~1"));
+            // RFC 6901 only requires encoding ~ as ~0 and / as ~1
+            // We do NOT use encodeURIComponent as it encodes characters like $ which should remain literal
+            base += "/" + token.replace(tildes, "~0").replace(slashes, "~1");
         }
         return base;
     }
@@ -268,7 +223,7 @@ class Pointer {
  */
 function resolveIf$Ref(pointer, options, pathFromRoot) {
     // Is the value a JSON reference? (and allowed?)
-    if (ref_js_1.default.isAllowed$Ref(pointer.value, options)) {
+    if ($Ref.isAllowed$Ref(pointer.value, options)) {
         const $refPath = url.resolve(pointer.path, pointer.value.$ref);
         if ($refPath === pointer.path && !isRootPath(pathFromRoot)) {
             // The value is a reference to itself, so there's nothing to do.
@@ -280,10 +235,10 @@ function resolveIf$Ref(pointer, options, pathFromRoot) {
                 return false;
             }
             pointer.indirections += resolved.indirections + 1;
-            if (ref_js_1.default.isExtended$Ref(pointer.value)) {
+            if ($Ref.isExtended$Ref(pointer.value)) {
                 // This JSON reference "extends" the resolved value, rather than simply pointing to it.
                 // So the resolved path does NOT change.  Just the value does.
-                pointer.value = ref_js_1.default.dereference(pointer.value, resolved.value);
+                pointer.value = $Ref.dereference(pointer.value, resolved.value, options);
                 return false;
             }
             else {
@@ -297,7 +252,7 @@ function resolveIf$Ref(pointer, options, pathFromRoot) {
     }
     return undefined;
 }
-exports.default = Pointer;
+export default Pointer;
 /**
  * Sets the specified token value of the {@link Pointer#value}.
  *
@@ -319,12 +274,12 @@ function setValue(pointer, token, value) {
         }
     }
     else {
-        throw new errors_js_1.JSONParserError(`Error assigning $ref pointer "${pointer.path}". \nCannot set "${token}" of a non-object.`);
+        throw new JSONParserError(`Error assigning $ref pointer "${pointer.path}". \nCannot set "${token}" of a non-object.`);
     }
     return value;
 }
 function unwrapOrThrow(value) {
-    if ((0, errors_js_1.isHandledError)(value)) {
+    if (isHandledError(value)) {
         throw value;
     }
     return value;

package/dist/lib/ref.d.ts

@@ -2,7 +2,8 @@ import Pointer from "./pointer.js";
 import type { JSONParserError, MissingPointerError, ParserError, ResolverError } from "./util/errors.js";
 import type $Refs from "./refs.js";
 import type { ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
+import type { JSONSchema } from "./index.js";
+import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 export type $RefError = JSONParserError | ResolverError | ParserError | MissingPointerError;
 /**
  * This class represents a single JSON reference and its resolved value.
@@ -83,7 +84,7 @@ declare class $Ref<S extends object = JSONSchema, O extends ParserOptions<S> = P
      * @param path - The full path of the property to set, optionally with a JSON pointer in the hash
      * @param value - The value to assign
      */
-    set(path: string, value: any): void;
+    set(path: string, value: JSONSchema4Type | JSONSchema6Type | JSONSchema7Type): void;
     /**
      * Determines whether the given value is a JSON reference.
      *
@@ -174,8 +175,9 @@ declare class $Ref<S extends object = JSONSchema, O extends ParserOptions<S> = P
      *
      * @param $ref - The JSON reference object (the one with the "$ref" property)
      * @param resolvedValue - The resolved value, which can be any type
+     * @param options - The options
      * @returns - Returns the dereferenced value
      */
-    static dereference<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>($ref: $Ref<S, O>, resolvedValue: S): S;
+    static dereference<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>($ref: $Ref<S, O>, resolvedValue: S, options?: O): S;
 }
 export default $Ref;

package/dist/lib/ref.js

@@ -1,41 +1,6 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const pointer_js_1 = __importStar(require("./pointer.js"));
-const errors_js_1 = require("./util/errors.js");
-const url_js_1 = require("./util/url.js");
+import Pointer, { nullSymbol } from "./pointer.js";
+import { InvalidPointerError, isHandledError, normalizeError } from "./util/errors.js";
+import { safePointerToPath, stripHash, getHash } from "./util/url.js";
 /**
  * This class represents a single JSON reference and its resolved value.
  *
@@ -92,10 +57,10 @@ class $Ref {
         // but just in case something went wrong, normalizeError injects path if necessary
         // moreover, certain errors might point at the same spot, so filter them out to reduce noise
         if ("errors" in err && Array.isArray(err.errors)) {
-            this.errors.push(...err.errors.map(errors_js_1.normalizeError).filter(({ footprint }) => !existingErrors.includes(footprint)));
+            this.errors.push(...err.errors.map(normalizeError).filter(({ footprint }) => !existingErrors.includes(footprint)));
         }
         else if (!("footprint" in err) || !existingErrors.includes(err.footprint)) {
-            this.errors.push((0, errors_js_1.normalizeError)(err));
+            this.errors.push(normalizeError(err));
         }
     }
     /**
@@ -134,23 +99,23 @@ class $Ref {
      * @returns
      */
     resolve(path, options, friendlyPath, pathFromRoot) {
-        const pointer = new pointer_js_1.default(this, path, friendlyPath);
+        const pointer = new Pointer(this, path, friendlyPath);
         try {
             const resolved = pointer.resolve(this.value, options, pathFromRoot);
-            if (resolved.value === pointer_js_1.nullSymbol) {
+            if (resolved.value === nullSymbol) {
                 resolved.value = null;
             }
             return resolved;
         }
         catch (err) {
-            if (!options || !options.continueOnError || !(0, errors_js_1.isHandledError)(err)) {
+            if (!options || !options.continueOnError || !isHandledError(err)) {
                 throw err;
             }
             if (err.path === null) {
-                err.path = (0, url_js_1.safePointerToPath)((0, url_js_1.getHash)(pathFromRoot));
+                err.path = safePointerToPath(getHash(pathFromRoot));
             }
-            if (err instanceof errors_js_1.InvalidPointerError) {
-                err.source = decodeURI((0, url_js_1.stripHash)(pathFromRoot));
+            if (err instanceof InvalidPointerError) {
+                err.source = decodeURI(stripHash(pathFromRoot));
             }
             this.addError(err);
             return null;
@@ -164,9 +129,9 @@ class $Ref {
      * @param value - The value to assign
      */
     set(path, value) {
-        const pointer = new pointer_js_1.default(this, path);
+        const pointer = new Pointer(this, path);
         this.value = pointer.set(this.value, value);
-        if (this.value === pointer_js_1.nullSymbol) {
+        if (this.value === nullSymbol) {
             this.value = null;
         }
     }
@@ -280,9 +245,10 @@ class $Ref {
      *
      * @param $ref - The JSON reference object (the one with the "$ref" property)
      * @param resolvedValue - The resolved value, which can be any type
+     * @param options - The options
      * @returns - Returns the dereferenced value
      */
-    static dereference($ref, resolvedValue) {
+    static dereference($ref, resolvedValue, options) {
         if (resolvedValue && typeof resolvedValue === "object" && $Ref.isExtended$Ref($ref)) {
             const merged = {};
             for (const key of Object.keys($ref)) {
@@ -291,11 +257,23 @@ class $Ref {
                     merged[key] = $ref[key];
                 }
             }
-            for (const key of Object.keys(resolvedValue)) {
+            const mergeKeys = options?.dereference?.mergeKeys ?? true;
+            for (const _key of Object.keys(resolvedValue)) {
+                const key = _key;
                 if (!(key in merged)) {
-                    // @ts-expect-error TS(7053): Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
                     merged[key] = resolvedValue[key];
                 }
+                else {
+                    // TODO: this behavior should be configurable from options on the CLI
+                    // Key is already in merged, so we should merge them if both are objects
+                    if (mergeKeys &&
+                        typeof merged[key] === "object" &&
+                        merged[key] !== null &&
+                        typeof resolvedValue[key] === "object" &&
+                        resolvedValue[key] !== null) {
+                        merged[key] = deepMerge(resolvedValue[key], merged[key]);
+                    }
+                }
             }
             return merged;
         }
@@ -305,4 +283,34 @@ class $Ref {
         }
     }
 }
-exports.default = $Ref;
+function deepMerge(target, source) {
+    //return {...target, ...source};
+    // If either isn't an object, just return source (overwrite)
+    if (typeof target !== "object" || target === null) {
+        return source;
+    }
+    if (typeof source !== "object" || source === null) {
+        return source;
+    }
+    // Ensure we don't mutate target directly
+    const output = Array.isArray(target) ? [...target] : { ...target };
+    for (const key of Object.keys(source)) {
+        // @ts-expect-error
+        if (Array.isArray(source[key])) {
+            // If it's an array, replace entirely (you can customize this to concat instead)
+            // @ts-expect-error
+            output[key] = [...source[key]];
+            // @ts-expect-error
+        }
+        else if (typeof source[key] === "object" && source[key] !== null) {
+            // @ts-expect-error
+            output[key] = deepMerge(target[key], source[key]);
+        }
+        else {
+            // @ts-expect-error
+            output[key] = source[key];
+        }
+    }
+    return output;
+}
+export default $Ref;

package/dist/lib/refs.d.ts

@@ -1,7 +1,7 @@
 import $Ref from "./ref.js";
 import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 import type { ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
+import type { JSONSchema } from "./index.js";
 interface $RefsMap<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
     [url: string]: $Ref<S, O>;
 }