re2 1.17.7 → 1.18.0

package/.github/actions/linux-alpine-node-19/Dockerfile

@@ -0,0 +1,6 @@
+FROM node:19-alpine
+
+RUN apk add --no-cache python3 make gcc g++
+
+COPY entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

package/.github/actions/linux-alpine-node-19/action.yml

@@ -0,0 +1,7 @@
+name: 'Create a binary artifact for Node 19 on Alpine Linux'
+description: 'Create a binary artifact for Node 19 on Alpine Linux using musl'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{inputs.node-version}}

package/.github/actions/linux-alpine-node-19/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+npm config set unsafe-perm true
+export USERNAME=`whoami`
+export DEVELOPMENT_SKIP_GETTING_ASSET=true
+npm i
+npm run build --if-present
+npm test
+npm run save-to-github

package/.github/actions/linux-node-12/Dockerfile

@@ -1,15 +1,15 @@
 FROM centos:centos7
 
 RUN yum install -y centos-release-scl && \
-    INSTALL_PKGS="devtoolset-7-gcc devtoolset-7-gcc-c++ python3 make" && \
+    INSTALL_PKGS="devtoolset-8 python3 make" && \
     yum install -y --setopt=tsflags=nodocs $INSTALL_PKGS && \
     rpm -V $INSTALL_PKGS && \
     yum -y clean all --enablerepo='*'
     #  && \
-    # source scl_source enable devtoolset-7 && \
+    # source scl_source enable devtoolset-8 && \
     # source scl_source enable python3
 
-ENV PATH=/opt/rh/devtoolset-7/root/usr/bin:$PATH
+ENV PATH=/opt/rh/devtoolset-8/root/usr/bin:$PATH
 
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

package/.github/actions/linux-node-12/entrypoint.sh

@@ -2,7 +2,7 @@
 
 NVM_DIR=$HOME/.nvm
 
-curl -sS -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+curl -sS -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
 [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
 
 nvm install --no-progress $1

package/.github/actions/linux-node-19/Dockerfile

@@ -0,0 +1,6 @@
+FROM node:19-buster
+
+RUN apt install python3 make gcc g++
+
+COPY entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

package/.github/actions/linux-node-19/action.yml

@@ -0,0 +1,12 @@
+name: 'Create a binary artifact for Node == 19 on Linux'
+description: 'Create a binary artifact for Node == 19 on Linux using node:19-buster'
+inputs:
+  node-version:
+    description: 'Node.js version'
+    required: false
+    default: '19'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{inputs.node-version}}

package/.github/actions/linux-node-19/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+npm config set unsafe-perm true
+export USERNAME=`whoami`
+export DEVELOPMENT_SKIP_GETTING_ASSET=true
+npm i
+npm run build --if-present
+npm test
+npm run save-to-github

package/.github/workflows/build.yml

@@ -31,7 +31,7 @@ jobs:
     strategy:
       matrix:
         os: [macOS-latest, windows-latest]
-        node-version: [14, 16, 18]
+        node-version: [14, 16, 18, 19]
         exclude:
           - os: windows-latest
             node-version: 14
@@ -44,18 +44,6 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{matrix.node-version}}
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: ${{runner.os}}-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          ${{runner.os}}-node-
-          ${{runner.os}}-
     - name: Install the package and run tests
       env:
         DEVELOPMENT_SKIP_GETTING_ASSET: true
@@ -82,18 +70,6 @@ jobs:
     - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: Linux-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          Linux-node-
-          Linux-
     - name: Install, test, and create artifact
       uses: ./.github/actions/linux-node-12/
       env:
@@ -111,23 +87,26 @@ jobs:
     - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: Linux-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          Linux-node-
-          Linux-
     - name: Install, test, and create artifact
       uses: ./.github/actions/linux-node-18/
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+  build-linux-node-19:
+    name: Node.js 19 on Debian Buster
+    needs: create-release
+    runs-on: ubuntu-latest
+    continue-on-error: true
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: Install, test, and create artifact
+      uses: ./.github/actions/linux-node-19/
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
   build-linux-alpine-node-14:
     name: Node.js 14 on Alpine Linux
     needs: create-release
@@ -138,18 +117,6 @@ jobs:
     - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: Linux-Alpine-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          Linux-Alpine-node-
-          Linux-Alpine-
     - name: Install, test, and create artifact
       uses: ./.github/actions/linux-alpine-node-14/
       env:
@@ -165,18 +132,6 @@ jobs:
     - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: Linux-Alpine-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          Linux-Alpine-node-
-          Linux-Alpine-
     - name: Install, test, and create artifact
       uses: ./.github/actions/linux-alpine-node-16/
       env:
@@ -192,19 +147,22 @@ jobs:
     - uses: actions/checkout@v3
       with:
         submodules: true
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: |
-        echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: Linux-Alpine-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          Linux-Alpine-node-
-          Linux-Alpine-
     - name: Install, test, and create artifact
       uses: ./.github/actions/linux-alpine-node-18/
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+  build-linux-alpine-node-19:
+    name: Node.js 19 on Alpine Linux
+    needs: create-release
+    runs-on: ubuntu-latest
+    continue-on-error: true
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: Install, test, and create artifact
+      uses: ./.github/actions/linux-alpine-node-19/
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
-        node-version: [14, 16, 18]
+        node-version: [14, 16, 18, 19]
         exclude:
           - os: windows-latest
             node-version: 14
@@ -27,17 +27,6 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{matrix.node-version}}
-    - name: Get NPM cache directory
-      id: npm-cache
-      run: echo "::set-output name=dir::$(npm config get cache)"
-    - name: Cache node modules
-      uses: actions/cache@v3
-      with:
-        path: ${{steps.npm-cache.outputs.dir}}
-        key: ${{runner.os}}-node-${{hashFiles('**/package-lock.json')}}
-        restore-keys: |
-          ${{runner.os}}-node-
-          ${{runner.os}}-
     - name: Install the package and run tests
       env:
         DEVELOPMENT_SKIP_GETTING_ASSET: true
@@ -45,3 +34,4 @@ jobs:
         npm i
         npm run build --if-present
         npm test
+        npm run ts-test

package/README.md

@@ -352,6 +352,8 @@ 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).*
 - 1.17.5 *Updated deps, updated test/build targets, implemented `matchAll()` (thx, [ThePendulum](https://github.com/ThePendulum) and [David Sichau](https://github.com/DavidSichau)).*

package/binding.gyp

@@ -39,7 +39,7 @@
         "vendor/util/strutil.cc"
       ],
       "cflags": [
-        "-std=c++14",
+        "-std=c++2a",
         "-Wall",
         "-Wextra",
         "-Wno-sign-compare",
@@ -59,10 +59,10 @@
       ],
       "xcode_settings": {
         "MACOSX_DEPLOYMENT_TARGET": "10.7",
-        "CLANG_CXX_LANGUAGE_STANDARD": "c++11",
+        "CLANG_CXX_LANGUAGE_STANDARD": "c++2a",
         "CLANG_CXX_LIBRARY": "libc++",
         "OTHER_CFLAGS": [
-          "-std=c++14",
+          "-std=c++2a",
           "-Wall",
           "-Wextra",
           "-Wno-sign-compare",

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "re2",
-  "version": "1.17.7",
+  "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",
+  "type": "commonjs",
   "main": "re2.js",
   "types": "re2.d.ts",
   "directories": {
@@ -11,14 +12,17 @@
   },
   "dependencies": {
     "install-artifact-from-github": "^1.3.1",
-    "nan": "^2.16.0",
-    "node-gyp": "^9.0.0"
+    "nan": "^2.17.0",
+    "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,21 +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]: Buffer
+    }
   }
 
-  interface RE2ExecArray<K> extends Array<K> {
-    index: number;
-    input: K;
+  interface RE2BufferMatchArray {
+    index?: number;
+    input?: Buffer;
+    0: Buffer;
+    groups?: {
+      [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;
@@ -26,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/re2.js

@@ -19,7 +19,7 @@ if (typeof Symbol != 'undefined') {
     (RE2.prototype[Symbol.split] = function (str, limit) {
       return this.split(str, limit);
     });
-    Symbol.matchAll &&
+  Symbol.matchAll &&
     (RE2.prototype[Symbol.matchAll] = function* (str) {
       if (!this.global) {
         throw TypeError('String.prototype.matchAll called with a non-global RE2 argument');

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"]
+}