@liveblocks/node 2.0.0 → 2.0.2

package/dist/index.d.mts

@@ -65,10 +65,14 @@ declare type LiveblocksOptions = {
      */
     secret: string;
 };
-declare type CreateSessionOptions<U extends BaseUserMeta = DU> = {
+declare type CreateSessionOptions<U extends BaseUserMeta = DU> = Record<string, never> extends U["info"] ? {
+    userInfo?: U["info"];
+} : {
     userInfo: U["info"];
 };
-declare type IdentifyUserOptions<U extends BaseUserMeta = DU> = {
+declare type IdentifyUserOptions<U extends BaseUserMeta = DU> = Record<string, never> extends U["info"] ? {
+    userInfo?: U["info"];
+} : {
     userInfo: U["info"];
 };
 declare type AuthResponse = {
@@ -155,7 +159,7 @@ declare class Liveblocks {
      * `other.info` property.
      *
      */
-    prepareSession(userId: string, options?: CreateSessionOptions<U>): Session;
+    prepareSession(userId: string, ...rest: Record<string, never> extends CreateSessionOptions<U> ? [options?: CreateSessionOptions<U>] : [options: CreateSessionOptions<U>]): Session;
     /**
      * Call this to authenticate the user as an actor you want to allow to use
      * Liveblocks.
@@ -188,7 +192,7 @@ declare class Liveblocks {
      * add here will be visible to all other clients in the room, through the
      * `other.info` property.
      */
-    identifyUser(identity: string | Identity, options?: IdentifyUserOptions<U>): Promise<AuthResponse>;
+    identifyUser(identity: string | Identity, ...rest: Record<string, never> extends IdentifyUserOptions<U> ? [options?: IdentifyUserOptions<U>] : [options: IdentifyUserOptions<U>]): Promise<AuthResponse>;
     /**
      * Returns a list of your rooms. The rooms are returned sorted by creation date, from newest to oldest. You can filter rooms by metadata, users accesses and groups accesses.
      * @param params.limit (optional) A limit on the number of rooms to be returned. The limit can range between 1 and 100, and defaults to 20.
@@ -552,6 +556,15 @@ declare class Liveblocks {
      * @returns The created thread. The thread will be created with the specified comment as its first comment.
      */
     createThread(params: CreateThreadOptions<M>): 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.
+     */
+    deleteThread(params: {
+        roomId: string;
+        threadId: string;
+    }): Promise<void>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -725,7 +738,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -911,6 +924,19 @@ declare type ThreadCreatedEvent = {
         createdBy: string;
     };
 };
+declare type ThreadDeletedEvent = {
+    type: "threadDeleted";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        deletedAt: string;
+    };
+};
 declare type ThreadNotificationEvent = {
     type: "notification";
     data: {

package/dist/index.d.ts

@@ -65,10 +65,14 @@ declare type LiveblocksOptions = {
      */
     secret: string;
 };
-declare type CreateSessionOptions<U extends BaseUserMeta = DU> = {
+declare type CreateSessionOptions<U extends BaseUserMeta = DU> = Record<string, never> extends U["info"] ? {
+    userInfo?: U["info"];
+} : {
     userInfo: U["info"];
 };
-declare type IdentifyUserOptions<U extends BaseUserMeta = DU> = {
+declare type IdentifyUserOptions<U extends BaseUserMeta = DU> = Record<string, never> extends U["info"] ? {
+    userInfo?: U["info"];
+} : {
     userInfo: U["info"];
 };
 declare type AuthResponse = {
@@ -155,7 +159,7 @@ declare class Liveblocks {
      * `other.info` property.
      *
      */
-    prepareSession(userId: string, options?: CreateSessionOptions<U>): Session;
+    prepareSession(userId: string, ...rest: Record<string, never> extends CreateSessionOptions<U> ? [options?: CreateSessionOptions<U>] : [options: CreateSessionOptions<U>]): Session;
     /**
      * Call this to authenticate the user as an actor you want to allow to use
      * Liveblocks.
@@ -188,7 +192,7 @@ declare class Liveblocks {
      * add here will be visible to all other clients in the room, through the
      * `other.info` property.
      */
-    identifyUser(identity: string | Identity, options?: IdentifyUserOptions<U>): Promise<AuthResponse>;
+    identifyUser(identity: string | Identity, ...rest: Record<string, never> extends IdentifyUserOptions<U> ? [options?: IdentifyUserOptions<U>] : [options: IdentifyUserOptions<U>]): Promise<AuthResponse>;
     /**
      * Returns a list of your rooms. The rooms are returned sorted by creation date, from newest to oldest. You can filter rooms by metadata, users accesses and groups accesses.
      * @param params.limit (optional) A limit on the number of rooms to be returned. The limit can range between 1 and 100, and defaults to 20.
@@ -552,6 +556,15 @@ declare class Liveblocks {
      * @returns The created thread. The thread will be created with the specified comment as its first comment.
      */
     createThread(params: CreateThreadOptions<M>): 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.
+     */
+    deleteThread(params: {
+        roomId: string;
+        threadId: string;
+    }): Promise<void>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -725,7 +738,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -911,6 +924,19 @@ declare type ThreadCreatedEvent = {
         createdBy: string;
     };
 };
+declare type ThreadDeletedEvent = {
+    type: "threadDeleted";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        deletedAt: string;
+    };
+};
 declare type ThreadNotificationEvent = {
     type: "notification";
     data: {

package/dist/index.js

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "2.0.0";
+var PKG_VERSION = "2.0.2";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -292,7 +292,8 @@ var Liveblocks = class {
    * `other.info` property.
    *
    */
-  prepareSession(userId, options) {
+  prepareSession(userId, ...rest) {
+    const options = rest[0];
     return new Session(this.post.bind(this), userId, _optionalChain([options, 'optionalAccess', _ => _.userInfo]));
   }
   /**
@@ -328,7 +329,8 @@ var Liveblocks = class {
    * `other.info` property.
    */
   // These fields define the security identity of the user. Whatever you pass in here will define which
-  async identifyUser(identity, options) {
+  async identifyUser(identity, ...rest) {
+    const options = rest[0];
     const path = url`/v2/identify-user`;
     const userId = typeof identity === "string" ? identity : identity.userId;
     const groupIds = typeof identity === "string" ? void 0 : identity.groupIds;
@@ -928,6 +930,19 @@ var Liveblocks = class {
     }
     return _core.convertToThreadData.call(void 0, await res.json());
   }
+  /**
+   * 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.
+   */
+  async deleteThread(params) {
+    const { roomId, threadId } = params;
+    const res = await this.delete(url`/v2/rooms/${roomId}/threads/${threadId}`);
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
   /**
    * Updates the metadata of the specified thread in a room.
    * @param params.roomId The room ID to update the thread in.
@@ -1212,6 +1227,7 @@ var _WebhookHandler = class _WebhookHandler {
       "commentReactionRemoved",
       "threadMetadataUpdated",
       "threadCreated",
+      "threadDeleted",
       "ydocUpdated",
       "notification"
     ].includes(event.type)) {