arangojs 7.8.0 → 8.0.0

package/graph.js

@@ -20,7 +20,7 @@ const documents_1 = require("./documents");
 const error_1 = require("./error");
 const codes_1 = require("./lib/codes");
 /**
- * Indicates whether the given value represents a {@link Graph}.
+ * Indicates whether the given value represents a {@link graph.Graph}.
  *
  * @param graph - A value that might be a Graph.
  */
@@ -30,7 +30,6 @@ function isArangoGraph(graph) {
 exports.isArangoGraph = isArangoGraph;
 /**
  * @internal
- * @hidden
  */
 function mungeGharialResponse(body, prop) {
     const { new: newDoc, old: oldDoc, [prop]: doc, ...meta } = body;
@@ -43,28 +42,26 @@ function mungeGharialResponse(body, prop) {
 }
 /**
  * @internal
- * @hidden
  */
 function coerceEdgeDefinition(options) {
     const edgeDefinition = {};
-    edgeDefinition.collection = collection_1.collectionToString(options.collection);
+    edgeDefinition.collection = (0, collection_1.collectionToString)(options.collection);
     edgeDefinition.from = Array.isArray(options.from)
         ? options.from.map(collection_1.collectionToString)
-        : [collection_1.collectionToString(options.from)];
+        : [(0, collection_1.collectionToString)(options.from)];
     edgeDefinition.to = Array.isArray(options.to)
         ? options.to.map(collection_1.collectionToString)
-        : [collection_1.collectionToString(options.to)];
+        : [(0, collection_1.collectionToString)(options.to)];
     return edgeDefinition;
 }
 /**
- * Represents a {@link DocumentCollection} of vertices in a {@link Graph}.
+ * Represents a {@link collection.DocumentCollection} of vertices in a {@link graph.Graph}.
  *
  * @param T - Type to use for document data. Defaults to `any`.
  */
 class GraphVertexCollection {
     /**
      * @internal
-     * @hidden
      */
     constructor(db, name, graph) {
         this._db = db;
@@ -87,13 +84,13 @@ class GraphVertexCollection {
         return this._name;
     }
     /**
-     * A {@link DocumentCollection} instance for this vertex collection.
+     * A {@link collection.DocumentCollection} instance for this vertex collection.
      */
     get collection() {
         return this._collection;
     }
     /**
-     * The {@link Graph} instance this vertex collection is bound to.
+     * The {@link graph.Graph} instance this vertex collection is bound to.
      */
     get graph() {
         return this._graph;
@@ -122,7 +119,7 @@ class GraphVertexCollection {
         try {
             return await this._db.request({
                 method: "HEAD",
-                path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+                path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             }, () => true);
         }
         catch (err) {
@@ -141,7 +138,7 @@ class GraphVertexCollection {
         if (rev)
             headers["if-match"] = rev;
         const result = this._db.request({
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             headers,
             qs,
             allowDirtyRead,
@@ -152,7 +149,7 @@ class GraphVertexCollection {
             return await result;
         }
         catch (err) {
-            if (error_1.isArangoError(err) && err.errorNum === codes_1.DOCUMENT_NOT_FOUND) {
+            if ((0, error_1.isArangoError)(err) && err.errorNum === codes_1.DOCUMENT_NOT_FOUND) {
                 return null;
             }
             throw err;
@@ -176,7 +173,7 @@ class GraphVertexCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "PUT",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             body: newValue,
             qs,
             headers,
@@ -192,7 +189,7 @@ class GraphVertexCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "PATCH",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             body: newValue,
             qs,
             headers,
@@ -208,7 +205,7 @@ class GraphVertexCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "DELETE",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/vertex/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             qs,
             headers,
         }, (res) => mungeGharialResponse(res.body, "removed"));
@@ -216,14 +213,13 @@ class GraphVertexCollection {
 }
 exports.GraphVertexCollection = GraphVertexCollection;
 /**
- * Represents a {@link EdgeCollection} of edges in a {@link Graph}.
+ * Represents a {@link collection.EdgeCollection} of edges in a {@link graph.Graph}.
  *
  * @param T - Type to use for document data. Defaults to `any`.
  */
 class GraphEdgeCollection {
     /**
      * @internal
-     * @hidden
      */
     constructor(db, name, graph) {
         this._db = db;
@@ -246,13 +242,13 @@ class GraphEdgeCollection {
         return this._name;
     }
     /**
-     * A {@link EdgeCollection} instance for this edge collection.
+     * A {@link collection.EdgeCollection} instance for this edge collection.
      */
     get collection() {
         return this._collection;
     }
     /**
-     * The {@link Graph} instance this edge collection is bound to.
+     * The {@link graph.Graph} instance this edge collection is bound to.
      */
     get graph() {
         return this._graph;
@@ -281,7 +277,7 @@ class GraphEdgeCollection {
         try {
             return await this._db.request({
                 method: "HEAD",
-                path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+                path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             }, () => true);
         }
         catch (err) {
@@ -300,7 +296,7 @@ class GraphEdgeCollection {
         if (rev)
             headers["if-match"] = rev;
         const result = this._db.request({
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             qs,
             allowDirtyRead,
         }, (res) => res.body.edge);
@@ -310,7 +306,7 @@ class GraphEdgeCollection {
             return await result;
         }
         catch (err) {
-            if (error_1.isArangoError(err) && err.errorNum === codes_1.DOCUMENT_NOT_FOUND) {
+            if ((0, error_1.isArangoError)(err) && err.errorNum === codes_1.DOCUMENT_NOT_FOUND) {
                 return null;
             }
             throw err;
@@ -334,7 +330,7 @@ class GraphEdgeCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "PUT",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             body: newValue,
             qs,
             headers,
@@ -350,7 +346,7 @@ class GraphEdgeCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "PATCH",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             body: newValue,
             qs,
             headers,
@@ -366,7 +362,7 @@ class GraphEdgeCollection {
             headers["if-match"] = rev;
         return this._db.request({
             method: "DELETE",
-            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI(documents_1._documentHandle(selector, this._name))}`,
+            path: `/_api/gharial/${encodeURIComponent(this.graph.name)}/edge/${encodeURI((0, documents_1._documentHandle)(selector, this._name))}`,
             qs,
             headers,
         }, (res) => mungeGharialResponse(res.body, "removed"));
@@ -374,12 +370,11 @@ class GraphEdgeCollection {
 }
 exports.GraphEdgeCollection = GraphEdgeCollection;
 /**
- * Represents a graph in a {@link Database}.
+ * Represents a graph in a {@link database.Database}.
  */
 class Graph {
     /**
      * @internal
-     * @hidden
      */
     constructor(db, name) {
         this._name = name.normalize("NFC");
@@ -416,7 +411,7 @@ class Graph {
             return true;
         }
         catch (err) {
-            if (error_1.isArangoError(err) && err.errorNum === codes_1.GRAPH_NOT_FOUND) {
+            if ((0, error_1.isArangoError)(err) && err.errorNum === codes_1.GRAPH_NOT_FOUND) {
                 return false;
             }
             throw err;
@@ -457,8 +452,8 @@ class Graph {
      * // graph now exists
      * ```
      */
-    create(edgeDefinitions, options) {
-        const { orphanCollections, satellites, waitForSync, isSmart, isDisjoint, ...opts } = options !== null && options !== void 0 ? options : {};
+    create(edgeDefinitions, options = {}) {
+        const { orphanCollections, satellites, waitForSync, isSmart, isDisjoint, ...opts } = options;
         return this._db.request({
             method: "POST",
             path: "/_api/gharial",
@@ -466,12 +461,12 @@ class Graph {
                 orphanCollections: orphanCollections &&
                     (Array.isArray(orphanCollections)
                         ? orphanCollections.map(collection_1.collectionToString)
-                        : [collection_1.collectionToString(orphanCollections)]),
+                        : [(0, collection_1.collectionToString)(orphanCollections)]),
                 edgeDefinitions: edgeDefinitions.map(coerceEdgeDefinition),
                 isSmart,
                 isDisjoint,
                 name: this._name,
-                options: { ...opts, satellites: satellites === null || satellites === void 0 ? void 0 : satellites.map(collection_1.collectionToString) },
+                options: { ...opts, satellites: satellites?.map(collection_1.collectionToString) },
             },
             qs: { waitForSync },
         }, (res) => res.body.graph);
@@ -498,20 +493,20 @@ class Graph {
         }, (res) => res.body.removed);
     }
     /**
-     * Returns a {@link GraphVertexCollection} instance for the given collection
+     * Returns a {@link graph.GraphVertexCollection} instance for the given collection
      * name representing the collection in this graph.
      *
      * @param T - Type to use for document data. Defaults to `any`.
      * @param collection - Name of the vertex collection.
      */
     vertexCollection(collection) {
-        return new GraphVertexCollection(this._db, collection_1.collectionToString(collection), this);
+        return new GraphVertexCollection(this._db, (0, collection_1.collectionToString)(collection), this);
     }
     /**
      * Fetches all vertex collections of this graph from the database and returns
      * an array of their names.
      *
-     * See also {@link Graph.vertexCollections}.
+     * See also {@link graph.Graph#vertexCollections}.
      *
      * @example
      * ```js
@@ -533,9 +528,9 @@ class Graph {
     }
     /**
      * Fetches all vertex collections of this graph from the database and returns
-     * an array of {@link GraphVertexCollection} instances.
+     * an array of {@link graph.GraphVertexCollection} instances.
      *
-     * See also {@link Graph.listVertexCollections}.
+     * See also {@link graph.Graph#listVertexCollections}.
      *
      * @example
      * ```js
@@ -576,14 +571,14 @@ class Graph {
      * // The collection "extra-vertices" has been added to the graph
      * ```
      */
-    addVertexCollection(collection, options) {
-        const { satellites, ...opts } = options !== null && options !== void 0 ? options : {};
+    addVertexCollection(collection, options = {}) {
+        const { satellites, ...opts } = options;
         return this._db.request({
             method: "POST",
             path: `/_api/gharial/${encodeURIComponent(this._name)}/vertex`,
             body: {
-                collection: collection_1.collectionToString(collection),
-                options: { ...opts, satellites: satellites === null || satellites === void 0 ? void 0 : satellites.map(collection_1.collectionToString) },
+                collection: (0, collection_1.collectionToString)(collection),
+                options: { ...opts, satellites: satellites?.map(collection_1.collectionToString) },
             },
         }, (res) => res.body.graph);
     }
@@ -612,14 +607,14 @@ class Graph {
     removeVertexCollection(collection, dropCollection = false) {
         return this._db.request({
             method: "DELETE",
-            path: `/_api/gharial/${encodeURIComponent(this._name)}/vertex/${encodeURIComponent(collection_1.collectionToString(collection))}`,
+            path: `/_api/gharial/${encodeURIComponent(this._name)}/vertex/${encodeURIComponent((0, collection_1.collectionToString)(collection))}`,
             qs: {
                 dropCollection,
             },
         }, (res) => res.body.graph);
     }
     /**
-     * Returns a {@link GraphEdgeCollection} instance for the given collection
+     * Returns a {@link graph.GraphEdgeCollection} instance for the given collection
      * name representing the collection in this graph.
      *
      * @param T - Type to use for document data. Defaults to `any`.
@@ -642,13 +637,13 @@ class Graph {
      * ```
      */
     edgeCollection(collection) {
-        return new GraphEdgeCollection(this._db, collection_1.collectionToString(collection), this);
+        return new GraphEdgeCollection(this._db, (0, collection_1.collectionToString)(collection), this);
     }
     /**
      * Fetches all edge collections of this graph from the database and returns
      * an array of their names.
      *
-     * See also {@link Graph.edgeCollections}.
+     * See also {@link graph.Graph#edgeCollections}.
      *
      * @example
      * ```js
@@ -670,9 +665,9 @@ class Graph {
     }
     /**
      * Fetches all edge collections of this graph from the database and returns
-     * an array of {@link GraphEdgeCollection} instances.
+     * an array of {@link graph.GraphEdgeCollection} instances.
      *
-     * See also {@link Graph.listEdgeCollections}.
+     * See also {@link graph.Graph#listEdgeCollections}.
      *
      * @example
      * ```js
@@ -713,18 +708,18 @@ class Graph {
      * // The edge definition has been added to the graph
      * ```
      */
-    addEdgeDefinition(edgeDefinition, options) {
-        const { satellites, ...opts } = options !== null && options !== void 0 ? options : {};
+    addEdgeDefinition(edgeDefinition, options = {}) {
+        const { satellites, ...opts } = options;
         return this._db.request({
             method: "POST",
             path: `/_api/gharial/${encodeURIComponent(this._name)}/edge`,
             body: {
                 ...coerceEdgeDefinition(edgeDefinition),
-                options: { ...opts, satellites: satellites === null || satellites === void 0 ? void 0 : satellites.map(collection_1.collectionToString) },
+                options: { ...opts, satellites: satellites?.map(collection_1.collectionToString) },
             },
         }, (res) => res.body.graph);
     }
-    replaceEdgeDefinition(collectionOrEdgeDefinitionOptions, edgeDefinitionOrOptions, options) {
+    replaceEdgeDefinition(collectionOrEdgeDefinitionOptions, edgeDefinitionOrOptions, options = {}) {
         let collection = collectionOrEdgeDefinitionOptions;
         let edgeDefinition = edgeDefinitionOrOptions;
         if (edgeDefinitionOrOptions &&
@@ -737,13 +732,13 @@ class Graph {
                 collectionOrEdgeDefinitionOptions;
             collection = edgeDefinition.collection;
         }
-        const { satellites, ...opts } = options !== null && options !== void 0 ? options : {};
+        const { satellites, ...opts } = options;
         return this._db.request({
             method: "PUT",
-            path: `/_api/gharial/${encodeURIComponent(this._name)}/edge/${encodeURIComponent(collection_1.collectionToString(collection))}`,
+            path: `/_api/gharial/${encodeURIComponent(this._name)}/edge/${encodeURIComponent((0, collection_1.collectionToString)(collection))}`,
             body: {
                 ...coerceEdgeDefinition(edgeDefinition),
-                options: { ...opts, satellites: satellites === null || satellites === void 0 ? void 0 : satellites.map(collection_1.collectionToString) },
+                options: { ...opts, satellites: satellites?.map(collection_1.collectionToString) },
             },
         }, (res) => res.body.graph);
     }
@@ -772,7 +767,7 @@ class Graph {
     removeEdgeDefinition(collection, dropCollection = false) {
         return this._db.request({
             method: "DELETE",
-            path: `/_api/gharial/${encodeURIComponent(this._name)}/edge/${encodeURIComponent(collection_1.collectionToString(collection))}`,
+            path: `/_api/gharial/${encodeURIComponent(this._name)}/edge/${encodeURIComponent((0, collection_1.collectionToString)(collection))}`,
             qs: {
                 dropCollection,
             },
@@ -782,7 +777,7 @@ class Graph {
      * Performs a traversal starting from the given `startVertex` and following
      * edges contained in this graph.
      *
-     * See also {@link EdgeCollection.traversal}.
+     * See also {@link collection.EdgeCollection#traversal}.
      *
      * @param startVertex - Document `_id` of a vertex in this graph.
      * @param options - Options for performing the traversal.
@@ -801,12 +796,13 @@ class Graph {
      *   ["y", "vertices/b", "vertices/c"],
      *   ["z", "vertices/c", "vertices/d"],
      * ]);
-     * const result = await graph.traversal("vertices/a", {
-     *   direction: "outbound",
-     *   init: "result.vertices = [];",
-     *   visitor: "result.vertices.push(vertex._key);",
-     * });
-     * console.log(result.vertices); // ["a", "b", "c", "d"]
+     * const startVertex = "vertices/a";
+     * const cursor = await db.query(aql`
+     *   FOR vertex IN OUTBOUND ${startVertex} GRAPH ${graph}
+     *   RETURN vertex._key
+     * `);
+     * const result = await cursor.all();
+     * console.log(result); // ["a", "b", "c", "d"]
      * ```
      */
     traversal(startVertex, options) {