@liveblocks/node 3.22.0-rc1 → 3.22.0

package/dist/index.d.cts

@@ -311,6 +311,22 @@ type Page<T> = {
     nextCursor: string | null;
     data: T[];
 };
+type HistoryVersion = {
+    id: string;
+    createdAt: Date;
+    authors: {
+        id: string;
+    }[];
+};
+type GetVersionHistoryOptions = {
+    limit?: number;
+    cursor?: string;
+};
+type CreateVersionHistorySnapshotResponse = {
+    data: {
+        id: string;
+    };
+};
 type GetRoomsOptions = RoomsQueryCriteria & PaginationOptions;
 type GetInboxNotificationsOptions = InboxNotificationsQueryCriteria & PaginationOptions;
 type CreateRoomOptions = {
@@ -761,6 +777,43 @@ declare class Liveblocks {
     getYjsDocumentAsBinaryUpdate(roomId: string, params?: {
         guid?: string;
     }, options?: RequestOptions): Promise<ArrayBuffer>;
+    /**
+     * Returns the version history snapshots for the room, sorted by creation date from newest to oldest.
+     * @param roomId The ID of the room to get the version history from.
+     * @param params.limit (optional) The number of versions to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.cursor (optional) A cursor used for pagination. Get the value from the `nextCursor` response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A list of version history snapshots and the next page cursor.
+     */
+    getVersionHistory(roomId: string, params?: GetVersionHistoryOptions, options?: RequestOptions): Promise<Page<HistoryVersion>>;
+    /**
+     * Creates a new version history snapshot of the room, capturing both its Storage and Yjs documents.
+     * @param roomId The ID of the room to create a version history snapshot for.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The created version ID.
+     */
+    createVersionHistorySnapshot(roomId: string, options?: RequestOptions): Promise<CreateVersionHistorySnapshotResponse>;
+    /**
+     * Returns a specific version of the room's Yjs document encoded as a binary Yjs update.
+     * @param params.roomId The room ID to get the Yjs document version from.
+     * @param params.versionId The ID of the version to get.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The version's Yjs document encoded as a binary update.
+     */
+    getYjsVersion(params: {
+        roomId: string;
+        versionId: string;
+    }, options?: RequestOptions): Promise<ArrayBuffer>;
+    /**
+     * Permanently deletes a version from the room's history.
+     * @param params.roomId The room ID to delete the version in.
+     * @param params.versionId The ID of the version to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteVersion(params: {
+        roomId: string;
+        versionId: string;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Gets all the threads in a room.
      *
@@ -1995,4 +2048,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomPermission = RoomPermissions;
 
-export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent, markdownToCommentBody };
+export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateVersionHistorySnapshotResponse, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetVersionHistoryOptions, type GetWebKnowledgeSourceLinksOptions, type HistoryVersion, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent, markdownToCommentBody };

package/dist/index.d.ts

@@ -311,6 +311,22 @@ type Page<T> = {
     nextCursor: string | null;
     data: T[];
 };
+type HistoryVersion = {
+    id: string;
+    createdAt: Date;
+    authors: {
+        id: string;
+    }[];
+};
+type GetVersionHistoryOptions = {
+    limit?: number;
+    cursor?: string;
+};
+type CreateVersionHistorySnapshotResponse = {
+    data: {
+        id: string;
+    };
+};
 type GetRoomsOptions = RoomsQueryCriteria & PaginationOptions;
 type GetInboxNotificationsOptions = InboxNotificationsQueryCriteria & PaginationOptions;
 type CreateRoomOptions = {
@@ -761,6 +777,43 @@ declare class Liveblocks {
     getYjsDocumentAsBinaryUpdate(roomId: string, params?: {
         guid?: string;
     }, options?: RequestOptions): Promise<ArrayBuffer>;
+    /**
+     * Returns the version history snapshots for the room, sorted by creation date from newest to oldest.
+     * @param roomId The ID of the room to get the version history from.
+     * @param params.limit (optional) The number of versions to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.cursor (optional) A cursor used for pagination. Get the value from the `nextCursor` response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A list of version history snapshots and the next page cursor.
+     */
+    getVersionHistory(roomId: string, params?: GetVersionHistoryOptions, options?: RequestOptions): Promise<Page<HistoryVersion>>;
+    /**
+     * Creates a new version history snapshot of the room, capturing both its Storage and Yjs documents.
+     * @param roomId The ID of the room to create a version history snapshot for.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The created version ID.
+     */
+    createVersionHistorySnapshot(roomId: string, options?: RequestOptions): Promise<CreateVersionHistorySnapshotResponse>;
+    /**
+     * Returns a specific version of the room's Yjs document encoded as a binary Yjs update.
+     * @param params.roomId The room ID to get the Yjs document version from.
+     * @param params.versionId The ID of the version to get.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The version's Yjs document encoded as a binary update.
+     */
+    getYjsVersion(params: {
+        roomId: string;
+        versionId: string;
+    }, options?: RequestOptions): Promise<ArrayBuffer>;
+    /**
+     * Permanently deletes a version from the room's history.
+     * @param params.roomId The room ID to delete the version in.
+     * @param params.versionId The ID of the version to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteVersion(params: {
+        roomId: string;
+        versionId: string;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Gets all the threads in a room.
      *
@@ -1995,4 +2048,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomPermission = RoomPermissions;
 
-export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent, markdownToCommentBody };
+export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateVersionHistorySnapshotResponse, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetVersionHistoryOptions, type GetWebKnowledgeSourceLinksOptions, type HistoryVersion, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent, markdownToCommentBody };

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "3.22.0-rc1";
+var PKG_VERSION = "3.22.0";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -337,6 +337,12 @@ function inflateWebKnowledgeSourceLink(link) {
     lastIndexedAt: new Date(link.lastIndexedAt)
   };
 }
+function inflateHistoryVersion(version) {
+  return {
+    ...version,
+    createdAt: new Date(version.createdAt)
+  };
+}
 var Liveblocks = class {
   #secret;
   #baseUrl;
@@ -777,7 +783,7 @@ var Liveblocks = class {
    */
   async getActiveUsers(roomId, options) {
     const res = await this.#get(
-      url2`/v2/rooms/${roomId}/active_users`,
+      url2`/v2/rooms/${roomId}/active-users`,
       void 0,
       options
     );
@@ -794,7 +800,7 @@ var Liveblocks = class {
    */
   async broadcastEvent(roomId, message, options) {
     const res = await this.#post(
-      url2`/v2/rooms/${roomId}/broadcast_event`,
+      url2`/v2/rooms/${roomId}/broadcast-event`,
       message,
       options
     );
@@ -961,6 +967,82 @@ var Liveblocks = class {
     }
     return res.arrayBuffer();
   }
+  /**
+   * Returns the version history snapshots for the room, sorted by creation date from newest to oldest.
+   * @param roomId The ID of the room to get the version history from.
+   * @param params.limit (optional) The number of versions to return. The limit can range between 1 and 100, and defaults to 20.
+   * @param params.cursor (optional) A cursor used for pagination. Get the value from the `nextCursor` response of the previous page.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns A list of version history snapshots and the next page cursor.
+   */
+  async getVersionHistory(roomId, params = {}, options) {
+    const res = await this.#get(
+      url2`/v2/rooms/${roomId}/versions`,
+      { limit: params.limit, cursor: params.cursor },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const page = await res.json();
+    return {
+      nextCursor: page.nextCursor,
+      data: page.data.map(inflateHistoryVersion)
+    };
+  }
+  /**
+   * Creates a new version history snapshot of the room, capturing both its Storage and Yjs documents.
+   * @param roomId The ID of the room to create a version history snapshot for.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The created version ID.
+   */
+  async createVersionHistorySnapshot(roomId, options) {
+    const res = await this.#post(
+      url2`/v2/rooms/${roomId}/versions`,
+      {},
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return await res.json();
+  }
+  /**
+   * Returns a specific version of the room's Yjs document encoded as a binary Yjs update.
+   * @param params.roomId The room ID to get the Yjs document version from.
+   * @param params.versionId The ID of the version to get.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The version's Yjs document encoded as a binary update.
+   */
+  async getYjsVersion(params, options) {
+    const { roomId, versionId } = params;
+    const res = await this.#get(
+      url2`/v2/rooms/${roomId}/versions/${versionId}/yjs`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return res.arrayBuffer();
+  }
+  /**
+   * Permanently deletes a version from the room's history.
+   * @param params.roomId The room ID to delete the version in.
+   * @param params.versionId The ID of the version to delete.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteVersion(params, options) {
+    const { roomId, versionId } = params;
+    const res = await this.#delete(
+      url2`/v2/rooms/${roomId}/versions/${versionId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
   /* -------------------------------------------------------------------------------------------------
    * Comments
    * -----------------------------------------------------------------------------------------------*/
@@ -1933,7 +2015,7 @@ var Liveblocks = class {
     try {
       const resp = await this.#requestStorageMutation(roomId, { signal });
       const { actor, nodes } = resp;
-      const pool = createManagedPool(roomId, {
+      const pool = createManagedPool({
         getCurrentConnectionId: () => actor,
         onDispatch: (ops, _reverse, _storageUpdates) => {
           if (ops.length === 0) return;