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

package/src/mock-builders/event/messageUpdated.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,
+  newMessage: MessageResponse | LocalMessage,
+  channel: Partial<ChannelResponse> = {},
+) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      channel,
+      cid: channel.cid,
+      message: newMessage as MessageResponse,
+      type: 'message.updated',
+    }),
+  );
+};

package/src/mock-builders/event/notificationAddedToChannel.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: 'notification.added_to_channel',
+    }),
+  );
+};

package/src/mock-builders/event/notificationChannelMutesUpdated.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: 'notification.channel_mutes_updated',
+    }),
+  );
+};

package/src/mock-builders/event/notificationMarkRead.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: 'notification.mark_read',
+    }),
+  );
+};

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

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

package/src/mock-builders/event/notificationMessageNew.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: 'notification.message_new',
+    }),
+  );
+};

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

@@ -0,0 +1,16 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { Event, Mute, StreamChat } from 'stream-chat';
+
+export default (client: StreamChat, mutes: Mute[] = []) => {
+  client.dispatchEvent(
+    fromPartial<Event>({
+      created_at: '2020-05-26T07:11:57.968294216Z',
+      me: {
+        ...client.user,
+        channel_mutes: [],
+        mutes,
+      },
+      type: 'notification.mutes_updated',
+    }),
+  );
+};

package/src/mock-builders/event/notificationRemovedFromChannel.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: 'notification.removed_from_channel',
+    }),
+  );
+};

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,15 +1,16 @@
+import type { Action, Attachment } from 'stream-chat';
 import { v4 as uuidv4 } from 'uuid';
 
 const image_url = 'http://www.jackblack.com/tenac_iousd.bmp';
 
-export const generateAttachmentAction = (a) => ({
+export const generateAttachmentAction = (a?: Partial<Action>): Action => ({
   name: uuidv4(),
   text: uuidv4(),
   value: uuidv4(),
   ...a,
 });
 
-export const generateVideoAttachment = (a) => ({
+export const generateVideoAttachment = (a?: Partial<Attachment>): Attachment => ({
   asset_url: 'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4',
   mime_type: 'video/mp4',
   thumb_url:
@@ -19,15 +20,20 @@ export const generateVideoAttachment = (a) => ({
   ...a,
 });
 
-export const generateImageAttachment = (a) => ({
-  id: uuidv4(),
+export const generateImageAttachment = (a?: Partial<Attachment>): Attachment => ({
   image_url: uuidv4(),
   title: uuidv4(),
   type: 'image',
   ...a,
 });
 
-export const generateImageUploadPreview = (a) => ({
+type UploadPreview = {
+  file: { uri?: string; name?: string; type?: string };
+  id: string;
+  state: string;
+};
+
+export const generateImageUploadPreview = (a?: Partial<UploadPreview>): UploadPreview => ({
   file: {
     uri: image_url,
   },
@@ -36,9 +42,8 @@ export const generateImageUploadPreview = (a) => ({
   ...a,
 });
 
-export const generateAudioAttachment = (a) => ({
+export const generateAudioAttachment = (a?: Partial<Attachment>): Attachment => ({
   asset_url: 'http://www.jackblack.com/tribute.mp3',
-  description: uuidv4(),
   image_url,
   text: uuidv4(),
   title: uuidv4(),
@@ -46,9 +51,8 @@ export const generateAudioAttachment = (a) => ({
   ...a,
 });
 
-export const generateFileAttachment = (a) => ({
+export const generateFileAttachment = (a?: Partial<Attachment>): Attachment => ({
   asset_url: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
-  description: uuidv4(),
   file_size: 1337,
   mime_type: uuidv4(),
   text: uuidv4(),
@@ -57,7 +61,7 @@ export const generateFileAttachment = (a) => ({
   ...a,
 });
 
-export const generateFileUploadPreview = (a) => ({
+export const generateFileUploadPreview = (a?: Partial<UploadPreview>): UploadPreview => ({
   file: {
     name: 'dummy.pdf',
     type: 'file',
@@ -68,7 +72,7 @@ export const generateFileUploadPreview = (a) => ({
   ...a,
 });
 
-export const generateCardAttachment = (a) => ({
+export const generateCardAttachment = (a?: Partial<Attachment>): Attachment => ({
   image_url,
   og_scrape_url: uuidv4(),
   text: uuidv4(),
@@ -78,6 +82,6 @@ export const generateCardAttachment = (a) => ({
   ...a,
 });
 
-export const generateImgurAttachment = () => generateCardAttachment({ type: 'imgur' });
+export const generateImgurAttachment = (): Attachment => generateCardAttachment({ type: 'imgur' });
 
-export const generateGiphyAttachment = () => generateCardAttachment({ type: 'giphy' });
+export const generateGiphyAttachment = (): Attachment => generateCardAttachment({ type: 'giphy' });

package/src/mock-builders/generator/channel.ts

@@ -1,4 +1,10 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+import type {
+  ChannelMemberResponse,
+  ChannelResponse,
+  LocalMessage,
+  MessageResponse,
+  ReadResponse,
+} from 'stream-chat';
 import { v4 as uuidv4 } from 'uuid';
 
 import { generateUser, getUserDefaults } from './user';
@@ -29,8 +35,8 @@ const defaultConfig = {
     {
       args: '[text]',
       description: 'Post a random gif to the channel',
-      name: 'giphy',
-      set: 'fun_set',
+      name: 'giphy' as const,
+      set: 'fun_set' as const,
     },
   ],
   connect_events: true,
@@ -41,6 +47,7 @@ const defaultConfig = {
   name: 'messaging',
   reactions: true,
   read_events: true,
+  reminders: false,
   replies: true,
   search: true,
   typing_events: true,
@@ -54,54 +61,78 @@ const defaultState = {
   setIsUpToDate: jest.fn(),
 };
 
-const getChannelDefaults = (
-  { id, type }: { [key: string]: any } = { id: uuidv4(), type: 'messaging' },
-) => ({
-  _client: {},
-  channel: {
-    cid: `${type}:${id}`,
-    config: {
-      ...defaultConfig,
-      name: type,
+export type GeneratedChannel = {
+  channel: Partial<ChannelResponse> & { config: typeof defaultConfig };
+  cid: string;
+  id: string;
+  messages: Partial<MessageResponse>[];
+  state: typeof defaultState;
+  type: string;
+};
+
+type GeneratedChannelIdType = { id?: string; type?: string };
+
+const getChannelDefaults = (opts: GeneratedChannelIdType = {}): GeneratedChannel => {
+  const id = opts.id ?? uuidv4();
+  const type = opts.type ?? 'messaging';
+  return {
+    channel: {
+      cid: `${type}:${id}`,
+      config: {
+        ...defaultConfig,
+        name: type,
+      },
+      created_at: '2020-04-28T11:20:48.578147Z',
+      created_by: getUserDefaults(),
+      frozen: false,
+      id,
+      own_capabilities: defaultCapabilities,
       type,
+      updated_at: '2020-04-28T11:20:48.578147Z',
     },
-    created_at: '2020-04-28T11:20:48.578147Z',
-    created_by: getUserDefaults(),
-    frozen: false,
+    cid: `${type}:${id}`,
     id,
-    own_capabilities: defaultCapabilities,
+    messages: [],
+    state: defaultState,
     type,
-    updated_at: '2020-04-28T11:20:48.578147Z',
-  },
-  cid: `${type}:${id}`,
-  id,
-  messages: [],
-  state: defaultState,
-  type,
-});
+  };
+};
 
-export const generateChannel = (customValues: { [key: string]: any }) =>
-  Object.keys(customValues).reduce((accumulated, current) => {
+export const generateChannel = (
+  customValues: Partial<GeneratedChannel> & Record<string, unknown> = {},
+): GeneratedChannel =>
+  Object.keys(customValues).reduce<GeneratedChannel>((accumulated, current) => {
+    const key = current as keyof GeneratedChannel;
     if (current in accumulated) {
-      const key = current as keyof typeof accumulated;
-      accumulated[key] =
+      (accumulated as Record<string, unknown>)[current] =
         typeof accumulated[key] === 'object'
-          ? { ...accumulated[key], ...customValues[key] }
-          : (accumulated[key] = customValues[key]);
+          ? { ...(accumulated[key] as object), ...(customValues[current] as object) }
+          : customValues[current];
       return accumulated;
     }
-    return { ...accumulated, [current]: customValues[current] };
+    return { ...accumulated, [current]: customValues[current] } as GeneratedChannel;
   }, getChannelDefaults());
 
+type ChannelResponseMessage = Partial<MessageResponse> | LocalMessage;
+
+export type GeneratedChannelResponseCustomValues = {
+  channel?: Partial<ChannelResponse>;
+  id?: string;
+  messages?: ChannelResponseMessage[];
+  members?: Partial<ChannelMemberResponse>[];
+  read?: Partial<ReadResponse>[];
+  type?: string;
+};
+
 export const generateChannelResponse = (
-  customValues: {
-    channel?: Record<string, any>;
-    id?: string;
-    messages?: Record<string, any>[];
-    members?: Record<string, any>[];
-    read?: Record<string, any>[];
-    type?: string;
-  } = { channel: {}, id: uuidv4(), members: [], messages: [], read: [], type: 'messaging' },
+  customValues: GeneratedChannelResponseCustomValues = {
+    channel: {},
+    id: uuidv4(),
+    members: [],
+    messages: [],
+    read: [],
+    type: 'messaging',
+  },
 ) => {
   const {
     channel = {},

package/src/mock-builders/generator/member.ts

@@ -0,0 +1,18 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ChannelMemberResponse } from 'stream-chat';
+
+import { generateUser } from './user';
+
+export const generateMember = (
+  options: Partial<ChannelMemberResponse> = {},
+): ChannelMemberResponse => {
+  const user = (options && options.user) || generateUser();
+  return fromPartial<ChannelMemberResponse>({
+    invited: false,
+    is_moderator: false,
+    role: 'member',
+    user,
+    user_id: user.id,
+    ...options,
+  });
+};

package/src/mock-builders/generator/message.ts

@@ -0,0 +1,50 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { LocalMessage } from 'stream-chat';
+import { v4 as uuidv4, v5 as uuidv5 } from 'uuid';
+
+import { generateUser } from './user';
+
+type GenerateMessageOptions = Partial<LocalMessage> & { timestamp?: Date };
+
+// Returns a `LocalMessage`-shaped mock. Components across this SDK consume
+// `LocalMessage` (with `Date` objects for `created_at`/`updated_at`/`pinned_at`/
+// `deleted_at`), so the mock matches that shape. For tests that feed mock data
+// into an API response where the server returns `MessageResponse` (strings for
+// dates), cast at the call site — runtime values are the same either way.
+export const generateMessage = (options: GenerateMessageOptions = {}): LocalMessage => {
+  const timestamp =
+    options.timestamp || new Date(new Date().getTime() - Math.floor(Math.random() * 100000));
+
+  return fromPartial<LocalMessage>({
+    attachments: [],
+    created_at: timestamp,
+    deleted_at: null,
+    html: '<p>regular</p>',
+    id: uuidv4(),
+    message_text_updated_at: timestamp.toISOString(),
+    pinned_at: null,
+    status: 'received',
+    text: uuidv4(),
+    type: 'regular',
+    updated_at: timestamp,
+    user: generateUser(),
+    ...options,
+  });
+};
+
+const StreamReactNativeNamespace = '9b244ee4-7d69-4d7b-ae23-cf89e9f7b035';
+export const generateStaticMessage = (
+  seed: string,
+  options?: GenerateMessageOptions,
+  date?: string | Date,
+): LocalMessage => {
+  const staticDate = date ? new Date(date) : new Date('2020-04-27T13:39:49.331742Z');
+  return generateMessage({
+    created_at: staticDate,
+    id: uuidv5(seed, StreamReactNativeNamespace),
+    message_text_updated_at: staticDate.toISOString(),
+    text: seed,
+    updated_at: staticDate,
+    ...options,
+  });
+};

package/src/mock-builders/generator/reaction.ts

@@ -0,0 +1,15 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { ReactionResponse } from 'stream-chat';
+
+import { generateUser } from './user';
+
+export const generateReaction = (options: Partial<ReactionResponse> = {}): ReactionResponse => {
+  const user = options.user || generateUser();
+  return fromPartial<ReactionResponse>({
+    created_at: new Date() as unknown as string,
+    type: 'love',
+    user,
+    user_id: user.id,
+    ...options,
+  });
+};

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

@@ -1,22 +1,26 @@
+import { fromPartial } from '@total-typescript/shoehorn';
+import type { UserResponse } from 'stream-chat';
 import { v4 as uuidv4 } from 'uuid';
 
-export const getUserDefaults = () => ({
-  banned: false,
-  created_at: '2020-04-27T13:39:49.331742Z',
-  id: uuidv4(),
-  image: uuidv4(),
-  name: uuidv4(),
-  online: false,
-  role: 'user',
-  updated_at: '2020-04-27T13:39:49.332087Z',
-});
+export const getUserDefaults = (): UserResponse =>
+  fromPartial<UserResponse>({
+    banned: false,
+    created_at: '2020-04-27T13:39:49.331742Z',
+    id: uuidv4(),
+    image: uuidv4(),
+    name: uuidv4(),
+    online: false,
+    role: 'user',
+    updated_at: '2020-04-27T13:39:49.332087Z',
+  });
 
-export const generateUser = (options = {}) => ({
-  ...getUserDefaults(),
-  ...options,
-});
+export const generateUser = (options: Partial<UserResponse> = {}): UserResponse =>
+  fromPartial<UserResponse>({
+    ...getUserDefaults(),
+    ...options,
+  });
 
-const staticUsers = [
+const staticUsers: UserResponse[] = [
   // By the order of...
   generateUser({
     id: 'tommy',
@@ -40,7 +44,7 @@ const staticUsers = [
   }),
 ];
 
-export const generateStaticUser = (userNumber) => {
+export const generateStaticUser = (userNumber: number): UserResponse => {
   if (userNumber - 1 > staticUsers.length) {
     throw new Error(`Tried getting a static user that doesn't exist.
 Index: ${userNumber} , number of users: ${staticUsers.length}`);