@liveblocks/node 1.12.0 → 2.0.0-alpha1

package/dist/index.d.mts

@@ -1,95 +1,7 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, BaseMetadata, QueryMetadata, ThreadData, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, ActivityData } 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];
 /**
@@ -274,7 +186,8 @@ declare class Liveblocks {
         limit?: number;
         startingAfter?: string;
         /**
-         * @deprecated Use `query` instead.
+         * @deprecated Use `query` property instead. Support for the `metadata`
+         * field will be removed in a future version.
          */
         metadata?: QueryRoomMetadata;
         userId?: string;
@@ -492,7 +405,7 @@ declare class Liveblocks {
      * @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<TThreadMetadata extends BaseMetadata>(params: {
+    getThreads<M extends BaseMetadata = DM>(params: {
         roomId: string;
         /**
          * The query to filter threads by. It is based on our query language.
@@ -520,10 +433,10 @@ declare class Liveblocks {
          * ```
          */
         query?: string | {
-            metadata?: Partial<QueryMetadata<TThreadMetadata>>;
+            metadata?: Partial<QueryMetadata<M>>;
         };
     }): Promise<{
-        data: ThreadData[];
+        data: ThreadData<M>[];
     }>;
     /**
      * Gets a thread.
@@ -532,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.
      *
@@ -621,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.
@@ -641,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: {
@@ -649,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.
@@ -1009,4 +922,4 @@ declare type NotificationEvent = {
     };
 };
 
-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, 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 };

package/dist/index.d.ts

@@ -1,95 +1,7 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, BaseMetadata, QueryMetadata, ThreadData, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, ActivityData } 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];
 /**
@@ -274,7 +186,8 @@ declare class Liveblocks {
         limit?: number;
         startingAfter?: string;
         /**
-         * @deprecated Use `query` instead.
+         * @deprecated Use `query` property instead. Support for the `metadata`
+         * field will be removed in a future version.
          */
         metadata?: QueryRoomMetadata;
         userId?: string;
@@ -492,7 +405,7 @@ declare class Liveblocks {
      * @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<TThreadMetadata extends BaseMetadata>(params: {
+    getThreads<M extends BaseMetadata = DM>(params: {
         roomId: string;
         /**
          * The query to filter threads by. It is based on our query language.
@@ -520,10 +433,10 @@ declare class Liveblocks {
          * ```
          */
         query?: string | {
-            metadata?: Partial<QueryMetadata<TThreadMetadata>>;
+            metadata?: Partial<QueryMetadata<M>>;
         };
     }): Promise<{
-        data: ThreadData[];
+        data: ThreadData<M>[];
     }>;
     /**
      * Gets a thread.
@@ -532,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.
      *
@@ -621,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.
@@ -641,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: {
@@ -649,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.
@@ -1009,4 +922,4 @@ declare type NotificationEvent = {
     };
 };
 
-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, 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 };

package/dist/index.js

@@ -3,9 +3,18 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "1.12.0";
+var PKG_VERSION = "2.0.0-alpha1";
 var PKG_FORMAT = "cjs";
 
+// src/client.ts
+
+
+
+
+
+
+
+
 // src/utils.ts
 var DEFAULT_BASE_URL = "https://api.liveblocks.io";
 function getBaseUrl(baseUrl) {
@@ -66,57 +75,6 @@ function url(strings, ...values) {
   );
 }
 
-// src/authorize.ts
-async function authorize(options) {
-  let url2 = null;
-  try {
-    const { room, secret, userId, userInfo, groupIds } = (
-      // Ensure we'll validate inputs at runtime
-      options
-    );
-    assertNonEmpty(secret, "secret");
-    assertNonEmpty(room, "room");
-    assertNonEmpty(userId, "userId");
-    url2 = buildLiveblocksAuthorizeEndpoint(options, room);
-    const fetch = await fetchPolyfill();
-    const resp = await fetch(url2, {
-      method: "POST",
-      headers: {
-        Authorization: `Bearer ${secret}`,
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify({
-        userId,
-        userInfo,
-        groupIds
-      })
-    });
-    return {
-      status: normalizeStatusCode(resp.status),
-      body: await resp.text()
-    };
-  } catch (er) {
-    return {
-      status: 503,
-      body: (url2 ? `Call to "${url2}" failed.` : "Invalid authorize request.") + ' See "error" for more information.',
-      error: er
-    };
-  }
-}
-function buildLiveblocksAuthorizeEndpoint(options, roomId) {
-  const path = `/v2/rooms/${encodeURIComponent(roomId)}/authorize`;
-  return urljoin(getBaseUrl(options.baseUrl), path);
-}
-
-// src/client.ts
-
-
-
-
-
-
-
-
 // src/Session.ts
 var ALL_PERMISSIONS = Object.freeze([
   "room:write",
@@ -838,9 +796,7 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return _core.convertToThreadData.call(void 0, 
-      await res.json()
-    );
+    return _core.convertToThreadData.call(void 0, await res.json());
   }
   /**
    * Gets a thread's participants.
@@ -970,9 +926,7 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return _core.convertToThreadData.call(void 0, 
-      await res.json()
-    );
+    return _core.convertToThreadData.call(void 0, await res.json());
   }
   /**
    * Updates the metadata of the specified thread in a room.
@@ -1286,6 +1240,5 @@ _core.detectDupes.call(void 0, PKG_NAME, PKG_VERSION, PKG_FORMAT);
 
 
 
-
-exports.Liveblocks = Liveblocks; exports.LiveblocksError = LiveblocksError; exports.WebhookHandler = WebhookHandler; exports.authorize = authorize; exports.getMentionedIdsFromCommentBody = _core.getMentionedIdsFromCommentBody; exports.stringifyCommentBody = _core.stringifyCommentBody;
+exports.Liveblocks = Liveblocks; exports.LiveblocksError = LiveblocksError; exports.WebhookHandler = WebhookHandler; exports.getMentionedIdsFromCommentBody = _core.getMentionedIdsFromCommentBody; exports.stringifyCommentBody = _core.stringifyCommentBody;
 //# sourceMappingURL=index.js.map