@liveblocks/node 2.22.1 → 2.22.3

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 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';
+export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
@@ -240,6 +240,10 @@ type UpdateRoomOptions = {
     ] | ["room:read", "room:presence:write"] | null>;
     metadata?: Record<string, string | string[] | null>;
 };
+type UpsertRoomOptions = {
+    update: UpdateRoomOptions;
+    create?: CreateRoomOptions;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -345,7 +349,9 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
-    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions & {
+        idempotent?: boolean;
+    }): Promise<RoomData>;
     /**
      * Returns a room with the given id, or creates one with the given creation
      * options if it doesn't exist yet.
@@ -363,14 +369,12 @@ declare class Liveblocks {
      * 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 update The fields to update. These values will be updated when the room exists, or set when the room does not exist and gets created. Must specify at least one key.
+     * @param create (optional) The fields to only use when the room does not exist and will be created. When the room already exists, these values are ignored.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
-    upsertRoom(roomId: string, params: CreateRoomOptions & UpdateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    upsertRoom(roomId: string, params: UpsertRoomOptions, options?: RequestOptions): Promise<RoomData>;
     /**
      * Returns a room with the given id.
      * @param roomId The id of the room to return.
@@ -1303,4 +1307,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomInfo = RoomData;
 
-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 };
+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 UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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';
+export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
@@ -240,6 +240,10 @@ type UpdateRoomOptions = {
     ] | ["room:read", "room:presence:write"] | null>;
     metadata?: Record<string, string | string[] | null>;
 };
+type UpsertRoomOptions = {
+    update: UpdateRoomOptions;
+    create?: CreateRoomOptions;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -345,7 +349,9 @@ declare class Liveblocks {
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
-    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    createRoom(roomId: string, params: CreateRoomOptions, options?: RequestOptions & {
+        idempotent?: boolean;
+    }): Promise<RoomData>;
     /**
      * Returns a room with the given id, or creates one with the given creation
      * options if it doesn't exist yet.
@@ -363,14 +369,12 @@ declare class Liveblocks {
      * 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 update The fields to update. These values will be updated when the room exists, or set when the room does not exist and gets created. Must specify at least one key.
+     * @param create (optional) The fields to only use when the room does not exist and will be created. When the room already exists, these values are ignored.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
-    upsertRoom(roomId: string, params: CreateRoomOptions & UpdateRoomOptions, options?: RequestOptions): Promise<RoomData>;
+    upsertRoom(roomId: string, params: UpsertRoomOptions, options?: RequestOptions): Promise<RoomData>;
     /**
      * Returns a room with the given id.
      * @param roomId The id of the room to return.
@@ -1303,4 +1307,4 @@ declare function isCustomNotificationEvent(event: WebhookEvent): event is Custom
  */
 type RoomInfo = RoomData;
 
-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 };
+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 UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "2.22.1";
+var PKG_VERSION = "2.22.3";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -270,6 +270,15 @@ var Session = class {
 };
 
 // src/client.ts
+function inflateRoomData(room) {
+  const createdAt = new Date(room.createdAt);
+  const lastConnectionAt = room.lastConnectionAt ? new Date(room.lastConnectionAt) : void 0;
+  return {
+    ...room,
+    createdAt,
+    lastConnectionAt
+  };
+}
 var Liveblocks = class {
   #secret;
   #baseUrl;
@@ -477,15 +486,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const page = await res.json();
-    const rooms = page.data.map((room) => {
-      const lastConnectionAt = room.lastConnectionAt ? new Date(room.lastConnectionAt) : void 0;
-      const createdAt = new Date(room.createdAt);
-      return {
-        ...room,
-        createdAt,
-        lastConnectionAt
-      };
-    });
+    const rooms = page.data.map(inflateRoomData);
     return {
       ...page,
       data: rooms
@@ -536,7 +537,7 @@ var Liveblocks = class {
   async createRoom(roomId, params, options) {
     const { defaultAccesses, groupsAccesses, usersAccesses, metadata } = params;
     const res = await this.#post(
-      url2`/v2/rooms`,
+      options?.idempotent ? url2`/v2/rooms?idempotent` : url2`/v2/rooms`,
       {
         id: roomId,
         defaultAccesses,
@@ -550,13 +551,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const data = await res.json();
-    const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = new Date(data.createdAt);
-    return {
-      ...data,
-      lastConnectionAt,
-      createdAt
-    };
+    return inflateRoomData(data);
   }
   /**
    * Returns a room with the given id, or creates one with the given creation
@@ -571,37 +566,31 @@ var Liveblocks = class {
    * @returns The room.
    */
   async getOrCreateRoom(roomId, params, options) {
-    try {
-      return await this.createRoom(roomId, params, options);
-    } catch (err) {
-      if (err instanceof LiveblocksError && err.status === 409) {
-        return await this.getRoom(roomId, options);
-      } else {
-        throw err;
-      }
-    }
+    return await this.createRoom(roomId, params, {
+      ...options,
+      idempotent: true
+    });
   }
   /**
    * 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 update The fields to update. These values will be updated when the room exists, or set when the room does not exist and gets created. Must specify at least one key.
+   * @param create (optional) The fields to only use when the room does not exist and will be created. When the room already exists, these values are ignored.
    * @param options.signal (optional) An abort signal to cancel the request.
    * @returns The room.
    */
   async upsertRoom(roomId, params, options) {
-    try {
-      return await this.createRoom(roomId, params, options);
-    } catch (err) {
-      if (err instanceof LiveblocksError && err.status === 409) {
-        return await this.updateRoom(roomId, params, options);
-      } else {
-        throw err;
-      }
+    const res = await this.#post(
+      url2`/v2/rooms/${roomId}/upsert`,
+      params,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
     }
+    const data = await res.json();
+    return inflateRoomData(data);
   }
   /**
    * Returns a room with the given id.
@@ -615,13 +604,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const data = await res.json();
-    const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = new Date(data.createdAt);
-    return {
-      ...data,
-      createdAt,
-      lastConnectionAt
-    };
+    return inflateRoomData(data);
   }
   /**
    * Updates specific properties of a room. It’s not necessary to provide the entire room’s information.
@@ -650,13 +633,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const data = await res.json();
-    const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = new Date(data.createdAt);
-    return {
-      ...data,
-      lastConnectionAt,
-      createdAt
-    };
+    return inflateRoomData(data);
   }
   /**
    * 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.
@@ -1438,11 +1415,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const data = await res.json();
-    return {
-      ...data,
-      createdAt: new Date(data.createdAt),
-      lastConnectionAt: data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0
-    };
+    return inflateRoomData(data);
   }
   async triggerInboxNotification(params, options) {
     const res = await this.#post(
@@ -1842,10 +1815,16 @@ function isCustomNotificationEvent(event) {
 import {
   getMentionedIdsFromCommentBody,
   isNotificationChannelEnabled,
+  LiveList,
+  LiveMap,
+  LiveObject as LiveObject2,
   stringifyCommentBody
 } from "@liveblocks/core";
 detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
 export {
+  LiveList,
+  LiveMap,
+  LiveObject2 as LiveObject,
   Liveblocks,
   LiveblocksError,
   WebhookHandler,