@liveblocks/node 1.11.3 → 1.12.0-test2

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings } from '@liveblocks/core';
+import { IUserInfo, Json, PlainLsonObject, JsonObject, BaseMetadata, 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';
 
@@ -175,6 +175,7 @@ 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;
@@ -266,14 +267,46 @@ 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` instead.
+         */
+        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;
@@ -456,10 +489,39 @@ 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<TThreadMetadata extends BaseMetadata>(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<TThreadMetadata>>;
+        };
     }): Promise<{
         data: ThreadData[];
     }>;
@@ -674,6 +736,13 @@ declare class Liveblocks {
         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;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings } from '@liveblocks/core';
+import { IUserInfo, Json, PlainLsonObject, JsonObject, BaseMetadata, 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';
 
@@ -175,6 +175,7 @@ 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;
@@ -266,14 +267,46 @@ 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` instead.
+         */
+        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;
@@ -456,10 +489,39 @@ 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<TThreadMetadata extends BaseMetadata>(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<TThreadMetadata>>;
+        };
     }): Promise<{
         data: ThreadData[];
     }>;
@@ -674,6 +736,13 @@ declare class Liveblocks {
         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;

package/dist/index.js

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "1.11.3";
+var PKG_VERSION = "1.12.0-test2";
 var PKG_FORMAT = "cjs";
 
 // src/utils.ts
@@ -115,6 +115,8 @@ function buildLiveblocksAuthorizeEndpoint(options, roomId) {
 
 
 
+
+
 // src/Session.ts
 var ALL_PERMISSIONS = Object.freeze([
   "room:write",
@@ -405,10 +407,17 @@ var Liveblocks = class {
    * @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.
    */
   async getRooms(params = {}) {
     const path = url`/v2/rooms`;
+    let query;
+    if (typeof params.query === "string") {
+      query = params.query;
+    } else if (typeof params.query === "object") {
+      query = _core.objectToQuery.call(void 0, params.query);
+    }
     const queryParams = {
       limit: params.limit,
       startingAfter: params.startingAfter,
@@ -416,11 +425,12 @@ var Liveblocks = class {
       groupIds: params.groupIds ? params.groupIds.join(",") : void 0,
       // "Flatten" {metadata: {foo: "bar"}} to {"metadata.foo": "bar"}
       ...Object.fromEntries(
-        Object.entries(_nullishCoalesce(params.metadata, () => ( {}))).map(([key, val]) => {
-          const value = Array.isArray(val) ? val.join(",") : val;
-          return [`metadata.${key}`, value];
-        })
-      )
+        Object.entries(_nullishCoalesce(params.metadata, () => ( {}))).map(([key, val]) => [
+          `metadata.${key}`,
+          val
+        ])
+      ),
+      query
     };
     const res = await this.get(path, queryParams);
     if (!res.ok) {
@@ -791,11 +801,20 @@ var Liveblocks = class {
    * 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.
    */
   async getThreads(params) {
     const { roomId } = params;
-    const res = await this.get(url`/v2/rooms/${roomId}/threads`);
+    let query;
+    if (typeof params.query === "string") {
+      query = params.query;
+    } else if (typeof params.query === "object") {
+      query = _core.objectToQuery.call(void 0, params.query);
+    }
+    const res = await this.get(url`/v2/rooms/${roomId}/threads`, {
+      query
+    });
     if (!res.ok) {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
@@ -1042,12 +1061,9 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    const data = await res.json();
-    return {
-      ...data,
-      notifiedAt: new Date(data.notifiedAt),
-      readAt: data.readAt ? new Date(data.readAt) : null
-    };
+    return _core.convertToInboxNotificationData.call(void 0, 
+      await res.json()
+    );
   }
   /**
    * Gets the user's room notification settings.
@@ -1122,6 +1138,13 @@ var Liveblocks = class {
       lastConnectionAt: data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0
     };
   }
+  async triggerInboxNotification(params) {
+    const res = await this.post(url`/v2/inbox-notifications/trigger`, params);
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
 };
 var LiveblocksError = class extends Error {
   constructor(status, message = "") {