gremlin 3.8.1 → 4.0.0-beta.3

package/build/esm/driver/request-message.js

@@ -0,0 +1,238 @@
+/*
+ * 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 GremlinLang from '../process/gremlin-lang.js';
+// Token constants
+const Tokens = {
+    ARGS_LANGUAGE: 'language',
+    ARGS_PARAMETERS: 'parameters',
+    ARGS_G: 'g',
+    ARGS_MATERIALIZE_PROPERTIES: 'materializeProperties',
+    TIMEOUT_MILLIS: 'timeoutMillis',
+    BULK_RESULTS: 'bulkResults',
+    BATCH_SIZE: 'batchSize',
+    MATERIALIZE_PROPERTIES_TOKENS: 'tokens',
+    MATERIALIZE_PROPERTIES_ALL: 'all'
+};
+/**
+ * The model for a request message in the HTTP body that is sent to the server beginning in 4.0.0.
+ */
+export class RequestMessage {
+    gremlin;
+    language;
+    timeoutMillis;
+    parameters;
+    g;
+    materializeProperties;
+    bulkResults;
+    batchSize;
+    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.timeoutMillis = timeoutMillis;
+        this.parameters = parameters;
+        this.g = g;
+        this.materializeProperties = materializeProperties;
+        this.bulkResults = bulkResults;
+        this.batchSize = batchSize;
+        this.customFields = customFields;
+    }
+    getGremlin() {
+        return this.gremlin;
+    }
+    getLanguage() {
+        return this.language;
+    }
+    getTimeoutMillis() {
+        return this.timeoutMillis;
+    }
+    getParameters() {
+        return this.parameters;
+    }
+    getG() {
+        return this.g;
+    }
+    getMaterializeProperties() {
+        return this.materializeProperties;
+    }
+    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);
+    }
+}
+/**
+ * Builder class for RequestMessage.
+ */
+export class Builder {
+    gremlin;
+    parameters = {};
+    parametersString;
+    language;
+    timeoutMillis;
+    g;
+    materializeProperties;
+    bulkResults;
+    batchSize;
+    additionalFields = new Map();
+    constructor(gremlin) {
+        this.gremlin = gremlin;
+        this.language = "gremlin-lang";
+    }
+    addLanguage(language) {
+        if (!language)
+            throw new Error('language argument cannot be null.');
+        this.language = language;
+        return this;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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) {
+        if (!g)
+            throw new Error('g argument cannot be null.');
+        this.g = g;
+        return this;
+    }
+    addMaterializeProperties(materializeProps) {
+        if (!materializeProps)
+            throw new Error('materializeProps argument cannot be null.');
+        if (materializeProps !== Tokens.MATERIALIZE_PROPERTIES_TOKENS &&
+            materializeProps !== Tokens.MATERIALIZE_PROPERTIES_ALL) {
+            throw new Error(`materializeProperties argument must be either "${Tokens.MATERIALIZE_PROPERTIES_TOKENS}" or "${Tokens.MATERIALIZE_PROPERTIES_ALL}".`);
+        }
+        this.materializeProperties = materializeProps;
+        return this;
+    }
+    addTimeoutMillis(timeout) {
+        if (timeout < 0)
+            throw new Error('timeout argument cannot be negative.');
+        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;
+    }
+    /**
+     * 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 = GremlinLang.convertParametersToString(new Map(Object.entries(this.parameters)));
+        }
+        // @ts-ignore - accessing private constructor from Builder
+        return new RequestMessage(this.gremlin, this.language || 'gremlin-lang', this.timeoutMillis, parameters, this.g, this.materializeProperties, this.bulkResults, this.batchSize, this.additionalFields);
+    }
+}

package/build/esm/driver/response-error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents an error obtained from the server.
+ */
+export default class ResponseError extends Error {
+    statusCode: number;
+    statusMessage: string;
+    statusException: string | null;
+    constructor(message: string, responseStatus: {
+        code: ResponseError['statusCode'];
+        message: ResponseError['statusMessage'];
+        exception?: ResponseError['statusException'];
+    });
+}

package/{lib/driver/auth/mechanisms/sasl-mechanism-base.js → build/esm/driver/response-error.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
@@ -16,37 +16,27 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
-'use strict';
-
-/** @abstract */
-class SaslMechanismBase {
-  constructor(options) {
-    this.setopts(options);
-  }
-
-  /**
-   * Returns the name of the mechanism
-   */
-  get name() {
-    return null;
-  }
-
-  /**
-   * Set the options for the mechanism
-   * @param {object} options Options specific to the mechanism
-   */
-  setopts(options) {
-    this._options = options;
-  }
-
-  /**
-   * @abstract
-   * Evaluates the challenge from the server and returns appropriate response
-   * @param {String} challenge Challenge string presented by the server
-   */
-  evaluateChallenge(challenge) {
-    throw new Error('evaluateChallenge should be implemented');
-  }
+/**
+ * Represents an error obtained from the server.
+ */
+export default class ResponseError extends Error {
+    statusCode;
+    statusMessage;
+    statusException;
+    constructor(message, responseStatus) {
+        super(message);
+        this.name = 'ResponseError';
+        /**
+         * Gets the server status code.
+         */
+        this.statusCode = responseStatus.code;
+        /**
+         * Gets the server status message.
+         */
+        this.statusMessage = responseStatus.message;
+        /**
+         * Gets the server exception string (v4 protocol).
+         */
+        this.statusException = responseStatus.exception ?? null;
+    }
 }
-
-module.exports = SaslMechanismBase;

package/build/esm/driver/result-set.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Represents the response returned from the execution of a Gremlin traversal or script.
+ */
+export default class ResultSet {
+    private readonly items;
+    private readonly attributes;
+    readonly length: number;
+    /**
+     * Creates a new instance of {@link ResultSet}.
+     * @param {Array} items
+     * @param {Map} [attributes]
+     */
+    constructor(items: any[], attributes: Map<string, any>);
+    /**
+     * Gets the iterator associated with this instance.
+     * @returns {Iterator}
+     */
+    [Symbol.iterator](): ArrayIterator<any>;
+    /**
+     * Gets an array of result items.
+     * @returns {Array}
+     */
+    toArray(): Array<any>;
+    /**
+     * Returns the first item.
+     * @returns {Object|null}
+     */
+    first(): any | null;
+}

package/build/esm/driver/result-set.js

@@ -0,0 +1,75 @@
+/*
+ *  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 Jorge Bay Gondra
+ */
+import * as utils from '../utils.js';
+const emptyMap = Object.freeze(new utils.ImmutableMap());
+/**
+ * Represents the response returned from the execution of a Gremlin traversal or script.
+ */
+export default class ResultSet {
+    items;
+    attributes;
+    length;
+    /**
+     * Creates a new instance of {@link ResultSet}.
+     * @param {Array} items
+     * @param {Map} [attributes]
+     */
+    constructor(items, attributes) {
+        this.items = items;
+        if (!Array.isArray(items)) {
+            throw new TypeError('items must be an Array instance');
+        }
+        this.items = items;
+        /**
+         * Gets a Map representing the attributes of the response.
+         * @type {Map}
+         */
+        this.attributes = attributes || emptyMap;
+        /**
+         * Gets the amount of items in the result.
+         * @type {Number}
+         */
+        this.length = items.length;
+    }
+    /**
+     * Gets the iterator associated with this instance.
+     * @returns {Iterator}
+     */
+    [Symbol.iterator]() {
+        return this.items[Symbol.iterator]();
+    }
+    /**
+     * Gets an array of result items.
+     * @returns {Array}
+     */
+    toArray() {
+        return this.items;
+    }
+    /**
+     * Returns the first item.
+     * @returns {Object|null}
+     */
+    first() {
+        const item = this.items[0];
+        return item !== undefined ? item : null;
+    }
+}