gremlin 3.8.0 → 4.0.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gremlin",
-  "version": "3.8.0",
+  "version": "4.0.0-beta.2",
   "description": "JavaScript Gremlin Language Variant",
   "author": {
     "name": "Apache TinkerPop team"
@@ -17,27 +17,62 @@
     "graphdb"
   ],
   "license": "Apache-2.0",
+  "type": "module",
+  "main": "./build/cjs/index.cjs",
+  "types": "./build/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/esm/index.js",
+      "require": "./build/cjs/index.cjs",
+      "types": "./build/esm/index.d.ts"
+    },
+    "./language": {
+      "import": "./build/esm/language/index.js",
+      "types": "./build/esm/language/index.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "language": ["./build/esm/language/index.d.ts"]
+    }
+  },
+  "files": [
+    "build"
+  ],
   "dependencies": {
+    "antlr4ng": "3.0.16",
     "buffer": "^6.0.3",
     "eventemitter3": "^5.0.1",
     "readable-stream": "^4.5.2",
-    "uuid": "^9.0.1",
-    "ws": "^8.16.0"
+    "uuid": "^9.0.1"
+  },
+  "optionalDependencies": {
+    "@aws-sdk/credential-providers": "^3.967.0",
+    "@smithy/hash-node": "^4.2.12",
+    "@smithy/signature-v4": "^5.3.12"
   },
   "devDependencies": {
+    "@cucumber/cucumber": "~12.7.0",
+    "@eslint/js": "^9.16.0",
+    "@knighted/duel": "^4.0.2",
+    "@tsconfig/node18": "^18.2.2",
+    "@types/readable-stream": "^4.0.10",
+    "@types/uuid": "^9.0.8",
+    "antlr-ng": "^1.0.10",
     "chai": "~4.5.0",
     "chai-string": "~1.5.0",
     "colors": "1.4.0",
-    "cross-env": "^7.0.3",
-    "cucumber": "~6.0.7",
-    "eslint": "^8.42.0",
+    "cross-env": "^10.1.0",
+    "eslint": "^9.36.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.0.0",
-    "grunt": "^1.5.3",
-    "grunt-cli": "~1.5.0",
-    "grunt-jsdoc": "~2.4.1",
-    "mocha": "^10.2.0",
-    "prettier": "^3.0.0"
+    "globals": "^15.14.0",
+    "js-yaml": "^3.14.2",
+    "mocha": "^11.7.5",
+    "prettier": "^3.0.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.18",
+    "typescript": "^5.4.2"
   },
   "repository": {
     "type": "git",
@@ -48,21 +83,24 @@
     "url": "https://issues.apache.org/jira/browse/TINKERPOP"
   },
   "scripts": {
+    "generate": "mkdir -p lib/language/grammar && antlr-ng -Dlanguage=TypeScript -visitor --generate-listener --exact-output-dir -o lib/language/grammar ../../gremlin-language/src/main/antlr4/Gremlin.g4",
+    "prebuild": "node scripts/patch-antlr4ng.js && npm run generate",
+    "_prebuild_note": "patch-antlr4ng.js is a build-time stop-gap for antlr4ng missing .d.cts CJS type declarations (antlr4ng issues #23/#26). antlr4ng is pinned to an exact version in dependencies. Before upgrading antlr4ng, verify the patch still applies or that upstream has fixed the issue.",
+    "build": "rm -rf build && duel --dirs",
+    "prepare": "npm run generate && npm run build",
     "test": "npm run unit-test && npm run integration-test",
-    "unit-test": "mocha test/unit/*",
-    "integration-test": "npm run integration-test-graphson30 && npm run integration-test-graphbinary",
-    "integration-test-graphson30": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' ./node_modules/mocha/bin/mocha.js test/integration -t 5000",
-    "integration-test-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' ./node_modules/mocha/bin/mocha.js test/integration -t 5000",
+    "unit-test": "cross-env TS_NODE_PROJECT='tsconfig.test.json' mocha 'test/unit/**/*.{js,ts}'",
+    "integration-test": "npm run integration-test-graphbinary",
+    "integration-test-graphbinary": "cross-env TS_NODE_PROJECT='tsconfig.test.json' CLIENT_MIMETYPE='application/vnd.graphbinary-v4.0' mocha test/integration -t 5000",
     "TODO": "# test other mime types like graphbinary stringd",
-    "features": "npm run features-graphson30 && npm run features-graphbinary",
-    "features-graphson30": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --tags \"not @DataUUID and not @DataLong\" --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
-    "features-graphbinary": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong\" --require test/cucumber ../../../../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
-    "features-docker": "npm run features-graphson30-docker && npm run features-graphbinary-docker",
-    "features-graphson30-docker": "cross-env CLIENT_MIMETYPE='application/vnd.gremlin-v3.0+json' cucumber-js --tags \"not @DataUUID and not @DataLong\" --require test/cucumber ../gremlin-test/",
-    "features-graphbinary-docker": "cross-env CLIENT_MIMETYPE='application/vnd.graphbinary-v1.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong\" --require test/cucumber ../gremlin-test/",
-    "lint": "eslint --ext .js ."
+    "features": "npm run features-graphbinary",
+    "features-graphbinary": "cross-env NODE_OPTIONS='--loader ts-node/esm' TS_NODE_PROJECT='tsconfig.test.json' CLIENT_MIMETYPE='application/vnd.graphbinary-v4.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong and not @StepWrite\" --import test/cucumber ../../gremlin-test/src/main/resources/org/apache/tinkerpop/gremlin/test/features/",
+    "features-docker": "npm run features-graphbinary-docker",
+    "features-graphbinary-docker": "cross-env NODE_OPTIONS='--loader ts-node/esm' TS_NODE_PROJECT='tsconfig.test.json' CLIENT_MIMETYPE='application/vnd.graphbinary-v4.0' cucumber-js --tags \"not @DataBigDecimal and not @DataBigInt and not @DataUUID and not @DataLong and not @StepWrite\" --import test/cucumber ../gremlin-test/",
+    "lint": "eslint --ext .js .",
+    "doc": "typedoc --out doc --readme README.md --entryPointStrategy expand --entryPoints 'lib/**/*.ts' --tsconfig tsconfig.json --exclude 'lib/language/grammar/**'"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   }
 }

package/.eslintrc.js

@@ -1,154 +0,0 @@
-/*
- *  Licensed to the Apache Software Foundation (ASF) under one
- *  or more contributor license agreements.  See the NOTICE file
- *  distributed with this work for additional information
- *  regarding copyright ownership.  The ASF licenses this file
- *  to you under the Apache License, Version 2.0 (the
- *  "License"); you may not use this file except in compliance
- *  with the License.  You may obtain a copy of the License at
- *
- *  http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing,
- *  software distributed under the License is distributed on an
- *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- *  KIND, either express or implied.  See the License for the
- *  specific language governing permissions and limitations
- *  under the License.
- */
-
-'use strict';
-
-module.exports = {
-  env: {
-    commonjs: true,
-    es2022: true,
-    node: true,
-  },
-  parserOptions: {
-    ecmaVersion: 2022,
-  },
-  ignorePatterns: ['test/**/*.js', 'doc/**/*.js'],
-  extends: ['eslint:recommended', 'prettier'],
-  plugins: ['prettier'],
-  rules: {
-    'prettier/prettier': ['error', { endOfLine: 'auto' }],
-    'linebreak-style': 0,
-    quotes: ['error', 'single'],
-    semi: ['error', 'always'],
-    'no-constant-condition': ['error', { checkLoops: false }],
-    strict: ['error', 'global'],
-    'array-callback-return': 'error',
-    curly: 'error',
-    'no-unused-vars': ['error', { args: 'none' }],
-    'global-require': 'error',
-    eqeqeq: ['error', 'allow-null'],
-
-    // make sure for-in loops have an if statement
-    'guard-for-in': 'error',
-    'no-alert': 'error',
-    'no-caller': 'error',
-    'no-case-declarations': 'error',
-    'no-else-return': 'error',
-    'no-empty-pattern': 'error',
-    'no-eval': 'error',
-    'no-extend-native': 'error',
-    'no-extra-bind': 'error',
-    'no-extra-label': 'error',
-    'no-floating-decimal': 'error',
-    'no-global-assign': ['error', { exceptions: [] }],
-    'no-implicit-coercion': [
-      'off',
-      {
-        boolean: false,
-        number: true,
-        string: true,
-        allow: [],
-      },
-    ],
-    'no-implied-eval': 'error',
-    'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
-    'no-lone-blocks': 'error',
-    'no-loop-func': 'error',
-    //
-    // disallow use of multiple spaces
-    'no-multi-spaces': 'error',
-    'no-new': 'error',
-    'no-new-func': 'error',
-    'no-new-wrappers': 'error',
-    'no-octal-escape': 'error',
-    'no-proto': 'error',
-    'no-prototype-builtins': 0,
-    'no-redeclare': 'error',
-    'no-restricted-properties': [
-      'error',
-      {
-        object: 'arguments',
-        property: 'callee',
-        message: 'arguments.callee is deprecated',
-      },
-      {
-        property: '__defineGetter__',
-        message: 'Please use Object.defineProperty instead.',
-      },
-      {
-        property: '__defineSetter__',
-        message: 'Please use Object.defineProperty instead.',
-      },
-    ],
-    'no-self-assign': 'error',
-    'no-self-compare': 'error',
-    'no-sequences': 'error',
-    'no-throw-literal': 'error',
-    'no-unmodified-loop-condition': 'off',
-    'no-unused-expressions': [
-      'error',
-      {
-        allowShortCircuit: false,
-        allowTernary: false,
-      },
-    ],
-    'no-useless-call': 'off',
-    'no-useless-concat': 'error',
-    'no-useless-escape': 'error',
-    'no-useless-return': 'error',
-    'no-void': 'error',
-    'no-with': 'error',
-    'no-buffer-constructor': 'error',
-    radix: 'error',
-    'no-var': 'error',
-    'prefer-const': 'error',
-    'arrow-body-style': ['error', 'as-needed'],
-    'arrow-spacing': 'error',
-    'no-confusing-arrow': ['error', { allowParens: true }],
-    yoda: 'error',
-    'constructor-super': 'error',
-    'require-await': 'error',
-    'require-atomic-updates': 'off',
-  },
-  globals: {
-    Buffer: 'off',
-    Promise: true,
-    Symbol: false,
-    Uint16Array: false,
-    Int32Array: false,
-    Int8Array: false,
-    BigInt: false,
-    process: false,
-    setInterval: false,
-    setTimeout: false,
-    setImmediate: false,
-    clearInterval: false,
-    clearTimeout: false,
-    describe: false,
-    xdescribe: false,
-    it: false,
-    xit: false,
-    context: false,
-    after: false,
-    afterEach: false,
-    before: false,
-    beforeEach: false,
-    __filename: false,
-  },
-};

package/.nvmrc

@@ -1 +0,0 @@
-18

package/Gruntfile.js

@@ -1,35 +0,0 @@
-/*
- *  Licensed to the Apache Software Foundation (ASF) under one
- *  or more contributor license agreements.  See the NOTICE file
- *  distributed with this work for additional information
- *  regarding copyright ownership.  The ASF licenses this file
- *  to you under the Apache License, Version 2.0 (the
- *  "License"); you may not use this file except in compliance
- *  with the License.  You may obtain a copy of the License at
- *
- *  http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing,
- *  software distributed under the License is distributed on an
- *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- *  KIND, either express or implied.  See the License for the
- *  specific language governing permissions and limitations
- *  under the License.
- */
-'use strict';
-
-module.exports = function (grunt) {
-  grunt.loadNpmTasks('grunt-jsdoc');
-  grunt.initConfig({
-    jsdoc: {
-      dist: {
-        src: ['lib'],
-        options: {
-          destination: 'doc',
-          recurse: true,
-          readme: 'README.md',
-        },
-      },
-    },
-  });
-};

package/NOTICE

@@ -1,5 +0,0 @@
-Apache TinkerPop
-Copyright 2015-2025 The Apache Software Foundation.
-
-This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).