stream-chat-react-native-core 5.0.0-beta.0 → 5.0.0-beta.1

package/src/store/apis/getChannels.ts

@@ -1,36 +1,39 @@
-import type { DefaultStreamChatGenerics } from 'src/types/types';
-import type { ChannelAPIResponse, ChannelFilters, ChannelSort } from 'stream-chat';
+import type { ChannelAPIResponse } from 'stream-chat';
 
 import { getMessages } from './getChannelMessages';
 import { getMembers } from './getMembers';
 import { getReads } from './getReads';
-import { selectChannelIdsForFilterSort } from './queries/selectChannelIdsForFilterSort';
 import { selectChannels } from './queries/selectChannels';
 
+import type { DefaultStreamChatGenerics } from '../../types/types';
 import { mapStorableToChannel } from '../mappers/mapStorableToChannel';
 
+/**
+ * Returns the list of channels with state enriched for given channel ids.
+ *
+ * @param {Object} param
+ * @param {Array} param.channelIds List of channel ids to fetch.
+ * @param {Array} param.currentUserId Id of the current logged in user.
+ *
+ * @returns {Array} Channels with enriched state.
+ */
 export const getChannels = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >({
+  channelIds,
   currentUserId,
-  filters,
-  sort,
 }: {
+  channelIds: string[];
   currentUserId: string;
-  filters?: ChannelFilters<StreamChatGenerics>;
-  sort?: ChannelSort<StreamChatGenerics>;
 }): Omit<ChannelAPIResponse<StreamChatGenerics>, 'duration'>[] => {
-  if (!filters && !sort) {
-    console.warn('Please provide the query (filters/sort) to fetch channels from DB');
-    return [];
-  }
-
-  const channelIds = selectChannelIdsForFilterSort({ filters, sort });
   const channels = selectChannels({ channelIds });
 
   const cidVsMembers = getMembers<StreamChatGenerics>({ channelIds });
   const cidVsReads = getReads<StreamChatGenerics>({ channelIds });
-  const cidVsMessages = getMessages<StreamChatGenerics>({ channelIds, currentUserId });
+  const cidVsMessages = getMessages<StreamChatGenerics>({
+    channelIds,
+    currentUserId,
+  });
 
   // Enrich the channels with state
   return channels.map((c) => ({

package/src/store/apis/getChannelsForFilterSort.ts

@@ -0,0 +1,45 @@
+import type { DefaultStreamChatGenerics } from 'src/types/types';
+import type { ChannelAPIResponse, ChannelFilters, ChannelSort } from 'stream-chat';
+
+import { getChannels } from './getChannels';
+import { selectChannelIdsForFilterSort } from './queries/selectChannelIdsForFilterSort';
+
+/**
+ * Gets the channels from database for given filter and sort query.
+ *
+ * @param {Object} param
+ * @param {string} param.currentUserId Id of current logged in user
+ * @param {Object} param.filters Filters for channels https://getstream.io/chat/docs/javascript/query_channels/?language=javascript&q=su#query-parameters
+ * @param {Object} param.sort Sort for channels https://getstream.io/chat/docs/javascript/query_channels/?language=javascript&q=su#query-parameters
+ *
+ * @returns Array of channels corresponding to filters & sort. Returns null if filters + sort query doesn't exist in "channelQueries" table.
+ */
+export const getChannelsForFilterSort = <
+  StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
+>({
+  currentUserId,
+  filters,
+  sort,
+}: {
+  currentUserId: string;
+  filters?: ChannelFilters<StreamChatGenerics>;
+  sort?: ChannelSort<StreamChatGenerics>;
+}): Omit<ChannelAPIResponse<StreamChatGenerics>, 'duration'>[] | null => {
+  if (!filters && !sort) {
+    console.warn('Please provide the query (filters/sort) to fetch channels from DB');
+    return null;
+  }
+
+  const channelIds = selectChannelIdsForFilterSort({ filters, sort });
+
+  if (!channelIds) return null;
+
+  if (channelIds.length === 0) {
+    return [];
+  }
+
+  return getChannels({
+    channelIds,
+    currentUserId,
+  });
+};

package/src/store/apis/index.ts

@@ -0,0 +1,20 @@
+export * from './deleteChannel';
+export * from './deleteMember';
+export * from './deleteMessagesForChannel';
+export * from './deleteReactions';
+export * from './getAllChannelIds';
+export * from './getChannelMessages';
+export * from './getChannels';
+export * from './getChannelsForFilterSort';
+export * from './getLastSyncedAt';
+export * from './getMembers';
+export * from './getReads';
+export * from './updateMessage';
+export * from './updateReaction';
+export * from './upsertChannelData';
+export * from './upsertChannels';
+export * from './upsertCidsForQuery';
+export * from './upsertLastSyncedAt';
+export * from './upsertMembers';
+export * from './upsertMessages';
+export * from './upsertReads';

package/src/store/apis/queries/selectChannelIdsForFilterSort.ts

@@ -6,6 +6,16 @@ import { createSelectQuery } from '../../sqlite-utils/createSelectQuery';
 
 import { convertFilterSortToQuery } from '../utils/convertFilterSortToQuery';
 
+/**
+ * Gets the channel ids from database for given filter and sort query.
+ *
+ * @param {Object} param
+ * @param {Object} param.filters Filters for channels https://getstream.io/chat/docs/javascript/query_channels/?language=javascript&q=su#query-parameters
+ * @param {Object} param.sort Sort for channels https://getstream.io/chat/docs/javascript/query_channels/?language=javascript&q=su#query-parameters
+ *
+ * @returns Array of channel ids corresponding to filters & sort. Returns null if filters + sort query doesn't exist in "channelQueries" table.
+ */
+
 export const selectChannelIdsForFilterSort = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >({
@@ -14,7 +24,7 @@ export const selectChannelIdsForFilterSort = <
 }: {
   filters?: ChannelFilters<StreamChatGenerics>;
   sort?: ChannelSort<StreamChatGenerics>;
-}): string[] => {
+}): string[] | null => {
   const query = convertFilterSortToQuery({ filters, sort });
   const results = QuickSqliteClient.executeSql.apply(
     null,
@@ -24,5 +34,5 @@ export const selectChannelIdsForFilterSort = <
   );
 
   const channelIdsStr = results?.[0]?.cids;
-  return channelIdsStr ? JSON.parse(channelIdsStr) : [];
+  return channelIdsStr ? JSON.parse(channelIdsStr) : null;
 };

package/src/store/apis/queries/selectChannels.ts

@@ -5,9 +5,15 @@ import type { TableRowJoinedUser } from '../../types';
 export const selectChannels = ({
   channelIds,
 }: { channelIds?: string[] } = {}): TableRowJoinedUser<'channels'>[] => {
-  const query = createSelectQuery('channels', ['*'], {
-    cid: channelIds,
-  });
+  const query = createSelectQuery(
+    'channels',
+    ['*'],
+    channelIds
+      ? {
+          cid: channelIds,
+        }
+      : undefined,
+  );
 
   const result = QuickSqliteClient.executeSql.apply(null, query);
 

package/src/store/sqlite-utils/appendWhereCluase.ts

@@ -15,7 +15,6 @@ export const appendWhereClause = <T extends keyof Schema>(
     if (value === undefined) continue;
 
     if (Array.isArray(value)) {
-      if (value.length === 0) continue;
       const questionMarks = Array(Object.keys(value).length).fill('?').join(',');
       whereClause.push(`${key} in (${questionMarks})`);
       whereParams.push(...value);
@@ -25,7 +24,7 @@ export const appendWhereClause = <T extends keyof Schema>(
     }
   }
 
-  if (!whereParams.length) {
+  if (!whereParams.length && !whereClause.length) {
     return [selectQuery, []];
   }
 

package/src/{__tests__/utils → test-utils}/BetterSqlite.js

@@ -1,6 +1,6 @@
 import Database from 'better-sqlite3';
 
-import { tables } from '../../store/schema';
+import { tables } from '../store/schema';
 
 export class BetterSqlite {
   db = null;

package/src/version.json

@@ -1,3 +1,3 @@
 {
-  "version": "5.0.0-beta.0"
+  "version": "5.0.0-beta.1"
 }