arangojs 7.6.0 → 7.8.0

package/database.js

@@ -77,7 +77,7 @@ class Database {
         this._views = new Map();
         if (isArangoDatabase(configOrDatabase)) {
             const connection = configOrDatabase._connection;
-            const databaseName = name || configOrDatabase.name;
+            const databaseName = (name || configOrDatabase.name).normalize("NFC");
             this._connection = connection;
             this._name = databaseName;
             const database = connection.database(databaseName);
@@ -90,7 +90,7 @@ class Database {
                 ? { databaseName: name, url: config }
                 : config;
             this._connection = new connection_1.Connection(options);
-            this._name = databaseName || "_system";
+            this._name = (databaseName === null || databaseName === void 0 ? void 0 : databaseName.normalize("NFC")) || "_system";
         }
     }
     //#region misc
@@ -158,7 +158,7 @@ class Database {
     }
     request({ absolutePath = false, basePath, ...opts }, transform) {
         if (!absolutePath) {
-            basePath = `/_db/${this.name}${basePath || ""}`;
+            basePath = `/_db/${encodeURIComponent(this._name)}${basePath || ""}`;
         }
         return this._connection.request({ basePath, ...opts }, transform);
     }
@@ -218,7 +218,27 @@ class Database {
         this._connection.close();
     }
     async waitForPropagation({ basePath, ...request }, timeout) {
-        await this._connection.waitForPropagation({ ...request, basePath: `/_db/${this.name}${basePath || ""}` }, timeout);
+        await this._connection.waitForPropagation({
+            ...request,
+            basePath: `/_db/${encodeURIComponent(this._name)}${basePath || ""}`,
+        }, timeout);
+    }
+    /**
+     * Methods for accessing the server-reported queue times of the mostly
+     * recently received responses.
+     */
+    get queueTime() {
+        return this._connection.queueTime;
+    }
+    /**
+     * Sets the limit for the number of values of the most recently received
+     * server-reported queue times that can be accessed using
+     * {@link Database.queueTime}.
+     *
+     * @param responseQueueTimeSamples - Number of values to maintain.
+     */
+    setResponseQueueTimeSamples(responseQueueTimeSamples) {
+        this._connection.setResponseQueueTimeSamples(responseQueueTimeSamples);
     }
     //#endregion
     //#region auth
@@ -243,7 +263,7 @@ class Database {
      */
     useDatabase(databaseName) {
         this._connection.database(this._name, null);
-        this._name = databaseName;
+        this._name = databaseName.normalize("NFC");
         return this;
     }
     /**
@@ -328,8 +348,7 @@ class Database {
      * ```
      */
     database(databaseName) {
-        const db = new Database(this, databaseName);
-        return db;
+        return new Database(this, databaseName);
     }
     /**
      * Fetches the database description for the active database from the server.
@@ -373,7 +392,7 @@ class Database {
         return this.request({
             method: "POST",
             path: "/_api/database",
-            body: { name: databaseName, users, options },
+            body: { name: databaseName.normalize("NFC"), users, options },
         }, () => this.database(databaseName));
     }
     /**
@@ -456,9 +475,10 @@ class Database {
      * ```
      */
     dropDatabase(databaseName) {
+        databaseName = databaseName.normalize("NFC");
         return this.request({
             method: "DELETE",
-            path: `/_api/database/${databaseName}`,
+            path: `/_api/database/${encodeURIComponent(databaseName)}`,
         }, (res) => res.body.result);
     }
     //#endregion
@@ -503,6 +523,7 @@ class Database {
      * ```
      */
     collection(collectionName) {
+        collectionName = collectionName.normalize("NFC");
         if (!this._collections.has(collectionName)) {
             this._collections.set(collectionName, new collection_1.Collection(this, collectionName));
         }
@@ -560,10 +581,11 @@ class Database {
      * @param newName - The new name of the collection.
      */
     async renameCollection(collectionName, newName) {
+        collectionName = collectionName.normalize("NFC");
         const result = await this.request({
             method: "PUT",
-            path: `/_api/collection/${collectionName}/rename`,
-            body: { name: newName },
+            path: `/_api/collection/${encodeURIComponent(collectionName)}/rename`,
+            body: { name: newName.normalize("NFC") },
         }, (res) => res.body);
         this._collections.delete(collectionName);
         return result;
@@ -647,6 +669,7 @@ class Database {
      * ```
      */
     graph(graphName) {
+        graphName = graphName.normalize("NFC");
         if (!this._graphs.has(graphName)) {
             this._graphs.set(graphName, new graph_1.Graph(this, graphName));
         }
@@ -661,7 +684,7 @@ class Database {
      * @param options - An object defining the properties of the graph.
      */
     async createGraph(graphName, edgeDefinitions, options) {
-        const graph = this.graph(graphName);
+        const graph = this.graph(graphName.normalize("NFC"));
         await graph.create(edgeDefinitions, options);
         return graph;
     }
@@ -712,6 +735,7 @@ class Database {
      * ```
      */
     view(viewName) {
+        viewName = viewName.normalize("NFC");
         if (!this._views.has(viewName)) {
             this._views.set(viewName, new view_1.View(this, viewName));
         }
@@ -732,7 +756,7 @@ class Database {
      * ```
      */
     async createView(viewName, options) {
-        const view = this.view(viewName);
+        const view = this.view(viewName.normalize("NFC"));
         await view.create({ ...options, type: view_1.ViewType.ARANGOSEARCH_VIEW });
         return view;
     }
@@ -749,10 +773,11 @@ class Database {
      * @param newName - The new name of the view.
      */
     async renameView(viewName, newName) {
+        viewName = viewName.normalize("NFC");
         const result = await this.request({
             method: "PUT",
-            path: `/_api/view/${viewName}/rename`,
-            body: { name: newName },
+            path: `/_api/view/${encodeURIComponent(viewName)}/rename`,
+            body: { name: newName.normalize("NFC") },
         }, (res) => res.body);
         this._views.delete(viewName);
         return result;
@@ -805,6 +830,7 @@ class Database {
      * ```
      */
     analyzer(analyzerName) {
+        analyzerName = analyzerName.normalize("NFC");
         if (!this._analyzers.has(analyzerName)) {
             this._analyzers.set(analyzerName, new analyzer_1.Analyzer(this, analyzerName));
         }
@@ -896,7 +922,7 @@ class Database {
     getUser(username) {
         return this.request({
             absolutePath: true,
-            path: `/_api/user/${username}`,
+            path: `/_api/user/${encodeURIComponent(username)}`,
         });
     }
     createUser(username, options) {
@@ -917,7 +943,7 @@ class Database {
         return this.request({
             absolutePath: true,
             method: "PATCH",
-            path: `/api/user/${username}`,
+            path: `/api/user/${encodeURIComponent(username)}`,
             body: options,
         }, (res) => res.body);
     }
@@ -941,7 +967,7 @@ class Database {
         return this.request({
             absolutePath: true,
             method: "PUT",
-            path: `/api/user/${username}`,
+            path: `/api/user/${encodeURIComponent(username)}`,
             body: options,
         }, (res) => res.body);
     }
@@ -961,7 +987,7 @@ class Database {
         return this.request({
             absolutePath: true,
             method: "DELETE",
-            path: `/_api/user/${username}`,
+            path: `/_api/user/${encodeURIComponent(username)}`,
         }, (res) => res.body);
     }
     /**
@@ -1031,19 +1057,23 @@ class Database {
      * });
      * // The access level of the user "steve" has been fetched for the
      * // "pokemons" collection in database "staging".
+     * ```
      */
     getUserAccessLevel(username, { database, collection }) {
+        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+            : (_a = database === null || database === void 0 ? void 0 : database.normalize("NFC")) !== null && _a !== void 0 ? _a : (collection_1.isArangoCollection(collection)
                 ? collection._db.name
-                : this.name);
+                : this._name);
         const suffix = collection
-            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+                ? collection.name
+                : collection.normalize("NFC"))}`
             : "";
         return this.request({
             absolutePath: true,
-            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+            path: `/_api/user/${encodeURIComponent(username)}/database/${encodeURIComponent(databaseName)}${suffix}`,
         }, (res) => res.body);
     }
     /**
@@ -1119,18 +1149,21 @@ class Database {
      * ```
      */
     setUserAccessLevel(username, { database, collection, grant, }) {
+        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+            : (_a = database === null || database === void 0 ? void 0 : database.normalize("NFC")) !== null && _a !== void 0 ? _a : (collection_1.isArangoCollection(collection)
                 ? collection._db.name
-                : this.name);
+                : this._name);
         const suffix = collection
-            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+                ? collection.name
+                : collection.normalize("NFC"))}`
             : "";
         return this.request({
             absolutePath: true,
             method: "PUT",
-            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+            path: `/_api/user/${encodeURIComponent(username)}/database/${encodeURIComponent(databaseName)}${suffix}`,
             body: { grant },
         }, (res) => res.body);
     }
@@ -1198,24 +1231,27 @@ class Database {
      * ```
      */
     clearUserAccessLevel(username, { database, collection }) {
+        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+            : (_a = database === null || database === void 0 ? void 0 : database.normalize("NFC")) !== null && _a !== void 0 ? _a : (collection_1.isArangoCollection(collection)
                 ? collection._db.name
-                : this.name);
+                : this._name);
         const suffix = collection
-            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+                ? collection.name
+                : collection.normalize("NFC"))}`
             : "";
         return this.request({
             absolutePath: true,
             method: "DELETE",
-            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+            path: `/_api/user/${encodeURIComponent(username)}/database/${encodeURIComponent(databaseName)}${suffix}`,
         }, (res) => res.body);
     }
     getUserDatabases(username, full) {
         return this.request({
             absolutePath: true,
-            path: `/_api/user/${username}/database`,
+            path: `/_api/user/${encodeURIComponent(username)}/database`,
             qs: { full },
         });
     }
@@ -1302,7 +1338,7 @@ class Database {
         else if (aql_1.isAqlLiteral(query)) {
             query = query.toAQL();
         }
-        const { allowDirtyRead, count, batchSize, cache, memoryLimit, ttl, timeout, ...opts } = options || {};
+        const { allowDirtyRead, retryOnConflict, count, batchSize, cache, memoryLimit, ttl, timeout, ...opts } = options || {};
         return this.request({
             method: "POST",
             path: "/_api/cursor",
@@ -1317,6 +1353,7 @@ class Database {
                 options: opts,
             },
             allowDirtyRead,
+            retryOnConflict,
             timeout,
         }, (res) => new cursor_1.BatchedArrayCursor(this, res.body, res.arangojsHostId, allowDirtyRead).items);
     }
@@ -1459,7 +1496,7 @@ class Database {
     killQuery(queryId) {
         return this.request({
             method: "DELETE",
-            path: `/_api/query/${queryId}`,
+            path: `/_api/query/${encodeURIComponent(queryId)}`,
         }, () => undefined);
     }
     //#endregion
@@ -1533,7 +1570,7 @@ class Database {
     dropFunction(name, group = false) {
         return this.request({
             method: "DELETE",
-            path: `/_api/aqlfunction/${name}`,
+            path: `/_api/aqlfunction/${encodeURIComponent(name)}`,
             qs: { group },
         }, (res) => res.body);
     }
@@ -1923,7 +1960,7 @@ class Database {
     runServiceScript(mount, name, params) {
         return this.request({
             method: "POST",
-            path: `/_api/foxx/scripts/${name}`,
+            path: `/_api/foxx/scripts/${encodeURIComponent(name)}`,
             body: params,
             qs: { mount },
         }, (res) => res.body);