@apidevtools/json-schema-ref-parser 11.9.2 → 12.0.0

package/dist/lib/dereference.js

@@ -76,11 +76,7 @@ function crawl(obj, path, pathFromRoot, parents, processedObjects, dereferencedC
         value: obj,
         circular: false,
     };
-    if (options && options.timeoutMs) {
-        if (Date.now() - startTime > options.timeoutMs) {
-            throw new errors_1.TimeoutError(options.timeoutMs);
-        }
-    }
+    checkDereferenceTimeout(startTime, options);
     const derefOptions = (options.dereference || {});
     const isExcludedPath = derefOptions.excludedPathMatcher || (() => false);
     if (derefOptions?.circular === "ignore" || !processedObjects.has(obj)) {
@@ -94,6 +90,7 @@ function crawl(obj, path, pathFromRoot, parents, processedObjects, dereferencedC
             }
             else {
                 for (const key of Object.keys(obj)) {
+                    checkDereferenceTimeout(startTime, options);
                     const keyPath = pointer_js_1.default.join(path, key);
                     const keyPathFromRoot = pointer_js_1.default.join(pathFromRoot, key);
                     if (isExcludedPath(keyPathFromRoot)) {
@@ -171,7 +168,15 @@ function dereference$Ref($ref, path, pathFromRoot, parents, processedObjects, de
     const shouldResolveOnCwd = isExternalRef && options?.dereference?.externalReferenceResolution === "root";
     const $refPath = url.resolve(shouldResolveOnCwd ? url.cwd() : path, $ref.$ref);
     const cache = dereferencedCache.get($refPath);
-    if (cache && !cache.circular) {
+    if (cache) {
+        // If the object we found is circular we can immediately return it because it would have been
+        // cached with everything we need already and we don't need to re-process anything inside it.
+        //
+        // If the cached object however is _not_ circular and there are additional keys alongside our
+        // `$ref` pointer here we should merge them back in and return that.
+        if (cache.circular) {
+            return cache;
+        }
         const refKeys = Object.keys($ref);
         if (refKeys.length > 1) {
             const extraKeys = {};
@@ -229,6 +234,19 @@ function dereference$Ref($ref, path, pathFromRoot, parents, processedObjects, de
     }
     return dereferencedObject;
 }
+/**
+ * Check if we've run past our allowed timeout and throw an error if we have.
+ *
+ * @param startTime - The time when the dereferencing started.
+ * @param options
+ */
+function checkDereferenceTimeout(startTime, options) {
+    if (options && options.timeoutMs) {
+        if (Date.now() - startTime > options.timeoutMs) {
+            throw new errors_1.TimeoutError(options.timeoutMs);
+        }
+    }
+}
 /**
  * Called when a circular reference is found.
  * It sets the {@link $Refs#circular} flag, executes the options.dereference.onCircular callback,

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";
+export declare const nullSymbol: unique symbol;
 /**
  * This class represents a single JSON pointer and its resolved value.
  *

package/dist/lib/pointer.js

@@ -36,9 +36,11 @@ 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');
 const slashes = /\//g;
 const tildes = /~/g;
 const escapedSlash = /~1/g;
@@ -110,6 +112,15 @@ class Pointer {
                 if (didFindSubstringSlashMatch) {
                     continue;
                 }
+                // If the token we're looking for ended up not containing any slashes but is
+                // 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`
+                    // value and our expected `null` value.
+                    this.value = exports.nullSymbol;
+                    continue;
+                }
                 this.value = null;
                 const path = this.$ref.path || "";
                 const targetRef = this.path.replace(path, "");

package/dist/lib/ref.js

@@ -1,9 +1,39 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+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 = __importDefault(require("./pointer.js"));
+const pointer_js_1 = __importStar(require("./pointer.js"));
 const errors_js_1 = require("./util/errors.js");
 const url_js_1 = require("./util/url.js");
 /**
@@ -78,7 +108,11 @@ class $Ref {
     resolve(path, options, friendlyPath, pathFromRoot) {
         const pointer = new pointer_js_1.default(this, path, friendlyPath);
         try {
-            return pointer.resolve(this.value, options, pathFromRoot);
+            const resolved = pointer.resolve(this.value, options, pathFromRoot);
+            if (resolved.value === pointer_js_1.nullSymbol) {
+                resolved.value = null;
+            }
+            return resolved;
         }
         catch (err) {
             if (!options || !options.continueOnError || !(0, errors_js_1.isHandledError)(err)) {
@@ -104,6 +138,9 @@ class $Ref {
     set(path, value) {
         const pointer = new pointer_js_1.default(this, path);
         this.value = pointer.set(this.value, value);
+        if (this.value === pointer_js_1.nullSymbol) {
+            this.value = null;
+        }
     }
     /**
      * Determines whether the given value is a JSON reference.

package/lib/dereference.ts

@@ -69,11 +69,8 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
     circular: false,
   };
 
-  if (options && options.timeoutMs) {
-    if (Date.now() - startTime > options.timeoutMs) {
-      throw new TimeoutError(options.timeoutMs);
-    }
-  }
+  checkDereferenceTimeout<S, O>(startTime, options);
+
   const derefOptions = (options.dereference || {}) as DereferenceOptions;
   const isExcludedPath = derefOptions.excludedPathMatcher || (() => false);
 
@@ -98,6 +95,8 @@ function crawl<S extends object = JSONSchema, O extends ParserOptions<S> = Parse
         result.value = dereferenced.value;
       } else {
         for (const key of Object.keys(obj)) {
+          checkDereferenceTimeout<S, O>(startTime, options);
+
           const keyPath = Pointer.join(path, key);
           const keyPathFromRoot = Pointer.join(pathFromRoot, key);
 
@@ -214,7 +213,17 @@ function dereference$Ref<S extends object = JSONSchema, O extends ParserOptions<
   const $refPath = url.resolve(shouldResolveOnCwd ? url.cwd() : path, $ref.$ref);
 
   const cache = dereferencedCache.get($refPath);
-  if (cache && !cache.circular) {
+
+  if (cache) {
+    // If the object we found is circular we can immediately return it because it would have been
+    // cached with everything we need already and we don't need to re-process anything inside it.
+    //
+    // If the cached object however is _not_ circular and there are additional keys alongside our
+    // `$ref` pointer here we should merge them back in and return that.
+    if (cache.circular) {
+      return cache;
+    }
+
     const refKeys = Object.keys($ref);
     if (refKeys.length > 1) {
       const extraKeys = {};
@@ -294,6 +303,23 @@ function dereference$Ref<S extends object = JSONSchema, O extends ParserOptions<
   return dereferencedObject;
 }
 
+/**
+ * Check if we've run past our allowed timeout and throw an error if we have.
+ *
+ * @param startTime - The time when the dereferencing started.
+ * @param options
+ */
+function checkDereferenceTimeout<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  startTime: number,
+  options: O,
+): void {
+  if (options && options.timeoutMs) {
+    if (Date.now() - startTime > options.timeoutMs) {
+      throw new TimeoutError(options.timeoutMs);
+    }
+  }
+}
+
 /**
  * Called when a circular reference is found.
  * It sets the {@link $Refs#circular} flag, executes the options.dereference.onCircular callback,

package/lib/pointer.ts

@@ -5,6 +5,8 @@ import * as url from "./util/url.js";
 import { JSONParserError, InvalidPointerError, MissingPointerError, isHandledError } from "./util/errors.js";
 import type { JSONSchema } from "./types";
 
+export const nullSymbol = Symbol('null');
+
 const slashes = /\//g;
 const tildes = /~/g;
 const escapedSlash = /~1/g;
@@ -121,6 +123,16 @@ class Pointer<S extends object = JSONSchema, O extends ParserOptions<S> = Parser
           continue;
         }
 
+        // If the token we're looking for ended up not containing any slashes but is
+        // 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`
+          // value and our expected `null` value.
+          this.value = nullSymbol;
+          continue;
+        }
+
         this.value = null;
 
         const path = this.$ref.path || "";

package/lib/ref.ts

@@ -1,4 +1,4 @@
-import Pointer from "./pointer.js";
+import Pointer, { nullSymbol } from "./pointer.js";
 import type { JSONParserError, MissingPointerError, ParserError, ResolverError } from "./util/errors.js";
 import { InvalidPointerError, isHandledError, normalizeError } from "./util/errors.js";
 import { safePointerToPath, stripHash, getHash } from "./util/url.js";
@@ -119,7 +119,12 @@ class $Ref<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOpt
   resolve(path: string, options?: O, friendlyPath?: string, pathFromRoot?: string) {
     const pointer = new Pointer<S, O>(this, path, friendlyPath);
     try {
-      return pointer.resolve(this.value, options, pathFromRoot);
+      const resolved = pointer.resolve(this.value, options, pathFromRoot);
+      if (resolved.value === nullSymbol) {
+        resolved.value = null;
+      }
+
+      return resolved;
     } catch (err: any) {
       if (!options || !options.continueOnError || !isHandledError(err)) {
         throw err;
@@ -148,6 +153,9 @@ class $Ref<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOpt
   set(path: string, value: any) {
     const pointer = new Pointer(this, path);
     this.value = pointer.set(this.value, value);
+    if (this.value === nullSymbol) {
+      this.value = null;
+    }
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "11.9.2",
+  "version": "12.0.0",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "scripts": {
     "prepublishOnly": "yarn build",