@ptolemy2002/rgx 2.8.0 → 2.9.0

package/README.md

@@ -140,6 +140,8 @@ Standard array properties and methods like `length`, `push`, `pop`, etc. are imp
 ### RGXClassToken (abstract)
 An abstract base class for creating custom RGX token classes. Subclasses must implement the `toRgx()` method, which returns any valid `RGXToken` (including other convertible tokens, allowing for recursive structures).
 
+Two type guards are provided for this class: `isRgxClassToken` to check if a value is an instance of `RGXClassToken`, and `assertRgxClassToken` to assert that a value is an instance of `RGXClassToken` (throwing an `InvalidTokenError` if the assertion fails). Both of these take a single parameter of type `unknown` for the value.
+
 #### Abstract Methods
 - `toRgx() => RGXToken`: Must be implemented by subclasses to return the token's regex representation as any valid RGX token (native, literal, convertible, or array of tokens).
 
@@ -153,7 +155,7 @@ An abstract base class for creating custom RGX token classes. Subclasses must im
 ### RGXClassUnionToken extends RGXClassToken
 A class representing a union (alternation) of RGX tokens. This is typically created via the `or()` method on `RGXClassToken`, but can also be instantiated directly.
 
-A function `rgxClassUnion` is provided with the same parameters as this class' constructor, for easier instantiation without needing to use the `new` keyword.
+A function `rgxClassUnion` is provided with the same parameters as this class' constructor, for easier instantiation without needing to use the `new` keyword. Two type guards are provided for this class: `isRgxClassUnionToken` to check if a value is an instance of `RGXClassUnionToken`, and `assertRgxClassUnionToken` to assert that a value is an instance of `RGXClassUnionToken` (throwing an `InvalidTokenError` if the assertion fails). Both of these take a single parameter of type `unknown` for the value.
 
 #### Constructor
 ```typescript

package/dist/class/base.d.ts

@@ -7,3 +7,5 @@ export declare abstract class RGXClassToken {
     or(...others: RGXTokenCollectionInput[]): RGXClassUnionToken;
     resolve(): ValidRegexString;
 }
+export declare const isRgxClassToken: (value: unknown) => value is RGXClassToken;
+export declare const assertRgxClassToken: (value: unknown) => asserts value is RGXClassToken;

package/dist/class/base.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RGXClassToken = void 0;
+exports.assertRgxClassToken = exports.isRgxClassToken = exports.RGXClassToken = void 0;
 const errors_1 = require("../errors");
 const resolve_1 = require("../resolve");
 class RGXClassToken {
@@ -15,3 +15,13 @@ class RGXClassToken {
     }
 }
 exports.RGXClassToken = RGXClassToken;
+// The createClassGuard function only accepts non-abstract classes, so we 
+// manually define the guard and assertion functions for RGXClassToken here.
+const isRgxClassToken = (value) => value instanceof RGXClassToken;
+exports.isRgxClassToken = isRgxClassToken;
+const assertRgxClassToken = (value) => {
+    if (!(value instanceof RGXClassToken)) {
+        throw new errors_1.RGXInvalidTokenError("Invalid token type", { type: "custom", values: ["instance of RGXClassToken"] }, value);
+    }
+};
+exports.assertRgxClassToken = assertRgxClassToken;

package/dist/class/union.d.ts

@@ -14,3 +14,5 @@ export declare class RGXClassUnionToken extends RGXClassToken {
 export declare function expandRgxUnionTokens(...tokens: RGXTokenCollectionInput[]): RGXTokenCollection;
 export declare function removeRgxUnionDuplicates(...tokens: RGXTokenCollectionInput[]): RGXTokenCollection;
 export declare const rgxClassUnion: (tokens?: RGXTokenCollectionInput) => RGXClassUnionToken;
+export declare const isRgxClassUnionToken: (value: unknown) => value is RGXClassUnionToken;
+export declare const assertRgxClassUnionToken: (value: unknown) => asserts value is RGXClassUnionToken;

package/dist/class/union.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rgxClassUnion = exports.RGXClassUnionToken = void 0;
+exports.assertRgxClassUnionToken = exports.isRgxClassUnionToken = exports.rgxClassUnion = exports.RGXClassUnionToken = void 0;
 exports.expandRgxUnionTokens = expandRgxUnionTokens;
 exports.removeRgxUnionDuplicates = removeRgxUnionDuplicates;
 const internal_1 = require("../internal");
@@ -87,3 +87,5 @@ function removeRgxUnionDuplicates(...tokens) {
     return new collection_1.RGXTokenCollection(uniqueTokens, 'union');
 }
 exports.rgxClassUnion = (0, internal_1.createConstructFunction)(RGXClassUnionToken);
+exports.isRgxClassUnionToken = (0, internal_1.createClassGuardFunction)(RGXClassUnionToken);
+exports.assertRgxClassUnionToken = (0, internal_1.createAssertClassGuardFunction)(RGXClassUnionToken);

package/dist/errors/invalidToken.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RGXInvalidTokenError = void 0;
 const errors_1 = require("./");
 const js_utils_1 = require("@ptolemy2002/js-utils");
+const class_1 = require("../class");
 const tokenExpectationMap = {
     'no-op': ['null', 'undefined'],
     'literal': ['RegExp'],
@@ -44,7 +45,8 @@ class RGXInvalidTokenError extends errors_1.RGXError {
         this.setExpected(expected);
     }
     toString() {
-        return `${this.name}: ${this.message}; Expected: ${this.expected}; Got: ${JSON.stringify(this.got)}`;
+        const gotString = (0, class_1.isRgxClassToken)(this.got) ? `instance of ${this.got.constructor.name}` : JSON.stringify(this.got);
+        return `${this.name}: ${this.message}; Expected: ${this.expected}; Got: [${gotString}]`;
     }
 }
 exports.RGXInvalidTokenError = RGXInvalidTokenError;

package/dist/internal/createClassGuardFunction.d.ts

@@ -0,0 +1,2 @@
+export declare function createClassGuardFunction<T extends new (...args: unknown[]) => unknown>(constructor: T): (value: unknown) => value is InstanceType<T>;
+export declare function createAssertClassGuardFunction<T extends new (...args: unknown[]) => unknown>(constructor: T): (value: unknown) => asserts value is InstanceType<T>;

package/dist/internal/createClassGuardFunction.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClassGuardFunction = createClassGuardFunction;
+exports.createAssertClassGuardFunction = createAssertClassGuardFunction;
+const errors_1 = require("../errors");
+function createClassGuardFunction(constructor) {
+    return (value) => value instanceof constructor;
+}
+function createAssertClassGuardFunction(constructor) {
+    return (value) => {
+        if (!(value instanceof constructor)) {
+            throw new errors_1.RGXInvalidTokenError("Invalid token type", { type: "custom", values: [`instance of ${constructor.name}`] }, value);
+        }
+    };
+}

package/dist/internal/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./createConstructFunction";
+export * from "./createClassGuardFunction";
 export * from "./taggedTemplateToArray";

package/dist/internal/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./createConstructFunction"), exports);
+__exportStar(require("./createClassGuardFunction"), exports);
 __exportStar(require("./taggedTemplateToArray"), exports);

package/package.json

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