stream-chat-react-native-core 9.0.1 → 9.0.2-beta.1

package/src/mock-builders/api/getOrCreateChannel.ts

@@ -1,21 +1,32 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { mockedApiResponse } from './utils';
+import type {
+  ChannelMemberResponse,
+  ChannelResponse,
+  DraftResponse,
+  LocalMessage,
+  MessageResponse,
+  ReadResponse,
+} from 'stream-chat';
+
+import { mockedApiResponse, type MockedApiResponse } from './utils';
+
+// Mock message input is either a `MessageResponse` (server shape) or a
+// `LocalMessage` (client shape — what `generateMessage` produces). The
+// downstream stream-chat client formats these interchangeably.
+type MockMessage = Partial<MessageResponse> | LocalMessage;
 
 export type GetOrCreateChannelApiParams = {
-  draft?: Record<string, any>;
-  channel?: Record<string, any>;
-  members?: Record<string, any>[];
-  messages?: Record<string, any>[];
-  pinnedMessages?: Record<string, any>[];
-  read?: Record<string, any>[];
+  draft?: Partial<DraftResponse>;
+  channel?: Partial<ChannelResponse>;
+  members?: Partial<ChannelMemberResponse>[];
+  messages?: MockMessage[];
+  pinnedMessages?: MockMessage[];
+  read?: Partial<ReadResponse>[];
 };
 
 /**
  * Returns the api response for queryChannel api.
  *
  * api - /channels/{type}/{id}/query
- *
- * @param {*} channel
  */
 export const getOrCreateChannelApi = (
   channel: GetOrCreateChannelApiParams = {
@@ -26,7 +37,7 @@ export const getOrCreateChannelApi = (
     pinnedMessages: [],
     read: [],
   },
-) => {
+): MockedApiResponse => {
   const result = {
     channel: channel.channel,
     draft: channel.draft,

package/src/mock-builders/api/{initiateClientWithChannels.js → initiateClientWithChannels.ts}

@@ -1,3 +1,5 @@
+import type { Channel, StreamChat, UserResponse } from 'stream-chat';
+
 import { getOrCreateChannelApi } from './getOrCreateChannel';
 import { useMockedApis } from './useMockedApis';
 
@@ -6,14 +8,24 @@ import { generateMember } from '../generator/member';
 import { generateUser } from '../generator/user';
 import { getTestClientWithUser } from '../mock';
 
-const initChannelFromData = async ({ channelData, client, defaultGenerateChannelOptions }) => {
+type ChannelData = Parameters<typeof generateChannel>[0];
+
+const initChannelFromData = async ({
+  channelData,
+  client,
+  defaultGenerateChannelOptions,
+}: {
+  channelData: ChannelData;
+  client: StreamChat;
+  defaultGenerateChannelOptions: ChannelData;
+}): Promise<Channel> => {
   const mockedChannelData = generateChannel({
     ...defaultGenerateChannelOptions,
     ...channelData,
   });
 
   useMockedApis(client, [getOrCreateChannelApi(mockedChannelData)]);
-  const channel = client.channel(mockedChannelData.channel.type, mockedChannelData.channel.id);
+  const channel = client.channel(mockedChannelData.type, mockedChannelData.id);
   await channel.watch();
   jest.spyOn(channel, 'getConfig').mockImplementation(() => mockedChannelData.channel.config);
   // jest
@@ -22,7 +34,13 @@ const initChannelFromData = async ({ channelData, client, defaultGenerateChannel
   return channel;
 };
 
-export const initiateClientWithChannels = async ({ channelsData, customUser } = {}) => {
+export const initiateClientWithChannels = async ({
+  channelsData,
+  customUser,
+}: {
+  channelsData?: ChannelData[];
+  customUser?: UserResponse;
+} = {}): Promise<{ channels: Channel[]; client: StreamChat }> => {
   const user = customUser || generateUser();
   const client = await getTestClientWithUser(user);
 

package/src/mock-builders/api/{queryChannels.js → queryChannels.ts}

@@ -1,13 +1,11 @@
-import { mockedApiResponse } from './utils';
+import { mockedApiResponse, type MockedApiResponse } from './utils';
 
 /**
  * Returns the api response for queryChannels api
  *
  * api - /channels
- *
- * @param {*} channels Array of channel objects.
  */
-export const queryChannelsApi = (channels = []) => {
+export const queryChannelsApi = (channels: unknown[] = []): MockedApiResponse => {
   const result = {
     channels,
     duration: 0.01,

package/src/mock-builders/api/{queryMembers.js → queryMembers.ts}

@@ -1,13 +1,14 @@
-import { mockedApiResponse } from './utils';
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelMemberResponse } from 'stream-chat';
+
+import { mockedApiResponse, type MockedApiResponse } from './utils';
 
 /**
  * Returns the api response for queryMembers api
  *
  * api - /query_members
- *
- * @param {*} members Array of User objects.
  */
-export const queryMembersApi = (members = []) => {
+export const queryMembersApi = (members: ChannelMemberResponse[] = []): MockedApiResponse => {
   const result = {
     members,
   };
@@ -15,8 +16,8 @@ export const queryMembersApi = (members = []) => {
   return mockedApiResponse(result, 'get');
 };
 
-export const CHANNEL_MEMBERS = [
-  {
+export const CHANNEL_MEMBERS: ChannelMemberResponse[] = [
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -28,8 +29,8 @@ export const CHANNEL_MEMBERS = [
       name: 'ben',
     },
     user_id: 'ben',
-  },
-  {
+  }),
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -41,8 +42,8 @@ export const CHANNEL_MEMBERS = [
       name: 'nick',
     },
     user_id: 'nick',
-  },
-  {
+  }),
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -54,8 +55,8 @@ export const CHANNEL_MEMBERS = [
       name: 'okechukwu nwagba',
     },
     user_id: 'okechukwu nwagba',
-  },
-  {
+  }),
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-28T09:08:43.274508Z',
@@ -67,9 +68,9 @@ export const CHANNEL_MEMBERS = [
       name: 'qatest1',
     },
     user_id: 'qatest1',
-  },
+  }),
 
-  {
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -81,11 +82,11 @@ export const CHANNEL_MEMBERS = [
       name: 'thierry',
     },
     user_id: 'thierry',
-  },
+  }),
 ];
 
-export const ONE_CHANNEL_MEMBER = [
-  {
+export const ONE_CHANNEL_MEMBER: ChannelMemberResponse[] = [
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -97,20 +98,21 @@ export const ONE_CHANNEL_MEMBER = [
       name: 'okechukwu nwagba martin',
     },
     user_id: 'okechukwu nwagba martin',
-  },
+  }),
 ];
 
-export const ONE_CHANNEL_MEMBER_MOCK = {
+export const ONE_CHANNEL_MEMBER_MOCK: Record<string, ChannelMemberResponse> = {
   okey: ONE_CHANNEL_MEMBER[0],
 };
 
-export const GROUP_CHANNEL_MEMBERS_MOCK = CHANNEL_MEMBERS.reduce((acc, member) => {
-  acc[member.user_id] = member;
-  return acc;
-}, {});
+export const GROUP_CHANNEL_MEMBERS_MOCK: Record<string, ChannelMemberResponse> =
+  CHANNEL_MEMBERS.reduce<Record<string, ChannelMemberResponse>>((acc, member) => {
+    if (member.user_id) acc[member.user_id] = member;
+    return acc;
+  }, {});
 
-export const ONE_MEMBER_WITH_EMPTY_USER = [
-  {
+export const ONE_MEMBER_WITH_EMPTY_USER: ChannelMemberResponse[] = [
+  fromPartial<ChannelMemberResponse>({
     banned: false,
     channel_role: 'channel_member',
     created_at: '2021-01-27T11:54:34.173125Z',
@@ -119,9 +121,9 @@ export const ONE_MEMBER_WITH_EMPTY_USER = [
     updated_at: '2021-02-12T12:12:35.862282Z',
     user: {},
     user_id: 'okechukwu nwagba martin',
-  },
+  }),
 ];
 
-export const ONE_MEMBER_WITH_EMPTY_USER_MOCK = {
+export const ONE_MEMBER_WITH_EMPTY_USER_MOCK: Record<string, ChannelMemberResponse> = {
   okey: ONE_MEMBER_WITH_EMPTY_USER[0],
 };

package/src/mock-builders/api/sendMessage.ts

@@ -0,0 +1,25 @@
+import type { LocalMessage, MessageResponse } from 'stream-chat';
+
+import { mockedApiResponse, type MockedApiResponse } from './utils';
+
+import { generateMessage } from '../generator/message';
+
+/**
+ * Returns the api response for sendMessage api.
+ *
+ * api - /channels/{type}/{id}/message
+ *
+ * Accepts either `MessageResponse` or `LocalMessage`; the mock infra treats
+ * them interchangeably at runtime, even though the real API shape is
+ * `MessageResponse`.
+ */
+export const sendMessageApi = (
+  message: MessageResponse | LocalMessage = generateMessage(),
+): MockedApiResponse => {
+  const result = {
+    duration: 0.01,
+    message,
+  };
+
+  return mockedApiResponse(result, 'post');
+};

package/src/mock-builders/api/sendReaction.ts

@@ -1,14 +1,18 @@
-import { mockedApiResponse } from './utils';
+import type { LocalMessage, MessageResponse, ReactionResponse } from 'stream-chat';
+
+import { mockedApiResponse, type MockedApiResponse } from './utils';
 
 import { generateReaction } from '../generator/reaction';
+
 /**
- * Returns the api response for sendMessage api.
+ * Returns the api response for sendReaction api.
  *
  * api - /messages/{id}/reaction
- *
- * @param {*} message
  */
-export const sendReactionApi = (message, reaction = generateReaction()) => {
+export const sendReactionApi = (
+  message: MessageResponse | LocalMessage,
+  reaction: ReactionResponse = generateReaction(),
+): MockedApiResponse => {
   const result = {
     duration: 0.01,
     message,

package/src/mock-builders/api/threadReplies.ts

@@ -0,0 +1,18 @@
+import type { LocalMessage, MessageResponse } from 'stream-chat';
+
+import { mockedApiResponse, type MockedApiResponse } from './utils';
+
+/**
+ * Returns the api response for thread replies api
+ *
+ * api - /messages/${parent_id}/replies
+ */
+export const threadRepliesApi = (
+  replies: Array<MessageResponse | LocalMessage> = [],
+): MockedApiResponse => {
+  const result = {
+    messages: replies,
+  };
+
+  return mockedApiResponse(result, 'get');
+};

package/src/mock-builders/api/{useMockedApis.js → useMockedApis.ts}

@@ -1,13 +1,14 @@
+import type { StreamChat } from 'stream-chat';
+
+import type { MockedApiResponse } from './utils';
+
 /**
  * Hook to mock the calls made through axios module.
  * You should provide the responses of Apis in order that they will be called.
  * You should use api functions from current directory to build these responses.
  * e.g., queryChannelsApi, sendMessageApi
- *
- * @param {StreamClient} client
- * @param {*} apiResponses
  */
-export const useMockedApis = (client, apiResponses) => {
+export const useMockedApis = (client: StreamChat, apiResponses: MockedApiResponse[]) => {
   apiResponses.forEach(({ response, type }) => {
     jest.spyOn(client.axiosInstance, type).mockImplementation().mockResolvedValue(response);
   });

package/src/mock-builders/api/utils.ts

@@ -0,0 +1,16 @@
+export type MockedApiResponse = {
+  response: { data: unknown; status: number };
+  type: 'get' | 'post' | 'put' | 'delete';
+};
+
+export const mockedApiResponse = (
+  response: unknown,
+  type: MockedApiResponse['type'] = 'get',
+  status = 200,
+): MockedApiResponse => ({
+  response: {
+    data: response,
+    status,
+  },
+  type,
+});

package/src/mock-builders/{attachments.js → attachments.ts}

@@ -1,43 +1,59 @@
+import type { Attachment } from 'stream-chat';
+
 import { generateRandomId } from '../utils/utils';
 
-export const generateLocalAttachmentData = () => ({
+type FileReference = {
+  name: string;
+  size: number;
+  type: string;
+  uri: string;
+};
+
+type LocalAttachmentData = {
+  localMetadata: { id: string };
+};
+
+export const generateLocalAttachmentData = (): LocalAttachmentData => ({
   localMetadata: {
     id: generateRandomId(),
   },
 });
 
-export const generateLocalFileUploadAttachmentData = (overrides, attachmentData) => ({
+export const generateLocalFileUploadAttachmentData = (
+  overrides?: Partial<LocalAttachmentData & { file: Partial<FileReference> }>,
+  attachmentData?: Partial<Attachment>,
+) => ({
   localMetadata: {
     ...generateLocalAttachmentData().localMetadata,
     ...overrides,
     file: generateFileReference(overrides?.file ?? {}),
   },
-  type: 'file',
+  type: 'file' as const,
   ...attachmentData,
 });
 
-export const generateImageAttachment = (a) => ({
+export const generateImageAttachment = (a?: Partial<Attachment>): Attachment => ({
   fallback: generateRandomId() + '.png',
   image_url: 'https://' + generateRandomId() + '.png',
   type: 'image',
   ...a,
 });
 
-export const generateAudioAttachment = (a) => ({
+export const generateAudioAttachment = (a?: Partial<Attachment>): Attachment => ({
   asset_url: 'https://' + generateRandomId() + '.mp3',
   fallback: generateRandomId() + '.mp3',
   type: 'audio',
   ...a,
 });
 
-export const generateFileAttachment = (a) => ({
+export const generateFileAttachment = (a?: Partial<Attachment>): Attachment => ({
   asset_url: 'https://' + generateRandomId() + '.xls',
   fallback: generateRandomId() + '.xls',
   type: 'file',
   ...a,
 });
 
-export const generateVideoAttachment = (a) => ({
+export const generateVideoAttachment = (a?: Partial<Attachment>): Attachment => ({
   fallback: generateRandomId() + '.mp4',
   image_url: 'https://' + generateRandomId() + '.mp4',
   type: 'video',
@@ -46,7 +62,7 @@ export const generateVideoAttachment = (a) => ({
 
 const fileName = generateRandomId() + '.png';
 
-export const generateFileReference = (a) => ({
+export const generateFileReference = (a?: Partial<FileReference>): FileReference => ({
   name: fileName,
   size: 1000,
   type: 'image/png',

package/src/mock-builders/event/channelDeleted.ts

@@ -0,0 +1,12 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, channel: Partial<ChannelResponse> = {}) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      type: 'channel.deleted',
+    }),
+  );
+};

package/src/mock-builders/event/channelHidden.ts

@@ -0,0 +1,12 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, channel: Partial<ChannelResponse> = {}) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      type: 'channel.hidden',
+    }),
+  );
+};

package/src/mock-builders/event/channelTruncated.ts

@@ -0,0 +1,12 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, channel: Partial<ChannelResponse> = {}) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      type: 'channel.truncated',
+    }),
+  );
+};

package/src/mock-builders/event/channelUpdated.ts

@@ -0,0 +1,12 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, channel: Partial<ChannelResponse> = {}) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      type: 'channel.updated',
+    }),
+  );
+};

package/src/mock-builders/event/channelVisible.ts

@@ -0,0 +1,12 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, channel: Partial<ChannelResponse> = {}) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      type: 'channel.visible',
+    }),
+  );
+};

package/src/mock-builders/event/connectionChanged.ts

@@ -0,0 +1,11 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, online = true) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      online,
+      type: 'connection.changed',
+    }),
+  );
+};

package/src/mock-builders/event/connectionRecovered.ts

@@ -0,0 +1,10 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { Event, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      type: 'connection.recovered',
+    }),
+  );
+};

package/src/mock-builders/event/memberAdded.ts

@@ -0,0 +1,19 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelMemberResponse, ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  member: ChannelMemberResponse,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel_id: channel.id,
+      channel_type: channel.type,
+      cid: channel.cid,
+      member,
+      type: 'member.added',
+      user: member.user,
+    }),
+  );
+};

package/src/mock-builders/event/memberRemoved.ts

@@ -0,0 +1,18 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelMemberResponse, ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  member: ChannelMemberResponse,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      member,
+      type: 'member.removed',
+      user: member.user,
+    }),
+  );
+};

package/src/mock-builders/event/memberUpdated.ts

@@ -0,0 +1,18 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelMemberResponse, ChannelResponse, Event, StreamChat } from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  member: ChannelMemberResponse,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      member,
+      type: 'member.updated',
+      user: member.user,
+    }),
+  );
+};

package/src/mock-builders/event/messageDeleted.ts

@@ -0,0 +1,23 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type {
+  ChannelResponse,
+  Event,
+  LocalMessage,
+  MessageResponse,
+  StreamChat,
+} from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  message: MessageResponse | LocalMessage,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      message: message as MessageResponse,
+      type: 'message.deleted',
+    }),
+  );
+};

package/src/mock-builders/event/messageNew.ts

@@ -0,0 +1,26 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type {
+  ChannelResponse,
+  Event,
+  LocalMessage,
+  MessageResponse,
+  StreamChat,
+} from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  newMessage: MessageResponse | LocalMessage,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      channel_id: channel.id,
+      channel_type: channel.type,
+      cid: channel.cid,
+      message: newMessage as MessageResponse,
+      type: 'message.new',
+      ...(newMessage.user ? { user: newMessage.user } : {}),
+    }),
+  );
+};

package/src/mock-builders/event/messageRead.ts

@@ -0,0 +1,23 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelResponse, Event, StreamChat, UserResponse } from 'stream-chat';
+
+export default (
+  client: StreamChat,
+  user: UserResponse,
+  channel: Partial<ChannelResponse> = {},
+  payload: Partial<Event> = {},
+): Event => {
+  const newDate = new Date() as unknown as string;
+  const event = fromPartial<Event>({
+    channel,
+    cid: channel.cid,
+    created_at: newDate,
+    received_at: newDate,
+    type: 'message.read',
+    user,
+    ...payload,
+  });
+  client.dispatchEvent(event);
+
+  return event;
+};