gremlin 4.0.0-beta.2 → 4.0.0-beta.3

package/build/cjs/driver/request-message.cjs

@@ -17,16 +17,21 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Builder = exports.RequestMessage = void 0;
+const gremlin_lang_js_1 = __importDefault(require("../process/gremlin-lang.cjs"));
 // Token constants
 const Tokens = {
     ARGS_LANGUAGE: 'language',
-    ARGS_BINDINGS: 'bindings',
+    ARGS_PARAMETERS: 'parameters',
     ARGS_G: 'g',
     ARGS_MATERIALIZE_PROPERTIES: 'materializeProperties',
-    TIMEOUT_MS: 'timeoutMs',
+    TIMEOUT_MILLIS: 'timeoutMillis',
     BULK_RESULTS: 'bulkResults',
+    BATCH_SIZE: 'batchSize',
     MATERIALIZE_PROPERTIES_TOKENS: 'tokens',
     MATERIALIZE_PROPERTIES_ALL: 'all'
 };
@@ -36,23 +41,25 @@ const Tokens = {
 class RequestMessage {
     gremlin;
     language;
-    timeoutMs;
-    bindings;
+    timeoutMillis;
+    parameters;
     g;
     materializeProperties;
     bulkResults;
+    batchSize;
     customFields;
-    constructor(gremlin, language, timeoutMs, bindings, g, materializeProperties, bulkResults, customFields) {
+    constructor(gremlin, language, timeoutMillis, parameters, g, materializeProperties, bulkResults, batchSize, customFields) {
         if (!gremlin) {
             throw new Error('RequestMessage requires gremlin argument');
         }
         this.gremlin = gremlin;
         this.language = language;
-        this.timeoutMs = timeoutMs;
-        this.bindings = bindings;
+        this.timeoutMillis = timeoutMillis;
+        this.parameters = parameters;
         this.g = g;
         this.materializeProperties = materializeProperties;
         this.bulkResults = bulkResults;
+        this.batchSize = batchSize;
         this.customFields = customFields;
     }
     getGremlin() {
@@ -61,11 +68,11 @@ class RequestMessage {
     getLanguage() {
         return this.language;
     }
-    getTimeoutMs() {
-        return this.timeoutMs;
+    getTimeoutMillis() {
+        return this.timeoutMillis;
     }
-    getBindings() {
-        return this.bindings;
+    getParameters() {
+        return this.parameters;
     }
     getG() {
         return this.g;
@@ -76,9 +83,49 @@ class RequestMessage {
     getBulkResults() {
         return this.bulkResults;
     }
+    getBatchSize() {
+        return this.batchSize;
+    }
     getFields() {
         return this.customFields;
     }
+    /**
+     * Builds the plain object that represents this message on the wire. Standard fields are
+     * included when set, and custom fields are flattened to the top level. This method is
+     * invoked automatically by {@link JSON.stringify}.
+     *
+     * When a new standard field is added to this class, it should be added here as well so that
+     * it is included in the serialized request body.
+     */
+    toJSON() {
+        const payload = { gremlin: this.gremlin };
+        if (this.language) {
+            payload['language'] = this.language;
+        }
+        if (this.g) {
+            payload['g'] = this.g;
+        }
+        if (this.parameters !== undefined) {
+            payload['parameters'] = this.parameters;
+        }
+        if (this.timeoutMillis !== undefined) {
+            payload['timeoutMillis'] = this.timeoutMillis;
+        }
+        if (this.materializeProperties) {
+            payload['materializeProperties'] = this.materializeProperties;
+        }
+        if (this.bulkResults !== undefined) {
+            payload['bulkResults'] = this.bulkResults;
+        }
+        if (this.batchSize !== undefined) {
+            payload['batchSize'] = this.batchSize;
+        }
+        // Flatten custom/provider fields to the top level
+        this.customFields.forEach((v, k) => {
+            payload[k] = v;
+        });
+        return payload;
+    }
     static build(gremlin) {
         return new Builder(gremlin);
     }
@@ -89,12 +136,14 @@ exports.RequestMessage = RequestMessage;
  */
 class Builder {
     gremlin;
-    bindings = {};
+    parameters = {};
+    parametersString;
     language;
-    timeoutMs;
+    timeoutMillis;
     g;
     materializeProperties;
     bulkResults;
+    batchSize;
     additionalFields = new Map();
     constructor(gremlin) {
         this.gremlin = gremlin;
@@ -106,14 +155,39 @@ class Builder {
         this.language = language;
         return this;
     }
-    addBinding(key, value) {
-        Object.assign(this.bindings, { [key]: value });
+    /**
+     * Adds a single query parameter. The accumulated parameters map is converted to a gremlin-lang
+     * map literal string when the message is created.
+     * Cannot be mixed with {@link addParametersString}.
+     */
+    addParameter(key, value) {
+        if (this.parametersString)
+            throw new Error('Cannot mix addParameter() with addParametersString().');
+        Object.assign(this.parameters, { [key]: value });
+        return this;
+    }
+    /**
+     * Merges the provided parameters into the accumulated parameters map. The values are converted to a
+     * gremlin-lang map literal string when the message is created.
+     * Cannot be mixed with {@link addParametersString}.
+     */
+    addParameters(otherParameters) {
+        if (!otherParameters)
+            throw new Error('parameters argument cannot be null.');
+        if (this.parametersString)
+            throw new Error('Cannot mix addParameters() with addParametersString().');
+        Object.assign(this.parameters, otherParameters);
         return this;
     }
-    addBindings(otherBindings) {
-        if (!otherBindings)
-            throw new Error('bindings argument cannot be null.');
-        Object.assign(this.bindings, otherBindings);
+    /**
+     * Sets the query parameters as a pre-formatted gremlin-lang map literal string (e.g. `'["x":1,"y":"knows"]'`).
+     * Calling this method replaces any previously set parameters string (last-one-wins).
+     * Cannot be mixed with {@link addParameter} or {@link addParameters}.
+     */
+    addParametersString(parametersString) {
+        if (Object.keys(this.parameters).length > 0)
+            throw new Error('Cannot mix addParametersString() with addParameter()/addParameters().');
+        this.parametersString = parametersString;
         return this;
     }
     addG(g) {
@@ -135,13 +209,19 @@ class Builder {
     addTimeoutMillis(timeout) {
         if (timeout < 0)
             throw new Error('timeout argument cannot be negative.');
-        this.timeoutMs = timeout;
+        this.timeoutMillis = timeout;
         return this;
     }
     addBulkResults(bulking) {
         this.bulkResults = bulking;
         return this;
     }
+    addBatchSize(batchSize) {
+        if (batchSize <= 0)
+            throw new Error('batchSize argument must be positive.');
+        this.batchSize = batchSize;
+        return this;
+    }
     addField(key, value) {
         this.additionalFields.set(key, value);
         return this;
@@ -150,8 +230,17 @@ class Builder {
      * Create the request message given the settings provided to the Builder.
      */
     create() {
+        // mutual exclusion between addParameters/addParameter and addParametersString is
+        // enforced at call time, so only one path can be set here
+        let parameters;
+        if (this.parametersString) {
+            parameters = this.parametersString;
+        }
+        else if (Object.keys(this.parameters).length > 0) {
+            parameters = gremlin_lang_js_1.default.convertParametersToString(new Map(Object.entries(this.parameters)));
+        }
         // @ts-ignore - accessing private constructor from Builder
-        return new RequestMessage(this.gremlin, this.language || 'gremlin-lang', this.timeoutMs, Object.keys(this.bindings).length > 0 ? this.bindings : undefined, this.g, this.materializeProperties, this.bulkResults, this.additionalFields);
+        return new RequestMessage(this.gremlin, this.language || 'gremlin-lang', this.timeoutMillis, parameters, this.g, this.materializeProperties, this.bulkResults, this.batchSize, this.additionalFields);
     }
 }
 exports.Builder = Builder;

package/build/cjs/driver/request-message.d.cts

@@ -4,21 +4,32 @@
 export declare class RequestMessage {
     private gremlin;
     private language;
-    private timeoutMs?;
-    private bindings?;
+    private timeoutMillis?;
+    private parameters?;
     private g?;
     private materializeProperties?;
     private bulkResults?;
+    private batchSize?;
     private customFields;
     private constructor();
     getGremlin(): string;
     getLanguage(): string;
-    getTimeoutMs(): number | undefined;
-    getBindings(): object | undefined;
+    getTimeoutMillis(): number | undefined;
+    getParameters(): object | undefined;
     getG(): string | undefined;
     getMaterializeProperties(): string | undefined;
     getBulkResults(): boolean | undefined;
+    getBatchSize(): number | undefined;
     getFields(): ReadonlyMap<string, any>;
+    /**
+     * Builds the plain object that represents this message on the wire. Standard fields are
+     * included when set, and custom fields are flattened to the top level. This method is
+     * invoked automatically by {@link JSON.stringify}.
+     *
+     * When a new standard field is added to this class, it should be added here as well so that
+     * it is included in the serialized request body.
+     */
+    toJSON(): Record<string, any>;
     static build(gremlin: string): Builder;
 }
 /**
@@ -26,21 +37,40 @@ export declare class RequestMessage {
  */
 export declare class Builder {
     private readonly gremlin;
-    private readonly bindings;
+    private readonly parameters;
+    private parametersString?;
     language: string;
-    timeoutMs?: number;
+    timeoutMillis?: number;
     g?: string;
     materializeProperties?: string;
     bulkResults?: boolean;
+    batchSize?: number;
     additionalFields: Map<string, any>;
     constructor(gremlin: string);
     addLanguage(language: string): Builder;
-    addBinding(key: string, value: any): Builder;
-    addBindings(otherBindings: object): Builder;
+    /**
+     * Adds a single query parameter. The accumulated parameters map is converted to a gremlin-lang
+     * map literal string when the message is created.
+     * Cannot be mixed with {@link addParametersString}.
+     */
+    addParameter(key: string, value: any): Builder;
+    /**
+     * Merges the provided parameters into the accumulated parameters map. The values are converted to a
+     * gremlin-lang map literal string when the message is created.
+     * Cannot be mixed with {@link addParametersString}.
+     */
+    addParameters(otherParameters: object): Builder;
+    /**
+     * Sets the query parameters as a pre-formatted gremlin-lang map literal string (e.g. `'["x":1,"y":"knows"]'`).
+     * Calling this method replaces any previously set parameters string (last-one-wins).
+     * Cannot be mixed with {@link addParameter} or {@link addParameters}.
+     */
+    addParametersString(parametersString: string): Builder;
     addG(g: string): Builder;
     addMaterializeProperties(materializeProps: string): Builder;
     addTimeoutMillis(timeout: number): Builder;
     addBulkResults(bulking: boolean): Builder;
+    addBatchSize(batchSize: number): Builder;
     addField(key: string, value: any): Builder;
     /**
      * Create the request message given the settings provided to the Builder.

package/build/cjs/driver/response-error.cjs

@@ -24,7 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 class ResponseError extends Error {
     statusCode;
     statusMessage;
-    statusAttributes;
+    statusException;
     constructor(message, responseStatus) {
         super(message);
         this.name = 'ResponseError';
@@ -37,9 +37,9 @@ class ResponseError extends Error {
          */
         this.statusMessage = responseStatus.message;
         /**
-         * Gets the server status attributes as a Map (may contain provider specific status information).
+         * Gets the server exception string (v4 protocol).
          */
-        this.statusAttributes = responseStatus.attributes || {};
+        this.statusException = responseStatus.exception ?? null;
     }
 }
 exports.default = ResponseError;

package/build/cjs/driver/response-error.d.cts

@@ -4,10 +4,10 @@
 export default class ResponseError extends Error {
     statusCode: number;
     statusMessage: string;
-    statusAttributes: Map<string, string>;
+    statusException: string | null;
     constructor(message: string, responseStatus: {
         code: ResponseError['statusCode'];
         message: ResponseError['statusMessage'];
-        attributes: ResponseError['statusAttributes'];
+        exception?: ResponseError['statusException'];
     });
 }

package/build/cjs/index.cjs

@@ -62,13 +62,16 @@ const t = __importStar(require("./process/traversal.cjs"));
 const gt = __importStar(require("./process/graph-traversal.cjs"));
 const strategiesModule = __importStar(require("./process/traversal-strategy.cjs"));
 const graph = __importStar(require("./structure/graph.cjs"));
+const PDTRegistry_js_1 = require("./structure/PDTRegistry.cjs");
 const rc = __importStar(require("./driver/remote-connection.cjs"));
 const gremlin_lang_js_1 = __importDefault(require("./process/gremlin-lang.cjs"));
+const gvalue_js_1 = require("./process/gvalue.cjs");
 const utils = __importStar(require("./utils.cjs"));
 const driver_remote_connection_js_1 = __importDefault(require("./driver/driver-remote-connection.cjs"));
 const response_error_js_1 = __importDefault(require("./driver/response-error.cjs"));
 const client_js_1 = __importDefault(require("./driver/client.cjs"));
 const result_set_js_1 = __importDefault(require("./driver/result-set.cjs"));
+const http_request_js_1 = require("./driver/http-request.cjs");
 const auth_js_1 = require("./driver/auth.cjs");
 const anonymous_traversal_js_1 = __importDefault(require("./process/anonymous-traversal.cjs"));
 exports.driver = {
@@ -79,6 +82,7 @@ exports.driver = {
     DriverRemoteConnection: driver_remote_connection_js_1.default,
     Client: client_js_1.default,
     ResultSet: result_set_js_1.default,
+    HttpRequest: http_request_js_1.HttpRequest,
     auth: {
         basic: auth_js_1.basic,
         sigv4: auth_js_1.sigv4,
@@ -109,6 +113,7 @@ exports.process = {
     GraphTraversalSource: gt.GraphTraversalSource,
     statics: gt.statics,
     GremlinLang: gremlin_lang_js_1.default,
+    GValue: gvalue_js_1.GValue,
     traversal: anonymous_traversal_js_1.default.traversal,
     AnonymousTraversalSource: anonymous_traversal_js_1.default,
     withOptions: t.withOptions,
@@ -117,9 +122,25 @@ exports.structure = {
     Edge: graph.Edge,
     Graph: graph.Graph,
     Path: graph.Path,
+    Tree: graph.Tree,
     Property: graph.Property,
+    PrimitivePDT: graph.PrimitivePDT,
+    CompositePDT: graph.CompositePDT,
+    PDTRegistry: PDTRegistry_js_1.PDTRegistry,
     Vertex: graph.Vertex,
     VertexProperty: graph.VertexProperty,
     toLong: utils.toLong,
+    toInt: utils.toInt,
+    toFloat: utils.toFloat,
+    toDouble: utils.toDouble,
+    toShort: utils.toShort,
+    toByte: utils.toByte,
+    Int: utils.Int,
+    Float: utils.Float,
+    Double: utils.Double,
+    Short: utils.Short,
+    Byte: utils.Byte,
+    Long: utils.Long,
+    unwrap: utils.unwrap,
 };
 exports.default = { driver: exports.driver, process: exports.process, structure: exports.structure };

package/build/cjs/index.d.cts

@@ -5,13 +5,16 @@ import * as t from './process/traversal.cjs';
 import * as gt from './process/graph-traversal.cjs';
 import * as strategiesModule from './process/traversal-strategy.cjs';
 import * as graph from './structure/graph.cjs';
+import { PDTRegistry } from './structure/PDTRegistry.cjs';
 import * as rc from './driver/remote-connection.cjs';
 import GremlinLang from './process/gremlin-lang.cjs';
+import { GValue } from './process/gvalue.cjs';
 import * as utils from './utils.cjs';
 import DriverRemoteConnection from './driver/driver-remote-connection.cjs';
 import ResponseError from './driver/response-error.cjs';
 import Client from './driver/client.cjs';
 import ResultSet from './driver/result-set.cjs';
+import { HttpRequest } from './driver/http-request.cjs';
 import { basic, sigv4 } from './driver/auth.cjs';
 import AnonymousTraversalSource from './process/anonymous-traversal.cjs';
 export declare const driver: {
@@ -22,6 +25,7 @@ export declare const driver: {
     DriverRemoteConnection: typeof DriverRemoteConnection;
     Client: typeof Client;
     ResultSet: typeof ResultSet;
+    HttpRequest: typeof HttpRequest;
     auth: {
         basic: typeof basic;
         sigv4: typeof sigv4;
@@ -55,6 +59,7 @@ export declare const process: {
         V: (...args: any[]) => any;
         addE: (...args: any[]) => any;
         addV: (...args: any[]) => any;
+        addLabel: (...args: any[]) => any;
         aggregate: (...args: any[]) => any;
         all: (...args: any[]) => any;
         and: (...args: any[]) => any;
@@ -87,6 +92,8 @@ export declare const process: {
         discard: (...args: any[]) => any;
         disjunct: (...args: any[]) => any;
         drop: (...args: any[]) => any;
+        dropLabel: (...args: any[]) => any;
+        dropLabels: (...args: any[]) => any;
         element: (...args: any[]) => any;
         elementMap: (...args: any[]) => any;
         emit: (...args: any[]) => any;
@@ -114,6 +121,7 @@ export declare const process: {
         is: (...args: any[]) => any;
         key: (...args: any[]) => any;
         label: (...args: any[]) => any;
+        labels: (...args: any[]) => any;
         length: (...args: any[]) => any;
         limit: (...args: any[]) => any;
         local: (...args: any[]) => any;
@@ -177,6 +185,7 @@ export declare const process: {
         where: (...args: any[]) => any;
     };
     GremlinLang: typeof GremlinLang;
+    GValue: typeof GValue;
     traversal: typeof AnonymousTraversalSource.traversal;
     AnonymousTraversalSource: typeof AnonymousTraversalSource;
     withOptions: {
@@ -196,10 +205,26 @@ export declare const structure: {
     Edge: typeof graph.Edge;
     Graph: typeof graph.Graph;
     Path: typeof graph.Path;
+    Tree: typeof graph.Tree;
     Property: typeof graph.Property;
+    PrimitivePDT: typeof graph.PrimitivePDT;
+    CompositePDT: typeof graph.CompositePDT;
+    PDTRegistry: typeof PDTRegistry;
     Vertex: typeof graph.Vertex;
     VertexProperty: typeof graph.VertexProperty;
     toLong: typeof utils.toLong;
+    toInt: typeof utils.toInt;
+    toFloat: typeof utils.toFloat;
+    toDouble: typeof utils.toDouble;
+    toShort: typeof utils.toShort;
+    toByte: typeof utils.toByte;
+    Int: typeof utils.Int;
+    Float: typeof utils.Float;
+    Double: typeof utils.Double;
+    Short: typeof utils.Short;
+    Byte: typeof utils.Byte;
+    Long: typeof utils.Long;
+    unwrap: typeof utils.unwrap;
 };
 declare const _default: {
     driver: {
@@ -210,6 +235,7 @@ declare const _default: {
         DriverRemoteConnection: typeof DriverRemoteConnection;
         Client: typeof Client;
         ResultSet: typeof ResultSet;
+        HttpRequest: typeof HttpRequest;
         auth: {
             basic: typeof basic;
             sigv4: typeof sigv4;
@@ -243,6 +269,7 @@ declare const _default: {
             V: (...args: any[]) => any;
             addE: (...args: any[]) => any;
             addV: (...args: any[]) => any;
+            addLabel: (...args: any[]) => any;
             aggregate: (...args: any[]) => any;
             all: (...args: any[]) => any;
             and: (...args: any[]) => any;
@@ -275,6 +302,8 @@ declare const _default: {
             discard: (...args: any[]) => any;
             disjunct: (...args: any[]) => any;
             drop: (...args: any[]) => any;
+            dropLabel: (...args: any[]) => any;
+            dropLabels: (...args: any[]) => any;
             element: (...args: any[]) => any;
             elementMap: (...args: any[]) => any;
             emit: (...args: any[]) => any;
@@ -302,6 +331,7 @@ declare const _default: {
             is: (...args: any[]) => any;
             key: (...args: any[]) => any;
             label: (...args: any[]) => any;
+            labels: (...args: any[]) => any;
             length: (...args: any[]) => any;
             limit: (...args: any[]) => any;
             local: (...args: any[]) => any;
@@ -365,6 +395,7 @@ declare const _default: {
             where: (...args: any[]) => any;
         };
         GremlinLang: typeof GremlinLang;
+        GValue: typeof GValue;
         traversal: typeof AnonymousTraversalSource.traversal;
         AnonymousTraversalSource: typeof AnonymousTraversalSource;
         withOptions: {
@@ -384,10 +415,26 @@ declare const _default: {
         Edge: typeof graph.Edge;
         Graph: typeof graph.Graph;
         Path: typeof graph.Path;
+        Tree: typeof graph.Tree;
         Property: typeof graph.Property;
+        PrimitivePDT: typeof graph.PrimitivePDT;
+        CompositePDT: typeof graph.CompositePDT;
+        PDTRegistry: typeof PDTRegistry;
         Vertex: typeof graph.Vertex;
         VertexProperty: typeof graph.VertexProperty;
         toLong: typeof utils.toLong;
+        toInt: typeof utils.toInt;
+        toFloat: typeof utils.toFloat;
+        toDouble: typeof utils.toDouble;
+        toShort: typeof utils.toShort;
+        toByte: typeof utils.toByte;
+        Int: typeof utils.Int;
+        Float: typeof utils.Float;
+        Double: typeof utils.Double;
+        Short: typeof utils.Short;
+        Byte: typeof utils.Byte;
+        Long: typeof utils.Long;
+        unwrap: typeof utils.unwrap;
     };
 };
 export default _default;