fix: change the way interface declaration is consumed

isekovanic · isekovanic · commit bc9a0835fc00 · 2025-03-06T12:19:06.000+01:00
diff --git a/examples/SampleApp/src/custom-types.d.ts b/examples/SampleApp/src/custom-types.d.ts
@@ -1,17 +1,41 @@
-import 'stream-chat';
-import { DefaultAttachmentType, DefaultMessageType } from 'stream-chat-react-native';
+import {
+  DefaultAttachmentType,
+  DefaultMessageType,
+  DefaultChannelType,
+  DefaultCommandType,
+  DefaultEventType,
+  DefaultMemberType,
+  DefaultPollOptionType,
+  DefaultPollType,
+  DefaultReactionType,
+  DefaultThreadType,
+  DefaultUserType,
+} from 'stream-chat-react-native';
 
 declare module 'stream-chat' {
-  // TODO: Check why does this not come automatically ?
-  interface CustomUserData {
-    image?: string;
-  }
-
   interface CustomAttachmentData extends DefaultAttachmentType {
     id?: string;
   }
 
+  interface CustomChannelData extends DefaultChannelType {}
+
+  interface CustomCommandData extends DefaultCommandType {}
+
+  interface CustomEventData extends DefaultEventType {}
+
+  interface CustomMemberData extends DefaultMemberType {}
+
+  interface CustomUserData extends DefaultUserType {}
+
   interface CustomMessageData extends DefaultMessageType {
     ai_generated?: boolean;
   }
+
+  interface CustomPollOptionData extends DefaultPollOptionType {}
+
+  interface CustomPollData extends DefaultPollType {}
+
+  interface CustomReactionData extends DefaultReactionType {}
+
+  interface CustomThreadData extends DefaultThreadType {}
 }
diff --git a/examples/SampleApp/src/screens/ThreadScreen.tsx b/examples/SampleApp/src/screens/ThreadScreen.tsx
@@ -17,7 +17,7 @@ import { ScreenHeader } from '../components/ScreenHeader';
 import type { RouteProp } from '@react-navigation/native';
 
 import type { StackNavigatorParamList } from '../types';
-import { ThreadState } from 'stream-chat';
+import { ThreadState, UserResponse } from 'stream-chat';
 
 const selector = (nextValue: ThreadState) => ({ parentMessage: nextValue.parentMessage }) as const;
 
@@ -39,12 +39,12 @@ export type ThreadHeaderProps = {
 
 const ThreadHeader: React.FC<ThreadHeaderProps> = ({ thread }) => {
   const typing = useTypingString();
-  let subtitleText = (thread as MessageType)?.user?.name;
+  let subtitleText = ((thread as MessageType)?.user as UserResponse)?.name;
   const { parentMessage } =
     useStateStore((thread as ThreadType)?.threadInstance?.state, selector) || {};
 
   if (subtitleText == null) {
-    subtitleText = parentMessage?.user?.name;
+    subtitleText = (parentMessage?.user as UserResponse)?.name;
   }
 
   return (
diff --git a/examples/SampleApp/yarn.lock b/examples/SampleApp/yarn.lock
@@ -989,7 +989,7 @@
     pirates "^4.0.6"
     source-map-support "^0.5.16"
 
-"@babel/runtime@^7.16.3", "@babel/runtime@^7.17.2", "@babel/runtime@^7.25.0", "@babel/runtime@^7.8.4":
+"@babel/runtime@^7.17.2", "@babel/runtime@^7.25.0", "@babel/runtime@^7.8.4":
   version "7.26.9"
   resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.26.9.tgz#aa4c6facc65b9cb3f87d75125ffd47781b475433"
   integrity sha512-aA63XwOkcl4xxQa3HjPMqOP6LiK0ZDv3mUPYEFXkpHbaFjtGggE1A61FjFzJnB+p7/oy2gA8E+rcBNl/zC1tMg==
@@ -2566,14 +2566,6 @@
     "@types/ms" "*"
     "@types/node" "*"
 
-"@types/jsonwebtoken@~9.0.0":
-  version "9.0.8"
-  resolved "https://registry.yarnpkg.com/@types/jsonwebtoken/-/jsonwebtoken-9.0.8.tgz#313490052801edfb031bb32b6bbd77cc9f230852"
-  integrity sha512-7fx54m60nLFUVYlxAB1xpe9CBWX2vSrk50Y6ogRJ1v5xxtba7qXTg5BgYDN5dq+yuQQ9HaVlHJyAAt1/mxryFg==
-  dependencies:
-    "@types/ms" "*"
-    "@types/node" "*"
-
 "@types/ms@*":
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/@types/ms/-/ms-2.1.0.tgz#052aa67a48eccc4309d7f0191b7e41434b90bb78"
@@ -2617,13 +2609,6 @@
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.3.tgz#6209321eb2c1712a7e7466422b8cb1fc0d9dd5d8"
   integrity sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==
 
-"@types/ws@^7.4.0":
-  version "7.4.7"
-  resolved "https://registry.yarnpkg.com/@types/ws/-/ws-7.4.7.tgz#f7c390a36f7a0679aa69de2d501319f4f8d9b702"
-  integrity sha512-JQbbmxZTZehdc2iszGKs5oC3NFnjeay7mtAWrdt7qNtAVK0g19muApzAy4bm9byz79xa2ZnO/BOBC2R8RC5Lww==
-  dependencies:
-    "@types/node" "*"
-
 "@types/ws@^8.5.14":
   version "8.18.0"
   resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.0.tgz#8a2ec491d6f0685ceaab9a9b7ff44146236993b5"
@@ -5239,11 +5224,6 @@ isobject@^3.0.1:
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
   integrity sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==
 
-isomorphic-ws@^4.0.1:
-  version "4.0.1"
-  resolved "https://registry.yarnpkg.com/isomorphic-ws/-/isomorphic-ws-4.0.1.tgz#55fd4cd6c5e6491e76dc125938dd863f5cd4f2dc"
-  integrity sha512-BhBvN2MBpWTaSHdWRb/bwdZJ1WaehQ2L1KngkCkfLUGF0mAWAT1sQUQacEmQ0jXkFw/czDXPNQSL5u2/Krsz1w==
-
 isomorphic-ws@^5.0.0:
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/isomorphic-ws/-/isomorphic-ws-5.0.0.tgz#e5529148912ecb9b451b46ed44d53dae1ce04bbf"
@@ -5788,7 +5768,7 @@ jsonfile@^4.0.0:
   optionalDependencies:
     graceful-fs "^4.1.6"
 
-jsonwebtoken@^9.0.2, jsonwebtoken@~9.0.0:
+jsonwebtoken@^9.0.2:
   version "9.0.2"
   resolved "https://registry.yarnpkg.com/jsonwebtoken/-/jsonwebtoken-9.0.2.tgz#65ff91f4abef1784697d40952bb1998c504caaf3"
   integrity sha512-PRp66vJ865SSqOlgqS8hujT5U4AOgMfhrwYIuIhfKaoSCZcirrmASQr8CX7cUg+RMih+hgznrjp99o+W4pJLHQ==
@@ -7550,25 +7530,6 @@ statuses@~1.5.0:
   resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c"
   integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==
 
-stream-chat-react-native-core@6.6.6:
-  version "6.6.6"
-  resolved "https://registry.yarnpkg.com/stream-chat-react-native-core/-/stream-chat-react-native-core-6.6.6.tgz#d701beb9652f0a5851286f752d8c4fdadb3e0603"
-  integrity sha512-sfBtWz4K4OzhFDMRaPF2xMj7aP9FQU4dMN1XCsmRT07hyYn6iEviECxNttYvoRLB1zNdeja5cL63IDY3UZSpAQ==
-  dependencies:
-    "@gorhom/bottom-sheet" "^5.1.1"
-    dayjs "1.10.5"
-    emoji-regex "^10.3.0"
-    i18next "^21.6.14"
-    intl-pluralrules "^2.0.1"
-    linkifyjs "^4.1.1"
-    lodash-es "4.17.21"
-    mime-types "^2.1.34"
-    path "0.12.7"
-    react-native-markdown-package "1.8.2"
-    react-native-url-polyfill "^1.3.0"
-    stream-chat "^8.57.5"
-    use-sync-external-store "^1.4.0"
-
 "stream-chat-react-native-core@link:../../package":
   version "0.0.0"
   uid ""
@@ -7591,21 +7552,6 @@ stream-chat@9.0.0-rc.4:
     jsonwebtoken "^9.0.2"
     ws "^8.18.1"
 
-stream-chat@^8.57.5:
-  version "8.57.5"
-  resolved "https://registry.yarnpkg.com/stream-chat/-/stream-chat-8.57.5.tgz#1b49b7504371e19a539465e2ae5dc86aa3269637"
-  integrity sha512-ndcbH/zGzUIAhZLGn1owVV8MeNvVfWITIlhAhfmnsV7RLoo/eiGFEuP4aNoG1YRos/g9xJQ7TEmKpz8xYqo13w==
-  dependencies:
-    "@babel/runtime" "^7.16.3"
-    "@types/jsonwebtoken" "~9.0.0"
-    "@types/ws" "^7.4.0"
-    axios "^1.6.0"
-    base64-js "^1.5.1"
-    form-data "^4.0.0"
-    isomorphic-ws "^4.0.1"
-    jsonwebtoken "~9.0.0"
-    ws "^7.5.10"
-
 strict-uri-encode@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/strict-uri-encode/-/strict-uri-encode-2.0.0.tgz#b9c7330c7042862f6b142dc274bbcc5866ce3546"
diff --git a/package/src/types/stream-chat-common-custom-data.d.ts b/package/src/types/stream-chat-common-custom-data.d.ts
@@ -1,28 +1,42 @@
 import 'stream-chat';
-import { Asset, File } from './types';
+import {
+  DefaultAttachmentType,
+  DefaultChannelType,
+  DefaultCommandType,
+  DefaultEventType,
+  DefaultMemberType,
+  DefaultMessageType,
+  DefaultPollOptionType,
+  DefaultPollType,
+  DefaultReactionType,
+  DefaultThreadType,
+  DefaultUserType,
+} from './types';
 
 declare module 'stream-chat' {
-  interface CustomUserData {
-    image?: string;
-  }
-
-  interface CustomChannelData {
-    [key: string]: unknown;
-
-    image?: string;
-  }
-
-  interface CustomAttachmentData {
-    duration?: number;
-    file_size?: number;
-    mime_type?: string;
-    originalFile?: File;
-    originalImage?: Partial<Asset>;
-    waveform_data?: number[];
-  }
-
-  interface CustomCommandData {
-    flag: unknown;
-    imgur: unknown;
-  }
+  /* eslint-disable @typescript-eslint/no-empty-object-type */
+
+  interface CustomAttachmentData extends DefaultAttachmentType {}
+
+  interface CustomChannelData extends DefaultChannelType {}
+
+  interface CustomCommandData extends DefaultCommandType {}
+
+  interface CustomEventData extends DefaultEventType {}
+
+  interface CustomMemberData extends DefaultMemberType {}
+
+  interface CustomUserData extends DefaultUserType {}
+
+  interface CustomMessageData extends DefaultMessageType {}
+
+  interface CustomPollOptionData extends DefaultPollOptionType {}
+
+  interface CustomPollData extends DefaultPollType {}
+
+  interface CustomReactionData extends DefaultReactionType {}
+
+  interface CustomThreadData extends DefaultThreadType {}
+
+  /* eslint-enable @typescript-eslint/no-empty-object-type */
 }
diff --git a/package/src/types/types.ts b/package/src/types/types.ts
@@ -51,17 +51,7 @@ export type FileUpload = {
   url?: string;
   waveform_data?: number[];
 };
-
-export type ImageUpload = {
-  file: Partial<Asset>;
-  id: string;
-  state: FileStateValue;
-  height?: number;
-  url?: string;
-  width?: number;
-};
-
-export interface DefaultAttachmentType extends UnknownType {
+export interface DefaultAttachmentType {
   duration?: number;
   file_size?: number;
   mime_type?: string;
@@ -70,38 +60,46 @@ export interface DefaultAttachmentType extends UnknownType {
   waveform_data?: number[];
 }
 
-export interface DefaultUserType extends UnknownType {
+export interface DefaultUserType {
   image?: string;
 }
 
-export interface DefaultChannelType extends UnknownType {
+export interface DefaultChannelType {
   [key: string]: unknown;
 
   image?: string;
 }
 
-export interface DefaultCommandType extends UnknownType {
+export interface DefaultCommandType {
   flag: unknown;
   imgur: unknown;
 }
 
 /* eslint-disable @typescript-eslint/no-empty-object-type */
 
-export interface DefaultEventType extends UnknownType {}
+export interface DefaultEventType {}
 
-export interface DefaultMemberType extends UnknownType {}
+export interface DefaultMemberType {}
 
-export interface DefaultMessageType extends UnknownType {}
+export interface DefaultMessageType {}
 
-export interface DefaultPollOptionType extends UnknownType {}
+export interface DefaultPollOptionType {}
 
-export interface DefaultPollType extends UnknownType {}
+export interface DefaultPollType {}
 
-export interface DefaultReactionType extends UnknownType {}
+export interface DefaultReactionType {}
 
-export interface DefaultThreadType extends UnknownType {}
+export interface DefaultThreadType {}
 
 /* eslint-enable @typescript-eslint/no-empty-object-type */
+export type ImageUpload = {
+  file: Partial<Asset>;
+  id: string;
+  state: FileStateValue;
+  height?: number;
+  url?: string;
+  width?: number;
+};
 
 export type Reaction = {
   id: string;
