@amityco/ts-sdk 7.7.0 → 7.7.1-4e97d71.0

package/src/liveReactionRepository/internalApi/createLiveReaction.ts

@@ -0,0 +1,42 @@
+import { getActiveClient } from '~/client/api/activeClient';
+// TODO: confirm id
+/* begin_public_function
+  id: live_reaction.create
+*/
+/**
+ * ```js
+ * import { acceptInvitation } from '@amityco/ts-sdk'
+ * const isAccepted = await acceptInvitation(invitationId)
+ * ```
+ *
+ * Accepts array of {@link Amity.LiveReaction} object without userId
+ *
+ * @param reactions the array of {@link Amity.LiveReaction} to create
+//  TODO: confirm what is the ids in addedIds
+ * @returns An object addedIds contains array of reaction ID
+ *
+ * @category Live Reaction API
+ * @async
+ */
+export const createLiveReaction = async ({
+  reactions,
+  liveStreamId,
+}: {
+  reactions: Amity.CreateLiveReactionRequest[];
+  liveStreamId: string;
+}): Promise<Amity.CreateLiveReactionResponse> => {
+  const client = getActiveClient();
+
+  client.log('live_reaction/addReaction', reactions);
+
+  const { data } = await client.http.post<Amity.CreateLiveReactionResponse>(
+    `/api/v1/reactions/live`,
+    {
+      liveStreamId,
+      reactions,
+    },
+  );
+
+  return data;
+};
+/* end_public_function */

package/src/liveReactionRepository/observers/getReactions.ts

@@ -0,0 +1,59 @@
+import { ASCError } from '~/core/errors';
+import { onLiveReactionCreated } from '../events';
+import { getActiveClient, getActiveUser } from '~/client';
+import { onLiveReactionCreatedLocal } from '../events/onLiveReactionCreatedLocal';
+
+/**
+ *
+ * ```js
+ * import { getReactions } from '@amityco/ts-sdk';
+ *
+ * const unsubscribe = getReactions(response => {
+ *       reactions = response.data
+ * });
+ * ```
+ *
+ * Observe live reactions {@link_Amity.LiveReaction} that have been created in a post linked with a stream
+ *
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the events
+ *
+ * @category Live Reaction Observable
+ */
+// TODO: confirm return type for this observable property
+export const getReactions = (
+  postId: string,
+  callback: Amity.Listener<Amity.LiveReaction[]>,
+): Amity.Unsubscriber => {
+  const { _id: userId } = getActiveUser();
+
+  if (!userId)
+    throw new ASCError(
+      'The _id has not been defined in ActiveUser',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.ERROR,
+    );
+
+  const { log } = getActiveClient();
+
+  const timestamp = Date.now();
+  log(`getReactions(tmpid: ${timestamp}) > listen`);
+
+  const disposers: Amity.Unsubscriber[] = [];
+
+  const dispatcher = (data: Amity.LiveReaction[]) => {
+    callback(data);
+  };
+
+  const realtimeRouter = (data: Amity.LiveReaction[]) => {
+    const relevantReactions = data.filter(({ referenceId }) => referenceId === postId);
+    dispatcher(relevantReactions);
+  };
+
+  disposers.push(onLiveReactionCreated(realtimeRouter));
+  disposers.push(onLiveReactionCreatedLocal(realtimeRouter));
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/liveReactionRepository/observers/index.ts

@@ -0,0 +1 @@
+export * from './getReactions';

package/src/liveReactionRepository/service/ReactionSyncEngine.ts

@@ -0,0 +1,138 @@
+import { onOffline } from '~/client/utils/onOffline';
+import { onOnline } from '~/client/utils/onOnline';
+import { SECOND } from '~/utils/constants';
+import { createLiveReaction as _createLiveReaction } from '../internalApi/createLiveReaction';
+
+class LiveReactionSyncEngine {
+  private readonly TIMER_INTERVAL_MS = 1 * SECOND;
+
+  private buffer: (Amity.CreateLiveReactionRequest & { streamId: string })[] = [];
+
+  private timer: NodeJS.Timer | undefined;
+
+  private isSyncing = false;
+
+  private connectionListener: (() => void)[] = [];
+
+  private isConnected = true;
+
+  constructor() {
+    this.addConnectionListener();
+  }
+
+  startReactionsSync() {
+    if (!this.timer) {
+      this.timer = setInterval(() => {
+        if (this.isConnected) this.syncLiveReactions();
+      }, this.TIMER_INTERVAL_MS);
+    }
+  }
+
+  stopReactionsSync() {
+    if (this.timer) {
+      clearInterval(this.timer);
+      this.timer = undefined;
+    }
+  }
+
+  createLiveReaction(liveReaction: Amity.CreateLiveReactionRequest & { streamId: string }) {
+    this.buffer.push(liveReaction);
+  }
+
+  private addConnectionListener() {
+    if (this.connectionListener.length > 0) return;
+    this.connectionListener.push(
+      onOnline(() => {
+        this.isConnected = true;
+      }),
+    );
+
+    this.connectionListener.push(
+      onOffline(() => {
+        this.isConnected = false;
+      }),
+    );
+  }
+
+  private removeConnectionListener() {
+    if (this.connectionListener.length > 0) {
+      this.connectionListener.forEach(listener => listener());
+      this.connectionListener = [];
+    }
+  }
+
+  private syncLiveReactions() {
+    if (this.isSyncing) {
+      return;
+    }
+
+    this.isSyncing = true;
+
+    const reactions = this.buffer;
+
+    // Clear buffer
+    this.clearBuffer();
+
+    const payloads: Record<string, Amity.CreateLiveReactionRequest[]> = reactions.reduce(
+      (prev: Record<string, Amity.CreateLiveReactionRequest[]>, curr) => {
+        const { streamId, ...rest } = curr;
+        if (!prev[streamId]) {
+          // eslint-disable-next-line no-param-reassign
+          prev[streamId] = [rest];
+        } else prev[streamId].push(rest);
+        return prev;
+      },
+      {} as Record<string, Amity.CreateLiveReactionRequest[]>,
+    );
+
+    // Call server api `POST /api/v1/reactions/live` to sync live reactions
+    Object.entries(payloads).forEach(([streamId, reactions]) => {
+      _createLiveReaction({
+        liveStreamId: streamId,
+        reactions,
+      });
+    });
+
+    // After sending request
+    this.isSyncing = false;
+  }
+
+  private clearBuffer() {
+    this.buffer = [];
+  }
+
+  // Session Management : SessionComponent
+  onSessionEstablished() {
+    this.startReactionsSync();
+    this.addConnectionListener();
+  }
+
+  onSessionDestroyed() {
+    // Stop timer
+    this.stopReactionsSync();
+
+    // Clear buffer
+    this.clearBuffer();
+
+    // Reset state
+    this.isSyncing = false;
+
+    // remove connection listener
+    this.removeConnectionListener();
+  }
+
+  onTokenExpired() {
+    this.stopReactionsSync();
+  }
+}
+
+let instance: LiveReactionSyncEngine;
+
+export default {
+  getInstance: () => {
+    if (!instance) {
+      instance = new LiveReactionSyncEngine();
+    }
+    return instance;
+  },
+};

package/src/liveReactionRepository/utils/ReactionSyncEngineOnLoginHandler.ts

@@ -0,0 +1,19 @@
+import { onSessionStateChange } from '~/client/events/onSessionStateChange';
+import ReactionSyncEngine from '../service/ReactionSyncEngine';
+
+export default () => {
+  const reactionSynceEngine = ReactionSyncEngine.getInstance();
+  reactionSynceEngine.startReactionsSync();
+
+  onSessionStateChange(state => {
+    if (state === Amity.SessionStates.ESTABLISHED) {
+      reactionSynceEngine.onSessionEstablished();
+    } else if (state === Amity.SessionStates.TOKEN_EXPIRED) {
+      reactionSynceEngine.onTokenExpired();
+    } else reactionSynceEngine.onSessionDestroyed();
+  });
+
+  return () => {
+    reactionSynceEngine.onSessionDestroyed();
+  };
+};

package/src/liveStreamPlayer/api/getPlayer.ts

@@ -60,7 +60,7 @@ export const getPlayer = async (parameters: { streamId: string }): Promise<HTMLV
     video.src = recording.mp4.url;
   }
 
-  new EventRegister(video, resolution).registerEvents();
+  new EventRegister(video, resolution, streamId).registerEvents();
 
   return video;
 };

package/src/liveStreamPlayer/utils/eventRegister.ts

@@ -1,5 +1,6 @@
 import uuid from 'react-native-uuid';
 import { getUsageCollector } from '../api/getUsageCollector';
+import { onStreamViewerBanned } from '~/streamRepository/events';
 
 const SECOND = 1000;
 /*
@@ -32,7 +33,9 @@ export class EventRegister {
 
   _observer: MutationObserver;
 
-  constructor(player: HTMLVideoElement, resolution: string) {
+  _SDKUnsubscribers: Amity.Unsubscriber[] = [];
+
+  constructor(player: HTMLVideoElement, resolution: string, streamId: string) {
     this.player = player;
     this.resolution = resolution;
     this._startTime = null;
@@ -53,10 +56,22 @@ export class EventRegister {
         mutation.removedNodes.forEach(node => {
           if (node === player) {
             this._unregisterEvents();
+            this._SDKUnsubscribers.forEach(fn => fn?.());
           }
         });
       });
     });
+
+    this._SDKUnsubscribers.push(
+      onStreamViewerBanned(stream => {
+        // if still has stream.watcherUrl, the current user has not banned.
+        if (stream.watcherUrl) return;
+        this.player.pause();
+        this.player.removeAttribute('src');
+        this.player.load();
+        this.player.remove();
+      }),
+    );
   }
 
   _resetStartTime() {

package/src/messageRepository/api/deleteMessage.ts

@@ -23,6 +23,22 @@ export const deleteMessage = async (
   const client = getActiveClient();
   client.log('message/deleteMessage', messageId);
 
+  if (messageId.includes('LOCAL_')) {
+    const message = pullFromCache<Amity.InternalMessage>(['message', 'get', messageId])?.data;
+    if (!message) throw Error('messageId not found');
+
+    const deletedMessage = {
+      ...message,
+      isDeleted: true,
+    };
+
+    fireEvent('local.message.deleted', {
+      messages: [deletedMessage],
+    });
+
+    return LinkedObject.message(deletedMessage);
+  }
+
   // API-FIX: This endpoint has not been implemented yet.
   const { data: deleted } = await client.http.delete<Amity.MessagePayload>(
     `/api/v5/messages/${encodeURIComponent(messageId)}`,

package/src/messageRepository/observers/getMessage.ts

@@ -11,6 +11,7 @@ import {
   onMessageReactionAdded,
   onMessageReactionRemoved,
 } from '../events';
+import { onStreamViewerBanned } from '~/streamRepository/events/onStreamViewerBanned';
 import { onMessageFetched } from '../events/onMessageFetched';
 import { LinkedObject } from '~/utils/linkedObject';
 
@@ -57,6 +58,7 @@ export const getMessage = (
     onMessageReactionRemoved,
     convertEventPayload(onMessageMarkerFetched, 'contentId', 'message'),
     convertEventPayload(onMessageMarked, 'contentId', 'message'),
+    convertEventPayload(onStreamViewerBanned, 'channelId', 'message'),
   ]);
 };
 /* end_public_function */

package/src/messageRepository/observers/getMessages/MessageLiveCollectionController.ts

@@ -11,6 +11,7 @@ import {
   onMessageUnflagged,
   onMessageUpdated,
 } from '~/messageRepository/events';
+import { onStreamViewerBanned } from '~/streamRepository/events/onStreamViewerBanned';
 import { convertEventPayload } from '~/utils/event';
 import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
 import { onMessageMarked, onMessageMarkerFetched } from '~/marker/events';
@@ -70,6 +71,7 @@ export class MessageLiveCollectionController extends LiveCollectionController<
         action: 'onUpdate',
       },
       { fn: convertEventPayload(onMessageMarked, 'contentId', 'message'), action: 'onUpdate' },
+      { fn: convertEventPayload(onStreamViewerBanned, 'channelId', 'message'), action: 'onUpdate' },
     ]);
   }
 

package/src/messageRepository/observers/getMessages/MessageQueryStreamController.ts

@@ -116,6 +116,19 @@ export class MessageQueryStreamController extends QueryStreamController<
         pushToCache(this.cacheKey, collection);
       }
 
+      if (action === 'onDelete' && payload.syncState === Amity.SyncState.Error) {
+        const collection = pullFromCache<Amity.MessageLiveCollectionCache>(this.cacheKey)?.data;
+        if (!collection) return;
+
+        if (collection.data.includes(payload.messageId)) {
+          const newCollectionData = collection.data.filter(
+            messageId => messageId !== payload.messageId,
+          );
+
+          pushToCache(this.cacheKey, { ...collection, data: newCollectionData });
+        }
+      }
+
       this.notifyChange({ origin: Amity.LiveDataOrigin.EVENT, loading: false });
     };
   }

package/src/postRepository/api/createPost.ts

@@ -2,8 +2,8 @@ import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
-import { prepareMembershipPayload } from '~/group/utils';
 import { LinkedObject } from '~/utils/linkedObject';
+import { preparePostPayload } from '../utils/payload';
 
 /* begin_public_function
   id: post.create.text_post, post.create.image_post, post.create.file_post, post.create.video_post, post.create.poll_post, post.create.livestream_post, post.create.custom_post
@@ -46,7 +46,8 @@ export const createPost = async <T extends Amity.PostContentType | string>(
 
   fireEvent('post.created', payload);
 
-  const data = prepareMembershipPayload(payload, 'communityUsers');
+  const data = preparePostPayload(payload);
+
   const cachedAt = client.cache && Date.now();
 
   if (client.cache) ingestInCache(data, { cachedAt });

package/src/postRepository/utils/payload.ts

@@ -1,8 +1,28 @@
 import { addPostSetting } from '~/communityRepository/utils';
 import { updateMembershipStatus } from '~/communityRepository/utils/communityWithMembership';
+import { isAmityLivestreamPost } from '~/utils/postTypePredicate';
+
+const updateStreamReferences = (
+  streams: Amity.RawStream[],
+  streamId: string | undefined,
+  postId: string,
+) => {
+  if (!streamId) return streams;
+
+  return streams.map(stream =>
+    stream.streamId === streamId
+      ? {
+          ...stream,
+          referenceType: 'post',
+          referenceId: postId,
+          postId,
+        }
+      : stream,
+  );
+};
 
 export const preparePostPayload = (payload: Amity.PostPayload): Amity.ProcessedPostPayload => {
-  const { posts: postsData, ...postPayload } = payload;
+  const { posts: postsData, postChildren, videoStreamings, ...postPayload } = payload;
 
   // Unpack community payload by mapping payload field to postSetting value.
   const communitiesWithPostSetting = addPostSetting({ communities: postPayload.communities });
@@ -24,18 +44,34 @@ export const preparePostPayload = (payload: Amity.PostPayload): Amity.ProcessedP
     mappedCommunityUsers,
   );
 
+  let mappedNewStream: Amity.RawStream[] = [];
+
   // feed type
   const posts = postsData.map(post => {
     const feedType = postPayload.feeds.find(feed => feed.feedId === post.feedId)?.feedType;
+    const childPosts = payload.postChildren.filter(
+      children => children.parentPostId === post.postId,
+    );
+
+    if (childPosts.length > 0 && isAmityLivestreamPost(childPosts[0])) {
+      mappedNewStream = updateStreamReferences(
+        videoStreamings,
+        childPosts[0].data?.streamId,
+        post.postId,
+      );
+    }
 
     return {
       ...post,
+      childPosts,
       feedType,
     };
   });
 
   return {
     ...postPayload,
+    postChildren,
+    videoStreamings: mappedNewStream,
     posts,
     communities: communityWithMembershipStatus,
     communityUsers: mappedCommunityUsers,

package/src/streamRepository/api/createStream.ts

@@ -21,7 +21,10 @@ import { LinkedObject } from '~/utils/linkedObject';
  * @async
  */
 export const createStream = async (
-  bundle: Pick<Amity.InternalStream, 'title' | 'thumbnailFileId' | 'description'> & {
+  bundle: Pick<
+    Amity.InternalStream,
+    'title' | 'thumbnailFileId' | 'description' | 'channelEnabled'
+  > & {
     isSecure?: boolean;
   },
 ): Promise<Amity.Cached<Amity.Stream>> => {

package/src/streamRepository/api/editStream.ts

@@ -0,0 +1,51 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { LinkedObject } from '~/utils/linkedObject';
+
+/* begin_public_function
+  id: stream.update
+*/
+/**
+ *
+ * ```js
+ * import { StreamRepository } from '@amityco/ts-sdk'
+ * const updated = await StreamRepository.editStream(streamId, { title: 'foobar' })
+ * ```
+ *
+ * Updates an {@link Amity.Stream}
+ *
+ * @param streamId The ID of the {@link Amity.Stream} to edit
+ * @param patch The patch data to apply
+ * @returns the updated {@link Amity.Stream} object
+ *
+ * @category Stream API
+ * @async
+ */
+
+export const editStream = async (
+  streamId: Amity.Stream['streamId'],
+  patch: Patch<
+    Amity.Stream,
+    'title' | 'thumbnailFileId' | 'description' | 'metadata' | 'channelEnabled'
+  >,
+): Promise<Amity.Cached<Amity.Stream>> => {
+  const client = getActiveClient();
+  client.log('stream/updateStream', streamId, patch);
+
+  const { data } = await client.http.put<Amity.StreamPayload>(
+    `/api/v3/video-streaming/${streamId}`,
+    patch,
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { videoStreamings } = data;
+
+  return {
+    data: LinkedObject.stream(videoStreamings.find(stream => stream.streamId === streamId)!),
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/streamRepository/api/index.ts

@@ -2,3 +2,4 @@ export * from './createStream';
 export * from './updateStream';
 export * from './deleteStream';
 export * from './disposeStream';
+export * from './editStream';

package/src/streamRepository/api/updateStream.ts

@@ -7,6 +7,9 @@ import { LinkedObject } from '~/utils/linkedObject';
   id: stream.update
 */
 /**
+ * @deprecated this function is deprecated,
+ * please use {@link Amity.StreamRepository.editStream} instead.
+ *
  * ```js
  * import { updateStream } from '@amityco/ts-sdk'
  * const updated = await updateStream(streamId, { title: 'foobar' })
@@ -21,9 +24,13 @@ import { LinkedObject } from '~/utils/linkedObject';
  * @category Stream API
  * @async
  */
+
 export const updateStream = async (
   streamId: Amity.Stream['streamId'],
-  patch: Patch<Amity.Stream, 'title' | 'thumbnailFileId' | 'description' | 'metadata'>,
+  patch: Patch<
+    Amity.Stream,
+    'title' | 'thumbnailFileId' | 'description' | 'metadata' | 'channelEnabled'
+  >,
 ): Promise<Amity.Cached<Amity.Stream>> => {
   const client = getActiveClient();
   client.log('stream/updateStream', streamId, patch);

package/src/streamRepository/events/index.ts

@@ -3,3 +3,5 @@ export { onStreamStopped } from './onStreamStopped';
 export { onStreamRecorded } from './onStreamRecorded';
 export { onStreamFlagged } from './onStreamFlagged';
 export { onStreamTerminated } from './onStreamTerminated';
+export { onStreamViewerBanned } from './onStreamViewerBanned';
+export { onStreamViewerUnbanned } from './onStreamViewerUnbanned';

package/src/streamRepository/events/onStreamViewerBanned.ts

@@ -0,0 +1,58 @@
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+import { mergeInCache, pullFromCache, queryCache } from '~/cache/api';
+
+/**
+ * ```js
+ * import { onStreamViewerBanned } from '@amityco/ts-sdk'
+ * const dispose = onStreamViewerBanned(stream => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user in channel linked to stream has been banned
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Stream Events
+ */
+export const onStreamViewerBanned = (
+  callback: Amity.Listener<Amity.InternalStream>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = (payloads: Amity.StreamViewerBanPayload) => {
+    payloads.forEach(streamBanned => {
+      mergeInCache(['stream', 'get', streamBanned.streamId], { watcherUrl: null });
+
+      // Update isDeleted = true in banned user's messages
+      const messageCache = queryCache<Amity.InternalMessage>(['message', 'get'])?.filter(
+        // Check if creator id and user id are internal or external id
+        ({ data }) => data.creatorId === streamBanned.userId,
+      );
+
+      // Update isDeleted for each relavant messages
+      messageCache?.forEach(message => {
+        mergeInCache(message.key, { isDeleted: true });
+      });
+    });
+
+    const stream = pullFromCache<Amity.InternalStream>([
+      'stream',
+      'get',
+      payloads[0].streamId,
+    ])?.data;
+
+    if (!stream) return;
+
+    callback(stream);
+  };
+
+  return createEventSubscriber(
+    client,
+    'stream/onStreamViewerDidBan',
+    'video-streaming.viewerDidBan',
+    filter,
+  );
+};

package/src/streamRepository/events/onStreamViewerUnbanned.ts

@@ -0,0 +1,47 @@
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+import { mergeInCache, pullFromCache } from '~/cache/api';
+import { getStream } from '../internalApi/getStream';
+
+/**
+ * ```js
+ * import { onStreamViewerUnbanned } from '@amityco/ts-sdk'
+ * const dispose = onStreamViewerBanned(stream => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user in channel linked to stream has been unbanned
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Stream Events
+ */
+export const onStreamViewerUnbanned = (
+  callback: Amity.Listener<Amity.InternalStream>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = async (payloads: Amity.StreamViewerUnbanPayload) => {
+    // Get new stream object to restore stream watcherUrl in cache
+    await Promise.all(payloads.map(({ streamId }) => getStream(streamId)));
+
+    const stream = pullFromCache<Amity.InternalStream>([
+      'stream',
+      'get',
+      payloads[0].streamId,
+    ])?.data;
+
+    if (!stream) return;
+
+    callback(stream);
+  };
+
+  return createEventSubscriber(
+    client,
+    'stream/onStreamViewerDidUnban',
+    'video-streaming.viewerDidUnban',
+    filter,
+  );
+};