@amityco/ts-sdk 6.17.3 → 6.18.0

package/src/@types/core/payload.ts

@@ -18,6 +18,7 @@ declare global {
       poll: Amity.PollPayload;
       stream: Amity.StreamPayload;
       story: Amity.StoryPayload;
+      globalStoryFeed: Amity.GlobalStoryFeedPayload;
       reaction: Amity.ReactionPayload;
     };
 
@@ -63,7 +64,10 @@ declare global {
 
     type UserMarkerResponse = Omit<Amity.UserMarker, 'hasMentioned'> & Amity.IsMentioned;
     type UserEntityMarkerResponse = Omit<Amity.ChannelMarker, 'hasMentioned'> & Amity.IsMentioned;
-    type UserFeedMarkerResponse = Omit<Amity.SubChannelMarker, 'hasMentioned'> & Amity.IsMentioned;
+    type UserFeedMarkerResponse = Omit<Amity.SubChannelMarker, 'hasMentioned'> & {
+      oldUnreadCount: number;
+      lastMentionSegment: number;
+    } & Amity.IsMentioned;
 
     type UserMarkerPayload = {
       userMarkers: UserMarkerResponse[];
@@ -75,11 +79,17 @@ declare global {
     };
 
     type SubChannelMarkerPayload = {
+      feedMarkers: Amity.FeedMarker[];
       userFeedMarkers: UserFeedMarkerResponse[];
       userEntityMarkers: UserEntityMarkerResponse[];
       userMarkers: UserMarkerResponse[];
     };
 
+    type UserMessageFeedMarkerPayload = {
+      feedMarkers: Amity.FeedMarker[];
+      userFeedMarkers: UserFeedMarkerResponse[];
+    };
+
     type MessageMarkerPayload = {
       contentMarkers: Amity.MessageMarker[];
       feedMarkers: Amity.FeedMarker[];
@@ -165,6 +175,11 @@ declare global {
       userFeedMarkers: UserFeedMarkerResponse[];
     };
 
+    type UserFeedUpdatedPayload = {
+      feedMarkers: Amity.FeedMarker[];
+      userFeedMarkers: Amity.UserFeedMarkerResponse[];
+    };
+
     type SubChannelPayload<T extends Amity.MessageContentType = any> = {
       messageFeeds: Amity.RawSubChannel[];
       messages: Amity.RawMessage<T>[];
@@ -179,7 +194,7 @@ declare global {
      */
     type ProcessedSubChannelPayload<T extends Amity.MessageContentType = any> = {
       messageFeeds: Amity.SubChannel[];
-      messages: Amity.Message<T>[];
+      messages: Amity.InternalMessage<T>[];
       users: Amity.InternalUser[];
       files: Amity.File[];
     };
@@ -209,7 +224,7 @@ declare global {
      * - messages: `Amity.RawMessage` -> `Amity.Message` (Model Restructuring)
      */
     type ProcessedMessagePayload<T extends Amity.MessageContentType = any> = {
-      messages: Amity.Message<T>[];
+      messages: Amity.InternalMessage<T>[];
       users: Amity.InternalUser[];
       files: Amity.File[];
       reactions: Amity.Reactor[];
@@ -301,6 +316,9 @@ declare global {
       storyTargets: Amity.RawStoryTarget[];
     };
 
+    type GlobalStoryFeedPayload = Omit<Amity.StoryBasePayload, 'comments'> &
+      Amity.StoryTargetPayload;
+
     // Original Payload form BE
     type StoryPayload = {
       stories: Amity.RawStory[];
@@ -311,6 +329,11 @@ declare global {
       stories: Amity.InternalStory[];
     } & Amity.StoryBasePayload;
 
+    // Payload with Reaction
+    type StoryReactionPayload = {
+      reactions: Amity.Reactor[];
+    } & Amity.StoryPayload;
+
     /**
      * Items that extend from `Amity.PostPayload`
      * - communities: `Amity.RawCommunity` -> `Amity.Community` (Added Marker Service related props)

package/src/@types/core/readReceipt.ts

@@ -0,0 +1,23 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum ReadReceiptSyncState {
+      CREATED = 'create',
+      SYNCING = 'syncing',
+    }
+
+    type ReadReceipt = {
+      subChannelId: Amity.SubChannel['subChannelId'];
+      latestSegment: number;
+      latestSyncSegment: number;
+    };
+
+    type ReadReceiptSyncJob = {
+      subChannelId: Amity.SubChannel['subChannelId'];
+      segment: number;
+      syncState: ReadReceiptSyncState;
+      retryCount: number;
+    };
+  }
+}

package/src/@types/domains/channel.ts

@@ -71,12 +71,14 @@ declare global {
       isUnreadCountSupport: boolean;
       unreadCount: number;
       hasMentioned: boolean;
+      isMentioned: boolean;
+      subChannelsUnreadCount: number;
     };
 
     /* public type */
     type Channel<T extends ChannelType = any> = Omit<
       InternalChannel<T>,
-      'messagePreview' | 'messageCount'
+      'messagePreview' | 'messageCount' | 'unreadCount' | 'hasMentioned'
     > & {
       messagePreview?: Amity.MessagePreview | null;
 
@@ -84,6 +86,14 @@ declare global {
        * @deprecated Please use the default sub channel `messageCount` instead.
        */
       messageCount: RawChannel['messageCount'];
+      /**
+       * @deprecated Please use `subChannelsUnreadCount` instead.
+       */
+      unreadCount: number;
+      /**
+       * @deprecated Please use `isMentioned` instead.
+       */
+      hasMentioned: boolean;
     };
 
     type QueryChannels = {

package/src/@types/domains/client.ts

@@ -41,6 +41,8 @@ declare global {
       emitter: Emitter<Amity.Events>;
 
       hasPermission: (permission: string) => Amity.PermissionChecker;
+      validateUrls: (urls: string[]) => Promise<boolean>;
+      validateTexts: (texts: string[]) => Promise<boolean>;
 
       sessionState: Amity.SessionStates;
       sessionHandler?: Amity.SessionHandler;
@@ -52,17 +54,17 @@ declare global {
 
       token?: Omit<Amity.Tokens, 'refreshToken'>;
 
+      isUnreadCountEnabled: boolean;
+
       use: () => void;
 
-      accessTokenExpiryWatcher: (
-        expiresAt: Amity.Tokens['expiresAt'],
-        issuedAt: Amity.Tokens['issuedAt'],
-        sessionHandler: Amity.SessionHandler,
-      ) => Amity.Unsubscriber;
+      accessTokenExpiryWatcher: (sessionHandler: Amity.SessionHandler) => Amity.Unsubscriber;
 
       getFeedSettings: () => Promise<Amity.FeedSettings>;
       getSocialSettings: () => Promise<Amity.SocialSettings>;
       getMessagePreviewSetting: (refresh?: boolean) => Promise<Amity.MessagePreviewSetting>;
+
+      getMarkerSyncConsistentMode: () => boolean;
     };
 
     type Device = {
@@ -134,6 +136,12 @@ declare global {
 
     type ActiveUser = Pick<Amity.InternalUser, '_id' | 'userId' | 'path' | 'displayName'>;
 
-    type UserUnread = Pick<Amity.UserMarker, 'unreadCount' | 'hasMentioned'>;
+    type UserUnread = Pick<Amity.UserMarker, 'unreadCount'> & {
+      /**
+       * @deprecated use `isMentioned` instead
+       */
+      hasMentioned: boolean;
+      isMentioned: boolean;
+    };
   }
 }

package/src/@types/domains/community.ts

@@ -61,6 +61,8 @@ declare global {
 
       hasFlaggedComment: boolean;
       hasFlaggedPost: boolean;
+
+      allowCommentInStory?: boolean;
     } & Amity.Taggable &
       Amity.Metadata &
       Amity.Timestamps &
@@ -70,9 +72,6 @@ declare global {
     type Community = Omit<Amity.RawCommunity, 'onlyAdminCanPost' | 'needApprovalOnPostCreation'> &
       Amity.CommunityStorySettings & {
         postSetting?: ValueOf<typeof CommunityPostSettings>;
-        storySetting?: {
-          enableComment: boolean;
-        };
       };
 
     type QueryCommunities = {

package/src/@types/domains/group.ts

@@ -13,14 +13,14 @@ declare global {
     } & (T extends 'channel'
       ? {
           channelId: Amity.Channel['channelId'];
-          membership: 'member' | 'none' | 'banned';
+          membership: 'member' | 'none' | 'banned' | 'muted';
           readToSegment: number;
           lastMentionedSegment: number;
         }
       : T extends 'community'
       ? {
           communityId: Amity.Community['communityId'];
-          communityMembership: 'member' | 'none' | 'banned';
+          communityMembership: 'member' | 'none' | 'banned' | 'muted';
         }
       : never) &
       Amity.Timestamps;

package/src/@types/domains/marker.ts

@@ -16,5 +16,22 @@ declare global {
       FORCE_SYNC = 'force sync',
       MARKER_UPDATED = 'feed marker updated',
     }
+
+    type ChannelUnreadInfo = {
+      channelId: Amity.RawChannel['channelId'];
+      unreadCount: number;
+      isMentioned: boolean;
+    } & Amity.Timestamps;
+
+    type SubChannelUnreadInfo = {
+      subChannelId: Amity.RawSubChannel['messageFeedId'];
+      channelId: Amity.RawChannel['channelId'];
+      readToSegment: number;
+      lastSegment: number;
+      lastMentionSegment: number;
+      unreadCount: number;
+      isMentioned: boolean;
+      isDeleted: boolean;
+    } & Amity.Timestamps;
   }
 }

package/src/@types/domains/message.ts

@@ -65,6 +65,7 @@ declare global {
       readCount: number;
       deliveredCount: number;
       referenceId?: string;
+      markRead: () => void;
     } & Amity.Content<T> &
       Amity.Flaggable &
       Amity.Mentionable<'user' | 'channel'> &
@@ -75,6 +76,11 @@ declare global {
       Amity.Timestamps &
       Amity.Taggable;
 
+    type InternalMessage<T extends Amity.MessageContentType = any> = Omit<
+      Amity.Message<T>,
+      'readCount' | 'deliveredCount' | 'markRead'
+    > & { creatorPrivateId: string };
+
     type QueryMessages = {
       subChannelId: Amity.SubChannel['subChannelId'];
       /**

package/src/@types/domains/story.ts

@@ -1,7 +1,5 @@
 import { VideoResolution } from './file';
 
-export {};
-
 declare global {
   namespace Amity {
     type CommunityStorySettings = {
@@ -33,18 +31,32 @@ declare global {
       Video = 'video',
     }
 
+    const enum StorySeenQuery {
+      SEEN = 'seen',
+      UNSEEN = 'unseen',
+      ALL = 'all',
+      SMART = 'smart',
+    }
+
     type StorySortOption = {
       sortBy?: StorySortBy;
       orderBy?: 'asc' | 'desc';
     };
 
+    type StoryGlobalQuery = {
+      seenState: Amity.StorySeenQuery;
+    };
+
     type RawStoryTarget = {
-      lastStoryExpiresAt?: Amity.timestamp;
-      lastStorySeenExpiresAt?: Amity.timestamp;
       targetId: string;
       targetType: string;
       targetPublicId: string;
       targetUpdatedAt: Amity.timestamp;
+
+      lastStoryExpiresAt?: Amity.timestamp;
+      lastStorySeenExpiresAt?: Amity.timestamp;
+
+      localFilter?: Amity.StorySeenQuery;
     };
 
     type StoryTargetQueryParam = Pick<Amity.RawStoryTarget, 'targetId' | 'targetType'>;
@@ -65,6 +77,15 @@ declare global {
     type StoryTarget = Pick<Amity.RawStoryTarget, 'targetId' | 'targetType'> & {
       updatedAt: Amity.timestamp;
       hasUnseen: boolean;
+      lastStoryExpiresAt?: Amity.timestamp;
+
+      localLastExpires: number;
+      localLastSeen: number;
+      localSortingDate: number;
+      localFilter?: Amity.StorySeenQuery;
+
+      syncingStoriesCount: number;
+      failedStoriesCount: number;
     };
 
     type StoryItemData<T extends StoryItemType> = T extends 'hyperlink'
@@ -99,6 +120,7 @@ declare global {
         markAsSeen: () => void;
         markLinkAsClicked: () => void;
       };
+      creator?: Amity.User;
       storyTarget?: Amity.StoryTarget;
       community?: Amity.Community;
       communityCategories?: Amity.Category[];

package/src/@types/domains/subChannel.ts

@@ -35,7 +35,11 @@ declare global {
       subChannelId: string;
       isUnreadCountSupport: boolean;
       unreadCount: number;
+      /**
+       * @deprecated use `isMentioned` instead
+       */
       hasMentioned: boolean;
+      isMentioned: boolean;
       messagePreviewId?: string | null;
       messagePreview?: Amity.MessagePreview | null;
     } & Amity.Timestamps &

package/src/channelRepository/api/markAsRead.ts

@@ -1,10 +1,6 @@
 import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
-import {
-  convertChannelMarkerResponse,
-  convertSubChannelMarkerResponse,
-  convertUserMarkerResponse,
-} from '~/utils/marker';
+import { convertChannelMarkerResponse, convertSubChannelMarkerResponse } from '~/utils/marker';
 import { fireEvent } from '~/core/events';
 
 /**
@@ -30,7 +26,7 @@ export const markAsRead = async (channelId: Amity.Channel['channelId']): Promise
   );
 
   const {
-    userMarkers: userMarkersPayload,
+    userMarkers,
     userEntityMarkers: userEntityMarkersPayload,
     userFeedMarkers: userFeedMarkersPayload,
     ...rest
@@ -43,7 +39,7 @@ export const markAsRead = async (channelId: Amity.Channel['channelId']): Promise
   if (client.cache)
     ingestInCache(
       {
-        userMarkers: convertUserMarkerResponse(userMarkersPayload),
+        userMarkers,
         userEntityMarkers: channelMarkers,
         userFeedMarkers: subChannelMarkers,
         ...rest,

package/src/channelRepository/channelModeration/api/index.ts

@@ -3,3 +3,6 @@ export * from './removeRole';
 
 export * from './banMembers';
 export * from './unbanMembers';
+
+export * from './muteMembers';
+export * from './unmuteMembers';

package/src/channelRepository/channelModeration/api/muteMembers.ts

@@ -0,0 +1,47 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { prepareChannelPayload } from '../../utils';
+
+const MUTE_FOREVER = -1;
+
+/* begin_public_function
+  id: channel.moderation.mute_members
+*/
+/**
+ * ```js
+ * import { muteMembers } from '@amityco/ts-sdk'
+ *
+ * await muteMembers('channel-id-1', ['userId1', 'userId2'], 10)
+ * ```
+ *
+ * @param channelId of {@link Amity.Channel} from which the users should be muted
+ * @param userIds of the {@link Amity.InternalUser}'s to be muted
+ * @param period to be muted in seconds
+ * @returns the updated {@link Amity.Membership}'s object
+ *
+ * @category Channel API
+ * @async
+ * */
+export const muteMembers = async (
+  channelId: Amity.Channel['channelId'],
+  userIds: Amity.InternalUser['userId'][],
+  mutePeriod = MUTE_FOREVER,
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('channel/muteMembers', { userIds, channelId, mutePeriod });
+
+  const { data } = await client.http.put<{ success: boolean }>(
+    `/api/v2/channel/${channelId}/users/mute`,
+    {
+      userIds,
+      mutePeriod: mutePeriod === MUTE_FOREVER ? mutePeriod : mutePeriod * 1000,
+    },
+  );
+
+  const { success } = data;
+
+  return success;
+};
+/* end_public_function */

package/src/channelRepository/channelModeration/api/unmuteMembers.ts

@@ -0,0 +1,43 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+import { prepareChannelPayload } from '../../utils';
+
+/* begin_public_function
+  id: channel.moderation.unban_members
+*/
+/**
+ * ```js
+ * import { unbanMembers } from '@amityco/ts-sdk'
+ *
+ * await unbanMembers('channel-id-1', ['userId1', 'userId2'])
+ * ```
+ *
+ * @param channelId of {@link Amity.Channel} where the users should be unbanned
+ * @param userIds of the {@link Amity.InternalUser}'s to be unbanned
+ * @returns the updated {@link Amity.Membership}'s object
+ *
+ * @category Channel API
+ * @async
+ * */
+export const unmuteMembers = async (
+  channelId: Amity.Channel['channelId'],
+  userIds: Amity.InternalUser['userId'][],
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('channel/unmuteMembers', { userIds, channelId });
+
+  const { data } = await client.http.put<{ success: boolean }>(
+    `/api/v2/channel/${encodeURIComponent(channelId)}/users/mute`,
+    {
+      userIds,
+      mutePeriod: 0,
+    },
+  );
+
+  const { success } = data;
+
+  return success;
+};
+/* end_public_function */

package/src/channelRepository/events/onChannelCreated.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';

package/src/channelRepository/events/onChannelDeleted.ts

@@ -4,6 +4,8 @@ import { getActiveClient } from '~/client/api/activeClient';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils/prepareChannelPayload';
+import { addFlagIsDeletedSubChannelUnreadByChannelId } from '~/marker/utils/addFlagIsDeletedSubChannelUnreadByChannelId';
+import { deleteChannelUnreadByChannelId } from '../../marker/utils/deleteChannelUnreadByChannelId';
 
 /**
  * ```js
@@ -26,6 +28,13 @@ export const onChannelDeleted = (callback: Amity.Listener<Amity.InternalChannel>
   const filter = async (payload: Amity.ChannelPayload) => {
     const data = await prepareChannelPayload(payload);
 
+    if (client.isUnreadCountEnabled && client.getMarkerSyncConsistentMode()) {
+      data.channels.forEach(channel => {
+        addFlagIsDeletedSubChannelUnreadByChannelId(channel.channelId);
+        deleteChannelUnreadByChannelId(channel.channelId);
+      });
+    }
+
     ingestInCache(data);
     callback(data.channels[0]);
   };

package/src/channelRepository/events/onChannelJoined.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';

package/src/channelRepository/events/onChannelLeft.ts

@@ -1,9 +1,11 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
+import { deleteChannelUnreadByChannelId } from '../../marker/utils/deleteChannelUnreadByChannelId';
+import { addFlagIsDeletedSubChannelUnreadByChannelId } from '~/marker/utils/addFlagIsDeletedSubChannelUnreadByChannelId';
 
 /**
  * ```js
@@ -35,6 +37,13 @@ export const onChannelLeft = (
       isMessagePreviewUpdated: isLeftByMe,
     });
 
+    if (client.isUnreadCountEnabled && client.getMarkerSyncConsistentMode() && isLeftByMe) {
+      preparedPayload.channels.forEach(channel => {
+        addFlagIsDeletedSubChannelUnreadByChannelId(channel.channelId);
+        deleteChannelUnreadByChannelId(channel.channelId);
+      });
+    }
+
     const { channels, channelUsers } = preparedPayload;
 
     ingestInCache(preparedPayload);

package/src/channelRepository/events/onChannelMemberAdded.ts

@@ -1,5 +1,5 @@
 import { ingestInCache } from '~/cache/api/ingestInCache';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { prepareChannelPayload } from '../utils';

package/src/channelRepository/events/onChannelMemberBanned.ts

@@ -4,6 +4,8 @@ import { getActiveClient } from '~/client/api/activeClient';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../utils';
+import { addFlagIsDeletedSubChannelUnreadByChannelId } from '~/marker/utils/addFlagIsDeletedSubChannelUnreadByChannelId';
+import { deleteChannelUnreadByChannelId } from '../../marker/utils/deleteChannelUnreadByChannelId';
 
 /**
  * ```js
@@ -29,6 +31,21 @@ export const onChannelMemberBanned = (
     const preparedPayload = await prepareChannelPayload(payload);
     const { channels, channelUsers } = preparedPayload;
 
+    const isCurrentUserBanned = channelUsers.some(
+      cu => cu.membership === 'banned' && cu.userId === client.userId,
+    );
+
+    if (
+      client.isUnreadCountEnabled &&
+      client.getMarkerSyncConsistentMode() &&
+      isCurrentUserBanned
+    ) {
+      preparedPayload.channels.forEach(channel => {
+        addFlagIsDeletedSubChannelUnreadByChannelId(channel.channelId);
+        deleteChannelUnreadByChannelId(channel.channelId);
+      });
+    }
+
     ingestInCache(preparedPayload);
     callback(channels[0], channelUsers.find(cu => cu.membership === 'banned')!);
   };

package/src/channelRepository/events/onChannelMemberRemoved.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';

package/src/channelRepository/events/onChannelMemberRoleAdded.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 /**

package/src/channelRepository/events/onChannelMemberRoleRemoved.ts

@@ -1,5 +1,5 @@
 import { ingestInCache } from '~/cache/api/ingestInCache';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { prepareChannelPayload } from '../utils';

package/src/channelRepository/events/onChannelMemberUnbanned.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';

package/src/channelRepository/events/onChannelMuted.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';

package/src/channelRepository/events/onChannelUpdated.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 import { createEventSubscriber } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';