@json-schema-tools/referencer 1.0.5 → 1.1.0

package/README.md

@@ -17,6 +17,7 @@ The input schema, as well as all of its subschemas must have titles. Their title
 Features:
  - Cyclic schemas become cyclic references
  - Completely synchronous
+ - immutable by default, option to mutate in place.
  - No external dependencies
  - Fully typed against the generated [meta-schema typings](https://github.com/json-schema-tools/meta-schema/)
  - magically makes your json schema smaller.

package/build/index.d.ts

@@ -5,6 +5,15 @@ export declare class NoTitleError implements Error {
     message: string;
     constructor(schema: JSONSchema, parentSchema: JSONSchema);
 }
+/**
+ * Options that can be passed into the Referencer.
+ */
+export interface ReferencerOptions {
+    /**
+     * If true, the schema passed in will be referenced in-place, mutating the original. Default is false.
+     */
+    mutate?: boolean;
+}
 /**
  * Returns the schema where all subschemas have been replaced with $refs and added to definitions.
  *
@@ -20,4 +29,4 @@ export declare class NoTitleError implements Error {
  * @category SchemaImprover
  *
  */
-export default function referencer(s: JSONSchema): JSONSchema;
+export default function referencer(s: JSONSchema, options?: ReferencerOptions): JSONSchema;

package/build/index.js

@@ -25,7 +25,7 @@ var stringifyCircular = function (obj) {
     return JSON.stringify(obj, function (key, value) {
         if (typeof value === "object" && value !== null) {
             if (cache.indexOf(value) !== -1) {
-                return "[Circular: " + (value.title ? value.title : "NoTitle") + "]";
+                return "[Circular: ".concat(value.title ? value.title : "NoTitle", "]");
             }
             cache.push(value);
         }
@@ -42,13 +42,13 @@ var NoTitleError = /** @class */ (function () {
             schemaStr = JSON.stringify(schema);
         }
         catch (e) {
-            schemaStr = exports.stringifyCircular(schema);
+            schemaStr = (0, exports.stringifyCircular)(schema);
         }
         try {
             parentSchemaStr = JSON.stringify(parentSchema);
         }
         catch (e) {
-            parentSchemaStr = exports.stringifyCircular(parentSchema);
+            parentSchemaStr = (0, exports.stringifyCircular)(parentSchema);
         }
         this.message = [
             "Title is required on subschemas.",
@@ -64,6 +64,9 @@ var NoTitleError = /** @class */ (function () {
     return NoTitleError;
 }());
 exports.NoTitleError = NoTitleError;
+var defaultReferencerOptions = {
+    mutate: false,
+};
 /**
  * Returns the schema where all subschemas have been replaced with $refs and added to definitions.
  *
@@ -79,26 +82,27 @@ exports.NoTitleError = NoTitleError;
  * @category SchemaImprover
  *
  */
-function referencer(s) {
+function referencer(s, options) {
+    if (options === void 0) { options = defaultReferencerOptions; }
     var definitions = {};
-    traverse_1.default(s, function (subSchema, isRootCycle) {
+    var newS = (0, traverse_1.default)(s, function (subSchema, isRootCycle) {
         var t = "";
         if (isRootCycle && subSchema !== true && subSchema !== false) {
             if (subSchema.$ref) {
                 var title = subSchema.$ref.replace("#/definitions/", "");
                 var hasDefForRef = definitions[title];
                 if (hasDefForRef === undefined) {
-                    throw new Error("Encountered unknown $ref: " + subSchema.$ref);
+                    throw new Error("Encountered unknown $ref: ".concat(subSchema.$ref));
                 }
                 return subSchema;
             }
             if (subSchema === s) {
                 definitions[s.title] = { $ref: "#" };
-                return { $ref: "#/definitions/" + s.title };
+                return { $ref: "#/definitions/".concat(s.title) };
             }
             definitions[subSchema.title] = __assign({}, subSchema);
             deleteAllProps(subSchema);
-            subSchema.$ref = "#/definitions/" + subSchema.title;
+            subSchema.$ref = "#/definitions/".concat(subSchema.title);
             return subSchema;
         }
         if (subSchema === true) {
@@ -119,13 +123,16 @@ function referencer(s) {
             t = subSchema.title;
             definitions[t] = __assign({}, subSchema);
             deleteAllProps(subSchema);
-            subSchema.$ref = "#/definitions/" + t;
+            subSchema.$ref = "#/definitions/".concat(t);
         }
         return subSchema;
-    }, { mutable: true, skipFirstMutation: true });
-    if (typeof s === "object" && Object.keys(definitions).length > 0) {
-        s.definitions = __assign(__assign({}, s.definitions), definitions);
+    }, { mutable: options.mutate, skipFirstMutation: true });
+    if (options.mutate === true) {
+        newS = s;
+    }
+    if (typeof newS === "object" && Object.keys(definitions).length > 0) {
+        newS.definitions = __assign(__assign({}, newS.definitions), definitions);
     }
-    return s;
+    return newS;
 }
 exports.default = referencer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@json-schema-tools/referencer",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "main": "build/index.js",
   "publishConfig": {
     "access": "public"
@@ -26,19 +26,19 @@
     "!build/**/*.test.*"
   ],
   "devDependencies": {
-    "@json-schema-tools/meta-schema": "^1.6.18",
-    "@types/jest": "^26.0.23",
-    "@types/node": "^15.12.2",
-    "@typescript-eslint/eslint-plugin": "^4.26.1",
-    "@typescript-eslint/parser": "^4.26.1",
-    "eslint": "^7.28.0",
-    "jest": "^26.6.3",
-    "ts-jest": "^26.5.6",
-    "typedoc": "^0.21.0",
-    "typescript": "4.2.4"
+    "@json-schema-tools/meta-schema": "^1.7.0",
+    "@types/jest": "^29.2.0",
+    "@types/node": "^18.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "eslint": "^8.26.0",
+    "jest": "^29.2.2",
+    "ts-jest": "^29.0.3",
+    "typedoc": "^0.23.18",
+    "typescript": "^4.8.4"
   },
   "dependencies": {
-    "@json-schema-tools/traverse": "^1.7.8"
+    "@json-schema-tools/traverse": "^1.10.1"
   },
   "homepage": "https://github.com/json-schema-tools/referencer#readme",
   "description": "Get a copy of a JSON Schema where all subschemas are turned into `$ref`s with corresponding definitions section."

package/CHANGELOG.md

@@ -1,53 +0,0 @@
-## [1.0.5](https://github.com/json-schema-tools/referencer/compare/1.0.4...1.0.5) (2021-06-24)
-
-
-### Bug Fixes
-
-* update to new meta-schema ([521cb6f](https://github.com/json-schema-tools/referencer/commit/521cb6fc253040d6dda4b9f657fe18697b9e8891))
-
-## [1.0.4](https://github.com/json-schema-tools/referencer/compare/1.0.3...1.0.4) (2021-06-08)
-
-
-### Bug Fixes
-
-* linting fixup ([04d6243](https://github.com/json-schema-tools/referencer/commit/04d62436e0e40348d4fe5dcc1d14901f4ebcdab2))
-* update deps ([7bfb05b](https://github.com/json-schema-tools/referencer/commit/7bfb05b7cee8ef07de40cd8187b437b20a25ff22))
-
-## [1.0.3](https://github.com/json-schema-tools/referencer/compare/1.0.2...1.0.3) (2020-11-03)
-
-
-### Bug Fixes
-
-* add docs ([a67a07f](https://github.com/json-schema-tools/referencer/commit/a67a07f1e7aa96e86edee05a2800092d5f8189cc))
-
-## [1.0.2](https://github.com/json-schema-tools/referencer/compare/1.0.1...1.0.2) (2020-10-23)
-
-
-### Bug Fixes
-
-* add funding ([606b55b](https://github.com/json-schema-tools/referencer/commit/606b55b4d2170c412aa7b3e5ba19098b98a8e1bd))
-
-## [1.0.1](https://github.com/json-schema-tools/referencer/compare/1.0.0...1.0.1) (2020-10-23)
-
-
-### Bug Fixes
-
-* add pristine items ([9f68961](https://github.com/json-schema-tools/referencer/commit/9f689612c9975b53eec21e7bf9b797a23611e88a))
-* lock node version ([7ee46e8](https://github.com/json-schema-tools/referencer/commit/7ee46e8dc5da95055eff24412d2870ccf8ae1c5e))
-* remove dependabot badge ([adb559f](https://github.com/json-schema-tools/referencer/commit/adb559f23701c0727ac77b850af1920ee0668512))
-* update all deps ([ecc2d58](https://github.com/json-schema-tools/referencer/commit/ecc2d584946d03ca981d8c9dbae1fdf6d54a1a23))
-* update eslint ([2862bcb](https://github.com/json-schema-tools/referencer/commit/2862bcbf5591fd7c8fbffd6f762cd5a6858504ff))
-* update readme ([a6702e6](https://github.com/json-schema-tools/referencer/commit/a6702e6d060a847eb6ca80763eb68b096807842e))
-
-# 1.0.0 (2020-08-29)
-
-
-### Bug Fixes
-
-* build stuff ([d669ace](https://github.com/json-schema-tools/referencer/commit/d669acee8ed69f659d78bad3ab3d6d080ca5bdaa))
-* tests working ([94f270e](https://github.com/json-schema-tools/referencer/commit/94f270e063cca68e4c0cc6790d749b685b3e4269))
-
-
-### Features
-
-* first ([cf7d97a](https://github.com/json-schema-tools/referencer/commit/cf7d97a694be116376e7eccdb1ae370af2affe58))