@liveblocks/node 1.19.0-test1 → 2.0.0-alpha1

package/dist/index.d.ts

@@ -1,95 +1,7 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction } from '@liveblocks/core';
-export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyResolveUsersArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, stringifyCommentBody } from '@liveblocks/core';
+import { IUserInfo, Json, PlainLsonObject, JsonObject, BaseMetadata, DM, QueryMetadata, ThreadData, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, ActivityData } 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, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
-/**
- * TODO Officially mark as DEPRECATED, point to migration guide.
- */
-declare type AuthorizeOptions = {
-    /**
-     * The secret API key for your Liveblocks account. You can find it on
-     * https://liveblocks.io/dashboard/apikeys
-     */
-    secret: string;
-    /**
-     * The room ID for which to authorize the user. This will authorize the user
-     * to enter the Liveblocks room.
-     */
-    room: string;
-    /**
-     * Associates a user ID to the session that is being authorized. The user ID
-     * is typically set to the user ID from your own database.
-     *
-     * It can also be used to generate a token that gives access to a private
-     * room where the userId is configured in the room accesses.
-     *
-     * This user ID will be used as the unique identifier to compute your
-     * Liveblocks account's Monthly Active Users.
-     */
-    userId: string;
-    /**
-     * Arbitrary metadata associated to this user session.
-     *
-     * You can use it to store a small amount of static metadata for a user
-     * session. It is public information, that will be visible to other users in
-     * the same room, like name, avatar URL, etc.
-     *
-     * It's only suitable for static info that won't change during a session. If
-     * you want to store dynamic metadata on a user session, don't keep that in
-     * the session token, but use Presence instead.
-     *
-     * Can't exceed 1KB when serialized as JSON.
-     */
-    userInfo?: unknown;
-    /**
-     * Tell Liveblocks which group IDs this user belongs to. This will authorize
-     * the user session to access private rooms that have at least one of these
-     * group IDs listed in their room access configuration.
-     *
-     * See https://liveblocks.io/docs/guides/managing-rooms-users-permissions#permissions
-     * for how to configure your room's permissions to use this feature.
-     */
-    groupIds?: string[];
-};
-/**
- * TODO Officially mark as DEPRECATED, point to migration guide.
- */
-declare type AuthorizeResponse = {
-    status: number;
-    body: string;
-    error?: Error;
-};
-/**
- * @deprecated Since 1.2, we’re deprecating single-room tokens in favor of
- * either access tokens or ID tokens. Single-room tokens are still supported,
- * but support for them will be dropped in the future. Please refer to our
- * Upgrade Guide to learn how to adopt the new-style authorization, see
- * https://liveblocks.io/docs/platform/upgrading/1.2
- *
- * Tells Liveblocks that a user should be allowed access to a room, which user
- * this session is for, and what metadata to associate with the user (like
- * name, avatar, etc.)
- *
- * @example
- * export default async function auth(req, res) {
- *
- * // Implement your own security here.
- *
- * const room = req.body.room;
- * const response = await authorize({
- *   room,
- *   secret,
- *   userId: "123",
- *   userInfo: {    // Optional
- *     name: "Ada Lovelace"
- *   },
- *   groupIds: ["group1"] // Optional
- * });
- * return res.status(response.status).end(response.body);
- * }
- */
-declare function authorize(options: AuthorizeOptions): Promise<AuthorizeResponse>;
-
 declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
 declare type Permission = (typeof ALL_PERMISSIONS)[number];
 /**
@@ -175,15 +87,16 @@ declare type RoomAccesses = Record<string, [
     "room:write"
 ] | ["room:read", "room:presence:write"]>;
 declare type RoomMetadata = Record<string, string | string[]>;
+declare type QueryRoomMetadata = Record<string, string>;
 declare type RoomInfo = {
     type: "room";
     id: string;
-    metadata: RoomMetadata;
-    groupsAccesses: RoomAccesses;
-    usersAccesses: RoomAccesses;
-    defaultAccesses: RoomPermission;
+    createdAt: Date;
     lastConnectionAt?: Date;
-    createdAt?: Date;
+    defaultAccesses: RoomPermission;
+    usersAccesses: RoomAccesses;
+    groupsAccesses: RoomAccesses;
+    metadata: RoomMetadata;
 };
 declare type RoomUser<Info> = {
     type: "user";
@@ -266,16 +179,50 @@ declare class Liveblocks {
      * @param params.userId (optional) A filter on users accesses.
      * @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.
      * @returns A list of rooms.
      */
     getRooms(params?: {
         limit?: number;
         startingAfter?: string;
-        metadata?: RoomMetadata;
+        /**
+         * @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;
+            };
+        };
     }): Promise<{
         nextPage: string | null;
+        nextCursor: string | null;
         data: RoomInfo[];
     }>;
     /**
@@ -389,18 +336,22 @@ declare class Liveblocks {
     /**
      * 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 params The Yjs binary update to send. Read the [Yjs documentation](https://docs.yjs.dev/api/document-updates) to learn how to create a binary update.
+     * @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.
      */
-    sendYjsBinaryUpdate(roomId: string, params: {
-        update: string;
+    sendYjsBinaryUpdate(roomId: string, update: Uint8Array, params?: {
+        guid?: string;
     }): 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.
      * @returns The room’s Yjs document encoded as a single binary update.
      */
-    getYjsDocumentAsBinaryUpdate(roomId: string): Promise<ArrayBuffer>;
+    getYjsDocumentAsBinaryUpdate(roomId: string, params?: {
+        guid?: string;
+    }): 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
@@ -451,12 +402,41 @@ declare class Liveblocks {
      * 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.
      * @returns A list of threads.
      */
-    getThreads(params: {
+    getThreads<M extends BaseMetadata = DM>(params: {
         roomId: string;
+        /**
+         * The query to filter threads by. It is based on our query language.
+         *
+         * @example
+         * ```
+         * {
+         *   query: "metadata['organization']^'liveblocks:' AND metadata['status']:'open' AND metadata['resolved']:false AND metadata['priority']:3"
+         * }
+         * ```
+         * @example
+         * ```
+         * {
+         *   query: {
+         *     metadata: {
+         *       status: "open",
+         *       resolved: false,
+         *       priority: 3,
+         *       organization: {
+         *         startsWith: "liveblocks:"
+         *       }
+         *     }
+         *   }
+         * }
+         * ```
+         */
+        query?: string | {
+            metadata?: Partial<QueryMetadata<M>>;
+        };
     }): Promise<{
-        data: ThreadData[];
+        data: ThreadData<M>[];
     }>;
     /**
      * Gets a thread.
@@ -465,10 +445,10 @@ declare class Liveblocks {
      * @param params.threadId The thread ID.
      * @returns A thread.
      */
-    getThread<TThreadMetadata extends BaseMetadata = never>(params: {
+    getThread<M extends BaseMetadata = DM>(params: {
         roomId: string;
         threadId: string;
-    }): Promise<ThreadData<TThreadMetadata>>;
+    }): Promise<ThreadData<M>>;
     /**
      * Gets a thread's participants.
      *
@@ -554,17 +534,17 @@ declare class Liveblocks {
      * @param params.thread.comment.body The body of the comment.
      * @returns The created thread. The thread will be created with the specified comment as its first comment.
      */
-    createThread<TThreadMetadata extends BaseMetadata = never>(params: {
+    createThread<M extends BaseMetadata = DM>(params: {
         roomId: string;
         data: {
-            metadata?: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
+            metadata?: [M] extends [never] ? Record<string, never> : M;
             comment: {
                 userId: string;
                 createdAt?: Date;
                 body: CommentBody;
             };
         };
-    }): Promise<ThreadData<TThreadMetadata>>;
+    }): Promise<ThreadData<M>>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -574,7 +554,7 @@ declare class Liveblocks {
      * @param params.data.updatedAt (optional) The date the thread is set to be updated.
      * @returns The updated thread.
      */
-    editThreadMetadata<TThreadMetadata extends BaseMetadata = never>(params: {
+    editThreadMetadata<M extends BaseMetadata = DM>(params: {
         roomId: string;
         threadId: string;
         data: {
@@ -582,7 +562,7 @@ declare class Liveblocks {
             userId: string;
             updatedAt?: Date;
         };
-    }): Promise<TThreadMetadata>;
+    }): Promise<M>;
     /**
      * Adds a new comment reaction to a comment.
      * @param params.roomId The room ID to add the comment reaction in.
@@ -622,6 +602,64 @@ declare class Liveblocks {
             removedAt?: Date;
         };
     }): 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.
+     */
+    getInboxNotification(params: {
+        userId: string;
+        inboxNotificationId: string;
+    }): Promise<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.
+     */
+    getRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): 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.
+     */
+    updateRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+        data: RoomNotificationSettings;
+    }): 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.
+     */
+    deleteRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * Update a room ID.
+     * @param params.roomId The current ID of the room.
+     * @param params.newRoomId The new room ID.
+     */
+    updateRoomId(params: {
+        currentRoomId: string;
+        newRoomId: string;
+    }): Promise<RoomInfo>;
+    triggerInboxNotification(params: {
+        userId: string;
+        kind: `$${string}`;
+        roomId?: string;
+        subjectId: string;
+        activityData: ActivityData;
+    }): Promise<void>;
+}
+declare class LiveblocksError extends Error {
+    status: number;
+    constructor(status: number, message?: string);
 }
 
 declare class WebhookHandler {
@@ -680,7 +718,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | ThreadCreatedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -831,6 +869,11 @@ declare type YDocUpdatedEvent = {
     data: {
         projectId: string;
         roomId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedAt: string;
     };
 };
 declare type ThreadMetadataUpdatedEvent = {
@@ -861,5 +904,22 @@ declare type ThreadCreatedEvent = {
         createdBy: string;
     };
 };
+declare type NotificationEvent = {
+    type: "notification";
+    data: {
+        channel: "email";
+        kind: "thread";
+        projectId: string;
+        roomId: string;
+        userId: string;
+        threadId: string;
+        inboxNotificationId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        createdAt: string;
+    };
+};
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, type LiveblocksOptions, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, authorize };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest };