Use reserved keys approach instead

Author: arnautov-anton

src/client.ts

@@ -269,7 +269,6 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   defaultWSTimeoutWithFallback: number;
   defaultWSTimeout: number;
   private nextRequestAbortController: AbortController | null = null;
-  public readonly customPropertyKeys: NonNullable<StreamChatOptions['customPropertyKeys']>;
 
   /**
    * Initialize a client
@@ -363,7 +362,6 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     this.defaultWSTimeout = 15 * 1000;
 
     this.axiosInstance.defaults.paramsSerializer = axiosParamsSerializer;
-    this.customPropertyKeys = options?.customPropertyKeys ?? { thread: [] };
 
     /**
      * logger function should accept 3 parameters:

src/thread.ts

@@ -68,19 +68,42 @@ export type ThreadReadState<SCG extends ExtendableGenerics = DefaultGenerics> =
 const DEFAULT_PAGE_LIMIT = 50;
 const DEFAULT_SORT: { created_at: AscDesc }[] = [{ created_at: -1 }];
 const MARK_AS_READ_THROTTLE_TIMEOUT = 1000;
+const THREAD_RESERVED_KEYS = [
+  'channel',
+  'channel_cid',
+  'created_at',
+  'created_by_user_id',
+  'parent_message_id',
+  'title',
+  'updated_at',
+  'latest_replies',
+  'active_participant_count',
+  'deleted_at',
+  'last_message_at',
+  'participant_count',
+  'reply_count',
+  'read',
+  'thread_participants',
+  'created_by',
+  'parent_message',
+] as const;
 
 // TODO: remove this once we move to API v2
-const constructCustomDataObject = <SCG extends ExtendableGenerics>(
-  customPropertyKeys: (keyof ThreadResponseCustomData)[],
-  threadData: ThreadResponse<SCG>,
-) =>
-  customPropertyKeys.reduce<ThreadResponseCustomData>((custom, key) => {
-    if (threadData[key]) {
-      custom[key] = threadData[key];
+const constructCustomDataObject = <SCG extends ExtendableGenerics>(threadData: ThreadResponse<SCG>) => {
+  const custom: ThreadResponseCustomData = {};
+
+  for (const key in threadData) {
+    if (THREAD_RESERVED_KEYS.includes(key as keyof ThreadResponse<SCG>)) {
+      continue;
     }
 
-    return custom;
-  }, {});
+    const customKey = key as keyof ThreadResponseCustomData;
+
+    custom[customKey] = threadData[customKey];
+  }
+
+  return custom;
+};
 
 export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
   public readonly state: StateStore<ThreadState<SCG>>;
@@ -122,7 +145,7 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
       replyCount: threadData.reply_count ?? 0,
       updatedAt: threadData.updated_at ? new Date(threadData.updated_at) : null,
       title: threadData.title,
-      custom: constructCustomDataObject(client.customPropertyKeys.thread, threadData),
+      custom: constructCustomDataObject<SCG>(threadData),
     });
 
     this.id = threadData.parent_message_id;
@@ -230,7 +253,7 @@ export class Thread<SCG extends ExtendableGenerics = DefaultGenerics> {
         updatedAt: new Date(threadData.updated_at),
         deletedAt: threadData.deleted_at ? new Date(threadData.deleted_at) : null,
         // TODO: use threadData.custom once we move to API v2
-        custom: constructCustomDataObject(this.client.customPropertyKeys.thread, threadData),
+        custom: constructCustomDataObject<SCG>(threadData),
       });
     }).unsubscribe;
   };

src/types.ts

@@ -534,6 +534,7 @@ export interface ThreadResponse<SCG extends ExtendableGenerics = DefaultGenerics
   parent_message_id: string;
   title: string;
   updated_at: string;
+  active_participant_count?: number;
   created_by?: UserResponse<SCG>;
   deleted_at?: string;
   last_message_at?: string;
@@ -1174,17 +1175,6 @@ export type StreamChatOptions = AxiosRequestConfig & {
    */
   baseURL?: string;
   browser?: boolean;
-  /**
-   * To access your custom data from `StateStore` you'll need to declare your custom property names for each feature.
-   * At the moment this is only needed for the Thread class. To get full type support make sure to merge interface
-   * declarations too.
-   */
-  customPropertyKeys?: {
-    /**
-     * Interface declaration for custom object properties: `ThreadResponseCustomData`
-     */
-    thread: (keyof ThreadResponseCustomData)[];
-  };
   device?: BaseDeviceFields;
   enableInsights?: boolean;
   /** experimental feature, please contact support if you want this feature enabled for you */

test/unit/threads.test.ts

@@ -596,34 +596,10 @@ describe('Threads 2.0', () => {
           expect(stateAfter.title).to.eq('B');
         });
 
-        it('ignores custom data when keys are missing from "StreamChat.customPropertyKeys.thread"', () => {
-          const customKey = uuidv4();
-          const thread = createTestThread({ [customKey]: 1 });
-          thread.registerSubscriptions();
-
-          const stateBefore = thread.state.getLatestValue();
-
-          expect(stateBefore.custom).to.not.have.property(customKey);
-
-          client.dispatchEvent({
-            type: 'thread.updated',
-            thread: generateThreadResponse(channelResponse, generateMsg({ id: parentMessageResponse.id }), {
-              [customKey]: 2,
-            }),
-          });
-
-          const stateAfter = thread.state.getLatestValue();
-
-          expect(stateAfter.custom).to.not.have.property(customKey);
-        });
-
-        it('properly handles custom data when keys are defined in "StreamChat.customPropertyKeys.thread"', () => {
+        it('properly handles custom data', () => {
           const customKey1 = uuidv4();
           const customKey2 = uuidv4();
 
-          // @ts-expect-error keys should be declared within `ThreadResponseCustomData` interface through interface merging
-          client.customPropertyKeys.thread = [customKey1, customKey2];
-
           const thread = createTestThread({ [customKey1]: 1, [customKey2]: { key: 1 } });
           thread.registerSubscriptions();