feat(cloning): add option to clone input schema, add notice to readme

Author: jonluca

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);
 }

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,

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,

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;
 };