@niledatabase/server 5.0.0-alpha.12 → 5.0.0-alpha.14

package/dist/index.js

@@ -2512,10 +2512,23 @@ async function obtainCsrf(config, rawResponse = false) {
 var Users = class {
   #config;
   #logger;
+  /**
+   * Create a new Users helper.
+   * @param config - The configuration used for requests.
+   */
   constructor(config) {
     this.#config = config;
     this.#logger = config.logger("[me]");
   }
+  /**
+   * Update the current user via `PUT /api/me`.
+   *
+   * The OpenAPI description for this endpoint can be found in
+   * `packages/server/src/api/routes/me/index.ts` under `updateSelf`.
+   *
+   * @param req - Partial user fields to send.
+   * @param [rawResponse] - When `true`, return the raw {@link Response}.
+   */
   async updateSelf(req, rawResponse) {
     const res = await fetchMe(this.#config, "PUT", JSON.stringify(req));
     if (rawResponse) {
@@ -2527,6 +2540,13 @@ var Users = class {
       return res;
     }
   }
+  /**
+   * Remove the current user using `DELETE /api/me`.
+   *
+   * After the request the authentication headers are cleared with
+   * {@link updateHeaders}. The OpenAPI docs for this route are in
+   * `packages/server/src/api/routes/me/index.ts` under `removeSelf`.
+   */
   async removeSelf() {
     const me = await this.getSelf();
     if ("id" in me) {
@@ -2607,6 +2627,11 @@ var Tenants = class {
   constructor(config) {
     this.#config = config;
   }
+  /**
+   * Create a new tenant using `POST /api/tenants`.
+   * See `packages/server/src/api/routes/tenants/POST.ts` for the
+   * `createTenant` operation definition.
+   */
   async create(req, rawResponse) {
     let res;
     if (typeof req === "string") {
@@ -2627,6 +2652,11 @@ var Tenants = class {
       return res;
     }
   }
+  /**
+   * Remove a tenant via `DELETE /api/tenants/{tenantId}`.
+   *
+   * @param req - The tenant to remove or context containing the id.
+   */
   async delete(req) {
     if (typeof req === "string") {
       this.#config.tenantId = req;
@@ -2637,6 +2667,12 @@ var Tenants = class {
     const res = await fetchTenant(this.#config, "DELETE");
     return res;
   }
+  /**
+   * Fetch details for a tenant using `GET /api/tenants/{tenantId}`.
+   *
+   * @param req - Tenant identifier or context.
+   * @param [rawResponse] - When true, return the raw {@link Response}.
+   */
   async get(req, rawResponse) {
     if (typeof req === "string") {
       this.#config.tenantId = req;
@@ -2671,6 +2707,10 @@ var Tenants = class {
       return res;
     }
   }
+  /**
+   * List tenants for the current user via `GET /api/tenants`.
+   * See `packages/server/src/api/routes/tenants/GET.ts` for details.
+   */
   async list(req) {
     const res = await fetchTenantsByUser(this.#config);
     if (req === true) {
@@ -2682,6 +2722,11 @@ var Tenants = class {
       return res;
     }
   }
+  /**
+   * Leave the current tenant using `DELETE /api/tenants/{tenantId}/users/{userId}`.
+   *
+   * @param [req] - Optionally specify the tenant id to leave.
+   */
   async leaveTenant(req) {
     const me = await fetchMe(this.#config);
     try {
@@ -2707,6 +2752,12 @@ var Tenants = class {
     const res = await fetchTenantUser(this.#config, "PUT");
     return responseHandler(res, rawResponse);
   }
+  /**
+   * Remove a user from a tenant with `DELETE /api/tenants/{tenantId}/users/{userId}`.
+   *
+   * @param req - User and tenant identifiers or context.
+   * @param [rawResponse] - When true, return the raw {@link Response}.
+   */
   async removeMember(req, rawResponse) {
     this.#handleContext(req);
     const res = await fetchTenantUser(this.#config, "DELETE");
@@ -2720,6 +2771,9 @@ var Tenants = class {
       rawResponse || typeof req === "boolean" && req
     );
   }
+  /**
+   * List invites for the current tenant via `GET /api/tenants/{tenantId}/invites`.
+   */
   async invites() {
     const res = await fetchInvites(this.#config);
     return responseHandler(res);
@@ -2757,6 +2811,12 @@ var Tenants = class {
     );
     return responseHandler(res, rawResponse);
   }
+  /**
+   * Accept an invite using `PUT /api/tenants/{tenantId}/invite`.
+   *
+   * @param req - Identifier and token from the invite email.
+   * @param [rawResponse] - When true, return the raw {@link Response}.
+   */
   async acceptInvite(req, rawResponse) {
     if (!req) {
       throw new Error("The identifier and token are required.");
@@ -2775,6 +2835,11 @@ var Tenants = class {
     );
     return responseHandler(res, rawResponse);
   }
+  /**
+   * Delete a pending invite using `DELETE /api/tenants/{tenantId}/invite/{inviteId}`.
+   *
+   * @param req - Identifier of the invite to remove.
+   */
   async deleteInvite(req) {
     let id = "";
     if (typeof req === "object") {