arangojs 7.8.0 → 8.0.0

package/database.js

@@ -24,7 +24,6 @@ function isArangoDatabase(database) {
 exports.isArangoDatabase = isArangoDatabase;
 /**
  * @internal
- * @hidden
  */
 function coerceTransactionCollections(collections) {
     if (typeof collections === "string") {
@@ -33,8 +32,8 @@ function coerceTransactionCollections(collections) {
     if (Array.isArray(collections)) {
         return { write: collections.map(collection_1.collectionToString) };
     }
-    if (collection_1.isArangoCollection(collections)) {
-        return { write: collection_1.collectionToString(collections) };
+    if ((0, collection_1.isArangoCollection)(collections)) {
+        return { write: (0, collection_1.collectionToString)(collections) };
     }
     const cols = {};
     if (collections) {
@@ -44,17 +43,17 @@ function coerceTransactionCollections(collections) {
         if (collections.read) {
             cols.read = Array.isArray(collections.read)
                 ? collections.read.map(collection_1.collectionToString)
-                : collection_1.collectionToString(collections.read);
+                : (0, collection_1.collectionToString)(collections.read);
         }
         if (collections.write) {
             cols.write = Array.isArray(collections.write)
                 ? collections.write.map(collection_1.collectionToString)
-                : collection_1.collectionToString(collections.write);
+                : (0, collection_1.collectionToString)(collections.write);
         }
         if (collections.exclusive) {
             cols.exclusive = Array.isArray(collections.exclusive)
                 ? collections.exclusive.map(collection_1.collectionToString)
-                : collection_1.collectionToString(collections.exclusive);
+                : (0, collection_1.collectionToString)(collections.exclusive);
         }
     }
     return cols;
@@ -64,12 +63,6 @@ function coerceTransactionCollections(collections) {
  * cursors, analyzers and so on are linked to a `Database` object.
  */
 class Database {
-    // There's currently no way to hide a single overload from typedoc
-    // /**
-    //  * @internal
-    //  * @hidden
-    //  */
-    // constructor(database: Database, name?: string);
     constructor(configOrDatabase = {}, name) {
         this._analyzers = new Map();
         this._collections = new Map();
@@ -90,7 +83,7 @@ class Database {
                 ? { databaseName: name, url: config }
                 : config;
             this._connection = new connection_1.Connection(options);
-            this._name = (databaseName === null || databaseName === void 0 ? void 0 : databaseName.normalize("NFC")) || "_system";
+            this._name = databaseName?.normalize("NFC") || "_system";
         }
     }
     //#region misc
@@ -129,10 +122,10 @@ class Database {
             method: "GET",
             path: "/_api/version",
             qs: { details },
-        }, (res) => res.body);
+        });
     }
     /**
-     * Returns a new {@link Route} instance for the given path (relative to the
+     * Returns a new {@link route.Route} instance for the given path (relative to the
      * database) that can be used to perform arbitrary HTTP requests.
      *
      * @param path - The database-relative URL of the route. Defaults to the
@@ -156,22 +149,25 @@ class Database {
     route(path, headers) {
         return new route_1.Route(this, path, headers);
     }
-    request({ absolutePath = false, basePath, ...opts }, transform) {
+    request({ absolutePath = false, basePath, ...opts }, transform = (res) => res.body) {
         if (!absolutePath) {
             basePath = `/_db/${encodeURIComponent(this._name)}${basePath || ""}`;
         }
-        return this._connection.request({ basePath, ...opts }, transform);
+        return this._connection.request({ basePath, ...opts }, transform || undefined);
     }
     /**
      * Updates the URL list by requesting a list of all coordinators in the
      * cluster and adding any endpoints not initially specified in the
-     * {@link Config}.
+     * {@link connection.Config}.
      *
      * For long-running processes communicating with an ArangoDB cluster it is
      * recommended to run this method periodically (e.g. once per hour) to make
      * sure new coordinators are picked up correctly and can be used for
      * fail-over or load balancing.
      *
+     * @param overwrite - If set to `true`, the existing host list will be
+     * replaced instead of extended.
+     *
      * @example
      * ```js
      * const db = new Database();
@@ -182,12 +178,17 @@ class Database {
      *
      * // later
      * clearInterval(interval);
-     * db.close();
+     * system.close();
      * ```
      */
-    async acquireHostList() {
+    async acquireHostList(overwrite = false) {
         const urls = await this.request({ path: "/_api/cluster/endpoints" }, (res) => res.body.endpoints.map((endpoint) => endpoint.endpoint));
-        this._connection.addToHostList(urls);
+        if (urls.length > 0) {
+            if (overwrite)
+                this._connection.setHostList(urls);
+            else
+                this._connection.addToHostList(urls);
+        }
     }
     /**
      * Closes all active connections of this database instance.
@@ -210,7 +211,7 @@ class Database {
      *     REMOVE session IN ${sessions}
      *   `);
      *   // Making sure to close the connections because they're no longer used
-     *   db.close();
+     *   system.close();
      * }, 1000 * 60 * 60);
      * ```
      */
@@ -233,7 +234,7 @@ class Database {
     /**
      * 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}.
+     * {@link Database#queueTime}.
      *
      * @param responseQueueTimeSamples - Number of values to maintain.
      */
@@ -243,31 +244,7 @@ class Database {
     //#endregion
     //#region auth
     /**
-     * Updates the `Database` instance and its connection string to use the given
-     * `databaseName`, then returns itself.
-     *
-     * **Note**: This also affects all collections, cursors and other arangojs
-     * objects originating from this database object, which may cause unexpected
-     * results.
-     *
-     * @param databaseName - Name of the database to use.
-     *
-     * @deprecated Use {@link Database.database} instead.
-     *
-     * @example
-     * ```js
-     * const systemDb = new Database();
-     * // systemDb.useDatabase("my_database"); // deprecated
-     * const myDb = systemDb.database("my_database");
-     * ```
-     */
-    useDatabase(databaseName) {
-        this._connection.database(this._name, null);
-        this._name = databaseName.normalize("NFC");
-        return this;
-    }
-    /**
-     * Updates the `Database` instance's `authorization` header to use Basic
+     * Updates the underlying connection's `authorization` header to use Basic
      * authentication with the given `username` and `password`, then returns
      * itself.
      *
@@ -277,9 +254,7 @@ class Database {
      * @example
      * ```js
      * const db = new Database();
-     * db.useDatabase("test");
      * db.useBasicAuth("admin", "hunter2");
-     * // The database instance now uses the database "test"
      * // with the username "admin" and password "hunter2".
      * ```
      */
@@ -288,7 +263,7 @@ class Database {
         return this;
     }
     /**
-     * Updates the `Database` instance's `authorization` header to use Bearer
+     * Updates the underlying connection's `authorization` header to use Bearer
      * authentication with the given authentication `token`, then returns itself.
      *
      * @param token - The token to authenticate with.
@@ -315,9 +290,7 @@ class Database {
      * @example
      * ```js
      * const db = new Database();
-     * db.useDatabase("test");
      * await db.login("admin", "hunter2");
-     * // The database instance now uses the database "test"
      * // with an authentication token for the "admin" user.
      * ```
      */
@@ -337,7 +310,7 @@ class Database {
      * Creates a new `Database` instance for the given `databaseName` that
      * shares this database's connection pool.
      *
-     * See also {@link Database.constructor}.
+     * See also {@link Database:constructor}.
      *
      * @param databaseName - Name of the database.
      *
@@ -379,16 +352,16 @@ class Database {
             return true;
         }
         catch (err) {
-            if (error_1.isArangoError(err) && err.errorNum === codes_1.DATABASE_NOT_FOUND) {
+            if ((0, error_1.isArangoError)(err) && err.errorNum === codes_1.DATABASE_NOT_FOUND) {
                 return false;
             }
             throw err;
         }
     }
-    createDatabase(databaseName, usersOrOptions) {
+    createDatabase(databaseName, usersOrOptions = {}) {
         const { users, ...options } = Array.isArray(usersOrOptions)
             ? { users: usersOrOptions }
-            : usersOrOptions || {};
+            : usersOrOptions;
         return this.request({
             method: "POST",
             path: "/_api/database",
@@ -398,8 +371,8 @@ class Database {
     /**
      * Fetches all databases from the server and returns an array of their names.
      *
-     * See also {@link Database.databases} and
-     * {@link Database.listUserDatabases}.
+     * See also {@link Database#databases} and
+     * {@link Database#listUserDatabases}.
      *
      * @example
      * ```js
@@ -415,8 +388,8 @@ class Database {
      * Fetches all databases accessible to the active user from the server and
      * returns an array of their names.
      *
-     * See also {@link Database.userDatabases} and
-     * {@link Database.listDatabases}.
+     * See also {@link Database#userDatabases} and
+     * {@link Database#listDatabases}.
      *
      * @example
      * ```js
@@ -432,8 +405,8 @@ class Database {
      * Fetches all databases from the server and returns an array of `Database`
      * instances for those databases.
      *
-     * See also {@link Database.listDatabases} and
-     * {@link Database.userDatabases}.
+     * See also {@link Database#listDatabases} and
+     * {@link Database#userDatabases}.
      *
      * @example
      * ```js
@@ -449,8 +422,8 @@ class Database {
      * Fetches all databases accessible to the active user from the server and
      * returns an array of `Database` instances for those databases.
      *
-     * See also {@link Database.listUserDatabases} and
-     * {@link Database.databases}.
+     * See also {@link Database#listUserDatabases} and
+     * {@link Database#databases}.
      *
      * @example
      * ```js
@@ -487,8 +460,8 @@ class Database {
      * Returns a `Collection` instance for the given collection name.
      *
      * In TypeScript the collection implements both the
-     * {@link DocumentCollection} and {@link EdgeCollection} interfaces and can
-     * be cast to either type to enforce a stricter API.
+     * {@link collection.DocumentCollection} and {@link collection.EdgeCollection}
+     * interfaces and can be cast to either type to enforce a stricter API.
      *
      * @param T - Type to use for document data. Defaults to `any`.
      * @param collectionName - Name of the edge collection.
@@ -536,10 +509,10 @@ class Database {
     }
     /**
      * Creates a new edge collection with the given `collectionName` and
-     * `options`, then returns an {@link EdgeCollection} instance for the new
+     * `options`, then returns an {@link collection.EdgeCollection} instance for the new
      * edge collection.
      *
-     * This is a convenience method for calling {@link Database.createCollection}
+     * This is a convenience method for calling {@link Database#createCollection}
      * with `options.type` set to `EDGE_COLLECTION`.
      *
      * @param T - Type to use for edge document data. Defaults to `any`.
@@ -586,7 +559,7 @@ class Database {
             method: "PUT",
             path: `/_api/collection/${encodeURIComponent(collectionName)}/rename`,
             body: { name: newName.normalize("NFC") },
-        }, (res) => res.body);
+        });
         this._collections.delete(collectionName);
         return result;
     }
@@ -594,7 +567,7 @@ class Database {
      * Fetches all collections from the database and returns an array of
      * collection descriptions.
      *
-     * See also {@link Database.collections}.
+     * See also {@link Database#collections}.
      *
      * @param excludeSystem - Whether system collections should be excluded.
      *
@@ -625,10 +598,10 @@ class Database {
      * `Collection` instances.
      *
      * In TypeScript these instances implement both the
-     * {@link DocumentCollection} and {@link EdgeCollection} interfaces and can
-     * be cast to either type to enforce a stricter API.
+     * {@link collection.DocumentCollection} and {@link collection.EdgeCollection}
+     * interfaces and can be cast to either type to enforce a stricter API.
      *
-     * See also {@link Database.listCollections}.
+     * See also {@link Database#listCollections}.
      *
      * @param excludeSystem - Whether system collections should be excluded.
      *
@@ -636,18 +609,16 @@ class Database {
      * ```js
      * const db = new Database();
      * const collections = await db.collections();
-     * // collections is an array of DocumentCollection
-     * // and EdgeCollection instances
-     * // not including system collections
+     * // collections is an array of DocumentCollection and EdgeCollection
+     * // instances not including system collections
      * ```
      *
      * @example
      * ```js
      * const db = new Database();
      * const collections = await db.collections(false);
-     * // collections is an array of DocumentCollection
-     * // and EdgeCollection instances
-     * // including system collections
+     * // collections is an array of DocumentCollection and EdgeCollection
+     * // instances including system collections
      * ```
      */
     async collections(excludeSystem = true) {
@@ -657,7 +628,7 @@ class Database {
     //#endregion
     //#region graphs
     /**
-     * Returns a {@link Graph} instance representing the graph with the given
+     * Returns a {@link graph.Graph} instance representing the graph with the given
      * `graphName`.
      *
      * @param graphName - Name of the graph.
@@ -677,7 +648,7 @@ class Database {
     }
     /**
      * Creates a graph with the given `graphName` and `edgeDefinitions`, then
-     * returns a {@link Graph} instance for the new graph.
+     * returns a {@link graph.Graph} instance for the new graph.
      *
      * @param graphName - Name of the graph to be created.
      * @param edgeDefinitions - An array of edge definitions.
@@ -692,7 +663,7 @@ class Database {
      * Fetches all graphs from the database and returns an array of graph
      * descriptions.
      *
-     * See also {@link Database.graphs}.
+     * See also {@link Database#graphs}.
      *
      * @example
      * ```js
@@ -705,10 +676,10 @@ class Database {
         return this.request({ path: "/_api/gharial" }, (res) => res.body.graphs);
     }
     /**
-     * Fetches all graphs from the database and returns an array of {@link Graph}
+     * Fetches all graphs from the database and returns an array of {@link graph.Graph}
      * instances for those graphs.
      *
-     * See also {@link Database.listGraphs}.
+     * See also {@link Database#listGraphs}.
      *
      * @example
      * ```js
@@ -724,9 +695,9 @@ class Database {
     //#endregion
     //#region views
     /**
-     * Returns an {@link ArangoSearchView} instance for the given `viewName`.
+     * Returns a {@link view.View} instance for the given `viewName`.
      *
-     * @param viewName - Name of the ArangoSearch View.
+     * @param viewName - Name of the ArangoSearch or SearchAlias View.
      *
      * @example
      * ```js
@@ -742,28 +713,28 @@ class Database {
         return this._views.get(viewName);
     }
     /**
-     * Creates a new ArangoSearch View with the given `viewName` and `options`
-     * and returns an {@link ArangoSearchView} instance for the created View.
+     * Creates a new View with the given `viewName` and `options`, then returns a
+     * {@link view.View} instance for the new View.
      *
-     * @param viewName - Name of the ArangoSearch View.
+     * @param viewName - Name of the View.
      * @param options - An object defining the properties of the View.
      *
      * @example
      * ```js
      * const db = new Database();
-     * const view = await db.createView("potatoes");
+     * const view = await db.createView("potatoes", { type: "arangosearch" });
      * // the ArangoSearch View "potatoes" now exists
      * ```
      */
     async createView(viewName, options) {
         const view = this.view(viewName.normalize("NFC"));
-        await view.create({ ...options, type: view_1.ViewType.ARANGOSEARCH_VIEW });
+        await view.create(options);
         return view;
     }
     /**
      * Renames the view `viewName` to `newName`.
      *
-     * Additionally removes any stored {@link View} instance for `viewName` from
+     * Additionally removes any stored {@link view.View} instance for `viewName` from
      * the `Database` instance's internal cache.
      *
      * **Note**: Renaming views may not be supported when ArangoDB is running in
@@ -778,7 +749,7 @@ class Database {
             method: "PUT",
             path: `/_api/view/${encodeURIComponent(viewName)}/rename`,
             body: { name: newName.normalize("NFC") },
-        }, (res) => res.body);
+        });
         this._views.delete(viewName);
         return result;
     }
@@ -786,7 +757,7 @@ class Database {
      * Fetches all Views from the database and returns an array of View
      * descriptions.
      *
-     * See also {@link Database.views}.
+     * See also {@link Database#views}.
      *
      * @example
      * ```js
@@ -801,9 +772,10 @@ class Database {
     }
     /**
      * Fetches all Views from the database and returns an array of
-     * {@link ArangoSearchView} instances for the Views.
+     * {@link view.View} instances
+     * for the Views.
      *
-     * See also {@link Database.listViews}.
+     * See also {@link Database#listViews}.
      *
      * @example
      * ```js
@@ -819,7 +791,7 @@ class Database {
     //#endregion
     //#region analyzers
     /**
-     * Returns an {@link Analyzer} instance representing the Analyzer with the
+     * Returns an {@link analyzer.Analyzer} instance representing the Analyzer with the
      * given `analyzerName`.
      *
      * @example
@@ -838,7 +810,7 @@ class Database {
     }
     /**
      * Creates a new Analyzer with the given `analyzerName` and `options`, then
-     * returns an {@link Analyzer} instance for the new Analyzer.
+     * returns an {@link analyzer.Analyzer} instance for the new Analyzer.
      *
      * @param analyzerName - Name of the Analyzer.
      * @param options - An object defining the properties of the Analyzer.
@@ -859,7 +831,7 @@ class Database {
      * Fetches all Analyzers visible in the database and returns an array of
      * Analyzer descriptions.
      *
-     * See also {@link Database.analyzers}.
+     * See also {@link Database#analyzers}.
      *
      * @example
      * ```js
@@ -873,9 +845,9 @@ class Database {
     }
     /**
      * Fetches all Analyzers visible in the database and returns an array of
-     * {@link Analyzer} instances for those Analyzers.
+     * {@link analyzer.Analyzer} instances for those Analyzers.
      *
-     * See also {@link Database.listAnalyzers}.
+     * See also {@link Database#listAnalyzers}.
      *
      * @example
      * ```js
@@ -1060,21 +1032,21 @@ class Database {
      * ```
      */
     getUserAccessLevel(username, { database, collection }) {
-        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : (_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);
+            : database?.normalize("NFC") ??
+                ((0, collection_1.isArangoCollection)(collection)
+                    ? collection._db.name
+                    : this._name);
         const suffix = collection
-            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+            ? `/${encodeURIComponent((0, collection_1.isArangoCollection)(collection)
                 ? collection.name
                 : collection.normalize("NFC"))}`
             : "";
         return this.request({
             absolutePath: true,
             path: `/_api/user/${encodeURIComponent(username)}/database/${encodeURIComponent(databaseName)}${suffix}`,
-        }, (res) => res.body);
+        }, (res) => res.body.result);
     }
     /**
      * Sets the given ArangoDB user's access level for the database, or the
@@ -1149,14 +1121,14 @@ class Database {
      * ```
      */
     setUserAccessLevel(username, { database, collection, grant, }) {
-        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : (_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);
+            : database?.normalize("NFC") ??
+                ((0, collection_1.isArangoCollection)(collection)
+                    ? collection._db.name
+                    : this._name);
         const suffix = collection
-            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+            ? `/${encodeURIComponent((0, collection_1.isArangoCollection)(collection)
                 ? collection.name
                 : collection.normalize("NFC"))}`
             : "";
@@ -1231,14 +1203,14 @@ class Database {
      * ```
      */
     clearUserAccessLevel(username, { database, collection }) {
-        var _a;
         const databaseName = isArangoDatabase(database)
             ? database.name
-            : (_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);
+            : database?.normalize("NFC") ??
+                ((0, collection_1.isArangoCollection)(collection)
+                    ? collection._db.name
+                    : this._name);
         const suffix = collection
-            ? `/${encodeURIComponent(collection_1.isArangoCollection(collection)
+            ? `/${encodeURIComponent((0, collection_1.isArangoCollection)(collection)
                 ? collection.name
                 : collection.normalize("NFC"))}`
             : "";
@@ -1253,24 +1225,26 @@ class Database {
             absolutePath: true,
             path: `/_api/user/${encodeURIComponent(username)}/database`,
             qs: { full },
-        });
+        }, (res) => res.body.result);
     }
-    executeTransaction(collections, action, options) {
+    executeTransaction(collections, action, options = {}) {
+        const { allowDirtyRead = undefined, ...opts } = options;
         return this.request({
             method: "POST",
             path: "/_api/transaction",
+            allowDirtyRead,
             body: {
                 collections: coerceTransactionCollections(collections),
                 action,
-                ...options,
+                ...opts,
             },
         }, (res) => res.body.result);
     }
     /**
-     * Returns a {@link Transaction} instance for an existing streaming
+     * Returns a {@link transaction.Transaction} instance for an existing streaming
      * transaction with the given `id`.
      *
-     * See also {@link Database.beginTransaction}.
+     * See also {@link Database#beginTransaction}.
      *
      * @param id - The `id` of an existing stream transaction.
      *
@@ -1286,13 +1260,15 @@ class Database {
     transaction(transactionId) {
         return new transaction_1.Transaction(this, transactionId);
     }
-    beginTransaction(collections, options) {
+    beginTransaction(collections, options = {}) {
+        const { allowDirtyRead = undefined, ...opts } = options;
         return this.request({
             method: "POST",
             path: "/_api/transaction/begin",
+            allowDirtyRead,
             body: {
                 collections: coerceTransactionCollections(collections),
-                ...options,
+                ...opts,
             },
         }, (res) => new transaction_1.Transaction(this, res.body.result.id));
     }
@@ -1300,7 +1276,7 @@ class Database {
      * Fetches all active transactions from the database and returns an array of
      * transaction descriptions.
      *
-     * See also {@link Database.transactions}.
+     * See also {@link Database#transactions}.
      *
      * @example
      * ```js
@@ -1314,9 +1290,9 @@ class Database {
     }
     /**
      * Fetches all active transactions from the database and returns an array of
-     * {@link Transaction} instances for those transactions.
+     * {@link transaction.Transaction} instances for those transactions.
      *
-     * See also {@link Database.listTransactions}.
+     * See also {@link Database#listTransactions}.
      *
      * @example
      * ```js
@@ -1329,16 +1305,16 @@ class Database {
         const transactions = await this.listTransactions();
         return transactions.map((data) => this.transaction(data.id));
     }
-    query(query, bindVars, options) {
-        if (aql_1.isAqlQuery(query)) {
-            options = bindVars;
+    query(query, bindVars, options = {}) {
+        if ((0, aql_1.isAqlQuery)(query)) {
+            options = bindVars ?? {};
             bindVars = query.bindVars;
             query = query.query;
         }
-        else if (aql_1.isAqlLiteral(query)) {
+        else if ((0, aql_1.isAqlLiteral)(query)) {
             query = query.toAQL();
         }
-        const { allowDirtyRead, retryOnConflict, 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",
@@ -1355,32 +1331,32 @@ class Database {
             allowDirtyRead,
             retryOnConflict,
             timeout,
-        }, (res) => new cursor_1.BatchedArrayCursor(this, res.body, res.arangojsHostId, allowDirtyRead).items);
+        }, (res) => new cursor_1.BatchedArrayCursor(this, res.body, res.arangojsHostUrl, allowDirtyRead).items);
     }
     explain(query, bindVars, options) {
-        if (aql_1.isAqlQuery(query)) {
+        if ((0, aql_1.isAqlQuery)(query)) {
             options = bindVars;
             bindVars = query.bindVars;
             query = query.query;
         }
-        else if (aql_1.isAqlLiteral(query)) {
+        else if ((0, aql_1.isAqlLiteral)(query)) {
             query = query.toAQL();
         }
         return this.request({
             method: "POST",
             path: "/_api/explain",
             body: { query, bindVars, options },
-        }, (res) => res.body);
+        });
     }
     /**
      * Parses the given query and returns the result.
      *
-     * See the {@link aql} template string handler for information about how
+     * See the {@link aql!aql} template string handler for information about how
      * to create a query string without manually defining bind parameters nor
      * having to worry about escaping variables.
      *
      * @param query - An AQL query string or an object containing an AQL query
-     * string and bind parameters, e.g. the object returned from an {@link aql}
+     * string and bind parameters, e.g. the object returned from an {@link aql!aql}
      * template string.
      *
      * @example
@@ -1395,17 +1371,34 @@ class Database {
      * ```
      */
     parse(query) {
-        if (aql_1.isAqlQuery(query)) {
+        if ((0, aql_1.isAqlQuery)(query)) {
             query = query.query;
         }
-        else if (aql_1.isAqlLiteral(query)) {
+        else if ((0, aql_1.isAqlLiteral)(query)) {
             query = query.toAQL();
         }
         return this.request({
             method: "POST",
             path: "/_api/query",
             body: { query },
-        }, (res) => res.body);
+        });
+    }
+    /**
+     * Fetches the available optimizer rules.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const rules = await db.queryRules();
+     * for (const rule of rules) {
+     *   console.log(rule.name);
+     * }
+     * ```
+     */
+    queryRules() {
+        return this.request({
+            path: "/_api/query/rules",
+        });
     }
     queryTracking(options) {
         return this.request(options
@@ -1417,12 +1410,12 @@ class Database {
             : {
                 method: "GET",
                 path: "/_api/query/properties",
-            }, (res) => res.body);
+            });
     }
     /**
      * Fetches a list of information for all currently running queries.
      *
-     * See also {@link Database.listSlowQueries} and {@link Database.killQuery}.
+     * See also {@link Database#listSlowQueries} and {@link Database#killQuery}.
      *
      * @example
      * ```js
@@ -1434,13 +1427,13 @@ class Database {
         return this.request({
             method: "GET",
             path: "/_api/query/current",
-        }, (res) => res.body);
+        });
     }
     /**
      * Fetches a list of information for all recent slow queries.
      *
-     * See also {@link Database.listRunningQueries} and
-     * {@link Database.clearSlowQueries}.
+     * See also {@link Database#listRunningQueries} and
+     * {@link Database#clearSlowQueries}.
      *
      * @example
      * ```js
@@ -1453,12 +1446,12 @@ class Database {
         return this.request({
             method: "GET",
             path: "/_api/query/slow",
-        }, (res) => res.body);
+        });
     }
     /**
      * Clears the list of recent slow queries.
      *
-     * See also {@link Database.listSlowQueries}.
+     * See also {@link Database#listSlowQueries}.
      *
      * @example
      * ```js
@@ -1476,7 +1469,7 @@ class Database {
     /**
      * Kills a running query with the given `queryId`.
      *
-     * See also {@link Database.listRunningQueries}.
+     * See also {@link Database#listRunningQueries}.
      *
      * @param queryId - The ID of a currently running query.
      *
@@ -1550,7 +1543,7 @@ class Database {
             method: "POST",
             path: "/_api/aqlfunction",
             body: { name, code, isDeterministic },
-        }, (res) => res.body);
+        });
     }
     /**
      * Deletes the AQL user function with the given name from the database.
@@ -1572,7 +1565,7 @@ class Database {
             method: "DELETE",
             path: `/_api/aqlfunction/${encodeURIComponent(name)}`,
             qs: { group },
-        }, (res) => res.body);
+        });
     }
     //#endregion
     //#region services
@@ -1597,7 +1590,7 @@ class Database {
         return this.request({
             path: "/_api/foxx",
             qs: { excludeSystem },
-        }, (res) => res.body);
+        });
     }
     /**
      * Installs a new service.
@@ -1633,7 +1626,7 @@ class Database {
      */
     async installService(mount, source, options = {}) {
         const { configuration, dependencies, ...qs } = options;
-        const req = await multipart_1.toForm({
+        const req = await (0, multipart_1.toForm)({
             configuration,
             dependencies,
             source,
@@ -1644,7 +1637,7 @@ class Database {
             path: "/_api/foxx",
             isBinary: true,
             qs: { ...qs, mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Replaces an existing service with a new service by completely removing the
@@ -1681,7 +1674,7 @@ class Database {
      */
     async replaceService(mount, source, options = {}) {
         const { configuration, dependencies, ...qs } = options;
-        const req = await multipart_1.toForm({
+        const req = await (0, multipart_1.toForm)({
             configuration,
             dependencies,
             source,
@@ -1692,7 +1685,7 @@ class Database {
             path: "/_api/foxx/service",
             isBinary: true,
             qs: { ...qs, mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Replaces an existing service with a new service while retaining the old
@@ -1729,7 +1722,7 @@ class Database {
      */
     async upgradeService(mount, source, options = {}) {
         const { configuration, dependencies, ...qs } = options;
-        const req = await multipart_1.toForm({
+        const req = await (0, multipart_1.toForm)({
             configuration,
             dependencies,
             source,
@@ -1740,7 +1733,7 @@ class Database {
             path: "/_api/foxx/service",
             isBinary: true,
             qs: { ...qs, mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Completely removes a service from the database.
@@ -1777,118 +1770,51 @@ class Database {
         return this.request({
             path: "/_api/foxx/service",
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
-    async getServiceConfiguration(mount, minimal = false) {
-        const result = await this.request({
+    getServiceConfiguration(mount, minimal = false) {
+        return this.request({
             path: "/_api/foxx/configuration",
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (!minimal ||
-            !Object.keys(result).every((key) => result[key].title)) {
-            return result;
-        }
-        const values = {};
-        for (const key of Object.keys(result)) {
-            values[key] = result[key].current;
-        }
-        return values;
+        });
     }
-    async replaceServiceConfiguration(mount, cfg, minimal = false) {
-        const result = await this.request({
+    replaceServiceConfiguration(mount, cfg, minimal = false) {
+        return this.request({
             method: "PUT",
             path: "/_api/foxx/configuration",
             body: cfg,
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (minimal ||
-            !result.values ||
-            !Object.keys(result.values).every((key) => result.values[key].title)) {
-            return result;
-        }
-        const result2 = (await this.getServiceConfiguration(mount, false));
-        if (result.warnings) {
-            for (const key of Object.keys(result2)) {
-                result2[key].warning = result.warnings[key];
-            }
-        }
-        return result2;
+        });
     }
-    async updateServiceConfiguration(mount, cfg, minimal = false) {
-        const result = await this.request({
+    updateServiceConfiguration(mount, cfg, minimal = false) {
+        return this.request({
             method: "PATCH",
             path: "/_api/foxx/configuration",
             body: cfg,
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (minimal ||
-            !result.values ||
-            !Object.keys(result.values).every((key) => result.values[key].title)) {
-            return result;
-        }
-        const result2 = (await this.getServiceConfiguration(mount, false));
-        if (result.warnings) {
-            for (const key of Object.keys(result2)) {
-                result2[key].warning = result.warnings[key];
-            }
-        }
-        return result2;
+        });
     }
-    async getServiceDependencies(mount, minimal = false) {
-        const result = await this.request({
+    getServiceDependencies(mount, minimal = false) {
+        return this.request({
             path: "/_api/foxx/dependencies",
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (!minimal ||
-            !Object.keys(result).every((key) => result[key].title))
-            return result;
-        const values = {};
-        for (const key of Object.keys(result)) {
-            values[key] = result[key].current;
-        }
-        return values;
+        });
     }
-    async replaceServiceDependencies(mount, deps, minimal = false) {
-        const result = await this.request({
+    replaceServiceDependencies(mount, deps, minimal = false) {
+        return this.request({
             method: "PUT",
             path: "/_api/foxx/dependencies",
             body: deps,
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (minimal ||
-            !result.values ||
-            !Object.keys(result.values).every((key) => result.values[key].title)) {
-            return result;
-        }
-        // Work around "minimal" flag not existing in 3.3
-        const result2 = (await this.getServiceDependencies(mount, false));
-        if (result.warnings) {
-            for (const key of Object.keys(result2)) {
-                result2[key].warning = result.warnings[key];
-            }
-        }
-        return result2;
+        });
     }
-    async updateServiceDependencies(mount, deps, minimal = false) {
-        const result = await this.request({
+    updateServiceDependencies(mount, deps, minimal = false) {
+        return this.request({
             method: "PATCH",
             path: "/_api/foxx/dependencies",
             body: deps,
             qs: { mount, minimal },
-        }, (res) => res.body);
-        if (minimal ||
-            !result.values ||
-            !Object.keys(result.values).every((key) => result.values[key].title)) {
-            return result;
-        }
-        // Work around "minimal" flag not existing in 3.3
-        const result2 = (await this.getServiceDependencies(mount, false));
-        if (result.warnings) {
-            for (const key of Object.keys(result2)) {
-                result2[key].warning = result.warnings[key];
-            }
-        }
-        return result2;
+        });
     }
     /**
      * Enables or disables development mode for the given service.
@@ -1910,7 +1836,7 @@ class Database {
             method: enabled ? "POST" : "DELETE",
             path: "/_api/foxx/development",
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Retrieves a list of scripts defined in the service manifest's "scripts"
@@ -1931,7 +1857,7 @@ class Database {
         return this.request({
             path: "/_api/foxx/scripts",
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Executes a service script and retrieves its result exposed as
@@ -1963,7 +1889,7 @@ class Database {
             path: `/_api/foxx/scripts/${encodeURIComponent(name)}`,
             body: params,
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
     runServiceTests(mount, options) {
         return this.request({
@@ -1973,7 +1899,7 @@ class Database {
                 ...options,
                 mount,
             },
-        }, (res) => res.body);
+        });
     }
     /**
      * Retrieves the text content of the service's `README` or `README.md` file.
@@ -1994,7 +1920,7 @@ class Database {
         return this.request({
             path: "/_api/foxx/readme",
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Retrieves an Open API compatible Swagger API description object for the
@@ -2013,7 +1939,7 @@ class Database {
         return this.request({
             path: "/_api/foxx/swagger",
             qs: { mount },
-        }, (res) => res.body);
+        });
     }
     /**
      * Retrieves a zip bundle containing the service files.
@@ -2034,7 +1960,7 @@ class Database {
             path: "/_api/foxx/download",
             qs: { mount },
             expectBinary: true,
-        }, (res) => res.body);
+        });
     }
     /**
      * Writes all locally available services to the database and updates any