@liveblocks/node 2.18.4-uns2 → 2.20.0

package/dist/index.d.ts

@@ -58,7 +58,14 @@ declare class Session {
  * @liveblocks/core has browser-specific code.
  */
 
-type ToSimplifiedJson<S extends LsonObject> = LsonObject extends S ? JsonObject : ToImmutable<S>;
+type SerializeMaps<T> = T extends ReadonlyMap<infer K, infer V> ? K extends string ? {
+    readonly [P in K]: SerializeMaps<V>;
+} : {
+    readonly [key: string]: SerializeMaps<V>;
+} : T extends object ? {
+    readonly [P in keyof T]: SerializeMaps<T[P]>;
+} : T;
+type ToSimplifiedJson<S extends LsonObject> = LsonObject extends S ? JsonObject : SerializeMaps<ToImmutable<S>>;
 type LiveblocksOptions = {
     /**
      * The Liveblocks secret key. Must start with "sk_".
@@ -130,6 +137,9 @@ type E = DE;
 type M = DM;
 type S = DS;
 type U = DU;
+type RequestOptions = {
+    signal?: AbortSignal;
+};
 /**
  * Interact with the Liveblocks API from your Node.js backend.
  */
@@ -201,6 +211,7 @@ declare class Liveblocks {
      * @param params.metadata (optional) A filter on metadata. Multiple metadata keys can be used to filter rooms.
      * @param params.groupIds (optional) A filter on groups accesses. Multiple groups can be used.
      * @param params.query (optional) A query to filter rooms by. It is based on our query language. You can filter by metadata and room ID.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of rooms.
      */
     getRooms(params?: {
@@ -241,7 +252,7 @@ declare class Liveblocks {
                 startsWith: string;
             };
         };
-    }): Promise<{
+    }, options?: RequestOptions): Promise<{
         nextPage: string | null;
         nextCursor: string | null;
         data: RoomData[];
@@ -253,6 +264,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
     createRoom(roomId: string, params: {
@@ -260,13 +272,14 @@ declare class Liveblocks {
         groupsAccesses?: RoomAccesses;
         usersAccesses?: RoomAccesses;
         metadata?: RoomMetadata;
-    }): Promise<RoomData>;
+    }, options?: RequestOptions): Promise<RoomData>;
     /**
      * Returns a room with the given id.
      * @param roomId The id of the room to return.
      * @returns The room with the given id.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    getRoom(roomId: string): Promise<RoomData>;
+    getRoom(roomId: string, options?: RequestOptions): Promise<RoomData>;
     /**
      * Updates specific properties of a room. It’s not necessary to provide the entire room’s information.
      * Setting a property to `null` means to delete this property.
@@ -275,6 +288,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The updated room.
      */
     updateRoom(roomId: string, params: {
@@ -286,26 +300,29 @@ declare class Liveblocks {
             "room:write"
         ] | ["room:read", "room:presence:write"] | null>;
         metadata?: Record<string, string | string[] | null>;
-    }): Promise<RoomData>;
+    }, options?: RequestOptions): Promise<RoomData>;
     /**
      * Deletes a room with the given id. A deleted room is no longer accessible from the API or the dashboard and it cannot be restored.
      * @param roomId The id of the room to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    deleteRoom(roomId: string): Promise<void>;
+    deleteRoom(roomId: string, options?: RequestOptions): Promise<void>;
     /**
      * Returns a list of users currently present in the requested room. For better performance, we recommand to call this endpoint every 10 seconds maximum. Duplicates can happen if a user is in the requested room with multiple browser tabs opened.
      * @param roomId The id of the room to get the users from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of users currently present in the requested room.
      */
-    getActiveUsers(roomId: string): Promise<{
+    getActiveUsers(roomId: string, options?: RequestOptions): Promise<{
         data: RoomUser<U>[];
     }>;
     /**
      * Boadcasts an event to a room without having to connect to it via the client from @liveblocks/client. The connectionId passed to event listeners is -1 when using this API.
      * @param roomId The id of the room to broadcast the event to.
      * @param message The message to broadcast. It can be any JSON serializable value.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    broadcastEvent(roomId: string, message: E): Promise<void>;
+    broadcastEvent(roomId: string, message: E, options?: RequestOptions): Promise<void>;
     /**
      * Returns the contents of the room’s Storage tree.
      * The default outputted format is called “plain LSON”, which includes information on the Live data structures in the tree.
@@ -322,108 +339,122 @@ declare class Liveblocks {
      *
      * @param roomId The id of the room to get the storage from.
      * @param format (optional) Set to return `plan-lson` representation by default. If set to `json`, the output will be formatted as a simplified JSON representation of the Storage tree.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * In that format, each LiveObject and LiveMap will be formatted as a simple JSON object, and each LiveList will be formatted as a simple JSON array. This is a lossy format because information about the original data structures is not retained, but it may be easier to work with.
      */
-    getStorageDocument(roomId: string, format: "plain-lson"): Promise<PlainLsonObject>;
+    getStorageDocument(roomId: string, format: "plain-lson", options?: RequestOptions): Promise<PlainLsonObject>;
     getStorageDocument(roomId: string): Promise<PlainLsonObject>;
-    getStorageDocument(roomId: string, format: "json"): Promise<ToSimplifiedJson<S>>;
+    getStorageDocument(roomId: string, format: "json", options?: RequestOptions): Promise<ToSimplifiedJson<S>>;
     /**
      * Initializes a room’s Storage. The room must already exist and have an empty Storage.
      * Calling this endpoint will disconnect all users from the room if there are any.
      *
      * @param roomId The id of the room to initialize the storage from.
      * @param document The document to initialize the storage with.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The initialized storage document. It is of the same format as the one passed in.
      */
-    initializeStorageDocument(roomId: string, document: PlainLsonObject): Promise<PlainLsonObject>;
+    initializeStorageDocument(roomId: string, document: PlainLsonObject, options?: RequestOptions): Promise<PlainLsonObject>;
     /**
      * Deletes all of the room’s Storage data and disconnect all users from the room if there are any. Note that this does not delete the Yjs document in the room if one exists.
      * @param roomId The id of the room to delete the storage from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    deleteStorageDocument(roomId: string): Promise<void>;
+    deleteStorageDocument(roomId: string, options?: RequestOptions): Promise<void>;
     /**
      * Returns a JSON representation of the room’s Yjs document.
      * @param roomId The id of the room to get the Yjs document from.
      * @param params.format (optional) If true, YText will return formatting.
      * @param params.key (optional) If provided, returns only a single key’s value, e.g. doc.get(key).toJSON().
      * @param params.type (optional) Used with key to override the inferred type, i.e. "ymap" will return doc.get(key, Y.Map).
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A JSON representation of the room’s Yjs document.
      */
     getYjsDocument(roomId: string, params?: {
         format?: boolean;
         key?: string;
         type?: string;
-    }): Promise<JsonObject>;
+    }, options?: RequestOptions): Promise<JsonObject>;
     /**
      * Send a Yjs binary update to the room’s Yjs document. You can use this endpoint to initialize Yjs data for the room or to update the room’s Yjs document.
      * @param roomId The id of the room to send the Yjs binary update to.
      * @param update The Yjs update to send. Typically the result of calling `Yjs.encodeStateAsUpdate(doc)`. Read the [Yjs documentation](https://docs.yjs.dev/api/document-updates) to learn how to create a binary update.
      * @param params.guid (optional) If provided, the binary update will be applied to the Yjs subdocument with the given guid. If not provided, the binary update will be applied to the root Yjs document.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     sendYjsBinaryUpdate(roomId: string, update: Uint8Array, params?: {
         guid?: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Returns the room’s Yjs document encoded as a single binary update. This can be used by Y.applyUpdate(responseBody) to get a copy of the document in your backend.
      * See [Yjs documentation](https://docs.yjs.dev/api/document-updates) for more information on working with updates.
      * @param roomId The id of the room to get the Yjs document from.
      * @param params.guid (optional) If provided, returns the binary update of the Yjs subdocument with the given guid. If not provided, returns the binary update of the root Yjs document.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room’s Yjs document encoded as a single binary update.
      */
     getYjsDocumentAsBinaryUpdate(roomId: string, params?: {
         guid?: string;
-    }): Promise<ArrayBuffer>;
+    }, options?: RequestOptions): Promise<ArrayBuffer>;
     /**
      * Creates a new schema which can be referenced later to enforce a room’s Storage data structure.
      * @param name The name used to reference the schema. Must be a non-empty string with less than 65 characters and only contain lowercase letters, numbers and dashes
      * @param body The exact allowed shape of data in the room. It is a multi-line string written in the [Liveblocks schema syntax](https://liveblocks.io/docs/platform/schema-validation/syntax).
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created schema.
      */
-    createSchema(name: string, body: string): Promise<Schema>;
+    createSchema(name: string, body: string, options?: RequestOptions): Promise<Schema>;
     /**
      * Returns a schema by its id.
      * @param schemaId Id of the schema - this is the combination of the schema name and version of the schema to update. For example, `my-schema@1`.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The schema with the given id.
      */
-    getSchema(schemaId: string): Promise<Schema>;
+    getSchema(schemaId: string, options?: RequestOptions): Promise<Schema>;
     /**
      * Updates the body for the schema. A schema can only be updated if it is not used by any room.
      * @param schemaId Id of the schema - this is the combination of the schema name and version of the schema to update. For example, `my-schema@1`.
      * @param body The exact allowed shape of data in the room. It is a multi-line string written in the [Liveblocks schema syntax](https://liveblocks.io/docs/platform/schema-validation/syntax).
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The updated schema. The version of the schema will be incremented.
      */
-    updateSchema(schemaId: string, body: string): Promise<Schema>;
+    updateSchema(schemaId: string, body: string, options?: RequestOptions): Promise<Schema>;
     /**
      * Deletes a schema by its id. A schema can only be deleted if it is not used by any room.
      * @param schemaId Id of the schema - this is the combination of the schema name and version of the schema to update. For example, `my-schema@1`.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    deleteSchema(schemaId: string): Promise<void>;
+    deleteSchema(schemaId: string, options?: RequestOptions): Promise<void>;
     /**
      * Returns the schema attached to a room.
      * @param roomId The id of the room to get the schema from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns
      */
-    getSchemaByRoomId(roomId: string): Promise<Schema>;
+    getSchemaByRoomId(roomId: string, options?: RequestOptions): Promise<Schema>;
     /**
      * Attaches a schema to a room, and instantly enables runtime schema validation for the room.
      * If the current contents of the room’s Storage do not match the schema, attaching will fail and the error message will give details on why the schema failed to attach.
      * @param roomId The id of the room to attach the schema to.
      * @param schemaId Id of the schema - this is the combination of the schema name and version of the schema to update. For example, `my-schema@1`.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The schema id as JSON.
      */
-    attachSchemaToRoom(roomId: string, schemaId: string): Promise<{
+    attachSchemaToRoom(roomId: string, schemaId: string, options?: RequestOptions): Promise<{
         schema: string;
     }>;
     /**
      * Detaches a schema from a room, and disables runtime schema validation for the room.
      * @param roomId The id of the room to detach the schema from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
-    detachSchemaFromRoom(roomId: string): Promise<void>;
+    detachSchemaFromRoom(roomId: string, options?: RequestOptions): Promise<void>;
     /**
      * Gets all the threads in a room.
      *
      * @param params.roomId The room ID to get the threads from.
      * @param params.query The query to filter threads by. It is based on our query language and can filter by metadata.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of threads.
      */
     getThreads(params: {
@@ -458,7 +489,7 @@ declare class Liveblocks {
             metadata?: Partial<QueryMetadata<M>>;
             resolved?: boolean;
         };
-    }): Promise<{
+    }, options?: RequestOptions): Promise<{
         data: ThreadData<M>[];
     }>;
     /**
@@ -466,12 +497,13 @@ declare class Liveblocks {
      *
      * @param params.roomId The room ID to get the thread from.
      * @param params.threadId The thread ID.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A thread.
      */
     getThread(params: {
         roomId: string;
         threadId: string;
-    }): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
      * Gets a thread's participants.
      *
@@ -480,25 +512,27 @@ declare class Liveblocks {
      *
      * @param params.roomId The room ID to get the thread participants from.
      * @param params.threadId The thread ID to get the participants from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns An object containing an array of participant IDs.
      */
     getThreadParticipants(params: {
         roomId: string;
         threadId: string;
-    }): Promise<ThreadParticipants>;
+    }, options?: RequestOptions): Promise<ThreadParticipants>;
     /**
      * Gets a thread's comment.
      *
      * @param params.roomId The room ID to get the comment from.
      * @param params.threadId The thread ID to get the comment from.
      * @param params.commentId The comment ID.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A comment.
      */
     getComment(params: {
         roomId: string;
         threadId: string;
         commentId: string;
-    }): Promise<CommentData>;
+    }, options?: RequestOptions): Promise<CommentData>;
     /**
      * Creates a comment.
      *
@@ -507,6 +541,7 @@ declare class Liveblocks {
      * @param params.data.userId The user ID of the user who is set to create the comment.
      * @param params.data.createdAt (optional) The date the comment is set to be created.
      * @param params.data.body The body of the comment.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created comment.
      */
     createComment(params: {
@@ -517,7 +552,7 @@ declare class Liveblocks {
             createdAt?: Date;
             body: CommentBody;
         };
-    }): Promise<CommentData>;
+    }, options?: RequestOptions): Promise<CommentData>;
     /**
      * Edits a comment.
      * @param params.roomId The room ID to edit the comment in.
@@ -525,6 +560,7 @@ declare class Liveblocks {
      * @param params.commentId The comment ID to edit.
      * @param params.data.body The body of the comment.
      * @param params.data.editedAt (optional) The date the comment was edited.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The edited comment.
      */
     editComment(params: {
@@ -535,18 +571,19 @@ declare class Liveblocks {
             body: CommentBody;
             editedAt?: Date;
         };
-    }): Promise<CommentData>;
+    }, options?: RequestOptions): Promise<CommentData>;
     /**
      * Deletes a comment. Deletes a comment. If there are no remaining comments in the thread, the thread is also deleted.
      * @param params.roomId The room ID to delete the comment in.
      * @param params.threadId The thread ID to delete the comment in.
      * @param params.commentId The comment ID to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteComment(params: {
         roomId: string;
         threadId: string;
         commentId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Creates a new thread. The thread will be created with the specified comment as its first comment.
      * If the thread already exists, a `LiveblocksError` will be thrown with status code 409.
@@ -555,23 +592,26 @@ declare class Liveblocks {
      * @param params.thread.comment.userId The user ID of the user who created the comment.
      * @param params.thread.comment.createdAt (optional) The date the comment was created.
      * @param params.thread.comment.body The body of the comment.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created thread. The thread will be created with the specified comment as its first comment.
      */
-    createThread(params: CreateThreadOptions<M>): Promise<ThreadData<M>>;
+    createThread(params: CreateThreadOptions<M>, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
      * Deletes a thread and all of its comments.
      * @param params.roomId The room ID to delete the thread in.
      * @param params.threadId The thread ID to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteThread(params: {
         roomId: string;
         threadId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Mark a thread as resolved.
      * @param params.roomId The room ID of the thread.
      * @param params.threadId The thread ID to mark as resolved.
      * @param params.data.userId The user ID of the user who marked the thread as resolved.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The thread marked as resolved.
      */
     markThreadAsResolved(params: {
@@ -580,12 +620,13 @@ declare class Liveblocks {
         data: {
             userId: string;
         };
-    }): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
      * Mark a thread as unresolved.
      * @param params.roomId The room ID of the thread.
      * @param params.threadId The thread ID to mark as unresolved.
      * @param params.data.userId The user ID of the user who marked the thread as unresolved.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The thread marked as unresolved.
      */
     markThreadAsUnresolved(params: {
@@ -594,7 +635,7 @@ declare class Liveblocks {
         data: {
             userId: string;
         };
-    }): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -602,6 +643,7 @@ declare class Liveblocks {
      * @param params.data.metadata The metadata for the thread. Value must be a string, boolean or number
      * @param params.data.userId The user ID of the user who updated the thread.
      * @param params.data.updatedAt (optional) The date the thread is set to be updated.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The updated thread metadata.
      */
     editThreadMetadata(params: {
@@ -612,7 +654,7 @@ declare class Liveblocks {
             userId: string;
             updatedAt?: Date;
         };
-    }): Promise<M>;
+    }, options?: RequestOptions): Promise<M>;
     /**
      * Adds a new comment reaction to a comment.
      * @param params.roomId The room ID to add the comment reaction in.
@@ -621,6 +663,7 @@ declare class Liveblocks {
      * @param params.data.emoji The (emoji) reaction to add.
      * @param params.data.userId The user ID of the user associated with the reaction.
      * @param params.data.createdAt (optional) The date the reaction is set to be created.
+     * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created comment reaction.
      */
     addCommentReaction(params: {
@@ -632,7 +675,7 @@ declare class Liveblocks {
             userId: string;
             createdAt?: Date;
         };
-    }): Promise<CommentUserReaction>;
+    }, options?: RequestOptions): Promise<CommentUserReaction>;
     /**
      * Removes a reaction from a comment.
      * @param params.roomId The room ID to remove the comment reaction from.
@@ -641,6 +684,7 @@ declare class Liveblocks {
      * @param params.data.emoji The (emoji) reaction to remove.
      * @param params.data.userId The user ID of the user associated with the reaction.
      * @param params.data.removedAt (optional) The date the reaction is set to be removed.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     removeCommentReaction(params: {
         roomId: string;
@@ -651,20 +695,22 @@ declare class Liveblocks {
             userId: string;
             removedAt?: Date;
         };
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Returns the inbox notifications for a user.
      * @param params.userId The user ID to get the inbox notifications from.
      * @param params.inboxNotificationId The ID of the inbox notification to get.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     getInboxNotification(params: {
         userId: string;
         inboxNotificationId: string;
-    }): Promise<InboxNotificationData>;
+    }, options?: RequestOptions): Promise<InboxNotificationData>;
     /**
      * Returns the inbox notifications for a user.
      * @param params.userId The user ID to get the inbox notifications from.
      * @param params.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     getInboxNotifications(params: {
         userId: string;
@@ -691,97 +737,109 @@ declare class Liveblocks {
         query?: string | {
             unread: boolean;
         };
-    }): Promise<{
+    }, options?: RequestOptions): Promise<{
         data: InboxNotificationData[];
     }>;
     /**
      * Gets the user's room notification settings.
      * @param params.userId The user ID to get the room notifications from.
      * @param params.roomId The room ID to get the room notification settings from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     getRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-    }): Promise<RoomNotificationSettings>;
+    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
     /**
      * Updates the user's room notification settings.
      * @param params.userId The user ID to update the room notification settings for.
      * @param params.roomId The room ID to update the room notification settings for.
      * @param params.data The new room notification settings for the user.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     updateRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
         data: RoomNotificationSettings;
-    }): Promise<RoomNotificationSettings>;
+    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
     /**
      * Delete the user's room notification settings.
      * @param params.userId The user ID to delete the room notification settings from.
      * @param params.roomId The room ID to delete the room notification settings from.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Update a room ID.
      * @param params.roomId The current ID of the room.
      * @param params.newRoomId The new room ID.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     updateRoomId(params: {
         currentRoomId: string;
         newRoomId: string;
-    }): Promise<RoomData>;
+    }, options?: RequestOptions): Promise<RoomData>;
     triggerInboxNotification<K extends KDAD>(params: {
         userId: string;
         kind: K;
         roomId?: string;
         subjectId: string;
         activityData: DAD[K];
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Deletes an inbox notification for a user.
      * @param params.userId The user ID for which to delete the inbox notification.
      * @param params.inboxNotificationId The ID of the inbox notification to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteInboxNotification(params: {
         userId: string;
         inboxNotificationId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Deletes all inbox notifications for a user.
      * @param params.userId The user ID for which to delete all the inbox notifications.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteAllInboxNotifications(params: {
         userId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Get notification settings for a user for a project.
      * @param params.userId The user ID to get the notifications settings for.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     getNotificationSettings(params: {
         userId: string;
-    }): Promise<UserNotificationSettings>;
+    }, options?: RequestOptions): Promise<UserNotificationSettings>;
     /**
      * Update the user's notification settings.
      * @param params.userId The user ID to update the notification settings for.
      * @param params.data The new notification settings for the user.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     updateNotificationSettings(params: {
         userId: string;
         data: PartialUserNotificationSettings;
-    }): Promise<UserNotificationSettings>;
+    }, options?: RequestOptions): Promise<UserNotificationSettings>;
     /**
      * Delete the user's notification settings
      * @param params.userId The user ID to update the notification settings for.
+     * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteNotificationSettings(params: {
         userId: string;
-    }): Promise<void>;
+    }, options?: RequestOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
-    status: number;
-    constructor(status: number, message?: string);
+    readonly status: number;
+    readonly details?: string;
+    private constructor();
+    toString(): string;
+    static from(res: Response): Promise<LiveblocksError>;
 }
 
 declare class WebhookHandler {