stream-chat-react-native-core 5.5.1 → 5.6.0-beta.1

package/lib/typescript/store/schema.d.ts

@@ -1,10 +1,11 @@
 import type { MessageLabel, Role } from 'stream-chat';
+import type { PendingTaskTypes } from './types';
+import type { ValueOf } from '../types/types';
 declare type Tables = {
     [P in keyof Schema]: {
         columns: {
             [K in keyof Schema[P]]: string;
         };
-        primaryKey: Array<keyof Schema[P]>;
         foreignKeys?: Array<{
             column: `${Exclude<keyof Schema[P], symbol>}`;
             referenceTable: `${keyof Schema}`;
@@ -16,6 +17,7 @@ declare type Tables = {
             name: string;
             unique: boolean;
         }>;
+        primaryKey?: Array<keyof Schema[P]>;
     };
 };
 export declare const tables: Tables;
@@ -77,6 +79,15 @@ export declare type Schema = {
         text?: string;
         userId?: string;
     };
+    pendingTasks: {
+        channelId: string;
+        channelType: string;
+        createdAt: string;
+        id: number;
+        messageId: string;
+        payload: string;
+        type: ValueOf<PendingTaskTypes>;
+    };
     reactions: {
         createdAt: string;
         messageId: string;

package/lib/typescript/store/sqlite-utils/appendOrderByClause.d.ts

@@ -0,0 +1,3 @@
+import type { Schema } from '../schema';
+import type { PreparedQueries } from '../types';
+export declare const appendOrderByClause: <T extends keyof Schema>(selectQuery: string, orderBy?: Partial<{ [k in keyof Schema[T]]: 1 | -1; }> | undefined) => PreparedQueries;

package/lib/typescript/store/sqlite-utils/createSelectQuery.d.ts

@@ -10,4 +10,4 @@ import type { PreparedQueries, TableColumnNames, TableColumnValue } from '../typ
  *  All the conditions will be joined with AND in final query.
  * @returns {string} Final select query
  */
-export declare const createSelectQuery: <T extends keyof Schema>(table: T, fields?: "*"[] | (keyof Schema[T])[], whereCondition?: Partial<{ [k in keyof Schema[T]]: TableColumnValue | TableColumnValue[]; }> | undefined) => PreparedQueries;
+export declare const createSelectQuery: <T extends keyof Schema>(table: T, fields?: "*"[] | (keyof Schema[T])[], whereCondition?: Partial<{ [k in keyof Schema[T]]: TableColumnValue | TableColumnValue[]; }> | undefined, orderBy?: Partial<{ [k_1 in keyof Schema[T]]: 1 | -1; }> | undefined) => PreparedQueries;

package/lib/typescript/store/types.d.ts

@@ -1,3 +1,4 @@
+import type { Channel, StreamChat } from 'stream-chat';
 import type { Schema } from './schema';
 export declare type Table = keyof Schema;
 export declare type TableRow<T extends Table> = Schema[T];
@@ -7,3 +8,23 @@ export declare type TableRowJoinedUser<T extends Table> = Schema[T] & {
 export declare type TableColumnNames<T extends Table> = keyof Schema[T];
 export declare type TableColumnValue = string | boolean | number | undefined;
 export declare type PreparedQueries = [string] | [string, Array<any>];
+export declare type PendingTaskTypes = {
+    deleteMessage: 'delete-message';
+    deleteReaction: 'delete-reaction';
+    sendReaction: 'send-reaction';
+};
+export declare type PendingTask = {
+    channelId: string;
+    channelType: string;
+    messageId: string;
+    id?: number;
+} & ({
+    payload: Parameters<Channel['sendReaction']>;
+    type: PendingTaskTypes['sendReaction'];
+} | {
+    payload: Parameters<StreamChat['deleteMessage']>;
+    type: PendingTaskTypes['deleteMessage'];
+} | {
+    payload: Parameters<Channel['deleteReaction']>;
+    type: PendingTaskTypes['deleteReaction'];
+});

package/lib/typescript/types/types.d.ts

@@ -22,6 +22,7 @@ export declare type File = {
 export declare type DefaultAttachmentType = UnknownType & {
     file_size?: number | string;
     mime_type?: string;
+    originalFile?: File;
 };
 interface DefaultUserType extends UnknownType {
     image?: string;
@@ -31,7 +32,7 @@ interface DefaultChannelType extends UnknownType {
     image?: string;
 }
 export interface DefaultStreamChatGenerics extends ExtendableGenerics {
-    attachmentType: UnknownType;
+    attachmentType: DefaultAttachmentType;
     channelType: DefaultChannelType;
     commandType: LiteralStringForUnion;
     eventType: UnknownType;
@@ -40,4 +41,5 @@ export interface DefaultStreamChatGenerics extends ExtendableGenerics {
     userType: DefaultUserType;
 }
 export declare type UnknownType = Record<string, unknown>;
+export declare type ValueOf<T> = T[keyof T];
 export {};

package/lib/typescript/utils/DBSyncManager.d.ts

@@ -0,0 +1,47 @@
+import type { StreamChat } from 'stream-chat';
+import type { PendingTask } from '../store/types';
+import type { DefaultStreamChatGenerics } from '../types/types';
+export declare class DBSyncManager {
+    static syncStatus: boolean;
+    static listeners: Array<(status: boolean) => void>;
+    static client: StreamChat | null;
+    /**
+     * Returns weather channel states in local DB are synced with backend or not.
+     * @returns boolean
+     */
+    static getSyncStatus: () => boolean;
+    /**
+     * Initializes the DBSyncManager. This function should be called only once
+     * throughout the lifetime of SDK.
+     *
+     * @param client
+     */
+    static init: (client: StreamChat) => Promise<void>;
+    /**
+     * Subscribes a listener for sync status change.
+     *
+     * @param listener {function}
+     * @returns {function} to unsubscribe the listener.
+     */
+    static onSyncStatusChange: (listener: (status: boolean) => void) => {
+        unsubscribe: () => void;
+    };
+    static sync: () => Promise<void>;
+    static syncAndExecutePendingTasks: () => Promise<void>;
+    static queueTask: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>({ client, task, }: {
+        client: StreamChat<StreamChatGenerics>;
+        task: PendingTask;
+    }) => Promise<(import("stream-chat").APIResponse & {
+        message: import("stream-chat").MessageResponse<StreamChatGenerics>;
+    }) | undefined>;
+    static executeTask: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>({ client, task, }: {
+        client: StreamChat<StreamChatGenerics>;
+        task: PendingTask;
+    }) => Promise<import("stream-chat").APIResponse & {
+        message: import("stream-chat").MessageResponse<StreamChatGenerics>;
+    }>;
+    static executePendingTasks: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>(client: StreamChat<StreamChatGenerics>) => Promise<void>;
+    static dropPendingTasks: (conditions: {
+        messageId: string;
+    }) => void;
+}

package/lib/typescript/utils/addReactionToLocalState.d.ts

@@ -0,0 +1,9 @@
+import type { Channel, UserResponse } from 'stream-chat';
+import type { DefaultStreamChatGenerics } from '../types/types';
+export declare const addReactionToLocalState: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>({ channel, enforceUniqueReaction, messageId, reactionType, user, }: {
+    channel: Channel<StreamChatGenerics>;
+    enforceUniqueReaction: boolean;
+    messageId: string;
+    reactionType: string;
+    user: UserResponse<StreamChatGenerics>;
+}) => void;

package/lib/typescript/utils/removeReactionFromLocalState.d.ts

@@ -0,0 +1,8 @@
+import type { Channel, UserResponse } from 'stream-chat';
+import type { DefaultStreamChatGenerics } from '../types/types';
+export declare const removeReactionFromLocalState: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>({ channel, messageId, reactionType, user, }: {
+    channel: Channel<StreamChatGenerics>;
+    messageId: string;
+    reactionType: string;
+    user: UserResponse<StreamChatGenerics>;
+}) => void;

package/lib/typescript/{components/Message/utils → utils}/removeReservedFields.d.ts

@@ -1,3 +1,3 @@
-import type { DefaultStreamChatGenerics } from '../../../types/types';
-import type { MessageType } from '../../MessageList/hooks/useMessageList';
+import type { MessageType } from '../components/MessageList/hooks/useMessageList';
+import type { DefaultStreamChatGenerics } from '../types/types';
 export declare const removeReservedFields: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>(message: MessageType<StreamChatGenerics>) => MessageType<StreamChatGenerics>;

package/lib/typescript/utils/utils.d.ts

@@ -5,7 +5,7 @@ import type { MentionAllAppUsersQuery } from '../contexts/messageInputContext/Me
 import type { SuggestionCommand, SuggestionComponentType, SuggestionUser } from '../contexts/suggestionsContext/SuggestionsContext';
 import { Emoji } from '../emoji-data/compiled';
 import type { IconProps } from '../icons/utils/base';
-import type { DefaultStreamChatGenerics } from '../types/types';
+import type { DefaultStreamChatGenerics, ValueOf } from '../types/types';
 export declare type ReactionData = {
     Icon: React.FC<IconProps>;
     type: string;
@@ -29,9 +29,8 @@ export declare const MessageStatusTypes: {
     SENDING: string;
 };
 export declare type FileStateValue = typeof FileState[keyof typeof FileState];
-declare type ValueOf<T> = T[keyof T];
 declare type Progress = ValueOf<typeof ProgressIndicatorTypes>;
-export declare const getIndicatorTypeForFileState: (fileState: FileStateValue) => Progress | null;
+export declare const getIndicatorTypeForFileState: (fileState: FileStateValue, enableOfflineSupport: boolean) => Progress | null;
 export declare const queryMembersDebounced: DebouncedFunc<(<StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>(channel: Channel<StreamChatGenerics>, query: SuggestionUser<StreamChatGenerics>["name"], onReady?: ((users: SuggestionUser<StreamChatGenerics>[]) => void) | undefined, options?: {
     limit?: number;
 }) => Promise<void>)>;
@@ -105,6 +104,7 @@ export declare type QueryMembersFunction<StreamChatGenerics extends DefaultStrea
 export declare const ACITriggerSettings: <StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics>({ channel, client, onMentionSelectItem, }: ACITriggerSettingsParams<StreamChatGenerics>) => TriggerSettings<StreamChatGenerics>;
 export declare const makeImageCompatibleUrl: (url: string) => string;
 export declare const getUrlWithoutParams: (url?: string | undefined) => string | undefined;
+export declare const isLocalUrl: (url: string) => boolean;
 export declare const vw: (percentageWidth: number, rounded?: boolean) => number;
 export declare const vh: (percentageHeight: number, rounded?: boolean) => number;
 export declare const generateRandomId: (a?: string) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stream-chat-react-native-core",
   "description": "The official React Native and Expo components for Stream Chat, a service for building chat applications",
-  "version": "5.5.1",
+  "version": "5.6.0-beta.1",
   "author": {
     "company": "Stream.io Inc",
     "name": "Stream.io Inc"
@@ -44,6 +44,7 @@
     "extract-changelog": "FILTER_PATH='package' TAG_FORMAT='v${version}' node ../release/extract-changelog.js",
     "release": "FILTER_PATH='package' TAG_FORMAT='v${version}' node ../release/prod",
     "release-next": "FILTER_PATH='package' TAG_FORMAT='v${version}' node ../release/next",
+    "prepublishOnly": "echo 'running prepublishOnly for core package' && bash ./bin/before-tag.sh && bash ./bin/release.sh && echo 'finished running prepublishOnly for core package'",
     "prepack": " cp ../README.md .",
     "postpack": "rm README.md"
   },
@@ -135,7 +136,7 @@
     "react-native": "0.67.3",
     "react-native-builder-bob": "0.18.1",
     "react-native-gesture-handler": "2.3.1",
-    "react-native-quick-sqlite": "^4.0.3",
+    "react-native-quick-sqlite": "5.1.0",
     "react-native-reanimated": "2.7.0",
     "react-native-svg": "12.1.1",
     "react-native-typescript-transformer": "1.2.13",
@@ -144,4 +145,4 @@
     "uuid": "^8.3.2",
     "webpack": "4.44.2"
   }
-}
+}

package/src/__tests__/offline-feature.test.js

@@ -14,6 +14,7 @@ import { queryChannelsApi } from '../mock-builders/api/queryChannels';
 import { useMockedApis } from '../mock-builders/api/useMockedApis';
 import dispatchChannelTruncatedEvent from '../mock-builders/event/channelTruncated';
 import dispatchChannelUpdatedEvent from '../mock-builders/event/channelUpdated';
+import dispatchConnectionChangedEvent from '../mock-builders/event/connectionChanged';
 import dispatchMemberAddedEvent from '../mock-builders/event/memberAdded';
 import dispatchMemberRemovedEvent from '../mock-builders/event/memberRemoved';
 import dispatchMemberUpdatedEvent from '../mock-builders/event/memberUpdated';
@@ -206,7 +207,6 @@ describe('Offline support is enabled', () => {
 
     const channelQueriesRows = BetterSqlite.selectFromTable('channelQueries');
     const cidsInDB = JSON.parse(channelQueriesRows[0].cids);
-
     const filterSortQueryInDB = channelQueriesRows[0].id;
     const actualFilterSortQueryInDB = convertFilterSortToQuery({ filters, sort });
 
@@ -285,8 +285,10 @@ describe('Offline support is enabled', () => {
 
   it('should store filter-sort query and cids on ChannelList in channelQueries table', async () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
-
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
+    // await waiter();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     expectCIDsOnUIToBeInDB(queryAllByA11yRole);
@@ -296,6 +298,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     expectAllChannelsWithStateToBeInDB(queryAllByA11yRole);
@@ -305,6 +308,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
     const newMessage = generateMessage({
       cid: channels[0].channel.cid,
@@ -322,6 +326,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const newChannel = createChannel();
@@ -343,6 +348,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const updatedMessage = { ...channels[0].messages[0] };
@@ -361,6 +367,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
     const removedChannel = channels[getRandomInt(0, channels.length - 1)].channel;
     act(() => dispatchNotificationRemovedFromChannel(chatClient, removedChannel));
@@ -387,6 +394,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const newChannel = createChannel();
@@ -416,6 +424,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId, queryAllByA11yRole } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const channelToTruncate = channels[getRandomInt(0, channels.length - 1)].channel;
@@ -440,6 +449,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -481,6 +491,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -528,6 +539,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -561,6 +573,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -579,6 +592,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -597,6 +611,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -620,6 +635,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
 
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
@@ -640,6 +656,7 @@ describe('Offline support is enabled', () => {
     useMockedApis(chatClient, [queryChannelsApi(channels)]);
 
     const { getByTestId } = renderComponent();
+    act(() => dispatchConnectionChangedEvent(chatClient));
     await waitFor(() => expect(getByTestId('channel-list')).toBeTruthy());
     const targetChannel = channels[getRandomInt(0, channels.length - 1)];
     const targetMember = targetChannel.members[getRandomInt(0, targetChannel.members.length - 1)];