gremlin 3.8.0 → 3.8.2

package/eslint.config.mjs

@@ -0,0 +1,143 @@
+/*
+ *  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.
+ */
+
+import js from "@eslint/js";
+import prettier from "eslint-config-prettier";
+import prettierPlugin from "eslint-plugin-prettier";
+import globals from "globals";
+
+export default [
+  js.configs.recommended,
+  prettier,
+  {
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: "commonjs",
+      globals: {
+        ...globals.node,
+        ...globals.commonjs,
+        ...globals.mocha,
+        BigInt: "readonly",
+      },
+    },
+    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"],
+      "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",
+      "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",
+    },
+  },
+  {
+    ignores: ["test/**/*.js", "doc/**/*.js", "node_modules/**/*", ".prettierrc.js", "eslint.config.mjs"],
+  },
+  {
+    files: ["eslint.config.mjs"],
+    languageOptions: {
+      sourceType: "module",
+    },
+  },
+];

package/index.js

@@ -7,7 +7,7 @@
  *  "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
+ *    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

package/lib/process/traversal-strategy.js

@@ -276,6 +276,10 @@ class PathRetractionStrategy extends TraversalStrategy {
   }
 }
 
+/**
+ * @deprecated As of release 3.7.7, not replaced. This strategy was added as a temporary way to mimic pre-3.5.0
+ * null processing behavior.
+ */
 class ProductiveByStrategy extends TraversalStrategy {
   /**
    * @param {Object} [options]

package/lib/process/traversal.js

@@ -94,12 +94,35 @@ class Traversal {
   }
 
   /**
-   * Async iterator method implementation.
-   * Returns a promise containing an iterator item.
-   * @returns {Promise.<{value, done}>}
+   * Returns the next result from the traversal.
+   *
+   * When called without an argument, returns a Promise that resolves to an iterator
+   * item ({value, done}), following the async iterator protocol.
+   *
+   * When called with an amount, returns a Promise that resolves to an Array containing
+   * up to {@code amount} result values. The Array form is always used when an amount is
+   * supplied, including {@code next(1)}, which resolves to an Array of one value rather
+   * than a bare value, matching the behavior of next(n) in the other Gremlin language
+   * variants. If fewer results remain, the Array contains only those that remain, and an
+   * amount of zero or less yields an empty Array.
+   * @param {Number} [amount] The number of results to retrieve.
+   * @returns {Promise.<{value, done}>|Promise.<Array>}
    */
-  next() {
-    return this._applyStrategies().then(() => this._getNext());
+  next(amount) {
+    if (amount === undefined || amount === null) {
+      return this._applyStrategies().then(() => this._getNext());
+    }
+    return this._applyStrategies().then(() => {
+      const result = [];
+      for (let i = 0; i < amount; i++) {
+        const it = this._getNext();
+        if (it.done) {
+          break;
+        }
+        result.push(it.value);
+      }
+      return result;
+    });
   }
 
   /**

package/lib/structure/graph.js

@@ -61,6 +61,19 @@ class Element {
   equals(other) {
     return other instanceof Element && this.id === other.id;
   }
+
+  /**
+   * Groups this element's properties by key.
+   * @returns {Object<string, Object[]>} a map of property key to the array of
+   *   property objects for that key (empty object when there are no properties).
+   */
+  propertyMap() {
+    const map = Object.create(null);
+    for (const p of this.properties) {
+      (map[p.key] = map[p.key] || []).push(p);
+    }
+    return map;
+  }
 }
 
 class Vertex extends Element {

package/lib/structure/io/binary/internals/OffsetDateTimeSerializer.js

@@ -143,6 +143,15 @@ module.exports = class OffsetDateTimeSerializer {
       // use UTC time calculated with offset above
       const v = new Date(Date.UTC(year, month, date, h, m, s, ms));
 
+      // The GraphBinary DateTime/OffsetDateTime wire format can carry values (e.g. extreme years near
+      // +/-999999999) that fall outside the range representable by a JavaScript Date. In those cases
+      // Date.UTC(...) returns NaN and new Date(NaN) yields an invalid Date without throwing. Reject such
+      // values here so unsupported boundary date-times fail deserialization instead of silently producing
+      // an unusable Date instance.
+      if (Number.isNaN(v.getTime())) {
+        throw new Error('{value} is outside the range supported by JavaScript Date');
+      }
+
       return { v, len };
     } catch (err) {
       throw this.ioc.utils.des_error({ serializer: this, args: arguments, cursor, err });

package/lib/structure/io/type-serializers.js

@@ -103,7 +103,15 @@ class OffsetDateTimeSerializer extends TypeSerializer {
   }
 
   deserialize(obj) {
-    return new Date(obj[valueKey]);
+    // An OffsetDateTime value can carry a date-time (e.g. extreme years) that falls outside the range
+    // representable by a JavaScript Date. In those cases new Date(...) yields an invalid Date without
+    // throwing. Reject such values so unsupported boundary date-times fail deserialization instead of
+    // silently producing an unusable Date instance. Mirrors the GraphBinary OffsetDateTime reader.
+    const value = new Date(obj[valueKey]);
+    if (Number.isNaN(value.getTime())) {
+      throw new Error('OffsetDateTime value is outside the range supported by JavaScript Date');
+    }
+    return value;
   }
 
   canBeUsedFor(value) {

package/lib/utils.js

@@ -25,7 +25,7 @@
 
 const uuid = require('uuid');
 
-const gremlinVersion = '3.8.0'; // DO NOT MODIFY - Configured automatically by Maven Replacer Plugin
+const gremlinVersion = '3.8.2'; // DO NOT MODIFY - Configured automatically by Maven Replacer Plugin
 
 exports.toLong = function toLong(value) {
   return new Long(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gremlin",
-  "version": "3.8.0",
+  "version": "3.8.2",
   "description": "JavaScript Gremlin Language Variant",
   "author": {
     "name": "Apache TinkerPop team"
@@ -19,25 +19,26 @@
   "license": "Apache-2.0",
   "dependencies": {
     "buffer": "^6.0.3",
-    "eventemitter3": "^5.0.1",
-    "readable-stream": "^4.5.2",
-    "uuid": "^9.0.1",
-    "ws": "^8.16.0"
+    "eventemitter3": "^5.0.4",
+    "readable-stream": "^4.7.0",
+    "uuid": "^11.1.1",
+    "ws": "^8.21.1"
   },
   "devDependencies": {
     "chai": "~4.5.0",
-    "chai-string": "~1.5.0",
+    "chai-string": "~1.6.0",
     "colors": "1.4.0",
-    "cross-env": "^7.0.3",
-    "cucumber": "~6.0.7",
-    "eslint": "^8.42.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"
+    "cross-env": "^10.1.0",
+    "@cucumber/cucumber": "~12.7.0",
+    "@eslint/js": "^9.16.0",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "globals": "^15.14.0",
+    "jsdoc": "^4.0.5",
+    "js-yaml": "^3.14.2",
+    "mocha": "^11.7.6",
+    "prettier": "^3.9.6"
   },
   "repository": {
     "type": "git",
@@ -60,7 +61,8 @@
     "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 ."
+    "lint": "eslint .",
+    "doc": "jsdoc -r -d doc -R README.md lib/"
   },
   "engines": {
     "node": ">=20"

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/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/doc/DataType.js.html

@@ -1,150 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: DataType.js</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Source: DataType.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/*
- *  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.
- */
-
-/**
- * @author Igor Ostapenko
- */
-
-/**
- * Represents a GraphBinary data type.
- *
- * See org.apache.tinkerpop.gremlin.structure.io.binary.DataType Java class.
- */
-const DataType = {
-  INT: 0x01,
-  LONG: 0x02,
-  STRING: 0x03,
-  DATE: 0x04,
-  TIMESTAMP: 0x05,
-  CLASS: 0x06,
-  DOUBLE: 0x07,
-  FLOAT: 0x08,
-  LIST: 0x09,
-  MAP: 0x0a,
-  SET: 0x0b,
-  UUID: 0x0c,
-  EDGE: 0x0d,
-  PATH: 0x0e,
-  PROPERTY: 0x0f,
-  GRAPH: 0x10,
-  VERTEX: 0x11,
-  VERTEXPROPERTY: 0x12,
-  BARRIER: 0x13,
-  BINDING: 0x14,
-  BYTECODE: 0x15,
-  CARDINALITY: 0x16,
-  COLUMN: 0x17,
-  DIRECTION: 0x18,
-  OPERATOR: 0x19,
-  ORDER: 0x1a,
-  PICK: 0x1b,
-  POP: 0x1c,
-  LAMBDA: 0x1d,
-  P: 0x1e,
-  SCOPE: 0x1f,
-  T: 0x20,
-  TRAVERSER: 0x21,
-  BIGDECIMAL: 0x22,
-  BIGINTEGER: 0x23,
-  BYTE: 0x24,
-  BYTEBUFFER: 0x25,
-  SHORT: 0x26,
-  BOOLEAN: 0x27,
-  TEXTP: 0x28,
-  TRAVERSALSTRATEGY: 0x29,
-  BULKSET: 0x2a,
-  TREE: 0x2b,
-  METRICS: 0x2c,
-  TRAVERSALMETRICS: 0x2d,
-  MERGE: 0x2e,
-  DT: 0x2f,
-  GTYPE: 0x30,
-
-  CHAR: 0x80,
-  DURATION: 0x81,
-  INETADDRESS: 0x82,
-  INSTANT: 0x83,
-  LOCALDATE: 0x84,
-  LOCALDATETIME: 0x85,
-  LOCALTIME: 0x86,
-  MONTHDAY: 0x87,
-  OFFSETDATETIME: 0x88,
-  OFFSETTIME: 0x89,
-  PERIOD: 0x8a,
-  YEAR: 0x8b,
-  YEARMONTH: 0x8c,
-  ZONEDATETIME: 0x8d,
-  ZONEOFFSET: 0x8e,
-
-  CUSTOM: 0,
-  UNSPECIFIED_NULL: 0xfe,
-};
-
-export default DataType;
-</code></pre>
-        </article>
-    </section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Nov 10 2025 14:42:27 GMT-0800 (Pacific Standard Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>