@liveblocks/node 2.21.0-emails3 → 2.22.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -133,10 +133,113 @@ type Schema = {
     createdAt: Date;
     updatedAt: Date;
 };
+type MutateStorageCallback = (context: {
+    root: LiveObject<S>;
+}) => Awaitable<void>;
+type MutateStorageOptions = RequestOptions;
+type MassMutateStorageCallback = (context: {
+    room: RoomData;
+    root: LiveObject<S>;
+}) => Awaitable<void>;
+type MassMutateStorageOptions = MutateStorageOptions & {
+    concurrency?: number;
+};
 type E = DE;
 type M = DM;
 type S = DS;
 type U = DU;
+type RoomsQueryCriteria = {
+    userId?: string;
+    groupIds?: string[];
+    /**
+     * The query to filter rooms by. It is based on our query language.
+     * @example
+     * ```
+     * {
+     *   query: 'metadata["status"]:"open" AND roomId^"liveblocks:"'
+     * }
+     * ```
+     * @example
+     * ```
+     * {
+     *   query: {
+     *     metadata: {
+     *       status: "open",
+     *     },
+     *     roomId: {
+     *       startsWith: "liveblocks:"
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    query?: string | {
+        metadata?: QueryRoomMetadata;
+        roomId?: {
+            startsWith: string;
+        };
+    };
+};
+type InboxNotificationsQueryCriteria = {
+    userId: string;
+    /**
+     * The query to filter inbox notifications by. It is based on our query language.
+     *
+     * @example
+     * ```
+     * {
+     *  query: "unread:true"
+     * }
+     * ```
+     *
+     * @example
+     * ```
+     * {
+     *   query: {
+     *     unread: true
+     *   }
+     * }
+     * ```
+     *
+     */
+    query?: string | {
+        unread: boolean;
+    };
+};
+type PaginationOptions = {
+    limit?: number;
+    startingAfter?: string;
+};
+type Page<T> = {
+    /** @deprecated Prefer to rely on `nextCursor` instead. */
+    nextPage?: string | null;
+    nextCursor: string | null;
+    data: T[];
+};
+type GetRoomsOptions = RoomsQueryCriteria & PaginationOptions & {
+    /**
+     * @deprecated Use `query` property instead. Support for the `metadata`
+     * field will be removed in a future version.
+     */
+    metadata?: QueryRoomMetadata;
+};
+type GetInboxNotificationsOptions = InboxNotificationsQueryCriteria & PaginationOptions;
+type CreateRoomOptions = {
+    defaultAccesses: RoomPermission;
+    groupsAccesses?: RoomAccesses;
+    usersAccesses?: RoomAccesses;
+    metadata?: RoomMetadata;
+};
+type UpdateRoomOptions = {
+    defaultAccesses?: RoomPermission | null;
+    groupsAccesses?: Record<string, [
+        "room:write"
+    ] | ["room:read", "room:presence:write"] | null>;
+    usersAccesses?: Record<string, [
+        "room:write"
+    ] | ["room:read", "room:presence:write"] | null>;
+    metadata?: Record<string, string | string[] | null>;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -214,49 +317,24 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of rooms.
      */
-    getRooms(params?: {
-        limit?: number;
-        startingAfter?: string;
-        /**
-         * @deprecated Use `query` property instead. Support for the `metadata`
-         * field will be removed in a future version.
-         */
-        metadata?: QueryRoomMetadata;
-        userId?: string;
-        groupIds?: string[];
-        /**
-         * The query to filter rooms by. It is based on our query language.
-         * @example
-         * ```
-         * {
-         *   query: 'metadata["status"]:"open" AND roomId^"liveblocks:"'
-         * }
-         * ```
-         * @example
-         * ```
-         * {
-         *   query: {
-         *     metadata: {
-         *       status: "open",
-         *     },
-         *     roomId: {
-         *       startsWith: "liveblocks:"
-         *     }
-         *   }
-         * }
-         * ```
-         */
-        query?: string | {
-            metadata?: QueryRoomMetadata;
-            roomId?: {
-                startsWith: string;
-            };
-        };
-    }, options?: RequestOptions): Promise<{
-        nextPage: string | null;
-        nextCursor: string | null;
-        data: RoomData[];
-    }>;
+    getRooms(params?: GetRoomsOptions, options?: RequestOptions): Promise<Page<RoomData>>;
+    /**
+     * Iterates over all rooms that match the given criteria.
+     *
+     * The difference with .getRooms() is that pagination will happen
+     * automatically under the hood, using the given `pageSize`.
+     *
+     * @param criteria.userId (optional) A filter on users accesses.
+     * @param criteria.groupIds (optional) A filter on groups accesses. Multiple groups can be used.
+     * @param criteria.query.roomId (optional) A filter by room ID.
+     * @param criteria.query.metadata (optional) A filter by metadata.
+     *
+     * @param options.pageSize (optional) The page size to use for each request.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    iterRooms(criteria: RoomsQueryCriteria, options?: RequestOptions & {
+        pageSize?: number;
+    }): AsyncGenerator<RoomData>;
     /**
      * Creates a new room with the given id.
      * @param roomId The id of the room to create.
@@ -267,12 +345,32 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
-    createRoom(roomId: string, params: {
-        defaultAccesses: RoomPermission;
-        groupsAccesses?: RoomAccesses;
-        usersAccesses?: RoomAccesses;
-        metadata?: RoomMetadata;
-    }, options?: RequestOptions): Promise<RoomData>;
+    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Returns a room with the given id, or creates one with the given creation
+     * options if it doesn't exist yet.
+     *
+     * @param roomId The id of the room.
+     * @param params.defaultAccesses The default accesses for the room if the room will be created.
+     * @param params.groupsAccesses (optional) The group accesses for the room if the room will be created. 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 if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
+     * @param params.metadata (optional) The metadata for the room if the room will be created. 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 room.
+     */
+    getOrCreateRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Updates or creates a new room with the given properties.
+     *
+     * @param roomId The id of the room to update or create.
+     * @param params.defaultAccesses The default accesses for the room.
+     * @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 room.
+     */
+    upsertRoom(roomId: string, params: CreateRoomOptions & UpdateRoomOptions, options?: RequestOptions): Promise<RoomData>;
     /**
      * Returns a room with the given id.
      * @param roomId The id of the room to return.
@@ -291,16 +389,7 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The updated room.
      */
-    updateRoom(roomId: string, params: {
-        defaultAccesses?: RoomPermission | null;
-        groupsAccesses?: Record<string, [
-            "room:write"
-        ] | ["room:read", "room:presence:write"] | null>;
-        usersAccesses?: Record<string, [
-            "room:write"
-        ] | ["room:read", "room:presence:write"] | null>;
-        metadata?: Record<string, string | string[] | null>;
-    }, options?: RequestOptions): Promise<RoomData>;
+    updateRoom(roomId: string, params: UpdateRoomOptions, 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.
@@ -712,34 +801,21 @@ declare class Liveblocks {
      * @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;
-        /**
-         * The query to filter inbox notifications by. It is based on our query language.
-         *
-         * @example
-         * ```
-         * {
-         *  query: "unread:true"
-         * }
-         * ```
-         *
-         * @example
-         * ```
-         * {
-         *   query: {
-         *     unread: true
-         *   }
-         * }
-         * ```
-         *
-         */
-        query?: string | {
-            unread: boolean;
-        };
-    }, options?: RequestOptions): Promise<{
-        data: InboxNotificationData[];
-    }>;
+    getInboxNotifications(params: GetInboxNotificationsOptions, options?: RequestOptions): Promise<Page<InboxNotificationData>>;
+    /**
+     * Iterates over all inbox notifications for a user.
+     *
+     * The difference with .getInboxNotifications() is that pagination will
+     * happen automatically under the hood, using the given `pageSize`.
+     *
+     * @param criteria.userId The user ID to get the inbox notifications from.
+     * @param criteria.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param options.pageSize (optional) The page size to use for each request.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    iterInboxNotifications(criteria: InboxNotificationsQueryCriteria, options?: RequestOptions & {
+        pageSize?: number;
+    }): AsyncGenerator<InboxNotificationData>;
     /**
      * Gets the user's room notification settings.
      * @param params.userId The user ID to get the room notifications from.
@@ -833,6 +909,29 @@ declare class Liveblocks {
     deleteNotificationSettings(params: {
         userId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * Retrieves the current Storage contents for the given room ID and calls the
+     * provided callback function, in which you can mutate the Storage contents
+     * at will.
+     *
+     * If you need to run the same mutation across multiple rooms, prefer using
+     * `.massMutateStorage()` instead of looping over room IDs yourself.
+     */
+    mutateStorage(roomId: string, callback: MutateStorageCallback, options?: MutateStorageOptions): Promise<void>;
+    /**
+     * Retrieves the Storage contents for each room that matches the given
+     * criteria and calls the provided callback function, in which you can mutate
+     * the Storage contents at will.
+     *
+     * You can use the `criteria` parameter to select which rooms to process by
+     * their metadata. If you pass `{}` (empty object), all rooms will be
+     * selected and processed.
+     *
+     * This method will execute mutations in parallel, using the specified
+     * `concurrency` value. If you which to run the mutations serially, set
+     * `concurrency` to 1.
+     */
+    massMutateStorage(criteria: RoomsQueryCriteria, callback: MassMutateStorageCallback, massOptions?: MassMutateStorageOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;
@@ -1204,4 +1303,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomInfo = RoomData;
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateRoomOptions, type CustomNotificationEvent, type GetInboxNotificationsOptions, type GetRoomsOptions, type InboxNotificationsQueryCriteria, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -133,10 +133,113 @@ type Schema = {
     createdAt: Date;
     updatedAt: Date;
 };
+type MutateStorageCallback = (context: {
+    root: LiveObject<S>;
+}) => Awaitable<void>;
+type MutateStorageOptions = RequestOptions;
+type MassMutateStorageCallback = (context: {
+    room: RoomData;
+    root: LiveObject<S>;
+}) => Awaitable<void>;
+type MassMutateStorageOptions = MutateStorageOptions & {
+    concurrency?: number;
+};
 type E = DE;
 type M = DM;
 type S = DS;
 type U = DU;
+type RoomsQueryCriteria = {
+    userId?: string;
+    groupIds?: string[];
+    /**
+     * The query to filter rooms by. It is based on our query language.
+     * @example
+     * ```
+     * {
+     *   query: 'metadata["status"]:"open" AND roomId^"liveblocks:"'
+     * }
+     * ```
+     * @example
+     * ```
+     * {
+     *   query: {
+     *     metadata: {
+     *       status: "open",
+     *     },
+     *     roomId: {
+     *       startsWith: "liveblocks:"
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    query?: string | {
+        metadata?: QueryRoomMetadata;
+        roomId?: {
+            startsWith: string;
+        };
+    };
+};
+type InboxNotificationsQueryCriteria = {
+    userId: string;
+    /**
+     * The query to filter inbox notifications by. It is based on our query language.
+     *
+     * @example
+     * ```
+     * {
+     *  query: "unread:true"
+     * }
+     * ```
+     *
+     * @example
+     * ```
+     * {
+     *   query: {
+     *     unread: true
+     *   }
+     * }
+     * ```
+     *
+     */
+    query?: string | {
+        unread: boolean;
+    };
+};
+type PaginationOptions = {
+    limit?: number;
+    startingAfter?: string;
+};
+type Page<T> = {
+    /** @deprecated Prefer to rely on `nextCursor` instead. */
+    nextPage?: string | null;
+    nextCursor: string | null;
+    data: T[];
+};
+type GetRoomsOptions = RoomsQueryCriteria & PaginationOptions & {
+    /**
+     * @deprecated Use `query` property instead. Support for the `metadata`
+     * field will be removed in a future version.
+     */
+    metadata?: QueryRoomMetadata;
+};
+type GetInboxNotificationsOptions = InboxNotificationsQueryCriteria & PaginationOptions;
+type CreateRoomOptions = {
+    defaultAccesses: RoomPermission;
+    groupsAccesses?: RoomAccesses;
+    usersAccesses?: RoomAccesses;
+    metadata?: RoomMetadata;
+};
+type UpdateRoomOptions = {
+    defaultAccesses?: RoomPermission | null;
+    groupsAccesses?: Record<string, [
+        "room:write"
+    ] | ["room:read", "room:presence:write"] | null>;
+    usersAccesses?: Record<string, [
+        "room:write"
+    ] | ["room:read", "room:presence:write"] | null>;
+    metadata?: Record<string, string | string[] | null>;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -214,49 +317,24 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of rooms.
      */
-    getRooms(params?: {
-        limit?: number;
-        startingAfter?: string;
-        /**
-         * @deprecated Use `query` property instead. Support for the `metadata`
-         * field will be removed in a future version.
-         */
-        metadata?: QueryRoomMetadata;
-        userId?: string;
-        groupIds?: string[];
-        /**
-         * The query to filter rooms by. It is based on our query language.
-         * @example
-         * ```
-         * {
-         *   query: 'metadata["status"]:"open" AND roomId^"liveblocks:"'
-         * }
-         * ```
-         * @example
-         * ```
-         * {
-         *   query: {
-         *     metadata: {
-         *       status: "open",
-         *     },
-         *     roomId: {
-         *       startsWith: "liveblocks:"
-         *     }
-         *   }
-         * }
-         * ```
-         */
-        query?: string | {
-            metadata?: QueryRoomMetadata;
-            roomId?: {
-                startsWith: string;
-            };
-        };
-    }, options?: RequestOptions): Promise<{
-        nextPage: string | null;
-        nextCursor: string | null;
-        data: RoomData[];
-    }>;
+    getRooms(params?: GetRoomsOptions, options?: RequestOptions): Promise<Page<RoomData>>;
+    /**
+     * Iterates over all rooms that match the given criteria.
+     *
+     * The difference with .getRooms() is that pagination will happen
+     * automatically under the hood, using the given `pageSize`.
+     *
+     * @param criteria.userId (optional) A filter on users accesses.
+     * @param criteria.groupIds (optional) A filter on groups accesses. Multiple groups can be used.
+     * @param criteria.query.roomId (optional) A filter by room ID.
+     * @param criteria.query.metadata (optional) A filter by metadata.
+     *
+     * @param options.pageSize (optional) The page size to use for each request.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    iterRooms(criteria: RoomsQueryCriteria, options?: RequestOptions & {
+        pageSize?: number;
+    }): AsyncGenerator<RoomData>;
     /**
      * Creates a new room with the given id.
      * @param roomId The id of the room to create.
@@ -267,12 +345,32 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
-    createRoom(roomId: string, params: {
-        defaultAccesses: RoomPermission;
-        groupsAccesses?: RoomAccesses;
-        usersAccesses?: RoomAccesses;
-        metadata?: RoomMetadata;
-    }, options?: RequestOptions): Promise<RoomData>;
+    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Returns a room with the given id, or creates one with the given creation
+     * options if it doesn't exist yet.
+     *
+     * @param roomId The id of the room.
+     * @param params.defaultAccesses The default accesses for the room if the room will be created.
+     * @param params.groupsAccesses (optional) The group accesses for the room if the room will be created. 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 if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
+     * @param params.metadata (optional) The metadata for the room if the room will be created. 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 room.
+     */
+    getOrCreateRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Updates or creates a new room with the given properties.
+     *
+     * @param roomId The id of the room to update or create.
+     * @param params.defaultAccesses The default accesses for the room.
+     * @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 room.
+     */
+    upsertRoom(roomId: string, params: CreateRoomOptions & UpdateRoomOptions, options?: RequestOptions): Promise<RoomData>;
     /**
      * Returns a room with the given id.
      * @param roomId The id of the room to return.
@@ -291,16 +389,7 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The updated room.
      */
-    updateRoom(roomId: string, params: {
-        defaultAccesses?: RoomPermission | null;
-        groupsAccesses?: Record<string, [
-            "room:write"
-        ] | ["room:read", "room:presence:write"] | null>;
-        usersAccesses?: Record<string, [
-            "room:write"
-        ] | ["room:read", "room:presence:write"] | null>;
-        metadata?: Record<string, string | string[] | null>;
-    }, options?: RequestOptions): Promise<RoomData>;
+    updateRoom(roomId: string, params: UpdateRoomOptions, 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.
@@ -712,34 +801,21 @@ declare class Liveblocks {
      * @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;
-        /**
-         * The query to filter inbox notifications by. It is based on our query language.
-         *
-         * @example
-         * ```
-         * {
-         *  query: "unread:true"
-         * }
-         * ```
-         *
-         * @example
-         * ```
-         * {
-         *   query: {
-         *     unread: true
-         *   }
-         * }
-         * ```
-         *
-         */
-        query?: string | {
-            unread: boolean;
-        };
-    }, options?: RequestOptions): Promise<{
-        data: InboxNotificationData[];
-    }>;
+    getInboxNotifications(params: GetInboxNotificationsOptions, options?: RequestOptions): Promise<Page<InboxNotificationData>>;
+    /**
+     * Iterates over all inbox notifications for a user.
+     *
+     * The difference with .getInboxNotifications() is that pagination will
+     * happen automatically under the hood, using the given `pageSize`.
+     *
+     * @param criteria.userId The user ID to get the inbox notifications from.
+     * @param criteria.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param options.pageSize (optional) The page size to use for each request.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    iterInboxNotifications(criteria: InboxNotificationsQueryCriteria, options?: RequestOptions & {
+        pageSize?: number;
+    }): AsyncGenerator<InboxNotificationData>;
     /**
      * Gets the user's room notification settings.
      * @param params.userId The user ID to get the room notifications from.
@@ -833,6 +909,29 @@ declare class Liveblocks {
     deleteNotificationSettings(params: {
         userId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * Retrieves the current Storage contents for the given room ID and calls the
+     * provided callback function, in which you can mutate the Storage contents
+     * at will.
+     *
+     * If you need to run the same mutation across multiple rooms, prefer using
+     * `.massMutateStorage()` instead of looping over room IDs yourself.
+     */
+    mutateStorage(roomId: string, callback: MutateStorageCallback, options?: MutateStorageOptions): Promise<void>;
+    /**
+     * Retrieves the Storage contents for each room that matches the given
+     * criteria and calls the provided callback function, in which you can mutate
+     * the Storage contents at will.
+     *
+     * You can use the `criteria` parameter to select which rooms to process by
+     * their metadata. If you pass `{}` (empty object), all rooms will be
+     * selected and processed.
+     *
+     * This method will execute mutations in parallel, using the specified
+     * `concurrency` value. If you which to run the mutations serially, set
+     * `concurrency` to 1.
+     */
+    massMutateStorage(criteria: RoomsQueryCriteria, callback: MassMutateStorageCallback, massOptions?: MassMutateStorageOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;
@@ -1204,4 +1303,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomInfo = RoomData;
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateRoomOptions, type CustomNotificationEvent, type GetInboxNotificationsOptions, type GetRoomsOptions, type InboxNotificationsQueryCriteria, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };