@json-schema-tools/referencer 1.0.6 → 1.1.1

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

@@ -18,7 +18,8 @@ exports.NoTitleError = exports.stringifyCircular = void 0;
 var traverse_1 = __importDefault(require("@json-schema-tools/traverse"));
 var deleteAllProps = function (o) {
     Object.keys(o)
-        .forEach(function (k) { delete o[k]; });
+        .forEach(function (k) { if (k !== 'title')
+        delete o[k]; });
 };
 var stringifyCircular = function (obj) {
     var cache = [];
@@ -64,6 +65,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,9 +83,10 @@ exports.NoTitleError = NoTitleError;
  * @category SchemaImprover
  *
  */
-function referencer(s) {
+function referencer(s, options) {
+    if (options === void 0) { options = defaultReferencerOptions; }
     var definitions = {};
-    (0, 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) {
@@ -97,7 +102,6 @@ function referencer(s) {
                 return { $ref: "#/definitions/".concat(s.title) };
             }
             definitions[subSchema.title] = __assign({}, subSchema);
-            deleteAllProps(subSchema);
             subSchema.$ref = "#/definitions/".concat(subSchema.title);
             return subSchema;
         }
@@ -122,10 +126,13 @@ function referencer(s) {
             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.6",
+  "version": "1.1.1",
   "main": "build/index.js",
   "publishConfig": {
     "access": "public"
@@ -26,16 +26,19 @@
     "!build/**/*.test.*"
   ],
   "devDependencies": {
+    "@json-schema-tools/dereferencer": "^1.6.2",
     "@json-schema-tools/meta-schema": "^1.7.0",
+    "@json-schema-tools/titleizer": "^1.0.8",
+    "@json-schema-tools/transpiler": "^1.10.3",
     "@types/jest": "^29.2.0",
-    "@types/node": "^18.11.7",
+    "@types/node": "^20.12.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"
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.4"
   },
   "dependencies": {
     "@json-schema-tools/traverse": "^1.10.1"