@ptolemy2002/rgx 2.0.0 → 2.0.1

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.
Files changed (5) hide show
  1. package/dist/index.d.ts +20 -37
  2. package/dist/index.js +32 -12
  3. package/dist/types.d.ts +19 -0
  4. package/dist/types.js +5 -0
  5. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -1,38 +1,21 @@
1
- import { Branded } from "@ptolemy2002/ts-brand-utils";
2
- import { MaybeArray } from "@ptolemy2002/ts-utils";
1
+ import * as t from "./types";
3
2
  export * from "./errors";
4
- export type RGXNoOpToken = null | undefined;
5
- export type RGXLiteralToken = RegExp;
6
- export type RGXNativeToken = string | number | boolean | RGXNoOpToken;
7
- export type RGXConvertibleToken = {
8
- toRgx: () => MaybeArray<RGXNativeToken | RGXLiteralToken>;
9
- };
10
- export type RGXToken = RGXNativeToken | RGXLiteralToken | RGXConvertibleToken | RGXToken[];
11
- export type RGXTokenType = 'no-op' | 'literal' | 'native' | 'convertible' | RGXTokenType[];
12
- export type RGXTokenFromType<T extends RGXTokenType> = T extends 'no-op' ? RGXNoOpToken : T extends 'literal' ? RGXLiteralToken : T extends 'native' ? RGXNativeToken : T extends 'convertible' ? RGXConvertibleToken : T extends RGXTokenType[] ? {
13
- [K in keyof T]: T[K] extends RGXTokenType ? RGXTokenFromType<T[K]> : never;
14
- } : never;
15
- export declare const validRegexSymbol: unique symbol;
16
- export type ValidRegexBrandSymbol = typeof validRegexSymbol;
17
- export type ValidRegexString = Branded<string, [ValidRegexBrandSymbol]>;
18
- export declare const validVanillaRegexFlagsSymbol: unique symbol;
19
- export type ValidVanillaRegexFlagsBrandSymbol = typeof validVanillaRegexFlagsSymbol;
20
- export type ValidVanillaRegexFlags = Branded<string, [ValidVanillaRegexFlagsBrandSymbol]>;
21
- export declare function isRGXNoOpToken(value: unknown): value is RGXNoOpToken;
22
- export declare function assertRGXNoOpToken(value: unknown): asserts value is RGXNoOpToken;
23
- export declare function isRGXLiteralToken(value: unknown): value is RGXLiteralToken;
24
- export declare function assertRGXLiteralToken(value: unknown): asserts value is RGXLiteralToken;
25
- export declare function isRGXNativeToken(value: unknown): value is RGXNativeToken;
26
- export declare function assertRGXNativeToken(value: unknown): asserts value is RGXNativeToken;
27
- export declare function isRGXConvertibleToken(value: unknown): value is RGXConvertibleToken;
28
- export declare function assertRGXConvertibleToken(value: unknown): asserts value is RGXConvertibleToken;
29
- export declare function rgxTokenType(value: RGXToken): RGXTokenType;
30
- export declare function rgxTokenFromType<T extends RGXTokenType>(type: T, value: RGXToken): RGXTokenFromType<T>;
31
- export declare function isValidRegexString(value: string): value is ValidRegexString;
32
- export declare function assertValidRegexString(value: string): asserts value is ValidRegexString;
33
- export declare function isValidVanillaRegexFlags(value: string): value is ValidVanillaRegexFlags;
34
- export declare function assertValidVanillaRegexFlags(value: string): asserts value is ValidVanillaRegexFlags;
35
- export declare function escapeRegex(value: string): ValidRegexString;
36
- export declare function resolveRGXToken(token: RGXToken): ValidRegexString;
37
- export declare function rgxConcat(tokens: RGXToken[]): ValidRegexString;
38
- export default function rgx(flags?: string): (strings: TemplateStringsArray, ...tokens: RGXToken[]) => RegExp;
3
+ export * from "./types";
4
+ export declare function isRGXNoOpToken(value: unknown): value is t.RGXNoOpToken;
5
+ export declare function assertRGXNoOpToken(value: unknown): asserts value is t.RGXNoOpToken;
6
+ export declare function isRGXLiteralToken(value: unknown): value is t.RGXLiteralToken;
7
+ export declare function assertRGXLiteralToken(value: unknown): asserts value is t.RGXLiteralToken;
8
+ export declare function isRGXNativeToken(value: unknown): value is t.RGXNativeToken;
9
+ export declare function assertRGXNativeToken(value: unknown): asserts value is t.RGXNativeToken;
10
+ export declare function isRGXConvertibleToken(value: unknown): value is t.RGXConvertibleToken;
11
+ export declare function assertRGXConvertibleToken(value: unknown): asserts value is t.RGXConvertibleToken;
12
+ export declare function rgxTokenType(value: t.RGXToken): t.RGXTokenType;
13
+ export declare function rgxTokenFromType<T extends t.RGXTokenType>(type: T, value: t.RGXToken): t.RGXTokenFromType<T>;
14
+ export declare function isValidRegexString(value: string): value is t.ValidRegexString;
15
+ export declare function assertValidRegexString(value: string): asserts value is t.ValidRegexString;
16
+ export declare function isValidVanillaRegexFlags(value: string): value is t.ValidVanillaRegexFlags;
17
+ export declare function assertValidVanillaRegexFlags(value: string): asserts value is t.ValidVanillaRegexFlags;
18
+ export declare function escapeRegex(value: string): t.ValidRegexString;
19
+ export declare function resolveRGXToken(token: t.RGXToken): t.ValidRegexString;
20
+ export declare function rgxConcat(tokens: t.RGXToken[]): t.ValidRegexString;
21
+ export default function rgx(flags?: string): (strings: TemplateStringsArray, ...tokens: t.RGXToken[]) => RegExp;
package/dist/index.js CHANGED
@@ -10,6 +10,28 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
10
10
  if (k2 === undefined) k2 = k;
11
11
  o[k2] = m[k];
12
12
  }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
13
35
  var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
36
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
37
  };
@@ -17,7 +39,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
17
39
  return (mod && mod.__esModule) ? mod : { "default": mod };
18
40
  };
19
41
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.validVanillaRegexFlagsSymbol = exports.validRegexSymbol = void 0;
21
42
  exports.isRGXNoOpToken = isRGXNoOpToken;
22
43
  exports.assertRGXNoOpToken = assertRGXNoOpToken;
23
44
  exports.isRGXLiteralToken = isRGXLiteralToken;
@@ -37,16 +58,15 @@ exports.resolveRGXToken = resolveRGXToken;
37
58
  exports.rgxConcat = rgxConcat;
38
59
  exports.default = rgx;
39
60
  const is_callable_1 = __importDefault(require("is-callable"));
40
- const errors_1 = require("./errors");
61
+ const e = __importStar(require("./errors"));
41
62
  __exportStar(require("./errors"), exports);
42
- exports.validRegexSymbol = Symbol('rgx.ValidRegex');
43
- exports.validVanillaRegexFlagsSymbol = Symbol('rgx.ValidVanillaRegexFlags');
63
+ __exportStar(require("./types"), exports);
44
64
  function isRGXNoOpToken(value) {
45
65
  return value === null || value === undefined;
46
66
  }
47
67
  function assertRGXNoOpToken(value) {
48
68
  if (!isRGXNoOpToken(value)) {
49
- throw new errors_1.RGXInvalidTokenError(`Invalid no-op token`, 'null or undefined', value);
69
+ throw new e.RGXInvalidTokenError(`Invalid no-op token`, 'null or undefined', value);
50
70
  }
51
71
  }
52
72
  function isRGXLiteralToken(value) {
@@ -54,7 +74,7 @@ function isRGXLiteralToken(value) {
54
74
  }
55
75
  function assertRGXLiteralToken(value) {
56
76
  if (!isRGXLiteralToken(value)) {
57
- throw new errors_1.RGXInvalidTokenError(`Invalid literal token`, 'RegExp', value);
77
+ throw new e.RGXInvalidTokenError(`Invalid literal token`, 'RegExp', value);
58
78
  }
59
79
  }
60
80
  function isRGXNativeToken(value) {
@@ -62,7 +82,7 @@ function isRGXNativeToken(value) {
62
82
  }
63
83
  function assertRGXNativeToken(value) {
64
84
  if (!isRGXNativeToken(value)) {
65
- throw new errors_1.RGXInvalidTokenError(`Invalid native token`, 'string, number, boolean, null, or undefined', value);
85
+ throw new e.RGXInvalidTokenError(`Invalid native token`, 'string, number, boolean, null, or undefined', value);
66
86
  }
67
87
  }
68
88
  function isRGXConvertibleToken(value) {
@@ -80,7 +100,7 @@ function isRGXConvertibleToken(value) {
80
100
  }
81
101
  function assertRGXConvertibleToken(value) {
82
102
  if (!isRGXConvertibleToken(value)) {
83
- throw new errors_1.RGXInvalidTokenError(`Invalid convertible token`, 'object with a toRgx method that returns a valid token', value);
103
+ throw new e.RGXInvalidTokenError(`Invalid convertible token`, 'object with a toRgx method that returns a valid token', value);
84
104
  }
85
105
  }
86
106
  function rgxTokenType(value) {
@@ -96,7 +116,7 @@ function rgxTokenType(value) {
96
116
  return value.map(rgxTokenType);
97
117
  // Ignoring this line since it should be impossible to reach if the types are correct, but we need it to satisfy the return type
98
118
  /* istanbul ignore next */
99
- throw new errors_1.RGXInvalidTokenError(`Invalid RGX token: ${value}`, null, value);
119
+ throw new e.RGXInvalidTokenError(`Invalid RGX token: ${value}`, null, value);
100
120
  }
101
121
  function rgxTokenFromType(type, value) {
102
122
  // Ignoring this line because the function is entirely a TypeScript utility that doesn't need to be tested at runtime.
@@ -114,7 +134,7 @@ function isValidRegexString(value) {
114
134
  }
115
135
  function assertValidRegexString(value) {
116
136
  if (!isValidRegexString(value)) {
117
- throw new errors_1.RGXInvalidRegexStringError(`Invalid regex string: ${value}`, value);
137
+ throw new e.RGXInvalidRegexStringError(`Invalid regex string: ${value}`, value);
118
138
  }
119
139
  }
120
140
  function isValidVanillaRegexFlags(value) {
@@ -127,7 +147,7 @@ function isValidVanillaRegexFlags(value) {
127
147
  }
128
148
  function assertValidVanillaRegexFlags(value) {
129
149
  if (!isValidVanillaRegexFlags(value)) {
130
- throw new errors_1.RGXInvalidVanillaRegexFlagsError(`Invalid vanilla regex flags: ${value}`, value);
150
+ throw new e.RGXInvalidVanillaRegexFlagsError(`Invalid vanilla regex flags: ${value}`, value);
131
151
  }
132
152
  }
133
153
  function escapeRegex(value) {
@@ -154,7 +174,7 @@ function resolveRGXToken(token) {
154
174
  }
155
175
  // Ignoring this line since it should be impossible to reach if the types are correct, but we need it to satisfy the return type
156
176
  /* istanbul ignore next */
157
- throw new errors_1.RGXInvalidTokenError(`Invalid RGX token: ${token}`, null, token);
177
+ throw new e.RGXInvalidTokenError(`Invalid RGX token: ${token}`, null, token);
158
178
  }
159
179
  // Wrapper for letting an array of tokens be resolved as a concatenation instead of a union.
160
180
  function rgxConcat(tokens) {
package/dist/types.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ import { Branded } from "@ptolemy2002/ts-brand-utils";
2
+ import { MaybeArray } from "@ptolemy2002/ts-utils";
3
+ export type RGXNoOpToken = null | undefined;
4
+ export type RGXLiteralToken = RegExp;
5
+ export type RGXNativeToken = string | number | boolean | RGXNoOpToken;
6
+ export type RGXConvertibleToken = {
7
+ toRgx: () => MaybeArray<RGXNativeToken | RGXLiteralToken>;
8
+ };
9
+ export type RGXToken = RGXNativeToken | RGXLiteralToken | RGXConvertibleToken | RGXToken[];
10
+ export type RGXTokenType = 'no-op' | 'literal' | 'native' | 'convertible' | RGXTokenType[];
11
+ export type RGXTokenFromType<T extends RGXTokenType> = T extends 'no-op' ? RGXNoOpToken : T extends 'literal' ? RGXLiteralToken : T extends 'native' ? RGXNativeToken : T extends 'convertible' ? RGXConvertibleToken : T extends RGXTokenType[] ? {
12
+ [K in keyof T]: T[K] extends RGXTokenType ? RGXTokenFromType<T[K]> : never;
13
+ } : never;
14
+ export declare const validRegexSymbol: unique symbol;
15
+ export type ValidRegexBrandSymbol = typeof validRegexSymbol;
16
+ export type ValidRegexString = Branded<string, [ValidRegexBrandSymbol]>;
17
+ export declare const validVanillaRegexFlagsSymbol: unique symbol;
18
+ export type ValidVanillaRegexFlagsBrandSymbol = typeof validVanillaRegexFlagsSymbol;
19
+ export type ValidVanillaRegexFlags = Branded<string, [ValidVanillaRegexFlagsBrandSymbol]>;
package/dist/types.js ADDED
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validVanillaRegexFlagsSymbol = exports.validRegexSymbol = void 0;
4
+ exports.validRegexSymbol = Symbol('rgx.ValidRegex');
5
+ exports.validVanillaRegexFlagsSymbol = Symbol('rgx.ValidVanillaRegexFlags');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ptolemy2002/rgx",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "private": false,
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",