@amityco/ts-sdk 7.6.0 → 7.6.1-2841ad2c.0

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,
+  );
+};

package/src/streamRepository/internalApi/getLiveChat.ts

@@ -0,0 +1,59 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { mergeInCache, pullFromCache } from '~/cache/api';
+import { createChannel } from '~/channelRepository/api/createChannel';
+import { channelLinkedObject } from '~/utils/linkedObject/channelLinkedObject';
+import { getChannel } from '~/channelRepository/internalApi/getChannel';
+import { constructChannelObject } from '~/channelRepository/utils/constructChannelObject';
+
+/**
+ * ```js
+ * import { getStream } from '@amityco/ts-sdk'
+ * const stream = await getStream('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Channel} object linked with a current stream
+ *
+ * @param stream {@link Amity.Stream} that has linked live channel
+ * @returns the associated {@link Amity.Channel<'live'>} object
+ *
+ * @category Stream API
+ * @async
+ */
+
+export const getLiveChat = async (
+  stream: Amity.InternalStream,
+): Promise<Amity.Channel<'live'> | undefined> => {
+  const client = getActiveClient();
+  client.log('stream/getLiveChat', stream.streamId);
+
+  if (stream.channelId) {
+    const channel = pullFromCache<Amity.StaticInternalChannel>([
+      'channel',
+      'get',
+      stream.channelId,
+    ])?.data;
+
+    if (channel) return channelLinkedObject(constructChannelObject(channel));
+
+    const { data } = await getChannel(stream.channelId);
+    return channelLinkedObject(constructChannelObject(data));
+  }
+  // No Channel ID
+  // streamer: create a new live channel
+  if (stream.userId === client.userId) {
+    const { data: channel } = await createChannel({
+      type: 'live',
+      postId: stream.referenceId,
+      videoStreamId: stream.streamId,
+    });
+
+    // Update channelId to stream object in cache
+    mergeInCache(['stream', 'get', stream.streamId], {
+      channelId: channel.channelId,
+    });
+
+    return channel;
+  }
+  // watcher: return undefined
+  return undefined;
+};

package/src/streamRepository/internalApi/getStream.ts

@@ -22,7 +22,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  */
 export const getStream = async (
   streamId: Amity.Stream['streamId'],
-): Promise<Amity.Cached<Amity.Stream>> => {
+): Promise<Amity.Cached<Amity.InternalStream>> => {
   const client = getActiveClient();
   client.log('stream/getStream', streamId);
 
@@ -57,13 +57,13 @@ export const getStream = async (
  */
 getStream.locally = (
   streamId: Amity.Stream['streamId'],
-): Amity.Cached<Amity.Stream> | undefined => {
+): Amity.Cached<Amity.InternalStream> | undefined => {
   const client = getActiveClient();
   client.log('stream/getStream', streamId);
 
   if (!client.cache) return;
 
-  const cached = pullFromCache<Amity.Stream>(['stream', 'get', streamId]);
+  const cached = pullFromCache<Amity.InternalStream>(['stream', 'get', streamId]);
 
   if (!cached) return;
 

package/src/streamRepository/observers/getStreamById.ts

@@ -8,6 +8,7 @@ import { onStreamTerminated } from '~/streamRepository/events/onStreamTerminated
 import { LinkedObject } from '~/utils/linkedObject';
 import { getStream as _getStream } from '../internalApi/getStream';
 import { onStreamRecorded, onStreamStarted, onStreamStopped } from '../events';
+import { onStreamViewerBanned } from '../events/onStreamViewerBanned';
 
 /* begin_public_function
   id: stream.get
@@ -45,6 +46,7 @@ export const getStreamById = (
     onStreamStopped,
     onStreamFlagged,
     onStreamTerminated,
+    onStreamViewerBanned,
   ]);
 };
 /* end_public_function */

package/src/streamRepository/observers/getStreams/GetStreamsLiveCollectionController.ts

@@ -12,6 +12,8 @@ import {
 } from '~/streamRepository/events';
 import { GetStreamsPageController } from '~/streamRepository/observers/getStreams/GetStreamsPageController';
 import { GetStreamsQueryStreamController } from '~/streamRepository/observers/getStreams/GetStreamsQueryStreamController';
+import { onStreamViewerBanned } from '~/streamRepository/events/onStreamViewerBanned';
+import { onStreamViewerUnbanned } from '~/streamRepository/events/onStreamViewerUnbanned';
 
 export class GetStreamsLiveCollectionController extends LiveCollectionController<
   'stream',
@@ -77,6 +79,8 @@ export class GetStreamsLiveCollectionController extends LiveCollectionController
       { fn: onStreamStopped, action: 'onStreamStopped' },
       { fn: onStreamFlagged, action: 'onStreamFlagged' },
       { fn: onStreamTerminated, action: 'onStreamTerminated' },
+      { fn: onStreamViewerBanned, action: 'onStreamViewerBanned' },
+      { fn: onStreamViewerUnbanned, action: 'onStreamViewerUnbanned' },
     ]);
   }
 
@@ -102,7 +106,7 @@ export class GetStreamsLiveCollectionController extends LiveCollectionController
     this.queryStreamController.appendToQueryStream(response, direction, refresh);
   }
 
-  private applyFilter = (data: Amity.InternalStream[]): Amity.InternalStream[] => {
+  private applyFilter = (data: Amity.Stream[]): Amity.Stream[] => {
     let streams = filterByPropEquality(data, 'isDeleted', this.query.isDeleted);
 
     streams = streams.sort(

package/src/utils/linkedObject/channelLinkedObject.ts

@@ -2,6 +2,7 @@ import { markAsRead } from '~/channelRepository/internalApi/markAsRead';
 import { shallowClone } from '../shallowClone';
 import { queryCache } from '~/cache/api';
 import { channelMemberLinkedObject } from './channelMemberLinkedObject';
+import { getMyMembership } from '~/channelRepository/observers/getMyMembership';
 
 export const channelLinkedObject = (channel: Amity.InternalChannel): Amity.Channel => {
   let previewMembers: Amity.Membership<'channel'>[] = [];
@@ -23,5 +24,7 @@ export const channelLinkedObject = (channel: Amity.InternalChannel): Amity.Chann
   return shallowClone(channel, {
     markAsRead: () => markAsRead(channel.channelInternalId),
     previewMembers,
+    myMembership: (callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>) =>
+      getMyMembership(channel.channelId, callback),
   });
 };

package/src/utils/linkedObject/postLinkedObject.ts

@@ -2,12 +2,23 @@ import { pullFromCache } from '~/cache/api';
 import { commentLinkedObject } from '~/utils/linkedObject/commentLinkedObject';
 import AnalyticsEngine from '../../analytic/service/analytic/AnalyticsEngine';
 import { userLinkedObject } from './userLinkedObject';
-import { isAmityFilePost, isAmityImagePost, isAmityVideoPost } from '../postTypePredicate';
+import {
+  isAmityFilePost,
+  isAmityImagePost,
+  isAmityLivestreamPost,
+  isAmityPollPost,
+  isAmityVideoPost,
+} from '../postTypePredicate';
+import { streamLinkedObject } from './streamLinkedObject';
+import { isNonNullable } from '..';
 
 export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
   return {
     ...post,
-
+    childrenPosts: post.children
+      .map(childPost => pullFromCache<Amity.InternalPost>(['post', 'get', childPost])?.data)
+      .filter(isNonNullable)
+      .map(postLinkedObject),
     analytics: {
       markAsViewed: () => {
         const analyticsEngineInstance = AnalyticsEngine.getInstance();
@@ -64,5 +75,24 @@ export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
         ? pullFromCache<Amity.File<'file'>>(['file', 'get', post?.data?.fileId])?.data
         : undefined;
     },
+
+    getLivestreamInfo(): Amity.Stream | undefined {
+      if (!isAmityLivestreamPost(post)) return;
+      const cache = pullFromCache<Amity.InternalStream>([
+        'stream',
+        'get',
+        post?.data?.streamId,
+      ])?.data;
+      if (!cache) return;
+
+      return streamLinkedObject(cache);
+    },
+
+    getPollInfo(): Amity.Poll | undefined {
+      if (!isAmityPollPost(post)) return;
+      const cache = pullFromCache<Amity.Poll>(['poll', 'get', post?.data?.pollId])?.data;
+      if (!cache) return;
+      return cache;
+    },
   };
 };

package/src/utils/linkedObject/streamLinkedObject.ts

@@ -1,4 +1,5 @@
 import { pullFromCache } from '~/cache/api';
+import { getLiveChat as _getLiveChat } from '~/streamRepository/internalApi/getLiveChat';
 
 export const streamLinkedObject = (stream: Amity.InternalStream): Amity.Stream => {
   return {
@@ -18,5 +19,8 @@ export const streamLinkedObject = (stream: Amity.InternalStream): Amity.Stream =
     get user() {
       return pullFromCache<Amity.User>(['user', 'get', stream.userId])?.data;
     },
+    getLiveChat: () => _getLiveChat(stream),
+    isBanned: !stream.watcherUrl,
+    watcherUrl: null,
   };
 };

package/src/utils/postTypePredicate.ts

@@ -1,5 +1,6 @@
-export function isAmityImagePost(post: Amity.InternalPost): post is Amity.Post<'image'> {
+export function isAmityImagePost(post?: Amity.InternalPost): post is Amity.Post<'image'> {
   return !!(
+    post &&
     post.data &&
     typeof post.data !== 'string' &&
     'fileId' in post.data &&
@@ -7,8 +8,9 @@ export function isAmityImagePost(post: Amity.InternalPost): post is Amity.Post<'
   );
 }
 
-export function isAmityFilePost(post: Amity.InternalPost): post is Amity.Post<'file'> {
+export function isAmityFilePost(post?: Amity.InternalPost): post is Amity.Post<'file'> {
   return !!(
+    post &&
     post.data &&
     typeof post.data !== 'string' &&
     'fileId' in post.data &&
@@ -16,8 +18,9 @@ export function isAmityFilePost(post: Amity.InternalPost): post is Amity.Post<'f
   );
 }
 
-export function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'video'> {
+export function isAmityVideoPost(post?: Amity.InternalPost): post is Amity.Post<'video'> {
   return !!(
+    post &&
     post.data &&
     typeof post.data !== 'string' &&
     'videoFileId' in post.data &&
@@ -25,3 +28,23 @@ export function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'
     post.dataType === 'video'
   );
 }
+
+export function isAmityLivestreamPost(post?: Amity.InternalPost): post is Amity.Post<'liveStream'> {
+  return !!(
+    post &&
+    post.data &&
+    typeof post.data !== 'string' &&
+    'streamId' in post.data &&
+    post.dataType === 'liveStream'
+  );
+}
+
+export function isAmityPollPost(post?: Amity.InternalPost): post is Amity.Post<'poll'> {
+  return !!(
+    post &&
+    post.data &&
+    typeof post.data !== 'string' &&
+    'pollId' in post.data &&
+    post.dataType === 'poll'
+  );
+}

package/dist/channelRepository/events/onChannelMuted.d.ts

@@ -1,2 +0,0 @@
-export declare const onChannelMuted: (callback: Amity.Listener<Amity.StaticInternalChannel>) => () => void;
-//# sourceMappingURL=onChannelMuted.d.ts.map

package/dist/channelRepository/events/onChannelMuted.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"onChannelMuted.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/events/onChannelMuted.ts"],"names":[],"mappings":"AAsBA,eAAO,MAAM,cAAc,aAAc,MAAM,QAAQ,CAAC,MAAM,qBAAqB,CAAC,eAgBnF,CAAC"}

package/src/channelRepository/events/onChannelMuted.ts

@@ -1,39 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { createEventSubscriber } from '~/core/events';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-
-import { prepareChannelPayload } from '../utils';
-import { constructChannelDynamicValue } from '../utils/constructChannelDynamicValue';
-
-type CallbackFn = Amity.Listener<Amity.StaticInternalChannel>;
-const callbacks: CallbackFn[] = [];
-let mainDisposer: (() => void) | null = null;
-
-const dispose = (cb: CallbackFn) => {
-  const index = callbacks.indexOf(cb);
-  if (index > -1) {
-    callbacks.splice(index, 1);
-  }
-  if (callbacks.length === 0) {
-    mainDisposer?.();
-  }
-};
-
-export const onChannelMuted = (callback: Amity.Listener<Amity.StaticInternalChannel>) => {
-  if (callbacks.length === 0) {
-    const client = getActiveClient();
-
-    const filter = async (payload: Amity.ChannelPayload) => {
-      const data = await prepareChannelPayload(payload);
-
-      ingestInCache(data);
-      callbacks.forEach(cb => cb(data.channels[0]));
-    };
-
-    mainDisposer = createEventSubscriber(client, 'onChannelMuted', 'channel.setMuted', filter);
-  }
-
-  callbacks.push(callback);
-  return () => dispose(callback);
-};