@sendbird/uikit-utils 2.4.1 → 2.5.0-rc.0

package/lib/typescript/src/index.d.ts

@@ -21,11 +21,12 @@ export declare const isFunction: (param?: unknown) => param is Function;
 export declare function ifThenOr<T>(cond: boolean, then: T): T | undefined;
 export declare function ifThenOr<T, V>(cond: boolean, then: T, or: V): T | V;
 export declare const SBErrorCode: {
-    NON_AUTHORIZED: number;
-    CHANNEL_NOT_FOUND_SERVER: number;
-    CHANNEL_NOT_FOUND_SDK: number;
+    UNAUTHORIZED_REQUEST: number;
+    RESOURCE_NOT_FOUND: number;
+    BANNED_USER_SEND_MESSAGE_NOT_ALLOWED: number;
+    CHANNEL_NOT_FOUND: number;
 };
 export declare const SBErrorMessage: {
     ACL: string;
 };
-export type { UserStruct, FilterByValueType, UnionToIntersection, OmittedValues, PartialDeep, Optional, ContextValue, OnBeforeHandler, SendbirdMessage, SendbirdChatSDK, SendbirdChannel, SendbirdBaseChannel, SendbirdGroupChannel, SendbirdOpenChannel, SendbirdUser, SendbirdMember, SendbirdBaseMessage, SendbirdUserMessage, SendbirdFileMessage, SendbirdAdminMessage, SendbirdGroupChannelCreateParams, SendbirdFileMessageCreateParams, SendbirdUserMessageCreateParams, SendbirdError, SendbirdMessageCollection, SendbirdGroupChannelCollection, NotificationFiles, NotificationMentionedUsers, NotificationTranslations, PartialNullable, SendbirdDataPayload, SendbirdPreviousMessageListQuery, SendbirdSendableMessage, SendbirdOpenChannelListQuery, SendbirdGroupChannelListQuery, SendbirdGroupChannelUpdateParams, SendbirdUserMessageUpdateParams, SendbirdFileMessageUpdateParams, SendbirdUserUpdateParams, SendbirdRestrictedUser, SendbirdReaction, SendbirdEmojiContainer, SendbirdEmoji, SendbirdEmojiCategory, SendbirdOpenChannelUpdateParams, SendbirdOpenChannelCreateParams, SendbirdParticipant, } from './types';
+export * from './types';

package/lib/typescript/src/sendbird/message.d.ts

@@ -1,4 +1,5 @@
-import type { SendbirdBaseChannel, SendbirdBaseMessage, SendbirdDataPayload, SendbirdFileMessage, SendbirdMessage, SendbirdReaction, SendbirdSendableMessage } from '../types';
+import { MessageSearchOrder } from '@sendbird/chat/message';
+import type { SendbirdBaseChannel, SendbirdBaseMessage, SendbirdDataPayload, SendbirdFileMessage, SendbirdGroupChannel, SendbirdMessage, SendbirdReaction, SendbirdSendableMessage } from '../types';
 export declare function isNewMessage(msg: SendbirdMessage, currentUserId?: string): boolean;
 export declare function isSendableMessage(msg?: SendbirdMessage | null): msg is SendbirdSendableMessage;
 export declare function isMyMessage(msg?: SendbirdMessage | null, currentUserId?: string): boolean;
@@ -23,4 +24,10 @@ export declare function getReactionCount(reaction: SendbirdReaction): number;
 type MessageType = 'user' | 'admin' | 'file' | 'unknown' | `user.${'opengraph'}` | `file.${'image' | 'video' | 'audio'}`;
 export declare function getFileTypeFromMessage(message: SendbirdFileMessage): "video" | "audio" | "image" | "file";
 export declare function getMessageType(message: SendbirdMessage): MessageType;
+export declare function getDefaultMessageSearchQueryParams(channel: SendbirdGroupChannel, keyword: string): {
+    keyword: string;
+    channelUrl: string;
+    messageTimestampFrom: number;
+    order: MessageSearchOrder;
+};
 export {};

package/lib/typescript/src/types.d.ts

@@ -3,7 +3,7 @@ import type SendbirdChat from '@sendbird/chat';
 import type { BaseChannel, Emoji, EmojiCategory, EmojiContainer, Participant, RestrictedUser, SendbirdError as SBError, User, UserUpdateParams } from '@sendbird/chat';
 import type { GroupChannel, GroupChannelCollection, GroupChannelCreateParams, GroupChannelListQuery, GroupChannelModule, GroupChannelUpdateParams, Member, MessageCollection } from '@sendbird/chat/groupChannel';
 import type { ModuleNamespaces, OpenChannelCreateParams, OpenChannelUpdateParams, SendableMessage } from '@sendbird/chat/lib/__definition';
-import type { AdminMessage, BaseMessage, FileMessage, FileMessageCreateParams, FileMessageUpdateParams, PreviousMessageListQuery, Reaction, UserMessage, UserMessageCreateParams, UserMessageUpdateParams } from '@sendbird/chat/message';
+import type { AdminMessage, BaseMessage, FileMessage, FileMessageCreateParams, FileMessageUpdateParams, MessageSearchQuery, PreviousMessageListQuery, Reaction, UserMessage, UserMessageCreateParams, UserMessageUpdateParams } from '@sendbird/chat/message';
 import type { OpenChannel, OpenChannelListQuery, OpenChannelModule } from '@sendbird/chat/openChannel';
 export type FilterByValueType<T extends object, Type> = {
     [K in keyof T as T[K] extends Type ? K : never]: T[K];
@@ -55,6 +55,7 @@ export type SendbirdGroupChannelListQuery = GroupChannelListQuery;
 export type SendbirdOpenChannelListQuery = OpenChannelListQuery;
 export type SendbirdMessageCollection = MessageCollection;
 export type SendbirdPreviousMessageListQuery = PreviousMessageListQuery;
+export type SendbirdMessageSearchQuery = MessageSearchQuery;
 export type SendbirdError = SBError;
 export interface SendbirdDataPayload {
     app_id: string;

package/lib/typescript/src/ui-format/common.d.ts

@@ -1,4 +1,5 @@
 import type { Locale } from 'date-fns';
+import type { SendbirdBaseMessage } from '../types';
 type TruncateMode = 'head' | 'mid' | 'tail';
 type TruncateOption = {
     mode: TruncateMode;
@@ -41,4 +42,16 @@ export declare const getDateSeparatorFormat: (date: Date, locale?: Locale) => st
  * @returns {string}
  * */
 export declare const getMessageTimeFormat: (date: Date, locale?: Locale) => string;
+/**
+ * Message preview title text
+ * */
+export declare const getMessagePreviewTitle: (message: SendbirdBaseMessage, EMPTY_USERNAME?: string) => string;
+/**
+ * Message preview body text
+ * */
+export declare const getMessagePreviewBody: (message: SendbirdBaseMessage, EMPTY_MESSAGE?: string) => string;
+/**
+ * Message preview time format
+ * */
+export declare const getMessagePreviewTime: (timestamp: number, locale?: Locale) => string;
 export {};

package/lib/typescript/src/ui-format/groupChannel.d.ts

@@ -2,4 +2,4 @@ import type { Locale } from 'date-fns';
 import type { SendbirdGroupChannel } from '../types';
 export declare const getGroupChannelTitle: (currentUserId: string, channel: SendbirdGroupChannel, EMPTY_USERNAME?: string, NO_MEMBERS?: string, DEFAULT_CHANNEL_NAME?: string) => string;
 export declare const getGroupChannelPreviewTime: (channel: SendbirdGroupChannel, locale?: Locale) => string;
-export declare const getGroupChannelLastMessage: (channel: SendbirdGroupChannel, EMPTY_MESSAGE?: string, MAX_LEN?: number) => string;
+export declare const getGroupChannelLastMessage: (channel: SendbirdGroupChannel, EMPTY_MESSAGE?: string) => string;

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@sendbird/uikit-utils",
-  "version": "2.4.1",
-  "description": "UIKit utilities",
+  "version": "2.5.0-rc.0",
+  "description": "A collection of utility functions and constants for building chat UI components with Sendbird UIKit.",
+  "keywords": [
+    "sendbird",
+    "uikit",
+    "chat",
+    "UI components",
+    "utility functions",
+    "constants"
+  ],
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
   "types": "lib/typescript/src/index.d.ts",
@@ -18,10 +26,6 @@
     "build": "bob build",
     "clean": "del lib"
   },
-  "keywords": [
-    "react",
-    "sendbird"
-  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/sendbird/sendbird-uikit-react-native.git",
@@ -76,6 +80,5 @@
     "entryPoint": "./src/index.ts",
     "readmeFile": "./README.md",
     "displayName": "@sendbird/uikit-utils"
-  },
-  "gitHead": "9ba7a005c941a3edd5b0f78d88d8cd1df6c280fc"
+  }
 }

package/src/hooks/index.ts

@@ -102,3 +102,13 @@ export const useDebounceEffect = (action: () => void, delay: number, deps: Depen
 export const usePartialState = <S>(initialState: S) => {
   return useReducer((prev: S, state: Partial<S>) => ({ ...prev, ...state }), initialState);
 };
+
+export const useRefTracker = <T>(target: T) => {
+  const ref = useRef(target);
+
+  useLayoutEffect(() => {
+    ref.current = target;
+  });
+
+  return ref;
+};

package/src/index.ts

@@ -29,9 +29,10 @@ export function ifThenOr(cond: boolean, then: unknown, or?: unknown) {
 }
 
 export const SBErrorCode = {
-  NON_AUTHORIZED: 400108,
-  CHANNEL_NOT_FOUND_SERVER: 400201,
-  CHANNEL_NOT_FOUND_SDK: 900500,
+  UNAUTHORIZED_REQUEST: 400108,
+  RESOURCE_NOT_FOUND: 400201,
+  BANNED_USER_SEND_MESSAGE_NOT_ALLOWED: 900100,
+  CHANNEL_NOT_FOUND: 900500,
 };
 export const SBErrorMessage = {
   ACL:
@@ -41,52 +42,4 @@ export const SBErrorMessage = {
     'To manage your access control settings, you can turn on or off each setting on Sendbird Dashboard.',
 };
 
-export type {
-  UserStruct,
-  FilterByValueType,
-  UnionToIntersection,
-  OmittedValues,
-  PartialDeep,
-  Optional,
-  ContextValue,
-  OnBeforeHandler,
-  SendbirdMessage,
-  SendbirdChatSDK,
-  SendbirdChannel,
-  SendbirdBaseChannel,
-  SendbirdGroupChannel,
-  SendbirdOpenChannel,
-  SendbirdUser,
-  SendbirdMember,
-  SendbirdBaseMessage,
-  SendbirdUserMessage,
-  SendbirdFileMessage,
-  SendbirdAdminMessage,
-  SendbirdGroupChannelCreateParams,
-  SendbirdFileMessageCreateParams,
-  SendbirdUserMessageCreateParams,
-  SendbirdError,
-  SendbirdMessageCollection,
-  SendbirdGroupChannelCollection,
-  NotificationFiles,
-  NotificationMentionedUsers,
-  NotificationTranslations,
-  PartialNullable,
-  SendbirdDataPayload,
-  SendbirdPreviousMessageListQuery,
-  SendbirdSendableMessage,
-  SendbirdOpenChannelListQuery,
-  SendbirdGroupChannelListQuery,
-  SendbirdGroupChannelUpdateParams,
-  SendbirdUserMessageUpdateParams,
-  SendbirdFileMessageUpdateParams,
-  SendbirdUserUpdateParams,
-  SendbirdRestrictedUser,
-  SendbirdReaction,
-  SendbirdEmojiContainer,
-  SendbirdEmoji,
-  SendbirdEmojiCategory,
-  SendbirdOpenChannelUpdateParams,
-  SendbirdOpenChannelCreateParams,
-  SendbirdParticipant,
-} from './types';
+export * from './types';

package/src/sendbird/message.ts

@@ -1,9 +1,12 @@
+import { MessageSearchOrder } from '@sendbird/chat/message';
+
 import { getFileExtension, getFileType } from '../shared/file';
 import type {
   SendbirdBaseChannel,
   SendbirdBaseMessage,
   SendbirdDataPayload,
   SendbirdFileMessage,
+  SendbirdGroupChannel,
   SendbirdMessage,
   SendbirdReaction,
   SendbirdSendableMessage,
@@ -173,3 +176,12 @@ export function getMessageType(message: SendbirdMessage): MessageType {
 
   return 'unknown';
 }
+
+export function getDefaultMessageSearchQueryParams(channel: SendbirdGroupChannel, keyword: string) {
+  return {
+    keyword,
+    channelUrl: channel.url,
+    messageTimestampFrom: Math.max(channel.joinedAt, channel.invitedAt),
+    order: MessageSearchOrder.TIMESTAMP,
+  };
+}

package/src/types.ts

@@ -37,6 +37,7 @@ import type {
   FileMessage,
   FileMessageCreateParams,
   FileMessageUpdateParams,
+  MessageSearchQuery,
   PreviousMessageListQuery,
   Reaction,
   UserMessage,
@@ -115,6 +116,7 @@ export type SendbirdGroupChannelListQuery = GroupChannelListQuery;
 export type SendbirdOpenChannelListQuery = OpenChannelListQuery;
 export type SendbirdMessageCollection = MessageCollection;
 export type SendbirdPreviousMessageListQuery = PreviousMessageListQuery;
+export type SendbirdMessageSearchQuery = MessageSearchQuery;
 
 export type SendbirdError = SBError;
 

package/src/ui-format/common.ts

@@ -1,5 +1,7 @@
 import type { Locale } from 'date-fns';
-import { format, isThisYear } from 'date-fns';
+import { format, isThisYear, isToday, isYesterday } from 'date-fns';
+
+import type { SendbirdBaseMessage } from '../types';
 
 type TruncateMode = 'head' | 'mid' | 'tail';
 type TruncateOption = { mode: TruncateMode; maxLen: number; separator: string };
@@ -73,3 +75,53 @@ export const getDateSeparatorFormat = (date: Date, locale?: Locale): string => {
 export const getMessageTimeFormat = (date: Date, locale?: Locale): string => {
   return format(date, 'p', { locale });
 };
+
+/**
+ * Message preview title text
+ * */
+export const getMessagePreviewTitle = (message: SendbirdBaseMessage, EMPTY_USERNAME = '(No name)') => {
+  if (message.isFileMessage() || message.isUserMessage()) {
+    return message.sender.nickname || EMPTY_USERNAME;
+  }
+  if (message.isAdminMessage()) {
+    return 'Admin';
+  }
+  return EMPTY_USERNAME;
+};
+
+/**
+ * Message preview body text
+ * */
+export const getMessagePreviewBody = (message: SendbirdBaseMessage, EMPTY_MESSAGE = '') => {
+  if (message.isFileMessage()) {
+    const extIdx = message.name.lastIndexOf('.');
+    if (extIdx > -1) {
+      const file = message.name.slice(0, extIdx);
+      const ext = message.name.slice(extIdx);
+      return file + ext;
+    }
+
+    return message.name;
+  }
+
+  if (message.isUserMessage()) {
+    return message.message ?? EMPTY_MESSAGE;
+  }
+
+  if (message.isAdminMessage()) {
+    return message.message ?? EMPTY_MESSAGE;
+  }
+
+  return EMPTY_MESSAGE;
+};
+
+/**
+ * Message preview time format
+ * */
+export const getMessagePreviewTime = (timestamp: number, locale?: Locale) => {
+  if (isToday(timestamp)) return format(timestamp, 'p', { locale });
+  if (isYesterday(timestamp)) return 'Yesterday';
+  if (isThisYear(timestamp)) return format(timestamp, 'MMM dd', { locale });
+
+  return format(timestamp, 'yyyy/MM/dd', { locale });
+};

package/src/ui-format/groupChannel.ts

@@ -1,8 +1,7 @@
 import type { Locale } from 'date-fns';
-import { format, isThisYear, isToday, isYesterday } from 'date-fns';
 
 import type { SendbirdGroupChannel } from '../types';
-import { truncate } from './common';
+import { getMessagePreviewBody, getMessagePreviewTime } from './common';
 
 export const getGroupChannelTitle = (
   currentUserId: string,
@@ -20,37 +19,12 @@ export const getGroupChannelTitle = (
 };
 
 export const getGroupChannelPreviewTime = (channel: SendbirdGroupChannel, locale?: Locale) => {
-  const timestamp = channel.lastMessage?.createdAt || channel.joinedAt * 1000 || channel.createdAt;
-
-  if (isToday(timestamp)) return format(timestamp, 'p', { locale });
-  if (isYesterday(timestamp)) return 'Yesterday';
-  if (isThisYear(timestamp)) return format(timestamp, 'MMM dd', { locale });
-
-  return format(timestamp, 'yyyy/MM/dd', { locale });
+  return getMessagePreviewTime(channel.lastMessage?.createdAt || channel.joinedAt * 1000 || channel.createdAt, locale);
 };
 
-export const getGroupChannelLastMessage = (channel: SendbirdGroupChannel, EMPTY_MESSAGE = '', MAX_LEN = 15) => {
+export const getGroupChannelLastMessage = (channel: SendbirdGroupChannel, EMPTY_MESSAGE = '') => {
   const message = channel.lastMessage;
   if (!message) return EMPTY_MESSAGE;
 
-  if (message.isFileMessage()) {
-    const extIdx = message.name.lastIndexOf('.');
-    if (extIdx > -1) {
-      const file = message.name.slice(0, extIdx);
-      const ext = message.name.slice(extIdx);
-      return truncate(file, { maxLen: MAX_LEN }) + ext;
-    }
-
-    return truncate(message.name, { maxLen: MAX_LEN });
-  }
-
-  if (message.isUserMessage()) {
-    return message.message ?? EMPTY_MESSAGE;
-  }
-
-  if (message.isAdminMessage()) {
-    return message.message ?? EMPTY_MESSAGE;
-  }
-
-  return EMPTY_MESSAGE;
+  return getMessagePreviewBody(message, EMPTY_MESSAGE);
 };