feat: add api for fetching app settings

Author: isekovanic

src/client.ts

@@ -802,7 +802,17 @@ export class StreamChat {
    * getAppSettings - retrieves application settings
    */
   async getAppSettings() {
-    return await this.get<AppSettingsAPIResponse>(this.baseURL + '/app');
+    const userId = this.userID as string;
+    if (!this.wsConnection?.isHealthy && this.offlineDb && userId) {
+      return await this.offlineDb?.getAppSettings({ userId });
+    }
+    const appSettings = await this.get<AppSettingsAPIResponse>(this.baseURL + '/app');
+
+    if (userId) {
+      this.offlineDb?.upsertAppSettings({ appSettings, userId });
+    }
+
+    return appSettings;
   }
 
   /**

src/offline_support_api.ts

@@ -1,5 +1,6 @@
 import type {
   APIErrorResponse,
+  AppSettingsAPIResponse,
   ChannelAPIResponse,
   ChannelFilters,
   ChannelSort,
@@ -28,6 +29,12 @@ export type UpsertChannelsType = {
   sort?: ChannelSort;
 };
 
+export type UpsertAppSettingsType = {
+  appSettings: AppSettingsAPIResponse;
+  userId: string;
+  flush?: boolean;
+};
+
 export type UpsertUserSyncStatusType = {
   userId: string;
   lastSyncedAt: string;
@@ -50,6 +57,10 @@ export type GetLastSyncedAtType = {
 
 export type GetPendingTasksType = { messageId?: string };
 
+export type GetAppSettingsType = {
+  userId: string;
+};
+
 export type DeletePendingTaskType = { id: number };
 
 export type DeleteReactionType = {
@@ -68,20 +79,22 @@ export interface OfflineDBApi {
   upsertCidsForQuery: (options: UpsertCidsForQueryType) => Promise<unknown>;
   upsertChannels: (options: UpsertChannelsType) => Promise<unknown>;
   upsertUserSyncStatus: (options: UpsertUserSyncStatusType) => Promise<unknown>;
+  upsertAppSettings: (options: UpsertAppSettingsType) => Promise<unknown>;
   getChannels: (options: GetChannelsType) => Promise<unknown>;
   getChannelsForQuery: (
     options: GetChannelsForQueryType,
   ) => Promise<Omit<ChannelAPIResponse, 'duration'>[] | null>;
   getAllChannelCids: () => Promise<string[]>;
   getLastSyncedAt: (options: GetLastSyncedAtType) => Promise<number | undefined>;
-  resetDB: () => Promise<unknown>;
+  getAppSettings: (options: GetAppSettingsType) => Promise<unknown>;
   executeSqlBatch: (queries: ExecuteBatchQueriesType) => Promise<unknown>;
   addPendingTask: (task: PendingTask) => Promise<() => Promise<void>>;
   getPendingTasks: (conditions?: GetPendingTasksType) => Promise<PendingTask[]>;
   deletePendingTask: (options: DeletePendingTaskType) => Promise<unknown>;
   deleteReaction: (options: DeleteReactionType) => Promise<unknown>;
-  hardDeleteMessage: (optins: DeleteMessageType) => Promise<unknown>;
-  softDeleteMessage: (optins: DeleteMessageType) => Promise<unknown>;
+  hardDeleteMessage: (options: DeleteMessageType) => Promise<unknown>;
+  softDeleteMessage: (options: DeleteMessageType) => Promise<unknown>;
+  resetDB: () => Promise<unknown>;
 }
 
 export abstract class AbstractOfflineDB implements OfflineDBApi {
@@ -97,6 +110,10 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
 
   abstract upsertChannels: OfflineDBApi['upsertChannels'];
 
+  abstract upsertUserSyncStatus: OfflineDBApi['upsertUserSyncStatus'];
+
+  abstract upsertAppSettings: OfflineDBApi['upsertAppSettings'];
+
   abstract getChannels: OfflineDBApi['getChannels'];
 
   abstract getChannelsForQuery: OfflineDBApi['getChannelsForQuery'];
@@ -105,16 +122,14 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
 
   abstract getLastSyncedAt: OfflineDBApi['getLastSyncedAt'];
 
-  abstract resetDB: OfflineDBApi['resetDB'];
+  abstract getPendingTasks: OfflineDBApi['getPendingTasks'];
 
-  abstract executeSqlBatch: OfflineDBApi['executeSqlBatch'];
+  abstract getAppSettings: OfflineDBApi['getAppSettings'];
 
-  abstract upsertUserSyncStatus: OfflineDBApi['upsertUserSyncStatus'];
+  abstract executeSqlBatch: OfflineDBApi['executeSqlBatch'];
 
   abstract addPendingTask: OfflineDBApi['addPendingTask'];
 
-  abstract getPendingTasks: OfflineDBApi['getPendingTasks'];
-
   abstract deletePendingTask: OfflineDBApi['deletePendingTask'];
 
   abstract deleteReaction: OfflineDBApi['deleteReaction'];
@@ -123,6 +138,8 @@ export abstract class AbstractOfflineDB implements OfflineDBApi {
 
   abstract softDeleteMessage: OfflineDBApi['softDeleteMessage'];
 
+  abstract resetDB: OfflineDBApi['resetDB'];
+
   public queueTask = async ({ task }: { task: PendingTask }) => {
     let response;
     try {