@apidevtools/json-schema-ref-parser 11.3.0 → 11.4.0

package/README.md

@@ -75,8 +75,13 @@ Example
 import $RefParser from "@apidevtools/json-schema-ref-parser";
 
 try {
-  let schema = await $RefParser.dereference(mySchema);
-  console.log(schema.definitions.person.properties.firstName);
+  await $RefParser.dereference(mySchema);
+  // note - by default, mySchema is modified in place, and the returned value is a reference to the same object
+  console.log(mySchema.definitions.person.properties.firstName);
+
+  // if you want to avoid modifying the original schema, you can disable the `mutateInputSchema` option
+  let clonedSchema = await $RefParser.dereference(mySchema, { mutateInputSchema: false });
+  console.log(clonedSchema.definitions.person.properties.firstName);
 } catch (err) {
   console.error(err);
 }

package/dist/lib/index.d.ts

@@ -1,9 +1,15 @@
 import $Refs from "./refs.js";
 import { JSONParserError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError } from "./util/errors.js";
 import type { ParserOptions } from "./options.js";
-import type { Plugin, $RefsCallback, JSONSchema, SchemaCallback, HTTPResolverOptions, FileInfo, ResolverOptions, JSONSchemaObject } from "./types/index.js";
-export { JSONSchemaObject, ResolverOptions, ParserError, UnmatchedResolverError, ResolverError, HTTPResolverOptions, FileInfo, UnmatchedParserError, ParserOptions, MissingPointerError, InvalidPointerError, JSONParserError, Plugin, JSONSchema, $RefsCallback, SchemaCallback, };
-export type RefParserSchema = string | JSONSchema;
+import type { $RefsCallback, JSONSchema, SchemaCallback } from "./types/index.js";
+export { JSONParserError };
+export { InvalidPointerError };
+export { MissingPointerError };
+export { ResolverError };
+export { ParserError };
+export { UnmatchedParserError };
+export { UnmatchedResolverError };
+type RefParserSchema = string | JSONSchema;
 /**
  * This class parses a JSON schema, builds a map of its JSON references and their resolved values,
  * and provides methods for traversing, manipulating, and dereferencing those references.

package/dist/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dereference = exports.bundle = exports.resolve = exports.parse = exports.$RefParser = exports.JSONParserError = exports.InvalidPointerError = exports.MissingPointerError = exports.UnmatchedParserError = exports.ResolverError = exports.UnmatchedResolverError = exports.ParserError = void 0;
+exports.dereference = exports.bundle = exports.resolve = exports.parse = exports.$RefParser = exports.UnmatchedResolverError = exports.UnmatchedParserError = exports.ParserError = exports.ResolverError = exports.MissingPointerError = exports.InvalidPointerError = exports.JSONParserError = void 0;
 const refs_js_1 = __importDefault(require("./refs.js"));
 const parse_js_1 = __importDefault(require("./parse.js"));
 const normalize_args_js_1 = __importDefault(require("./normalize-args.js"));

package/dist/lib/normalize-args.js

@@ -38,6 +38,10 @@ function normalizeArgs(_args) {
     catch (e) {
         console.log(e);
     }
+    if (!options.mutateInputSchema) {
+        // Make a deep clone of the schema, so that we don't alter the original object
+        schema = JSON.parse(JSON.stringify(schema));
+    }
     return {
         path,
         schema,

package/dist/lib/options.d.ts

@@ -77,6 +77,12 @@ interface $RefParserOptions {
          * Default: `relative`
          */
         externalReferenceResolution?: "relative" | "root";
+        /**
+         * Whether to clone the schema before dereferencing it.
+         * This is useful when you want to dereference the same schema multiple times, but you don't want to modify the original schema.
+         * Default: `true` due to mutating the input being the default behavior historically
+         */
+        mutateInputSchema?: boolean;
     };
 }
 export declare const getNewOptions: (options: DeepPartial<$RefParserOptions>) => $RefParserOptions;

package/dist/lib/options.js

@@ -70,6 +70,7 @@ const getDefaults = () => {
             excludedPathMatcher: () => false,
             referenceResolution: "relative",
         },
+        mutateInputSchema: true,
     };
     return defaults;
 };

package/dist/lib/parse.js

@@ -33,13 +33,20 @@ exports.default = parse;
  */
 async function parse(path, $refs, options) {
     // Remove the URL fragment, if any
-    path = url.stripHash(path);
+    const hashIndex = path.indexOf("#");
+    let hash = "";
+    if (hashIndex >= 0) {
+        hash = path.substring(hashIndex);
+        // Remove the URL fragment, if any
+        path = path.substring(0, hashIndex);
+    }
     // Add a new $Ref for this file, even though we don't have the value yet.
     // This ensures that we don't simultaneously read & parse the same file multiple times
     const $ref = $refs._add(path);
     // This "file object" will be passed to all resolvers and parsers.
     const file = {
         url: path,
+        hash,
         extension: url.getExtension(path),
     };
     // Read the file and then parse the data
@@ -111,7 +118,6 @@ async function readFile(file, options, $refs) {
  * The promise resolves with the parsed file contents and the parser that was used.
  */
 async function parseFile(file, options, $refs) {
-    // console.log('Parsing %s', file.url);
     // Find the parsers that can read this file type.
     // If none of the parsers are an exact match for this file, then we'll try ALL of them.
     // This handles situations where the file IS a supported type, just with an unknown extension.

package/dist/lib/pointer.d.ts

@@ -74,7 +74,7 @@ declare class Pointer {
      * @param [originalPath]
      * @returns
      */
-    static parse(path: string, originalPath?: string): any;
+    static parse(path: string, originalPath?: string): string[];
     /**
      * Creates a JSON pointer path, by joining one or more tokens to a base path.
      *

package/dist/lib/pointer.js

@@ -165,22 +165,22 @@ class Pointer {
      */
     static parse(path, originalPath) {
         // Get the JSON pointer from the path's hash
-        let pointer = url.getHash(path).substr(1);
+        const pointer = url.getHash(path).substring(1);
         // If there's no pointer, then there are no tokens,
         // so return an empty array
         if (!pointer) {
             return [];
         }
         // Split into an array
-        pointer = pointer.split("/");
+        const split = pointer.split("/");
         // Decode each part, according to RFC 6901
-        for (let i = 0; i < pointer.length; i++) {
-            pointer[i] = safeDecodeURIComponent(pointer[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
+        for (let i = 0; i < split.length; i++) {
+            split[i] = safeDecodeURIComponent(split[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
         }
-        if (pointer[0] !== "") {
-            throw new errors_js_1.InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
+        if (split[0] !== "") {
+            throw new errors_js_1.InvalidPointerError(split, originalPath === undefined ? path : originalPath);
         }
-        return pointer.slice(1);
+        return split.slice(1);
     }
     /**
      * Creates a JSON pointer path, by joining one or more tokens to a base path.

package/dist/lib/types/index.d.ts

@@ -99,6 +99,10 @@ export interface FileInfo {
      * The full URL of the file. This could be any type of URL, including "http://", "https://", "file://", "ftp://", "mongodb://", or even a local filesystem path (when running in Node.js).
      */
     url: string;
+    /**
+     * The hash (URL fragment) of the file URL, including the # symbol. If the URL doesn't have a hash, then this will be an empty string.
+     */
+    hash: string;
     /**
      * The lowercase file extension, such as ".json", ".yaml", ".txt", etc.
      */

package/dist/lib/util/url.d.ts

@@ -40,21 +40,21 @@ export declare function stripQuery(path: any): any;
  * @param path
  * @returns
  */
-export declare function getHash(path: any): any;
+export declare function getHash(path: undefined | string): string;
 /**
  * Removes the hash (URL fragment), if any, from the given path.
  *
  * @param path
  * @returns
  */
-export declare function stripHash(path: any): any;
+export declare function stripHash(path?: string | undefined): string;
 /**
  * Determines whether the given path is an HTTP(S) URL.
  *
  * @param path
  * @returns
  */
-export declare function isHttp(path: any): boolean;
+export declare function isHttp(path: string): boolean;
 /**
  * Determines whether the given path is a filesystem path.
  * This includes "file://" URLs.

package/dist/lib/util/url.js

@@ -52,12 +52,13 @@ exports.parse = parse;
 function resolve(from, to) {
     const fromUrl = new URL((0, convert_path_to_posix_1.default)(from), "resolve://");
     const resolvedUrl = new URL((0, convert_path_to_posix_1.default)(to), fromUrl);
+    const endSpaces = to.match(/(\s*)$/)?.[1] || "";
     if (resolvedUrl.protocol === "resolve:") {
         // `from` is a relative URL.
         const { pathname, search, hash } = resolvedUrl;
-        return pathname + search + hash;
+        return pathname + search + hash + endSpaces;
     }
-    return resolvedUrl.toString();
+    return resolvedUrl.toString() + endSpaces;
 }
 exports.resolve = resolve;
 /**
@@ -129,9 +130,12 @@ exports.stripQuery = stripQuery;
  * @returns
  */
 function getHash(path) {
+    if (!path) {
+        return "#";
+    }
     const hashIndex = path.indexOf("#");
     if (hashIndex >= 0) {
-        return path.substr(hashIndex);
+        return path.substring(hashIndex);
     }
     return "#";
 }
@@ -143,9 +147,12 @@ exports.getHash = getHash;
  * @returns
  */
 function stripHash(path) {
+    if (!path) {
+        return "";
+    }
     const hashIndex = path.indexOf("#");
     if (hashIndex >= 0) {
-        path = path.substr(0, hashIndex);
+        path = path.substring(0, hashIndex);
     }
     return path;
 }

package/lib/index.ts

@@ -19,37 +19,17 @@ import {
 import { ono } from "@jsdevtools/ono";
 import maybe from "./util/maybe.js";
 import type { ParserOptions } from "./options.js";
-import type {
-  Plugin,
-  $RefsCallback,
-  JSONSchema,
-  SchemaCallback,
-  HTTPResolverOptions,
-  FileInfo,
-  ResolverOptions,
-  JSONSchemaObject,
-} from "./types/index.js";
+import type { $RefsCallback, JSONSchema, SchemaCallback } from "./types/index.js";
 
-export {
-  JSONSchemaObject,
-  ResolverOptions,
-  ParserError,
-  UnmatchedResolverError,
-  ResolverError,
-  HTTPResolverOptions,
-  FileInfo,
-  UnmatchedParserError,
-  ParserOptions,
-  MissingPointerError,
-  InvalidPointerError,
-  JSONParserError,
-  Plugin,
-  JSONSchema,
-  $RefsCallback,
-  SchemaCallback,
-};
+export { JSONParserError };
+export { InvalidPointerError };
+export { MissingPointerError };
+export { ResolverError };
+export { ParserError };
+export { UnmatchedParserError };
+export { UnmatchedResolverError };
 
-export type RefParserSchema = string | JSONSchema;
+type RefParserSchema = string | JSONSchema;
 
 /**
  * This class parses a JSON schema, builds a map of its JSON references and their resolved values,

package/lib/normalize-args.ts

@@ -39,6 +39,11 @@ function normalizeArgs(_args: Partial<IArguments>) {
     console.log(e);
   }
 
+  if (!options.mutateInputSchema) {
+    // Make a deep clone of the schema, so that we don't alter the original object
+    schema = JSON.parse(JSON.stringify(schema));
+  }
+
   return {
     path,
     schema,

package/lib/options.ts

@@ -91,6 +91,13 @@ interface $RefParserOptions {
      * Default: `relative`
      */
     externalReferenceResolution?: "relative" | "root";
+
+    /**
+     * Whether to clone the schema before dereferencing it.
+     * This is useful when you want to dereference the same schema multiple times, but you don't want to modify the original schema.
+     * Default: `true` due to mutating the input being the default behavior historically
+     */
+    mutateInputSchema?: boolean;
   };
 }
 
@@ -159,6 +166,8 @@ const getDefaults = () => {
       excludedPathMatcher: () => false,
       referenceResolution: "relative",
     },
+
+    mutateInputSchema: true,
   } as $RefParserOptions;
   return defaults;
 };

package/lib/parse.ts

@@ -19,7 +19,13 @@ export default parse;
  */
 async function parse(path: string, $refs: $Refs, options: Options) {
   // Remove the URL fragment, if any
-  path = url.stripHash(path);
+  const hashIndex = path.indexOf("#");
+  let hash = "";
+  if (hashIndex >= 0) {
+    hash = path.substring(hashIndex);
+    // Remove the URL fragment, if any
+    path = path.substring(0, hashIndex);
+  }
 
   // Add a new $Ref for this file, even though we don't have the value yet.
   // This ensures that we don't simultaneously read & parse the same file multiple times
@@ -28,6 +34,7 @@ async function parse(path: string, $refs: $Refs, options: Options) {
   // This "file object" will be passed to all resolvers and parsers.
   const file = {
     url: path,
+    hash,
     extension: url.getExtension(path),
   } as FileInfo;
 
@@ -103,8 +110,6 @@ async function readFile(file: FileInfo, options: Options, $refs: $Refs): Promise
  * The promise resolves with the parsed file contents and the parser that was used.
  */
 async function parseFile(file: FileInfo, options: Options, $refs: $Refs) {
-  // console.log('Parsing %s', file.url);
-
   // Find the parsers that can read this file type.
   // If none of the parsers are an exact match for this file, then we'll try ALL of them.
   // This handles situations where the file IS a supported type, just with an unknown extension.

package/lib/pointer.ts

@@ -190,9 +190,9 @@ class Pointer {
    * @param [originalPath]
    * @returns
    */
-  static parse(path: string, originalPath?: string) {
+  static parse(path: string, originalPath?: string): string[] {
     // Get the JSON pointer from the path's hash
-    let pointer = url.getHash(path).substr(1);
+    const pointer = url.getHash(path).substring(1);
 
     // If there's no pointer, then there are no tokens,
     // so return an empty array
@@ -201,18 +201,18 @@ class Pointer {
     }
 
     // Split into an array
-    pointer = pointer.split("/");
+    const split = pointer.split("/");
 
     // Decode each part, according to RFC 6901
-    for (let i = 0; i < pointer.length; i++) {
-      pointer[i] = safeDecodeURIComponent(pointer[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
+    for (let i = 0; i < split.length; i++) {
+      split[i] = safeDecodeURIComponent(split[i].replace(escapedSlash, "/").replace(escapedTilde, "~"));
     }
 
-    if (pointer[0] !== "") {
-      throw new InvalidPointerError(pointer, originalPath === undefined ? path : originalPath);
+    if (split[0] !== "") {
+      throw new InvalidPointerError(split, originalPath === undefined ? path : originalPath);
     }
 
-    return pointer.slice(1);
+    return split.slice(1);
   }
 
   /**

package/lib/types/index.ts

@@ -130,6 +130,11 @@ export interface FileInfo {
    */
   url: string;
 
+  /**
+   * The hash (URL fragment) of the file URL, including the # symbol. If the URL doesn't have a hash, then this will be an empty string.
+   */
+  hash: string;
+
   /**
    * The lowercase file extension, such as ".json", ".yaml", ".txt", etc.
    */

package/lib/util/url.ts

@@ -28,12 +28,13 @@ export const parse = (u: string | URL) => new URL(u);
 export function resolve(from: string, to: string) {
   const fromUrl = new URL(convertPathToPosix(from), "resolve://");
   const resolvedUrl = new URL(convertPathToPosix(to), fromUrl);
+  const endSpaces = to.match(/(\s*)$/)?.[1] || "";
   if (resolvedUrl.protocol === "resolve:") {
     // `from` is a relative URL.
     const { pathname, search, hash } = resolvedUrl;
-    return pathname + search + hash;
+    return pathname + search + hash + endSpaces;
   }
-  return resolvedUrl.toString();
+  return resolvedUrl.toString() + endSpaces;
 }
 
 /**
@@ -105,10 +106,13 @@ export function stripQuery(path: any) {
  * @param path
  * @returns
  */
-export function getHash(path: any) {
+export function getHash(path: undefined | string) {
+  if (!path) {
+    return "#";
+  }
   const hashIndex = path.indexOf("#");
   if (hashIndex >= 0) {
-    return path.substr(hashIndex);
+    return path.substring(hashIndex);
   }
   return "#";
 }
@@ -119,10 +123,13 @@ export function getHash(path: any) {
  * @param path
  * @returns
  */
-export function stripHash(path: any) {
+export function stripHash(path?: string | undefined) {
+  if (!path) {
+    return "";
+  }
   const hashIndex = path.indexOf("#");
   if (hashIndex >= 0) {
-    path = path.substr(0, hashIndex);
+    path = path.substring(0, hashIndex);
   }
   return path;
 }
@@ -133,7 +140,7 @@ export function stripHash(path: any) {
  * @param path
  * @returns
  */
-export function isHttp(path: any) {
+export function isHttp(path: string) {
   const protocol = getProtocol(path);
   if (protocol === "http" || protocol === "https") {
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apidevtools/json-schema-ref-parser",
-  "version": "11.3.0",
+  "version": "11.4.0",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "keywords": [
     "json",