@ptolemy2002/rgx 13.9.0 → 13.10.0

package/dist/class/base.d.ts

@@ -1,4 +1,4 @@
-import { RGXConvertibleToken, RGXJSONClassToken, RGXJSONValue, RGXToken, ValidRegexFlags, ValidRegexString } from "../types";
+import { RGXConvertibleToken, RGXJSONClassToken, RGXJSONObjectToken, RGXJSONValue, RGXToken, ValidRegexFlags, ValidRegexString } from "../types";
 import { RGXTokenCollectionInput } from "../collection";
 import { ResolveRGXTokenOptions } from "../resolve";
 import { CloneDepth } from "@ptolemy2002/immutability-utils";
@@ -11,7 +11,7 @@ import type { RGXExclusionToken } from "./exclusion";
 export declare abstract class RGXClassToken implements RGXConvertibleToken {
     abstract toRgx(): RGXToken;
     abstract clone(depth?: CloneDepth): ThisType<this>;
-    toJSON(): RGXJSONClassToken;
+    toJSON(): RGXJSONObjectToken;
     static validateJSONArgs(args: RGXJSONValue[]): boolean | string;
     static fromJSON(json: RGXJSONClassToken): RGXClassToken;
     rgxAcceptInsertion(tokens: RGXToken[], flags: ValidRegexFlags): string | boolean;

package/dist/class/base.js

@@ -1,21 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RGXClassToken = void 0;
+const types_1 = require("../types");
 const errors_1 = require("../errors");
 const resolve_1 = require("../resolve");
 class RGXClassToken {
-    // Subclasses are expected to override toJSON and both static methods below. They are not marked abstract
-    // (so existing subclasses keep compiling), so they throw RGXNotImplementedError by default.
-    // toJSON must return a JSON class token whose args, when given to the registered constructor for the
-    // class, reconstruct an equivalent token.
+    // Subclasses that want lossless JSON serialization (i.e. to be part of the JSON class registry) should override
+    // toJSON and both static methods below. They are not marked abstract, since subclasses that are not registered
+    // remain serializable through the toJSON fallback. The static methods throw RGXNotImplementedError by default.
+    // When overridden, toJSON must return a JSON class token whose args, when given to the registered constructor for the
+    // class, reconstruct an equivalent token. By default, it falls back to resolving the token into a
+    // JSON literal token, the same way plain convertible tokens are handled by rgxTokenToJSON. This is lossy.
     toJSON() {
-        throw new errors_1.RGXNotImplementedError(`${this.constructor.name}.toJSON()`, 'subclasses must override this method.');
+        return { [types_1.RGX_JSON_FLAG]: true, source: (0, resolve_1.resolveRGXToken)(this, { groupWrap: false }) };
     }
     static validateJSONArgs(args) {
-        throw new errors_1.RGXNotImplementedError('RGXClassToken.validateJSONArgs(args)', 'subclasses must override this static method.');
+        throw new errors_1.RGXNotImplementedError('RGXClassToken.validateJSONArgs(args)', 'subclasses must override this static method in order to be registered in the JSON class registry.');
     }
     static fromJSON(json) {
-        throw new errors_1.RGXNotImplementedError('RGXClassToken.fromJSON(json)', 'subclasses must override this static method.');
+        throw new errors_1.RGXNotImplementedError('RGXClassToken.fromJSON(json)', 'subclasses must override this static method in order to be registered in the JSON class registry.');
     }
     rgxAcceptInsertion(tokens, flags) {
         return true;

package/dist/json.js

@@ -153,13 +153,14 @@ function rgxTokenToJSON(token, { resolveConvertible = true } = {}) {
         tg.assertRGXJSONObjectToken(token);
         return token;
     }
-    if (class_1.RGXClassToken.check(token))
+    if (class_1.RGXClassToken.check(token) && token.toJSON !== class_1.RGXClassToken.prototype.toJSON)
         return token.toJSON();
     if (collection_1.RGXTokenCollection.check(token))
         return (0, class_1.toRGXClassToken)(token).toJSON();
+    // Class tokens without a custom toJSON fall through to here, since they are also convertible tokens.
     if (tg.isRGXConvertibleToken(token, false)) {
         if (!resolveConvertible) {
-            throw new e.RGXNotJSONSerializableError("Cannot convert token to JSON", token, "Convertible tokens that are not class tokens can only be converted by resolving them, but resolveConvertible is false.");
+            throw new e.RGXNotJSONSerializableError("Cannot convert token to JSON", token, "Convertible tokens that are not class tokens with a custom toJSON method can only be converted by resolving them, but resolveConvertible is false.");
         }
         return createRGXJSONLiteralToken((0, resolve_1.resolveRGXToken)(token, { groupWrap: false }));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/rgx",
-    "version": "13.9.0",
+    "version": "13.10.0",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",