Merge pull request #189 from sendbird/chore/deprecation

chore: add deprecation marks to hooks

Author: bang9

packages/uikit-chat-hooks/src/channel/useGroupChannelList/index.ts

@@ -5,7 +5,7 @@ import { useGroupChannelListWithCollection } from './useGroupChannelListWithColl
 import { useGroupChannelListWithQuery } from './useGroupChannelListWithQuery';
 
 /**
- * @deprecated This hook is deprecated and will be replaced by the 'uikit-tools' package.
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
  * */
 export const useGroupChannelList: UseGroupChannelList = (sdk, userId, options) => {
   if (sdk.isCacheEnabled || options?.enableCollectionWithoutLocalCache) {

packages/uikit-chat-hooks/src/channel/useGroupChannelList/useGroupChannelListWithCollection.ts

@@ -26,6 +26,9 @@ const createGroupChannelListCollection = (
   });
 };
 
+/**
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
+ * */
 export const useGroupChannelListWithCollection: UseGroupChannelList = (sdk, userId, options) => {
   const handlerId = useUniqHandlerId('useGroupChannelListWithCollection');
   const { deliveryReceiptEnabled } = useAppFeatures(sdk);

packages/uikit-chat-hooks/src/channel/useGroupChannelList/useGroupChannelListWithQuery.ts

@@ -23,6 +23,9 @@ const createGroupChannelListQuery = (
   });
 };
 
+/**
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
+ * */
 export const useGroupChannelListWithQuery: UseGroupChannelList = (sdk, userId, options) => {
   const { deliveryReceiptEnabled } = useAppFeatures(sdk);
   const queryRef = useRef<SendbirdGroupChannelListQuery>();

packages/uikit-chat-hooks/src/channel/useGroupChannelMessages/index.ts

@@ -5,7 +5,7 @@ import { useGroupChannelMessagesWithCollection } from './useGroupChannelMessages
 import { useGroupChannelMessagesWithQuery } from './useGroupChannelMessagesWithQuery';
 
 /**
- * @deprecated This hook is deprecated and will be replaced by the 'uikit-tools' package.
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
  * */
 export const useGroupChannelMessages: UseGroupChannelMessages = (sdk, channel, userId, options) => {
   if (sdk.isCacheEnabled || options?.enableCollectionWithoutLocalCache) {

packages/uikit-chat-hooks/src/channel/useGroupChannelMessages/useGroupChannelMessagesWithCollection.ts

@@ -46,6 +46,9 @@ function shouldUseSearchLimit(startingPoint: number) {
   return startingPoint < Date.now();
 }
 
+/**
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
+ * */
 export const useGroupChannelMessagesWithCollection: UseGroupChannelMessages = (sdk, channel, userId, options) => {
   const initialStartingPoint = options?.startingPoint ?? Number.MAX_SAFE_INTEGER;
   const initialLimit = shouldUseSearchLimit(initialStartingPoint) ? MESSAGE_LIMIT.SEARCH : MESSAGE_LIMIT.DEFAULT;

packages/uikit-chat-hooks/src/channel/useGroupChannelMessages/useGroupChannelMessagesWithQuery.ts

@@ -31,6 +31,9 @@ const createMessageQuery = (channel: SendbirdGroupChannel, options?: UseGroupCha
   return channel.createPreviousMessageListQuery(params);
 };
 
+/**
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
+ * */
 export const useGroupChannelMessagesWithQuery: UseGroupChannelMessages = (sdk, channel, userId, options) => {
   const queryRef = useRef<SendbirdPreviousMessageListQuery>();
   const handlerId = useUniqHandlerId('useGroupChannelMessagesWithQuery');

packages/uikit-chat-hooks/src/handler/useChannelHandler.ts

@@ -6,6 +6,9 @@ import type { SendbirdChatSDK } from '@sendbird/uikit-utils';
 
 type ChannelType = 'open' | 'group';
 
+/**
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
+ * */
 export const useChannelHandler = <T extends ChannelType = 'group'>(
   sdk: SendbirdChatSDK,
   handlerId: string,

packages/uikit-chat-hooks/src/types.ts

@@ -33,7 +33,7 @@ export interface CustomBidirectionalQueryInterface<Data> {
 }
 
 /**
- * @deprecated This hook is deprecated and will be replaced by the 'uikit-tools' package.
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
  *
  * @interface UseGroupChannelList
  * @description interface for group channel list hook
@@ -75,7 +75,7 @@ export type UseGroupChannelListOptions = {
 };
 
 /**
- * @deprecated This hook is deprecated and will be replaced by the 'uikit-tools' package.
+ * @deprecated This hook is deprecated and will be replaced by the '@sendbird/uikit-tools' package.
  *
  * @interface UseGroupChannelMessages
  * @description interface for group channel messages hook