arangojs 7.4.0 → 7.6.1

package/database.js

@@ -862,6 +862,363 @@ class Database {
         const analyzers = await this.listAnalyzers();
         return analyzers.map((data) => this.analyzer(data.name));
     }
+    //#endregion
+    //#region users
+    /**
+     * Fetches all ArangoDB users visible to the authenticated user and returns
+     * an array of user objects.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const users = await db.listUsers();
+     * // users is an array of user objects
+     * ```
+     */
+    listUsers() {
+        return this.request({
+            absolutePath: true,
+            path: "/_api/user",
+        });
+    }
+    /**
+     * Fetches the user data of a single ArangoDB user.
+     *
+     * @param username - Name of the ArangoDB user to fetch.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const user = await db.getUser("steve");
+     * // user is the user object for the user named "steve"
+     * ```
+     */
+    getUser(username) {
+        return this.request({
+            absolutePath: true,
+            path: `/_api/user/${username}`,
+        });
+    }
+    createUser(username, options) {
+        if (typeof options === "string") {
+            options = { passwd: options };
+        }
+        return this.request({
+            absolutePath: true,
+            method: "POST",
+            path: "/_api/user",
+            body: { user: username, ...options },
+        }, (res) => res.body);
+    }
+    updateUser(username, options) {
+        if (typeof options === "string") {
+            options = { passwd: options };
+        }
+        return this.request({
+            absolutePath: true,
+            method: "PATCH",
+            path: `/api/user/${username}`,
+            body: options,
+        }, (res) => res.body);
+    }
+    /**
+     * Replaces the ArangoDB user's option with the new options.
+     *
+     * @param username - Name of the ArangoDB user to modify.
+     * @param options - New options to replace the user's existing options.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const user = await db.replaceUser("steve", { passwd: "", active: false });
+     * // The user "steve" has been set to inactive with an empty password
+     * ```
+     */
+    replaceUser(username, options) {
+        if (typeof options === "string") {
+            options = { passwd: options };
+        }
+        return this.request({
+            absolutePath: true,
+            method: "PUT",
+            path: `/api/user/${username}`,
+            body: options,
+        }, (res) => res.body);
+    }
+    /**
+     * Removes the ArangoDB user with the given username from the server.
+     *
+     * @param username - Name of the ArangoDB user to remove.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.removeUser("steve");
+     * // The user "steve" has been removed
+     * ```
+     */
+    removeUser(username) {
+        return this.request({
+            absolutePath: true,
+            method: "DELETE",
+            path: `/_api/user/${username}`,
+        }, (res) => res.body);
+    }
+    /**
+     * Fetches the given ArangoDB user's access level for the database, or the
+     * given collection in the given database.
+     *
+     * @param username - Name of the ArangoDB user to fetch the access level for.
+     * @param database - Database to fetch the access level for.
+     * @param collection - Collection to fetch the access level for.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const accessLevel = await db.getUserAccessLevel("steve");
+     * // The access level of the user "steve" has been fetched for the current
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const accessLevel = await db.getUserAccessLevel("steve", {
+     *   database: "staging"
+     * });
+     * // The access level of the user "steve" has been fetched for the "staging"
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const accessLevel = await db.getUserAccessLevel("steve", {
+     *   collection: "pokemons"
+     * });
+     * // The access level of the user "steve" has been fetched for the
+     * // "pokemons" collection in the current database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const accessLevel = await db.getUserAccessLevel("steve", {
+     *   database: "staging",
+     *   collection: "pokemons"
+     * });
+     * // The access level of the user "steve" has been fetched for the
+     * // "pokemons" collection in the "staging" database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * const accessLevel = await db.getUserAccessLevel("steve", {
+     *   database: staging
+     * });
+     * // The access level of the user "steve" has been fetched for the "staging"
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * const accessLevel = await db.getUserAccessLevel("steve", {
+     *   collection: staging.collection("pokemons")
+     * });
+     * // The access level of the user "steve" has been fetched for the
+     * // "pokemons" collection in database "staging".
+     */
+    getUserAccessLevel(username, { database, collection }) {
+        const databaseName = isArangoDatabase(database)
+            ? database.name
+            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+                ? collection._db.name
+                : this.name);
+        const suffix = collection
+            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            : "";
+        return this.request({
+            absolutePath: true,
+            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+        }, (res) => res.body);
+    }
+    /**
+     * Sets the given ArangoDB user's access level for the database, or the
+     * given collection in the given database.
+     *
+     * @param username - Name of the ArangoDB user to set the access level for.
+     * @param database - Database to set the access level for.
+     * @param collection - Collection to set the access level for.
+     * @param grant - Access level to set for the given user.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.setUserAccessLevel("steve", { grant: "rw" });
+     * // The user "steve" now has read-write access to the current database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.setUserAccessLevel("steve", {
+     *   database: "staging",
+     *   grant: "rw"
+     * });
+     * // The user "steve" now has read-write access to the "staging" database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.setUserAccessLevel("steve", {
+     *   collection: "pokemons",
+     *   grant: "rw"
+     * });
+     * // The user "steve" now has read-write access to the "pokemons" collection
+     * // in the current database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.setUserAccessLevel("steve", {
+     *   database: "staging",
+     *   collection: "pokemons",
+     *   grant: "rw"
+     * });
+     * // The user "steve" now has read-write access to the "pokemons" collection
+     * // in the "staging" database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * await db.setUserAccessLevel("steve", {
+     *   database: staging,
+     *   grant: "rw"
+     * });
+     * // The user "steve" now has read-write access to the "staging" database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * await db.setUserAccessLevel("steve", {
+     *   collection: staging.collection("pokemons"),
+     *   grant: "rw"
+     * });
+     * // The user "steve" now has read-write access to the "pokemons" collection
+     * // in database "staging".
+     * ```
+     */
+    setUserAccessLevel(username, { database, collection, grant, }) {
+        const databaseName = isArangoDatabase(database)
+            ? database.name
+            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+                ? collection._db.name
+                : this.name);
+        const suffix = collection
+            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            : "";
+        return this.request({
+            absolutePath: true,
+            method: "PUT",
+            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+            body: { grant },
+        }, (res) => res.body);
+    }
+    /**
+     * Clears the given ArangoDB user's access level for the database, or the
+     * given collection in the given database.
+     *
+     * @param username - Name of the ArangoDB user to clear the access level for.
+     * @param database - Database to clear the access level for.
+     * @param collection - Collection to clear the access level for.
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.clearUserAccessLevel("steve");
+     * // The access level of the user "steve" has been cleared for the current
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.clearUserAccessLevel("steve", { database: "staging" });
+     * // The access level of the user "steve" has been cleared for the "staging"
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.clearUserAccessLevel("steve", { collection: "pokemons" });
+     * // The access level of the user "steve" has been cleared for the
+     * // "pokemons" collection in the current database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * await db.clearUserAccessLevel("steve", {
+     *   database: "staging",
+     *   collection: "pokemons"
+     * });
+     * // The access level of the user "steve" has been cleared for the
+     * // "pokemons" collection in the "staging" database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * await db.clearUserAccessLevel("steve", { database: staging });
+     * // The access level of the user "steve" has been cleared for the "staging"
+     * // database.
+     * ```
+     *
+     * @example
+     * ```js
+     * const db = new Database();
+     * const staging = db.database("staging");
+     * await db.clearUserAccessLevel("steve", {
+     *   collection: staging.collection("pokemons")
+     * });
+     * // The access level of the user "steve" has been cleared for the
+     * // "pokemons" collection in database "staging".
+     * ```
+     */
+    clearUserAccessLevel(username, { database, collection }) {
+        const databaseName = isArangoDatabase(database)
+            ? database.name
+            : database !== null && database !== void 0 ? database : (collection_1.isArangoCollection(collection)
+                ? collection._db.name
+                : this.name);
+        const suffix = collection
+            ? `/${collection_1.isArangoCollection(collection) ? collection.name : collection}`
+            : "";
+        return this.request({
+            absolutePath: true,
+            method: "DELETE",
+            path: `/_api/user/${username}/database/${databaseName}${suffix}`,
+        }, (res) => res.body);
+    }
+    getUserDatabases(username, full) {
+        return this.request({
+            absolutePath: true,
+            path: `/_api/user/${username}/database`,
+            qs: { full },
+        });
+    }
     executeTransaction(collections, action, options) {
         return this.request({
             method: "POST",