re2 1.17.8 → 1.18.0

package/.github/workflows/tests.yml

@@ -34,3 +34,4 @@ jobs:
         npm i
         npm run build --if-present
         npm test
+        npm run ts-test

package/README.md

@@ -352,6 +352,7 @@ console.log('re2_res : ' + re2_res); // prints: re2_res : abc,a,b,c
 
 ## Release history
 
+- 1.18.0 *Modified TS bindings, added a type test (thx, [Kenichi Kamiya](https://github.com/kachick) and [Jamie Magee](https://github.com/JamieMagee)).*
 - 1.17.8 *Updated deps, added Node 19 as a pre-compilation target.*
 - 1.17.7 *Added support for a cross-platform fetching of a pre-compiled version by updating [install-artifact-from-github](https://github.com/uhop/install-artifact-from-github).*
 - 1.17.6 *Implemented `dotAll`. Thx [Michael Kriese](https://github.com/viceice).*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "re2",
-  "version": "1.17.8",
+  "version": "1.18.0",
   "description": "Bindings for RE2: fast, safe alternative to backtracking regular expression engines.",
   "homepage": "https://github.com/uhop/node-re2",
   "bugs": "https://github.com/uhop/node-re2/issues",
@@ -16,10 +16,13 @@
     "node-gyp": "^9.3.0"
   },
   "devDependencies": {
-    "heya-unit": "^0.3.0"
+    "@types/node": "^18.11.12",
+    "heya-unit": "^0.3.0",
+    "typescript": "^4.9.4"
   },
   "scripts": {
     "test": "node tests/tests.js",
+    "ts-test": "tsc",
     "save-to-github": "save-to-github-cache --artifact build/Release/re2.node",
     "install": "install-from-cache --artifact build/Release/re2.node --host-var RE2_DOWNLOAD_MIRROR --skip-path-var RE2_DOWNLOAD_SKIP_PATH --skip-ver-var RE2_DOWNLOAD_SKIP_VER || npm run rebuild",
     "verify-build": "node scripts/verify-build.js",

package/re2.d.ts

@@ -1,27 +1,31 @@
 declare module 're2' {
 
-  interface RE2MatchArray<K> extends Array<K> {
-    index?: number;
-    input?: K;
+  interface RE2BufferExecArray {
+    index: number;
+    input: Buffer;
+    0: Buffer;
     groups?: {
-      [key: string]: string
+      [key: string]: Buffer
     }
   }
 
-  interface RE2ExecArray<K> extends Array<K> {
-    index: number;
-    input: K;
+  interface RE2BufferMatchArray {
+    index?: number;
+    input?: Buffer;
+    0: Buffer;
     groups?: {
-      [key: string]: string
+      [key: string]: Buffer
     }
   }
 
   interface RE2 extends RegExp {
-    exec<K extends String | Buffer>(str: K): RE2ExecArray<K> | null;
+    exec(str: string): RegExpExecArray | null;
+    exec(str: Buffer): RE2BufferExecArray | null;
 
-    test(str: string | Buffer): boolean;
+    match(str: string): RegExpMatchArray | null;
+    match(str: Buffer): RE2BufferMatchArray | null;
 
-    match<K extends String | Buffer>(str: K): RE2MatchArray<K> | null;
+    test(str: string | Buffer): boolean;
 
     replace<K extends String | Buffer>(str: K, replaceValue: string | Buffer): K;
     replace<K extends String | Buffer>(str: K, replacer: (substring: string, ...args: any[]) => string | Buffer): K;
@@ -32,10 +36,10 @@ declare module 're2' {
   }
 
   interface RE2Constructor extends RegExpConstructor {
-    new(pattern: Buffer | RegExp | string): RE2;
-    new(pattern: Buffer | string, flags?: string): RE2;
-    (pattern: Buffer | RegExp | string): RE2;
-    (pattern: Buffer | string, flags?: string): RE2;
+    new(pattern: Buffer | RegExp | RE2 | string): RE2;
+    new(pattern: Buffer | string, flags?: string | Buffer): RE2;
+    (pattern: Buffer | RegExp | RE2 | string): RE2;
+    (pattern: Buffer | string, flags?: string | Buffer): RE2;
     readonly prototype: RE2;
 
     unicodeWarningLevel: 'nothing' | 'warnOnce' | 'warn' | 'throw';

package/ts-tests/test-types.ts

@@ -0,0 +1,28 @@
+import RE2 from 're2';
+
+function assertType<T>(_val: T) {}
+
+function test_execTypes() {
+  const re = new RE2('quick\\s(brown).+?(?<verb>jumps)', 'ig');
+  const result = re.exec('The Quick Brown Fox Jumps Over The Lazy Dog')
+  if (!(result && result.groups)) {
+    throw 'Unexpected Result'
+  }
+  assertType<number>(result.index)
+  assertType<string>(result.input)
+  assertType<string | undefined>(result.groups['verb'])
+}
+
+function test_matchTypes() {
+  const re = new RE2('quick\\s(brown).+?(?<verb>jumps)', 'ig');
+  const result = re.match('The Quick Brown Fox Jumps Over The Lazy Dog')
+  if (!(result && result.index && result.input && result.groups)) {
+    throw 'Unexpected Result'
+  }
+  assertType<number>(result.index)
+  assertType<string>(result.input)
+  assertType<string | undefined>(result.groups['verb'])
+}
+
+test_execTypes()
+test_matchTypes()

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+
+  },
+  "include": ["**/*.ts"]
+}