@amityco/ts-sdk 6.35.3-fa3d4ac.0 → 7.0.1-54f1ba3.0

package/src/client/api/createClient.ts

@@ -87,8 +87,6 @@ export const createClient = (
 
   const isUnreadCountEnabled = false;
 
-  const objectSyncMap = new Map<string, string>();
-
   const client = {
     version: `${VERSION}`,
     apiKey,
@@ -132,30 +130,6 @@ export const createClient = (
      * This is allow user to have multiple SDK client and Mqtt client within the same app.
      */
     prefixDeviceIdKey,
-
-    /*
-     * The objectSyncMap is used to keep the map between local referenceId and server id in two ways mapping.
-     *
-     * For objects created locally (optimistic creation), the SDK stores them with their local ID as the cache key, which is used throughout the entire SDK session (in-memory) for syncing updates.
-     * If the payload or response only contains the remote ID of the same object, the SDK will look up the corresponding local ID to retrieve the object through ObjectSyncMap.
-     *
-     * This is useful for syncing updates to the object, as the SDK can find the local ID from the server ID and update the object in the cache correctly.
-     *
-     * Example:
-     * In the case of message optimistically creation. The referenceId is created locally.
-     *
-     * 1. When creating a message optimistically, a local referenceId is created. The objectSyncMap will have the following structure.
-     * {
-     *   "LOCAL_uuid": undefined,
-     * }
-     *
-     * 2. After the message was created on the server and SDK received the response from server, the objectSyncMap will be updated to
-     * {
-     *  "LOCAL_uuid": "server_message_id",
-     *  "server_message_id": "LOCAL_uuid"
-     * }
-     */
-    objectSyncMap,
   };
 
   try {

package/src/client/api/fetchLinkPreview.ts

@@ -0,0 +1,30 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { fetchLinkPreview } from '@amityco/ts-sdk'
+ * const { title, description, imageUrl } = fetchLinkPreview('https://www.example.com/')
+ * ```
+ *
+ *
+ * @param url the url to fetch link preview
+ * @returns A {@link Amity.LinkPreview} instance
+ *
+ * @category Client API
+ * */
+
+export const fetchLinkPreview = async (url: string): Promise<Amity.LinkPreview> => {
+  const client = getActiveClient();
+
+  let fetchUrl = url;
+
+  if (!/^https?:\/\//i.test(url)) {
+    fetchUrl = `https://${url}`;
+  }
+
+  const { data } = await client.http.get<Amity.LinkPreview>(
+    `/api/v1/link-preview?url=${encodeURIComponent(fetchUrl)}`,
+  );
+
+  return data;
+};

package/src/client/api/index.ts

@@ -18,3 +18,5 @@ export * from './markerSync';
 export * from './enableUnreadCount';
 
 export * from './setUploadedFileAccessType';
+
+export * from './fetchLinkPreview';

package/src/client/observers/getUserUnread.ts

@@ -70,7 +70,7 @@ export const getUserUnread = (
 
     callback({
       data: callbackModel
-        ? { ...callbackModel, hasMentioned: callbackModel.isMentioned }
+        ? { ...callbackModel, isMentioned: callbackModel.isMentioned }
         : callbackModel,
 
       loading: data.loading,

package/src/client/observers/index.ts

@@ -1,2 +1 @@
-export * from './getTotalUnreadCount';
 export * from './getUserUnread';

package/src/client/utils/endpoints.ts

@@ -5,7 +5,7 @@ export const API_REGIONS = {
 } as const;
 
 const URLS = {
-  http: 'https://api.{region}.amity.co',
+  http: 'https://apix.{region}.amity.co',
   mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
 } as const;
 

package/src/client/utils/markerSyncEngine.ts

@@ -229,15 +229,6 @@ export const stopUnreadSync = () => {
   unRegisterEventListeners();
 };
 
-/**
- * @deprecated Please use `startUnreadSync` instead
- */
-export const stopUnreadSyncing = () => {
-  console.warn('`stopUnreadSyncing` has been deprecated, please use `stopUnreadSync` instead');
-
-  return stopUnreadSync();
-};
-
 setIntervalTask(async () => {
   if (!isSyncRunning) return;
 

package/src/client/utils/subscribeGlobalTopic.ts

@@ -7,6 +7,7 @@ import {
   getSmartFeedSubChannelTopic,
   getUserTopic,
   subscribeTopic,
+  getLiveStreamTopic,
 } from '~/core/subscription';
 
 export const subscribeGlobalTopic = () => {
@@ -19,6 +20,8 @@ export const subscribeGlobalTopic = () => {
     // subscribing to user topic is necessary to handle ban event
     subscribeTopic(getUserTopic(getActiveUser())),
     subscribeTopic(getMarkerUserFeedTopic()),
+
+    subscribeTopic(getLiveStreamTopic()),
   ];
 
   return () => disposers.forEach(fn => fn());

package/src/commentRepository/observers/index.ts

@@ -1,4 +1,2 @@
-export * from './observeComments';
-export * from './observeComment';
 export * from './getComment';
 export * from './getComments';

package/src/communityRepository/api/index.ts

@@ -6,6 +6,3 @@ export * from './deleteCommunity';
 
 export * from './joinCommunity';
 export * from './leaveCommunity';
-
-// deprecated
-export * from './getTopTrendingCommunities';

package/src/communityRepository/api/queryCommunities.ts

@@ -30,7 +30,7 @@ export const queryCommunities = async (
 
   // safe decapsulation
   const { page, limit = 10, ...params } = query ?? {};
-  const { displayName, membership, includeDeleted, ...restParams } = params ?? {};
+  const { membership, includeDeleted, ...restParams } = params ?? {};
 
   const options = (() => {
     if (page) return { token: page };
@@ -48,7 +48,6 @@ export const queryCommunities = async (
       params: {
         ...restParams,
         isDeleted: inferIsDeleted(includeDeleted),
-        keyword: displayName,
         filter: membership,
         options,
       },

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersLiveCollectionController.ts

@@ -149,10 +149,6 @@ export class CommunityMembersLiveCollectionController extends LiveCollectionCont
       });
     }
 
-    if (this.query.search) {
-      communityMembers = filterBySearchTerm(communityMembers, this.query.search);
-    }
-
     if (this.query.includeDeleted === false) {
       communityMembers = communityMembers.filter(({ user }) => user?.isDeleted !== true);
     }
@@ -161,14 +157,6 @@ export class CommunityMembersLiveCollectionController extends LiveCollectionCont
       case 'firstCreated':
         communityMembers = communityMembers.sort(sortByFirstCreated);
         break;
-      case 'displayName':
-        communityMembers = communityMembers.sort((a, b) => {
-          if (a?.user?.displayName && b?.user?.displayName) {
-            return a?.user?.displayName.localeCompare(b?.user?.displayName);
-          }
-          return 0;
-        });
-        break;
       case 'lastCreated':
       default:
         communityMembers = communityMembers.sort(sortByLastCreated);

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersQueryStreamController.ts

@@ -76,13 +76,6 @@ export class CommunityMembersQueryStreamController extends QueryStreamController
       )?.data;
       if (!collection) return;
 
-      if (
-        action === EnumCommunityMemberActions.OnCommunityUserRoleAdded &&
-        this.query.sortBy === 'displayName'
-      ) {
-        return;
-      }
-
       communityMembers.forEach(communityMember => {
         const communityMemberCacheId = getResolver('communityUsers')({
           communityId: this.query.communityId,

package/src/communityRepository/communityMembership/observers/getMembers.ts

@@ -26,10 +26,6 @@ export const applyFilter = <T extends Amity.Membership<'community'>>(
     });
   }
 
-  if (params.search) {
-    communityMembers = filterBySearchTerm(communityMembers, params.search);
-  }
-
   const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
   communityMembers = communityMembers.sort(
     sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated,

package/src/communityRepository/communityMembership/observers/searchMembers/SearchCommunityMembersPaginationController.ts

@@ -7,7 +7,7 @@ import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
  */
 export class SearchCommunityMembersPaginationController extends PaginationController<
   'communityUser',
-  Amity.CommunityMemberLiveCollection
+  Amity.SearchCommunityMemberLiveCollection
 > {
   async getRequest(
     queryParams: Amity.SearchCommunityMemberLiveCollection,

package/src/communityRepository/communityMembership/observers/tests/getMembers.test.ts

@@ -238,7 +238,6 @@ describe('getMembers > applyFilter', () => {
       [m1, m2],
       [m2, m1],
     ],
-    ['it should filter by search term', { communityId, search: 'sea' }, [m1, m2], [m2]],
   ];
 
   test.each(filters)('%s', (test, param, input, expected) => {

package/src/communityRepository/observers/getCommunities/CommunitiesLiveCollectionController.ts

@@ -138,22 +138,18 @@ export class CommunityLiveCollectionController extends LiveCollectionController<
       communities = filterByCommunityMembership(communities, this.query.membership, userId);
     }
 
-    if (!this.query.displayName) {
-      const sortFn = (() => {
-        switch (this.query.sortBy) {
-          case 'firstCreated':
-            return sortByFirstCreated;
-          case 'lastCreated':
-            return sortByLastCreated;
-          case 'displayName':
-            return sortByDisplayName;
-          default:
-            return sortByLastCreated;
-        }
-      })();
-
-      communities = communities.sort(sortFn);
-    }
+    const sortFn = (() => {
+      switch (this.query.sortBy) {
+        case 'firstCreated':
+          return sortByFirstCreated;
+        case 'lastCreated':
+          return sortByLastCreated;
+        default:
+          return sortByLastCreated;
+      }
+    })();
+
+    communities = communities.sort(sortFn);
 
     return communities;
   }

package/src/communityRepository/observers/getCommunities/CommunitiesPaginationController.ts

@@ -20,7 +20,6 @@ export class CommunitiesPaginationController extends PaginationController<
         params: {
           ...params,
           isDeleted: inferIsDeleted(params.includeDeleted),
-          keyword: params.displayName,
           filter: params.membership,
           options,
         },

package/src/communityRepository/observers/getCommunities/CommunitiesQueryStreamController.ts

@@ -64,10 +64,6 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
       const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
       if (!collection) return;
 
-      if (this.query.displayName && action === EnumCommunityActions.OnCommunityCreated) {
-        return;
-      }
-
       /*
        * Simply update a collection and let responder decide what to do with data
        */

package/src/communityRepository/observers/index.ts

@@ -1,5 +1,3 @@
-export * from './observeCommunity';
-
 export * from './searchCommunities';
 export * from './getCommunities';
 export * from './getCommunity';

package/src/communityRepository/observers/searchCommunities.ts

@@ -25,7 +25,7 @@ import { SearchCommunityLiveCollectionController } from './searchCommunities/Sea
  * @category Community Live Collection
  */
 export const searchCommunities = (
-  params: Amity.CommunityLiveCollection,
+  params: Amity.SearchCommunityLiveCollection,
   callback: Amity.LiveCollectionCallback<Amity.Community>,
   config?: Amity.LiveCollectionConfig,
 ) => {

package/src/communityRepository/observers/tests/getCommunities.test.ts

@@ -87,7 +87,6 @@ describe('getCommunities', () => {
   const filters: [string, Amity.CommunityLiveCollection, Amity.Community[]][] = [
     ['not deleted', { includeDeleted: false }, [community2]],
     ['categoryId', { categoryId: 'test-category-id', includeDeleted: true }, [community1]],
-    ['displayName', { displayName: 'community 1', includeDeleted: true }, [community1]],
     ['tagged', { tags: ['test-community-tag'], includeDeleted: true }, [community1]],
   ];
 

package/src/communityRepository/utils/communityQueryFilter.ts

@@ -1,7 +1,6 @@
 import {
   filterByCommunityMembership,
   filterByPropEquality,
-  sortByDisplayName,
   sortByFirstCreated,
   sortByLastCreated,
 } from '~/core/query';
@@ -12,7 +11,6 @@ export const communityQueryFilter = (
   userId: string,
 ): Amity.Community[] => {
   let communities = data;
-  communities = filterByPropEquality(communities, 'displayName', params.displayName);
 
   if (!params.includeDeleted) {
     communities = filterByPropEquality(communities, 'isDeleted', false);
@@ -44,11 +42,6 @@ export const communityQueryFilter = (
    *
    * This section needs to be updated as displayNames can be null as well
    */
-  if (sortBy === 'displayName') {
-    communities = communities
-      // this needs to be aligned with the backend data type
-      .map(c => (c.displayName ? c : { ...c, displayName: '' }))
-      .sort(sortByDisplayName);
-  }
+
   return communities;
 };

package/src/core/events.ts

@@ -15,10 +15,6 @@ const WS_EVENTS = [
   'sessionStateChange',
   // for internal use by accessTokenExpiryWatcher
   'tokenExpired',
-
-  'v3.video-streaming.didRecord',
-  'v3.video-streaming.didStart',
-  'v3.video-streaming.didStop',
 ] as const;
 
 const MQTT_EVENTS = [
@@ -30,7 +26,13 @@ const MQTT_EVENTS = [
   'end',
   'reconnect',
 
-  'user.didGlobalBan',
+  'video-streaming.didStart',
+  'video-streaming.didRecord',
+  'video-streaming.didStop',
+  'video-streaming.didFlag',
+  'video-streaming.didTerminate',
+
+  // 'user.didGlobalBan' remove due to message event,
 ] as const;
 
 /** @hidden */

package/src/core/model/index.ts

@@ -1,6 +1,5 @@
 export * from './idResolvers';
 export * from './identifyModel';
-export * from './localReferenceId';
 
 /**
  * A map of v3 response keys to a store name.

package/src/core/subscription.ts

@@ -168,3 +168,9 @@ export function subscribeTopic(
 
   return mqtt.subscribe(topic, callback);
 }
+
+export const getLiveStreamTopic = (): string => {
+  const user = getActiveUser();
+
+  return `${getNetworkId(user)}/videostreaming`;
+};

package/src/feedRepository/api/getCustomRankingGlobalFeed.ts

@@ -1,6 +1,4 @@
 import { getActiveClient } from '~/client/api/activeClient';
-
-import { toPage, toToken } from '~/core/query';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
@@ -26,40 +24,18 @@ import { LinkedObject } from '~/utils/linkedObject';
  * */
 export const getCustomRankingGlobalFeed = async (query?: {
   dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
-  /**
-   * @deprecated please use queryToken to query next pages or previous pages
-   * The first page result includes previous token and next token in paging field
-   * use this token as the queryToken to query next pages or previous pages
-   *
-   */
-  page?: Amity.Page;
   limit?: number;
   queryToken?: string;
 }): Promise<
-  Omit<Amity.Cached<Amity.Paged<Amity.Post>> & Amity.Pagination, 'nextPage' | 'prevPage'> & {
-    /**
-     * @deprecated use `paging.next` value as queryToken instead
-     */
-    nextPage?: Amity.Page;
-    /**
-     * @deprecated use `paging.previous` value as queryToken instead
-     */
-    prevPage?: Amity.Page;
-  }
+  Omit<Amity.Cached<Amity.Paged<Amity.Post>> & Amity.Pagination, 'nextPage' | 'prevPage'>
 > => {
   const client = getActiveClient();
   client.log('feed/getCustomRankingGlobalFeed', query);
 
-  const { page, queryToken, limit, ...params } = query ?? {};
+  const { queryToken, limit, ...params } = query ?? {};
 
   const options = (() => {
     if (queryToken) return { token: queryToken };
-
-    if (page)
-      return {
-        token: toToken(page, 'skiplimit'),
-      };
-
     return undefined;
   })();
 
@@ -85,18 +61,11 @@ export const getCustomRankingGlobalFeed = async (query?: {
   if (client.cache) {
     ingestInCache(data);
 
-    const cacheKey = [
-      'customGlobalFeed',
-      'query',
-      { ...params, options: { ...page } } as Amity.Serializable,
-    ];
+    const cacheKey = ['customGlobalFeed', 'query', { ...params, options } as Amity.Serializable];
     pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
   }
 
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
-  return { data: posts.map(LinkedObject.post), cachedAt, prevPage, nextPage, paging };
+  return { data: posts.map(LinkedObject.post), cachedAt, paging };
 };
 /* end_public_function */
 
@@ -117,29 +86,16 @@ export const getCustomRankingGlobalFeed = async (query?: {
 getCustomRankingGlobalFeed.locally = (
   query?: Parameters<typeof getCustomRankingGlobalFeed>[0],
 ):
-  | (Omit<Amity.Cached<Amity.Paged<Amity.Post>> & Amity.Pagination, 'nextPage' | 'prevPage'> & {
-      /**
-       * @deprecated use `paging.next` value as queryToken instead
-       */
-      nextPage?: Amity.Page;
-      /**
-       * @deprecated use `paging.previous` value as queryToken instead
-       */
-      prevPage?: Amity.Page;
-    })
+  | Omit<Amity.Cached<Amity.Paged<Amity.Post>> & Amity.Pagination, 'nextPage' | 'prevPage'>
   | undefined => {
   const client = getActiveClient();
   client.log('post/getCustomRankingGlobalFeed.locally', query);
 
   if (!client.cache) return;
 
-  const { page, ...params } = query ?? {};
+  const { ...params } = query ?? {};
 
-  const queryKey = [
-    'customGlobalFeed',
-    'query',
-    { ...params, options: { ...page } } as Amity.Serializable,
-  ];
+  const queryKey = ['customGlobalFeed', 'query', { ...params } as Amity.Serializable];
 
   const { data, cachedAt } =
     pullFromCache<{ posts: Amity.Post['postId'][] } & Amity.Pagination>(queryKey) ?? {};
@@ -151,12 +107,9 @@ getCustomRankingGlobalFeed.locally = (
     .filter(Boolean)
     .map(({ data }) => data);
 
-  const prevPage = toPage(data?.paging.previous);
-  const nextPage = toPage(data?.paging.next);
-
   const { paging } = data;
 
   return posts.length === data?.posts?.length
-    ? { data: posts.map(LinkedObject.post), cachedAt, prevPage, nextPage, paging }
+    ? { data: posts.map(LinkedObject.post), cachedAt, paging }
     : undefined;
 };

package/src/feedRepository/api/queryGlobalFeed.ts

@@ -1,6 +1,5 @@
 import { getActiveClient } from '~/client/api/activeClient';
 
-import { toPage, toToken } from '~/core/query';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
@@ -28,39 +27,15 @@ import { prepareCommunityPayload } from '~/communityRepository/utils';
 export const queryGlobalFeed = async (
   query?: Amity.QueryGlobalFeed,
 ): Promise<
-  Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'> & {
-    /**
-     * @deprecated use `paging.next` value as queryToken instead
-     */
-    nextPage?: Amity.Page;
-    /**
-     * @deprecated use `paging.previous` value as queryToken instead
-     */
-    prevPage?: Amity.Page;
-  }
+  Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'>
 > => {
   const client = getActiveClient();
   client.log('feed/queryGlobalFeed', query);
 
-  const { useCustomRanking, page, queryToken, ...params } = query ?? {};
-
-  /*
-   * TODO: Remove useCustomRanking key from query
-   */
-  if (useCustomRanking)
-    console.warn(
-      'The param "useCustomRanking" has been deprecated. To get custom ranking feed use FeedRepository.getCustomRankingGlobalFeed instead',
-    );
-
-  if (page) console.warn('The param "page" has been deprecated. Please use "queryToken" instead.');
+  const { queryToken, ...params } = query ?? {};
 
   const options = (() => {
     if (queryToken) return { token: queryToken };
-    if (page)
-      return {
-        token: toToken(page, 'skiplimit'),
-      };
-
     return undefined;
   })();
 
@@ -87,22 +62,13 @@ export const queryGlobalFeed = async (
   if (client.cache) {
     ingestInCache({ ...data, communitis: processedCommunity });
 
-    const cacheKey = [
-      'globalFeed',
-      'query',
-      { ...params, options: { ...page } } as Amity.Serializable,
-    ];
+    const cacheKey = ['globalFeed', 'query', { ...params, options } as Amity.Serializable];
     pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging });
   }
 
-  const nextPage = toPage(paging.next);
-  const prevPage = toPage(paging.previous);
-
   return {
     data: posts.map(LinkedObject.post),
     cachedAt,
-    prevPage,
-    nextPage,
     paging,
   };
 };
@@ -125,29 +91,16 @@ export const queryGlobalFeed = async (
 queryGlobalFeed.locally = (
   query?: Parameters<typeof queryGlobalFeed>[0],
 ):
-  | (Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'> & {
-      /**
-       * @deprecated use `paging.next` value as queryToken instead
-       */
-      nextPage?: Amity.Page;
-      /**
-       * @deprecated use `paging.previous` value as queryToken instead
-       */
-      prevPage?: Amity.Page;
-    })
+  | Omit<Amity.Cached<Amity.Paged<Amity.Post> & Amity.Pagination>, 'nextPage' | 'prevPage'>
   | undefined => {
   const client = getActiveClient();
   client.log('post/queryGlobalFeed.locally', query);
 
   if (!client.cache) return;
 
-  const { page, ...params } = query ?? {};
+  const { ...params } = query ?? {};
 
-  const queryKey = [
-    'globalFeed',
-    'query',
-    { ...params, options: { ...page } } as Amity.Serializable,
-  ];
+  const queryKey = ['globalFeed', 'query', { ...params } as Amity.Serializable];
   const { data, cachedAt } =
     pullFromCache<{ posts: Amity.Post['postId'][] } & Amity.Pagination>(queryKey) ?? {};
 
@@ -161,15 +114,10 @@ queryGlobalFeed.locally = (
 
   const { paging } = data;
 
-  const prevPage = toPage(data?.paging.previous);
-  const nextPage = toPage(data?.paging.next);
-
   return posts.length === data?.posts?.length
     ? {
         data: posts,
         cachedAt,
-        prevPage,
-        nextPage,
         paging,
       }
     : undefined;

package/src/feedRepository/api/test/getCustomRankingGlobalFeed.test.ts

@@ -13,7 +13,7 @@ const postsToQuery = [post11, post12];
 const postIdsToQuery = postsToQuery.map(post => post.postId);
 const pagingCriteria = { limit: 10 };
 const queryCriteriaWithoutPage = {};
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
+const queryCriteria = { ...queryCriteriaWithoutPage };
 
 const resolvedQueryFeedValue = {
   data: {

package/src/feedRepository/api/test/queryGlobalFeed.test.ts

@@ -13,7 +13,7 @@ const postsToQuery = [post11, post12];
 const postIdsToQuery = postsToQuery.map(post => post.postId);
 const pagingCriteria = { limit: 10 };
 const queryCriteriaWithoutPage = {};
-const queryCriteria = { ...queryCriteriaWithoutPage, page: pagingCriteria };
+const queryCriteria = { ...queryCriteriaWithoutPage };
 
 const resolvedQueryFeedValue = {
   data: {

package/src/fileRepository/api/index.ts

@@ -4,8 +4,3 @@ export * from './deleteFile';
 export * from './fileUrlWithSize';
 export * from './uploadVideo';
 export * from './uploadImage';
-
-// deprecated
-export * from './createImage';
-export * from './createFile';
-export * from './createVideo';