@ptolemy2002/rgx 4.11.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -12,12 +12,12 @@ import { CloneDepth } from "@ptolemy2002/immutability-utils";
12
12
  type RGXNoOpToken = null | undefined;
13
13
  type RGXLiteralToken = RegExp;
14
14
  type RGXNativeToken = string | number | boolean | RGXNoOpToken;
15
- type RGXConvertibleToken = { toRgx: () => RGXToken, readonly rgxGroupWrap?: boolean };
15
+ type RGXConvertibleToken = { toRgx: () => RGXToken, readonly rgxGroupWrap?: boolean, readonly rgxIsGroup?: boolean, readonly rgxIsRepeatable?: boolean };
16
16
  type RGXToken = RGXNativeToken | RGXLiteralToken | RGXConvertibleToken | RGXToken[];
17
17
 
18
18
  type RGXClassTokenConstructor = new (...args: unknown[]) => RGXClassToken;
19
- type RGXGroupedToken = RGXToken[] | RGXLiteralToken | (RGXClassToken & { isGroup: true }) | RGXGroupedConvertibleToken;
20
- type RGXGroupedConvertibleToken = { toRgx: () => RGXGroupedToken, readonly rgxGroupWrap: true };
19
+ type RGXGroupedToken = RGXToken[] | RGXLiteralToken | RGXGroupedConvertibleToken;
20
+ type RGXGroupedConvertibleToken = (RGXConvertibleToken & { readonly rgxIsGroup: true }) | (Omit<RGXConvertibleToken, "toRGX"> & { toRgx: () => RGXGroupedToken, readonly rgxGroupWrap: true });
21
21
 
22
22
  const validRegexSymbol = Symbol('rgx.ValidRegex');
23
23
  type ValidRegexBrandSymbol = typeof validRegexSymbol;
@@ -39,7 +39,7 @@ type ValidIdentifier = Branded<string, [ValidIdentifierBrandSymbol]>;
39
39
 
40
40
  type RGXTokenType = 'no-op' | 'literal' | 'native' | 'convertible' | 'class' | RGXTokenType[];
41
41
  type RGXTokenTypeFlat = Exclude<RGXTokenType, RGXTokenType[]> | "array";
42
- type RGXTokenTypeGuardInput = RGXTokenTypeFlat | null | RGXClassTokenConstructor | typeof ExtRegExp | typeof RGXTokenCollection | RGXTokenTypeGuardInput[];
42
+ type RGXTokenTypeGuardInput = RGXTokenTypeFlat | null | RGXClassTokenConstructor | typeof RegExp | typeof ExtRegExp | typeof RGXTokenCollection | RGXTokenTypeGuardInput[];
43
43
  type RGXTokenFromType<T extends RGXTokenTypeGuardInput> =
44
44
  // Maps token type strings to their corresponding types, e.g.:
45
45
  // 'no-op' -> RGXNoOpToken, 'literal' -> RGXLiteralToken, etc.
@@ -279,15 +279,15 @@ An abstract base class for creating custom RGX token classes. Subclasses must im
279
279
  - `clone(depth: CloneDepth = "max") => RGXClassToken`: Must be implemented by subclasses to return a deep clone of the token instance. The `depth` parameter controls how deeply nested tokens are cloned: `0` for no clone, `1` for a shallow clone of the top-level token, any other number for that many levels down, and `"max"` (the default) for a full deep clone.
280
280
 
281
281
  #### Properties
282
- - `isGroup` (`boolean`): Returns `false` by default. Subclasses can override this to indicate whether the token represents a group.
283
- - `isRepeatable` (`boolean`): Returns `true` by default. Subclasses can override this to indicate that the token cannot be wrapped in an `RGXRepeatToken`. When `false`, attempting to set this token as the `token` property of an `RGXRepeatToken` (including via `repeat()` or `optional()`) will throw an `RGXNotSupportedError`.
282
+ - `rgxIsGroup` (`boolean`): Returns `false` by default. Subclasses can override this to indicate whether the token represents a group.
283
+ - `rgxIsRepeatable` (`boolean`): Returns `true` by default. Subclasses can override this to indicate that the token cannot be wrapped in an `RGXRepeatToken`. When `false`, attempting to set this token as the `token` property of an `RGXRepeatToken` (including via `repeat()` or `optional()`) will throw an `RGXNotSupportedError`.
284
284
  - `rgxGroupWrap` (`boolean`): Returns `true` by default. Controls whether the resolver wraps this token's resolved output in a non-capturing group. Subclasses can override this to prevent double-wrapping (e.g., when the token already wraps itself in a group).
285
285
 
286
286
  #### Methods
287
287
  - `or(...others: RGXTokenCollectionInput[]) => RGXClassUnionToken`: Creates an `RGXClassUnionToken` that represents a union (alternation) of this token with the provided others. If any of the `others` are `RGXClassUnionToken` instances, their tokens are flattened into the union rather than nested. If `this` is already an `RGXClassUnionToken`, its existing tokens are preserved and the others are appended.
288
288
  - `group(args?: RGXGroupTokenArgs) => RGXGroupToken`: Wraps this token in an `RGXGroupToken` with the provided arguments. The `args` parameter defaults to `{}`, which creates a capturing group with no name. This is a convenience method that creates a new `RGXGroupToken` with `this` as the sole token.
289
- - `repeat(min?: number, max?: number | null) => RGXRepeatToken`: Wraps this token in an `RGXRepeatToken` with the given repetition bounds. `min` defaults to `1`, `max` defaults to `min`. Pass `null` for `max` to allow unlimited repetitions. This is a convenience method that creates a new `RGXRepeatToken` with `this` as the token. Throws `RGXNotSupportedError` if called on an `RGXLookaroundToken`, as lookaround assertions cannot be repeated.
290
- - `optional() => RGXRepeatToken`: Shorthand for `repeat(0, 1)`. Wraps this token in an `RGXRepeatToken` that matches the token zero or one times. Throws `RGXNotSupportedError` if called on an `RGXLookaroundToken`, as lookaround assertions cannot be made optional.
289
+ - `repeat(min?: number, max?: number | null) => RGXRepeatToken`: Wraps this token in an `RGXRepeatToken` with the given repetition bounds. `min` defaults to `1`, `max` defaults to `min`. Pass `null` for `max` to allow unlimited repetitions. This is a convenience method that creates a new `RGXRepeatToken` with `this` as the token. Throws `RGXNotSupportedError` if called on a token with `rgxIsRepeatable` set to `false` (e.g., `RGXLookaroundToken`).
290
+ - `optional() => RGXRepeatToken`: Shorthand for `repeat(0, 1)`. Wraps this token in an `RGXRepeatToken` that matches the token zero or one times. Throws `RGXNotSupportedError` if called on a token with `rgxIsRepeatable` set to `false` (e.g., `RGXLookaroundToken`).
291
291
  - `asLookahead(positive?: boolean) => RGXLookaheadToken`: Wraps this token in an `RGXLookaheadToken`. `positive` defaults to `true`. If this token is already an `RGXLookaheadToken`, it is returned as-is without re-wrapping.
292
292
  - `asLookbehind(positive?: boolean) => RGXLookbehindToken`: Wraps this token in an `RGXLookbehindToken`. `positive` defaults to `true`. If this token is already an `RGXLookbehindToken`, it is returned as-is without re-wrapping.
293
293
  - `resolve() => ValidRegexString`: A convenience method that resolves this token by calling `resolveRGXToken(this)`, returning the resolved regex string representation. Since this method is defined on `RGXClassToken`, it is available on all subclasses including `RGXClassUnionToken`, `RGXGroupToken`, `RGXRepeatToken`, and `RGXLookaroundToken`.
@@ -337,7 +337,7 @@ constructor(args?: RGXGroupTokenArgs, tokens?: RGXTokenCollectionInput)
337
337
  - `tokens` (`RGXTokenCollection`): The internal collection of tokens managed in 'concat' mode.
338
338
  - `name` (`string | null`): The name of the group. Setting this to a non-null value validates it as a valid identifier via `assertValidIdentifier`.
339
339
  - `capturing` (`boolean`): Whether the group is capturing. Any named group is automatically capturing (returns `true` when `name` is not `null`). Setting this to `false` also clears `name` to `null`.
340
- - `isGroup` (`true`): Returns `true` as a constant, indicating this token represents a group.
340
+ - `rgxIsGroup` (`true`): Returns `true` as a constant, indicating this token represents a group.
341
341
  - `rgxGroupWrap` (`false`): Returns `false` as a constant, since the group already wraps itself, preventing the resolver from double-wrapping.
342
342
 
343
343
  #### Methods
@@ -361,7 +361,7 @@ constructor(token: RGXToken, min?: number, max?: number | null)
361
361
  - `max` (`number | null`, optional): The maximum number of repetitions. Must be >= `min` when not `null`. Non-integer values are floored. Pass `null` for unlimited repetitions. Defaults to `min`.
362
362
 
363
363
  #### Properties
364
- - `token` (`RGXGroupedToken`): The token being repeated. Setting this will throw `RGXNotSupportedError` if the value is a class token with `isRepeatable` set to `false`, and will automatically wrap non-grouped tokens in a non-capturing `RGXGroupToken`.
364
+ - `token` (`RGXGroupedToken`): The token being repeated. Setting this will throw `RGXNotSupportedError` if the value is a convertible token with `rgxIsRepeatable` set to `false`, and will automatically wrap non-grouped tokens in a non-capturing `RGXGroupToken`.
365
365
  - `min` (`number`): The minimum number of repetitions. Setting this validates that the value is >= 0 and <= `max` (when `max` is not `null`), and floors non-integer values. Throws `RGXOutOfBoundsError` if validation fails.
366
366
  - `max` (`number | null`): The maximum number of repetitions. Setting this validates that the value is >= `min` when not `null`, and floors non-integer values. Pass `null` for unlimited. Throws `RGXOutOfBoundsError` if validation fails.
367
367
  - `repeaterSuffix` (`string`): Returns the regex quantifier suffix based on the current `min` and `max` values: `*` for `{0,}`, `+` for `{1,}`, `?` for `{0,1}`, `{n}` for exact repetitions, `{n,}` for minimum-only, `{n,m}` for a range, or an empty string for `{1,1}` (exactly once, no quantifier needed).
@@ -388,8 +388,8 @@ constructor(tokens?: RGXTokenCollectionInput, positive?: boolean)
388
388
  - `tokens` (`RGXTokenCollection`): The internal collection of tokens managed in 'concat' mode.
389
389
  - `positive` (`boolean`): Whether the lookaround is positive. Setting this updates `negative` accordingly.
390
390
  - `negative` (`boolean`): Whether the lookaround is negative. Setting this updates `positive` accordingly.
391
- - `isGroup` (`true`): Returns `true` as a constant, indicating this token represents a group.
392
- - `isRepeatable` (`false`): Returns `false` as a constant, since lookaround assertions cannot be repeated.
391
+ - `rgxIsGroup` (`true`): Returns `true` as a constant, indicating this token represents a group.
392
+ - `rgxIsRepeatable` (`false`): Returns `false` as a constant, since lookaround assertions cannot be repeated.
393
393
  - `rgxGroupWrap` (`false`): Returns `false` as a constant, since the lookaround already wraps itself in a group.
394
394
 
395
395
  #### Abstract Methods
@@ -425,7 +425,7 @@ A function `rgxLookbehind` is provided with the same parameters as this class' c
425
425
  - `toRgx() => RegExp`: Resolves the lookbehind to a `RegExp`. Positive lookbehinds produce `(?<=...)` and negative lookbehinds produce `(?<!...)`.
426
426
 
427
427
  ### RGXClassWrapperToken extends RGXClassToken
428
- A class that wraps any `RGXToken` as an `RGXClassToken`, giving you access to the extended API class tokens provide. It delegates `isGroup` and `isRepeatable` to the wrapped token where possible.
428
+ A class that wraps any `RGXToken` as an `RGXClassToken`, giving you access to the extended API class tokens provide. It delegates `rgxIsGroup` and `rgxIsRepeatable` to the wrapped token where possible.
429
429
 
430
430
  A function `rgxClassWrapper` is provided with the same parameters as this class' constructor, for easier instantiation without needing to use the `new` keyword.
431
431
 
@@ -441,8 +441,8 @@ constructor(token: RGXToken)
441
441
 
442
442
  #### Properties
443
443
  - `token` (`RGXToken`): The wrapped token.
444
- - `isGroup` (`boolean`): Delegates to the wrapped token's group status via `isRGXGroupedToken`. Returns `true` if the wrapped token is a grouped token, otherwise `false`.
445
- - `isRepeatable` (`boolean`): If the wrapped token is an `RGXClassToken`, delegates to its `isRepeatable` property. Otherwise, returns `true`.
444
+ - `rgxIsGroup` (`boolean`): Delegates to the wrapped token's group status via `isRGXGroupedToken`. Returns `true` if the wrapped token is a grouped token, otherwise `false`.
445
+ - `rgxIsRepeatable` (`boolean`): If the wrapped token is an `RGXClassToken`, delegates to its `rgxIsRepeatable` property. Otherwise, returns `true`.
446
446
 
447
447
  #### Methods
448
448
  - `unwrap() => RGXToken`: Returns the original wrapped token.
@@ -552,7 +552,7 @@ Asserts that the given value is a native token (string, number, boolean, or no-o
552
552
  function isRGXConvertibleToken(value: unknown, returnCheck?: boolean): value is RGXConvertibleToken
553
553
  ```
554
554
 
555
- Checks if the given value is a convertible token (an object with a `toRgx` method). If the `rgxGroupWrap` property is present, it must be a boolean; otherwise, the check fails. When `returnCheck` is `true` (the default), also validates that `toRgx` is callable and returns a valid `RGXToken` (which can be any RGX token type, including other convertible tokens, allowing for recursive structures).
555
+ Checks if the given value is a convertible token (an object with a `toRgx` method). If the `rgxGroupWrap`, `rgxIsRepeatable`, or `rgxIsGroup` properties are present, they must be booleans; otherwise, the check fails. When `returnCheck` is `true` (the default), also validates that `toRgx` is callable and returns a valid `RGXToken` (which can be any RGX token type, including other convertible tokens, allowing for recursive structures).
556
556
 
557
557
  #### Parameters
558
558
  - `value` (`unknown`): The value to check.
@@ -565,7 +565,7 @@ Checks if the given value is a convertible token (an object with a `toRgx` metho
565
565
  ```typescript
566
566
  function assertRGXConvertibleToken(value: unknown, returnCheck?: boolean): asserts value is RGXConvertibleToken
567
567
  ```
568
- Asserts that the given value is a convertible token (an object with a `toRgx` method). If the `rgxGroupWrap` property is present, it must be a boolean; otherwise, the assertion fails. When `returnCheck` is `true` (the default), also validates that `toRgx` is callable and returns a valid `RGXToken` (which can be any RGX token type, including other convertible tokens, allowing for recursive structures). If the assertion fails, an `RGXInvalidTokenError` will be thrown.
568
+ Asserts that the given value is a convertible token (an object with a `toRgx` method). If the `rgxGroupWrap`, `rgxIsRepeatable`, or `rgxIsGroup` properties are present, they must be booleans; otherwise, the assertion fails. When `returnCheck` is `true` (the default), also validates that `toRgx` is callable and returns a valid `RGXToken` (which can be any RGX token type, including other convertible tokens, allowing for recursive structures). If the assertion fails, an `RGXInvalidTokenError` will be thrown.
569
569
 
570
570
  #### Parameters
571
571
  - `value` (`unknown`): The value to assert.
@@ -701,7 +701,7 @@ function isRGXToken<T extends RGXTokenTypeGuardInput = null>(value: unknown, typ
701
701
 
702
702
  Checks if the given value is a valid RGX token, optionally narrowed to a specific token type. When `type` is `null` (the default), it checks against all token types. When `type` is a specific token type string, it checks only against that type. The `'class'` type matches `RGXClassToken` instances specifically, while `'convertible'` also matches class tokens since they implement the convertible interface.
703
703
 
704
- When `type` is an `RGXClassTokenConstructor` (a constructor for an `RGXClassToken` subclass), it performs an `instanceof` check against that specific constructor, allowing you to narrow to a specific class token subclass rather than all class tokens. In this case, `RGXTokenFromType` resolves to `InstanceType<T>`, giving you the specific subclass type.
704
+ When `type` is a constructor, it performs an `instanceof` check against that specific constructor, allowing you to narrow to a specific class token subclass rather than all class tokens. In this case, `RGXTokenFromType` resolves to `InstanceType<T>`, giving you the specific subclass type.
705
705
 
706
706
  When `type` is an array, it checks that every element of the value array is a valid RGX token matching the corresponding type in the `type` array. If `matchLength` is `true` (the default), it also requires that the value array has the same length as the type array; if `false`, it allows the value array to be longer than the type array, as long as all elements up to the length of the type array match and all elements after that are still valid RGX tokens of any type.
707
707
 
@@ -733,11 +733,11 @@ Asserts that the given value is a valid RGX token, optionally narrowed to a spec
733
733
  function isRGXGroupedToken(value: unknown, contentCheck?: boolean): value is RGXGroupedToken
734
734
  ```
735
735
 
736
- Checks if the given value is a grouped token — a token that is implicitly or explicitly a group. Arrays and literal tokens (`RegExp`) are implicitly groups. Class tokens are only groups if they have the `isGroup` property set to `true`. Convertible tokens are groups if they have `rgxGroupWrap` set to `true` and their `toRgx()` method returns a grouped token.
736
+ Checks if the given value is a grouped token — a token that is implicitly or explicitly a group. Arrays and literal tokens (`RegExp`) are implicitly groups. Convertible tokens (including class tokens) are groups if they have `rgxIsGroup` set to `true`, or if they have `rgxGroupWrap` set to `true` and their `toRgx()` method returns a grouped token.
737
737
 
738
738
  #### Parameters
739
739
  - `value` (`unknown`): The value to check.
740
- - `contentCheck` (`boolean`, optional): Whether to validate the contents of array tokens and the return values of convertible tokens. Defaults to `true`. When `false`, arrays are accepted without checking their elements, and convertible tokens with `rgxGroupWrap` set to `true` are accepted without checking their `toRgx()` return value.
740
+ - `contentCheck` (`boolean`, optional): Whether to validate the contents of array tokens and the return values of convertible tokens. Defaults to `true`. When `false`, arrays are accepted without checking their elements, and convertible tokens with `rgxGroupWrap` set to `true` are accepted without checking their `toRgx()` return value. This has no effect on the `rgxIsGroup` check, which always accepts the token as grouped regardless of `contentCheck`.
741
741
 
742
742
  #### Returns
743
743
  - `boolean`: `true` if the value is a grouped token, otherwise `false`.
@@ -751,7 +751,7 @@ Asserts that the given value is a grouped token. Uses the same logic as `isRGXGr
751
751
 
752
752
  #### Parameters
753
753
  - `value` (`unknown`): The value to assert.
754
- - `contentCheck` (`boolean`, optional): Whether to validate the contents of array tokens and the return values of convertible tokens. Defaults to `true`. When `false`, arrays are accepted without checking their elements, and convertible tokens with `rgxGroupWrap` set to `true` are accepted without checking their `toRgx()` return value.
754
+ - `contentCheck` (`boolean`, optional): Whether to validate the contents of array tokens and the return values of convertible tokens. Defaults to `true`. When `false`, arrays are accepted without checking their elements, and convertible tokens with `rgxGroupWrap` set to `true` are accepted without checking their `toRgx()` return value. This has no effect on the `rgxIsGroup` check, which always accepts the token as grouped regardless of `contentCheck`.
755
755
 
756
756
  #### Returns
757
757
  - `void`: This function does not return a value, but will throw an error if the assertion fails.
@@ -1,4 +1,4 @@
1
- import { RGXToken, ValidRegexString } from "../types";
1
+ import { RGXConvertibleToken, RGXToken, ValidRegexString } from "../types";
2
2
  import { RGXTokenCollectionInput } from "../collection";
3
3
  import { CloneDepth } from "@ptolemy2002/immutability-utils";
4
4
  import type { RGXClassUnionToken } from "./union";
@@ -6,13 +6,13 @@ import type { RGXGroupToken, RGXGroupTokenArgs } from "./group";
6
6
  import type { RGXRepeatToken } from "./repeat";
7
7
  import type { RGXLookaheadToken } from "./lookahead";
8
8
  import type { RGXLookbehindToken } from "./lookbehind";
9
- export declare abstract class RGXClassToken {
9
+ export declare abstract class RGXClassToken implements RGXConvertibleToken {
10
10
  abstract toRgx(): RGXToken;
11
11
  abstract clone(depth?: CloneDepth): ThisType<this>;
12
12
  static check: (value: unknown) => value is RGXClassToken;
13
13
  static assert: (value: unknown) => asserts value is RGXClassToken;
14
- get isGroup(): boolean;
15
- get isRepeatable(): boolean;
14
+ get rgxIsGroup(): boolean;
15
+ get rgxIsRepeatable(): boolean;
16
16
  get rgxGroupWrap(): boolean;
17
17
  or(...others: RGXTokenCollectionInput[]): RGXClassUnionToken;
18
18
  group(args?: RGXGroupTokenArgs): RGXGroupToken;
@@ -4,10 +4,10 @@ exports.RGXClassToken = void 0;
4
4
  const errors_1 = require("../errors");
5
5
  const resolve_1 = require("../resolve");
6
6
  class RGXClassToken {
7
- get isGroup() {
7
+ get rgxIsGroup() {
8
8
  return false;
9
9
  }
10
- get isRepeatable() {
10
+ get rgxIsRepeatable() {
11
11
  return true;
12
12
  }
13
13
  get rgxGroupWrap() {
@@ -15,7 +15,7 @@ export declare class RGXGroupToken extends RGXClassToken {
15
15
  set name(value: string | null);
16
16
  get capturing(): boolean;
17
17
  set capturing(value: boolean);
18
- get isGroup(): true;
18
+ get rgxIsGroup(): true;
19
19
  get rgxGroupWrap(): false;
20
20
  constructor({ name, capturing }?: RGXGroupTokenArgs, tokens?: RGXTokenCollectionInput);
21
21
  toRgx(): RegExp;
@@ -24,7 +24,7 @@ class RGXGroupToken extends base_1.RGXClassToken {
24
24
  this.name = null; // Non-capturing groups cannot have names
25
25
  this._capturing = value;
26
26
  }
27
- get isGroup() {
27
+ get rgxIsGroup() {
28
28
  return true;
29
29
  }
30
30
  get rgxGroupWrap() {
@@ -5,8 +5,8 @@ export declare abstract class RGXLookaroundToken extends RGXClassToken {
5
5
  _negative: boolean;
6
6
  static check: (value: unknown) => value is RGXLookaroundToken;
7
7
  static assert: (value: unknown) => asserts value is RGXLookaroundToken;
8
- get isGroup(): true;
9
- get isRepeatable(): false;
8
+ get rgxIsGroup(): true;
9
+ get rgxIsRepeatable(): false;
10
10
  get rgxGroupWrap(): false;
11
11
  set negative(value: boolean);
12
12
  get negative(): boolean;
@@ -5,10 +5,10 @@ const collection_1 = require("../collection");
5
5
  const base_1 = require("./base");
6
6
  const errors_1 = require("../errors");
7
7
  class RGXLookaroundToken extends base_1.RGXClassToken {
8
- get isGroup() {
8
+ get rgxIsGroup() {
9
9
  return true;
10
10
  }
11
- get isRepeatable() {
11
+ get rgxIsRepeatable() {
12
12
  return false;
13
13
  }
14
14
  get rgxGroupWrap() {
@@ -32,8 +32,13 @@ class RGXRepeatToken extends base_1.RGXClassToken {
32
32
  return this._token;
33
33
  }
34
34
  set token(value) {
35
- if ((0, typeGuards_1.isRGXToken)(value, "class") && !value.isRepeatable) {
36
- throw new errors_1.RGXNotSupportedError(`Repeating ${value.constructor.name} tokens`, "The token was manually marked as non-repeatable.");
35
+ if ((0, typeGuards_1.isRGXToken)(value, "convertible") && !value.rgxIsRepeatable) {
36
+ if ((0, typeGuards_1.isRGXToken)(value, "class")) {
37
+ throw new errors_1.RGXNotSupportedError(`Repeating ${value.constructor.name} tokens`, "The token was manually marked as non-repeatable.");
38
+ }
39
+ else {
40
+ throw new errors_1.RGXNotSupportedError("Repeating tokens with {rgxIsRepeatable: false}", "The token was manually marked as non-repeatable.");
41
+ }
37
42
  }
38
43
  // Make sure we are always working with a grouped token.
39
44
  if ((0, typeGuards_1.isRGXGroupedToken)(value))
@@ -6,8 +6,8 @@ export declare class RGXClassWrapperToken extends RGXClassToken {
6
6
  static check: (value: unknown) => value is RGXClassWrapperToken;
7
7
  static assert: (value: unknown) => asserts value is RGXClassWrapperToken;
8
8
  constructor(token: RGXToken);
9
- get isGroup(): boolean;
10
- get isRepeatable(): boolean;
9
+ get rgxIsGroup(): boolean;
10
+ get rgxIsRepeatable(): boolean;
11
11
  unwrap(): RGXToken;
12
12
  toRgx(): RGXToken;
13
13
  clone(depth?: CloneDepth): RGXClassWrapperToken;
@@ -11,12 +11,12 @@ class RGXClassWrapperToken extends base_1.RGXClassToken {
11
11
  super();
12
12
  this.token = token;
13
13
  }
14
- get isGroup() {
14
+ get rgxIsGroup() {
15
15
  return (0, typeGuards_1.isRGXGroupedToken)(this.token);
16
16
  }
17
- get isRepeatable() {
17
+ get rgxIsRepeatable() {
18
18
  if ((0, typeGuards_1.isRGXToken)(this.token, 'class'))
19
- return this.token.isRepeatable;
19
+ return this.token.rgxIsRepeatable;
20
20
  // Assume any other token is repeatable, since we don't know its implementation.
21
21
  return true;
22
22
  }
@@ -91,9 +91,13 @@ function assertRGXNativeToken(value) {
91
91
  }
92
92
  function isRGXConvertibleToken(value, returnCheck = true) {
93
93
  if (typeof value === 'object' && value !== null && 'toRgx' in value) {
94
- // The rgxGroupWrap property is optional, but if it exists it must be a boolean.
94
+ // The rgxGroupWrap, rgxIsRepeatable, and rgxIsGroup properties are optional, but if they exist they must be booleans.
95
95
  if ('rgxGroupWrap' in value && typeof value.rgxGroupWrap !== 'boolean')
96
96
  return false;
97
+ if ('rgxIsRepeatable' in value && typeof value.rgxIsRepeatable !== 'boolean')
98
+ return false;
99
+ if ('rgxIsGroup' in value && typeof value.rgxIsGroup !== 'boolean')
100
+ return false;
97
101
  if ((0, is_callable_1.default)(value.toRgx)) {
98
102
  if (!returnCheck)
99
103
  return true;
@@ -200,8 +204,8 @@ function isRGXGroupedToken(value, contentCheck = true) {
200
204
  // Classes are only groups if they have the isGroup property set to true.
201
205
  return (isRGXArrayToken(value, contentCheck) ||
202
206
  isRGXToken(value, "literal") ||
203
- (isRGXToken(value, "class") && value.isGroup) ||
204
- (isRGXConvertibleToken(value, false) && value.rgxGroupWrap === true && (!contentCheck || isRGXGroupedToken(value.toRgx()))));
207
+ (isRGXConvertibleToken(value, false) && (value.rgxIsGroup ||
208
+ (value.rgxGroupWrap === true && (!contentCheck || isRGXGroupedToken(value.toRgx()))))));
205
209
  }
206
210
  function assertRGXGroupedToken(value, contentCheck = true) {
207
211
  if (!isRGXGroupedToken(value, contentCheck)) {
package/dist/types.d.ts CHANGED
@@ -8,19 +8,21 @@ export type RGXNativeToken = string | number | boolean | RGXNoOpToken;
8
8
  export type RGXConvertibleToken = {
9
9
  toRgx: () => RGXToken;
10
10
  readonly rgxGroupWrap?: boolean;
11
+ readonly rgxIsGroup?: boolean;
12
+ readonly rgxIsRepeatable?: boolean;
11
13
  };
12
14
  export type RGXToken = RGXNativeToken | RGXLiteralToken | RGXConvertibleToken | RGXToken[];
13
15
  export type RGXClassTokenConstructor = new (...args: unknown[]) => RGXClassToken;
14
- export type RGXGroupedToken = RGXToken[] | RGXLiteralToken | (RGXClassToken & {
15
- isGroup: true;
16
- }) | RGXGroupedConvertibleToken;
17
- export type RGXGroupedConvertibleToken = {
16
+ export type RGXGroupedToken = RGXToken[] | RGXLiteralToken | RGXGroupedConvertibleToken;
17
+ export type RGXGroupedConvertibleToken = (RGXConvertibleToken & {
18
+ readonly rgxIsGroup: true;
19
+ }) | (Omit<RGXConvertibleToken, "toRGX"> & {
18
20
  toRgx: () => RGXGroupedToken;
19
21
  readonly rgxGroupWrap: true;
20
- };
22
+ });
21
23
  export type RGXTokenType = 'no-op' | 'literal' | 'native' | 'convertible' | 'class' | RGXTokenType[];
22
24
  export type RGXTokenTypeFlat = Exclude<RGXTokenType, RGXTokenType[]> | "array";
23
- export type RGXTokenTypeGuardInput = RGXTokenTypeFlat | null | RGXClassTokenConstructor | typeof ExtRegExp | typeof RGXTokenCollection | RGXTokenTypeGuardInput[];
25
+ export type RGXTokenTypeGuardInput = RGXTokenTypeFlat | null | RGXClassTokenConstructor | typeof RegExp | typeof ExtRegExp | typeof RGXTokenCollection | RGXTokenTypeGuardInput[];
24
26
  export type RGXTokenFromType<T extends RGXTokenTypeGuardInput> = T extends null ? RGXToken : T extends 'no-op' ? RGXNoOpToken : T extends 'literal' ? RGXLiteralToken : T extends 'native' ? RGXNativeToken : T extends 'convertible' ? RGXConvertibleToken : T extends 'class' ? RGXClassToken : T extends 'array' ? RGXToken[] : T extends new (...args: unknown[]) => infer R ? R : T extends RGXTokenTypeGuardInput[] ? {
25
27
  [K in keyof T]: T[K] extends RGXTokenTypeGuardInput ? RGXTokenFromType<T[K]> : never;
26
28
  } : never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ptolemy2002/rgx",
3
- "version": "4.11.0",
3
+ "version": "5.0.0",
4
4
  "private": false,
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",