feat: add offline api for querying reactions

Author: isekovanic

src/client.ts

@@ -1792,16 +1792,38 @@ export class StreamChat {
     sort: ReactionSort = [],
     options: QueryReactionsOptions = {},
   ) {
-    // Make sure we wait for the connect promise if there is a pending one
-    await this.wsPromise;
-
-    // Return a list of channels
     const payload = {
       filter,
       sort: normalizeQuerySort(sort),
       ...options,
     };
 
+    if (this.offlineDb?.getReactions && !options.next) {
+      try {
+        const reactionsFromDb = await this.offlineDb.getReactions({
+          messageId: messageID,
+          filters: filter,
+          sort,
+          limit: options.limit,
+        });
+
+        if (reactionsFromDb) {
+          this.dispatchEvent({
+            type: 'offline_reactions.queried',
+            offlineReactions: reactionsFromDb as ReactionResponse[],
+          });
+        }
+      } catch (e) {
+        this.logger('warn', 'An error has occurred while querying offline reactions', {
+          error: e,
+        });
+      }
+    }
+
+    // TODO: Why is this here ? Looks not needed.
+    // Make sure we wait for the connect promise if there is a pending one
+    await this.wsPromise;
+
     return await this.post<QueryReactionsAPIResponse>(
       this.baseURL + '/messages/' + encodeURIComponent(messageID) + '/reactions',
       payload,

src/events.ts

@@ -56,6 +56,7 @@ export const EVENT_MAP = {
 
   // local events
   'channels.queried': true,
+  'offline_reactions.queried': true,
   'connection.changed': true,
   'connection.recovered': true,
   'transport.changed': true,

src/offline_support_api.ts

@@ -5,6 +5,8 @@ import type {
   ChannelFilters,
   ChannelSort,
   Event,
+  ReactionFilters,
+  ReactionSort,
 } from './types';
 import type { AxiosError } from 'axios';
 import type { StreamChat } from './client';
@@ -61,6 +63,13 @@ export type GetAppSettingsType = {
   userId: string;
 };
 
+export type GetReactionsType = {
+  messageId: string;
+  filters?: Pick<ReactionFilters, 'type'>;
+  sort?: ReactionSort;
+  limit?: number;
+};
+
 export type DeletePendingTaskType = { id: number };
 
 export type DeleteReactionType = {
@@ -87,6 +96,7 @@ export interface OfflineDBApi {
   getAllChannelCids: () => Promise<string[]>;
   getLastSyncedAt: (options: GetLastSyncedAtType) => Promise<number | undefined>;
   getAppSettings: (options: GetAppSettingsType) => Promise<unknown>;
+  getReactions: (options: GetReactionsType) => Promise<unknown>;
   executeSqlBatch: (queries: ExecuteBatchQueriesType) => Promise<unknown>;
   addPendingTask: (task: PendingTask) => Promise<() => Promise<void>>;
   getPendingTasks: (conditions?: GetPendingTasksType) => Promise<PendingTask[]>;
@@ -126,6 +136,8 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
 
   abstract getAppSettings: OfflineDBApi['getAppSettings'];
 
+  abstract getReactions: OfflineDBApi['getReactions'];
+
   abstract executeSqlBatch: OfflineDBApi['executeSqlBatch'];
 
   abstract addPendingTask: OfflineDBApi['addPendingTask'];

src/types.ts

@@ -1416,6 +1416,7 @@ export type Event = CustomEventData & {
     channels: ChannelAPIResponse[];
     isLatestMessageSet?: boolean;
   };
+  offlineReactions?: ReactionResponse[];
   reaction?: ReactionResponse;
   received_at?: string | Date;
   shadow?: boolean;