Merge branch 'master' into vishal/thread_participants_type

Author: vishalnarkhede

src/client.ts

@@ -1976,6 +1976,59 @@ export class StreamChat<
     });
   }
 
+  /**
+   * pinMessage - pins provided message
+   * @param {UpdatedMessage<AttachmentType,ChannelType,CommandType,MessageType,ReactionType,UserType>} message object
+   * @param {undefined|number|string|Date} timeoutOrExpirationDate expiration date or timeout. Use number type to set timeout in seconds, string or Date to set exact expiration date
+   */
+  pinMessage(
+    message: UpdatedMessage<
+      AttachmentType,
+      ChannelType,
+      CommandType,
+      MessageType,
+      ReactionType,
+      UserType
+    >,
+    timeoutOrExpirationDate?: number | string | Date,
+  ) {
+    let pinExpires;
+    if (typeof timeoutOrExpirationDate === 'number') {
+      const now = new Date();
+      now.setSeconds(now.getSeconds() + timeoutOrExpirationDate);
+      pinExpires = now.toISOString();
+    } else if (isString(timeoutOrExpirationDate)) {
+      pinExpires = timeoutOrExpirationDate;
+    } else if (timeoutOrExpirationDate instanceof Date) {
+      pinExpires = timeoutOrExpirationDate.toISOString();
+    }
+    return this.updateMessage({
+      ...message,
+      pinned: true,
+      pin_expires: pinExpires,
+    });
+  }
+
+  /**
+   * unpinMessage - unpins provided message
+   * @param {UpdatedMessage<AttachmentType,ChannelType,CommandType,MessageType,ReactionType,UserType>} message object
+   */
+  unpinMessage(
+    message: UpdatedMessage<
+      AttachmentType,
+      ChannelType,
+      CommandType,
+      MessageType,
+      ReactionType,
+      UserType
+    >,
+  ) {
+    return this.updateMessage({
+      ...message,
+      pinned: false,
+    });
+  }
+
   /**
    * updateMessage - Update the given message
    *

src/types.ts

@@ -1484,10 +1484,14 @@ export type MessageBase<
   UserType = UnknownType
 > = MessageType & {
   id: string;
+  pinned: boolean;
   attachments?: Attachment<AttachmentType>[];
   html?: string;
   mml?: string;
   parent_id?: string;
+  pin_expires?: string;
+  pinned_at?: string;
+  pinned_by?: UserResponse<UserType> | null;
   quoted_message_id?: string;
   show_in_channel?: boolean;
   text?: string;