gremlin 3.8.1 → 4.0.0-beta.3

package/build/cjs/process/anonymous-traversal.cjs

@@ -0,0 +1,82 @@
+"use strict";
+/*
+ *  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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const remote_connection_js_1 = require("../driver/remote-connection.cjs");
+const graph_js_1 = require("../structure/graph.cjs");
+const graph_traversal_js_1 = require("./graph-traversal.cjs");
+const traversal_strategy_js_1 = require("./traversal-strategy.cjs");
+const gremlin_lang_js_1 = __importDefault(require("./gremlin-lang.cjs"));
+/**
+ * Provides a unified way to construct a <code>TraversalSource</code> from the perspective of the traversal. In this
+ * syntax the user is creating the source and binding it to a reference which is either an existing <code>Graph</code>
+ * instance or a <code>RemoteConnection</code>.
+ */
+class AnonymousTraversalSource {
+    traversalSourceClass;
+    traversalClass;
+    /**
+     * Creates a new instance of `AnonymousTraversalSource`.
+     * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor.
+     * @param {Function} [traversalClass] Optional `GraphTraversal` constructor.
+     */
+    constructor(traversalSourceClass, traversalClass) {
+        this.traversalSourceClass = traversalSourceClass;
+        this.traversalClass = traversalClass;
+    }
+    /**
+     * Constructs an `AnonymousTraversalSource` which will then be configured to spawn a
+     * {@link GraphTraversalSource}.
+     * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor.
+     * @param {Function} [traversalClass] Optional `GraphTraversalSource` constructor.
+     * @returns {AnonymousTraversalSource}.
+     */
+    static traversal(traversalSourceClass, traversalClass) {
+        return new AnonymousTraversalSource(traversalSourceClass || graph_traversal_js_1.GraphTraversalSource, traversalClass || graph_traversal_js_1.GraphTraversal);
+    }
+    /**
+     * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
+     * reference so that traversals spawned from it will execute over that reference.
+     * @param {RemoteConnection} connection
+     * @return {GraphTraversalSource}
+     */
+    with_(connection) {
+        const traversalStrategies = new traversal_strategy_js_1.TraversalStrategies();
+        traversalStrategies.addStrategy(new remote_connection_js_1.RemoteStrategy(connection));
+        const gl = new gremlin_lang_js_1.default();
+        if (connection.options?.pdtRegistry) {
+            gl.pdtRegistry = connection.options.pdtRegistry;
+        }
+        return new this.traversalSourceClass(new graph_js_1.Graph(), traversalStrategies, gl, this.traversalSourceClass, this.traversalClass);
+    }
+    /**
+     * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
+     * reference so that traversals spawned from it will execute over that reference.
+     * @param {RemoteConnection} remoteConnection
+     * @return {GraphTraversalSource}
+     * @deprecated As of release 3.8.0, prefer {@link with_}.
+     */
+    withRemote(remoteConnection) {
+        return this.with_(remoteConnection);
+    }
+}
+exports.default = AnonymousTraversalSource;

package/build/cjs/process/anonymous-traversal.d.cts

@@ -0,0 +1,40 @@
+import { RemoteConnection } from '../driver/remote-connection.cjs';
+import { GraphTraversalSource, GraphTraversal } from './graph-traversal.cjs';
+/**
+ * Provides a unified way to construct a <code>TraversalSource</code> from the perspective of the traversal. In this
+ * syntax the user is creating the source and binding it to a reference which is either an existing <code>Graph</code>
+ * instance or a <code>RemoteConnection</code>.
+ */
+export default class AnonymousTraversalSource {
+    readonly traversalSourceClass?: typeof GraphTraversalSource | undefined;
+    readonly traversalClass?: typeof GraphTraversal | undefined;
+    /**
+     * Creates a new instance of `AnonymousTraversalSource`.
+     * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor.
+     * @param {Function} [traversalClass] Optional `GraphTraversal` constructor.
+     */
+    constructor(traversalSourceClass?: typeof GraphTraversalSource | undefined, traversalClass?: typeof GraphTraversal | undefined);
+    /**
+     * Constructs an `AnonymousTraversalSource` which will then be configured to spawn a
+     * {@link GraphTraversalSource}.
+     * @param {Function} [traversalSourceClass] Optional `GraphTraversalSource` constructor.
+     * @param {Function} [traversalClass] Optional `GraphTraversalSource` constructor.
+     * @returns {AnonymousTraversalSource}.
+     */
+    static traversal(traversalSourceClass?: typeof GraphTraversalSource, traversalClass?: typeof GraphTraversal): AnonymousTraversalSource;
+    /**
+     * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
+     * reference so that traversals spawned from it will execute over that reference.
+     * @param {RemoteConnection} connection
+     * @return {GraphTraversalSource}
+     */
+    with_(connection: RemoteConnection): GraphTraversalSource;
+    /**
+     * Creates a {@link GraphTraversalSource} binding a {@link RemoteConnection} to a remote {@link Graph} instances as its
+     * reference so that traversals spawned from it will execute over that reference.
+     * @param {RemoteConnection} remoteConnection
+     * @return {GraphTraversalSource}
+     * @deprecated As of release 3.8.0, prefer {@link with_}.
+     */
+    withRemote(remoteConnection: RemoteConnection): GraphTraversalSource;
+}