@amityco/ts-sdk 6.26.3 → 6.27.1-061592b.0

package/src/analytic/service/analytic/AnalyticsEventCapturer.ts

@@ -21,19 +21,19 @@ export class AnalyticsEventCapturer {
   _bufferNewSeenStoryReferenceIds: Amity.Story['referenceId'][] = [];
 
   isAbleToEnqueue({
-    itemId,
+    uniqueId,
     expireTime,
     isHighPriority = false,
   }: {
-    itemId: Amity.Post['postId'] | Amity.Story['storyId'];
+    uniqueId: string;
     expireTime: number;
     isHighPriority?: boolean;
   }) {
     const now = new Date();
 
     const getRecentViewedDate = () => {
-      if (isHighPriority) return this._recentHighPriorityViewed[itemId];
-      return this._recentViewed[itemId];
+      if (isHighPriority) return this._recentHighPriorityViewed[uniqueId];
+      return this._recentViewed[uniqueId];
     };
 
     const recentViewedDate = getRecentViewedDate() || new Date(DAY * -1);
@@ -48,13 +48,20 @@ export class AnalyticsEventCapturer {
     return true;
   }
 
-  markAs(
-    itemId: string,
-    contentType: Amity.AnalyticEventContentType,
-    activityType: Amity.AnalyticEventActivityType,
-    metadata: Record<string, string> | undefined = undefined,
-  ) {
-    if (!this.isAbleToEnqueue({ itemId, expireTime: this._expireTime })) return;
+  markAs({
+    uniqueId,
+    contentId,
+    contentType,
+    activityType,
+    metadata,
+  }: {
+    uniqueId: string;
+    contentId: string;
+    contentType: Amity.AnalyticEventContentType;
+    activityType: Amity.AnalyticEventActivityType;
+    metadata?: Record<string, string>;
+  }) {
+    if (!this.isAbleToEnqueue({ uniqueId, expireTime: this._expireTime })) return;
 
     const now = new Date();
 
@@ -72,7 +79,7 @@ export class AnalyticsEventCapturer {
     }
 
     const analyticItem: Amity.AnalyticEventModel = {
-      contentId: itemId,
+      contentId,
       contentType,
       activityType,
       timestamp: now.toISOString(),
@@ -85,11 +92,16 @@ export class AnalyticsEventCapturer {
     currentData.event.push(analyticItem);
 
     upsertInCache(ANALYTIC_CACHE_KEY, currentData);
-    this._recentViewed[itemId] = now;
+    this._recentViewed[uniqueId] = now;
   }
 
   markPostAsViewed(postId: Amity.InternalPost['postId']) {
-    this.markAs(postId, Amity.AnalyticEventContentType.Post, Amity.AnalyticEventActivityType.View);
+    this.markAs({
+      uniqueId: postId,
+      contentId: postId,
+      contentType: Amity.AnalyticEventContentType.Post,
+      activityType: Amity.AnalyticEventActivityType.View,
+    });
   }
 
   markStory(story: Amity.InternalStory, activityType: Amity.AnalyticEventActivityType) {
@@ -99,7 +111,7 @@ export class AnalyticsEventCapturer {
 
     if (
       !this.isAbleToEnqueue({
-        itemId: story.storyId,
+        uniqueId: story.storyId,
         expireTime: expireTime.getTime(),
         isHighPriority: true,
       })
@@ -179,29 +191,35 @@ export class AnalyticsEventCapturer {
     this.markStory(story, Amity.AnalyticEventActivityType.Click);
   }
 
-  markAdAsViewed(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+  markAdAsViewed(ad: Amity.InternalAd, placement: Amity.AdPlacement) {
     const metadata = {
       placement,
     };
 
-    this.markAs(
-      `${ad.adId}.${Amity.AnalyticEventActivityType.View}.${placement}`,
-      Amity.AnalyticEventContentType.Ad,
-      Amity.AnalyticEventActivityType.View,
+    const activityType = Amity.AnalyticEventActivityType.View;
+
+    this.markAs({
+      uniqueId: `${ad.adId}.${activityType}.${placement}`,
+      contentId: ad.adId,
+      contentType: Amity.AnalyticEventContentType.Ad,
+      activityType,
       metadata,
-    );
+    });
   }
 
-  markAdAsClicked(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+  markAdAsClicked(ad: Amity.InternalAd, placement: Amity.AdPlacement) {
     const metadata = {
       placement,
     };
 
-    this.markAs(
-      `${ad.adId}.${Amity.AnalyticEventActivityType.View}.${placement}`,
-      Amity.AnalyticEventContentType.Ad,
-      Amity.AnalyticEventActivityType.Click,
+    const activityType = Amity.AnalyticEventActivityType.Click;
+
+    this.markAs({
+      uniqueId: `${ad.adId}.${activityType}.${placement}`,
+      contentId: ad.adId,
+      contentType: Amity.AnalyticEventContentType.Ad,
+      activityType,
       metadata,
-    );
+    });
   }
 }

package/src/client/api/getToken.ts

@@ -14,11 +14,17 @@ import { getDeviceInfo } from '~/core/device';
  * @category Client API
  * @hidden
  */
-export const getToken = async (params: {
-  userId: Amity.InternalUser['userId'];
-  displayName?: Amity.InternalUser['displayName'];
-  authToken?: string;
-  deviceId: Amity.Device['deviceId'];
+export const getToken = async ({
+  params,
+  options,
+}: {
+  params: {
+    userId: Amity.InternalUser['userId'];
+    displayName?: Amity.InternalUser['displayName'];
+    authToken?: string;
+    deviceId: Amity.Device['deviceId'];
+  };
+  options?: { setAccessTokenCookie?: boolean };
 }) => {
   const client = getActiveClient();
   client.log('client/api/getToken', params);
@@ -32,8 +38,10 @@ export const getToken = async (params: {
       deviceInfo,
     },
     {
-      // @ts-ignore
-      headers: { 'X-API-Key': client.apiKey },
+      headers: {
+        'X-API-Key': client.apiKey,
+        'set-access-token-cookie': options?.setAccessTokenCookie || false,
+      },
     },
   );
 

package/src/client/api/index.ts

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

package/src/client/api/login.ts

@@ -18,8 +18,6 @@ import { getActiveClient } from './activeClient';
 import { terminateClient } from './terminateClient';
 import { setActiveUser } from './activeUser';
 
-import { setSessionState } from './setSessionState';
-
 import { onClientBanned } from '../events';
 import { onTokenExpired } from '../events/onTokenExpired';
 import { onTokenTerminated } from '../events/onTokenTerminated';
@@ -29,6 +27,7 @@ import { removeChannelMarkerCache } from '../utils/removeChannelMarkerCache';
 import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
 import { startMarkerSync } from '../utils/markerSyncEngine';
 import { ASCError } from '~/core/errors';
+import SessionWatcher from '../utils/SessionWatcher';
 
 /*
  * declared earlier to accomodate case when logging in with a different user
@@ -92,9 +91,14 @@ export const login = async (
 
   try {
     const { users } = await setClientToken({
-      ...params,
-      displayName: params?.displayName,
-      deviceId: params?.deviceId || defaultDeviceId,
+      params: {
+        ...params,
+        displayName: params?.displayName,
+        deviceId: params?.deviceId || defaultDeviceId,
+      },
+      options: {
+        setAccessTokenCookie: true,
+      },
     });
 
     const user = users.find(u => u.userId === params.userId);
@@ -139,7 +143,7 @@ export const login = async (
      * if getting token failed session state reverts to initial state when app
      * is first launched
      */
-    setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+    SessionWatcher.getInstance().setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
 
     // pass error down tree so the calling function handle it
     throw error;
@@ -181,7 +185,7 @@ export const login = async (
       }),
 
       onTokenExpired(state => {
-        setSessionState(state);
+        SessionWatcher.getInstance().setSessionState(state);
 
         logout();
 

package/src/client/api/logout.ts

@@ -60,6 +60,10 @@ export const logout = async (): Promise<boolean> => {
   };
   client.ws.io.opts.query = { token: '' };
 
+  if (typeof document !== 'undefined') {
+    document.cookie = '_ascSession=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;';
+  }
+
   /*
    * Cache should be usable if tokenExpired
    * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#SDK-usability-based-on-Session-State

package/src/client/api/renewal.ts

@@ -40,7 +40,12 @@ export const renewal = (): Amity.AccessTokenRenewal => {
     } else {
       // about to expire
 
-      await refreshToken(params);
+      await refreshToken({
+        params,
+        options: {
+          setAccessTokenCookie: true,
+        },
+      });
     }
 
     tokenRenewed = true;

package/src/client/api/setUploadedFileAccessType.ts

@@ -0,0 +1,5 @@
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
+
+export function setUploadedFileAccessType(accessType: Amity.FileAccessType) {
+  GlobalFileAccessType.getInstance().setFileAccessType(accessType);
+}

package/src/client/api/tests/getToken.test.ts

@@ -13,7 +13,7 @@ describe('getToken', () => {
     const mockApi = jest.fn().mockResolvedValue(sessionResponse);
     client.http.post = mockApi;
 
-    await getToken(params);
+    await getToken({ params });
     const [recieved] = mockApi.mock.lastCall;
 
     expect(recieved).toBe(expected);
@@ -23,7 +23,7 @@ describe('getToken', () => {
     const expected = sessionResponse.data;
     client.http.post = jest.fn().mockResolvedValue(sessionResponse);
 
-    const recieved = await getToken(params);
+    const recieved = await getToken({ params });
 
     expect(recieved).toStrictEqual(expected);
   });
@@ -31,6 +31,6 @@ describe('getToken', () => {
   test('it should throw error', async () => {
     client.http.post = jest.fn().mockRejectedValue(new Error('error'));
 
-    await expect(getToken(params)).rejects.toThrow();
+    await expect(getToken({ params })).rejects.toThrow();
   });
 });

package/src/client/events/index.ts

@@ -4,3 +4,5 @@ export * from './onClientDisconnected';
 export * from './onClientBanned';
 
 export * from './onSessionStateChange';
+
+export * from './onNetworkActivities';

package/src/client/events/onNetworkActivities.ts

@@ -0,0 +1,14 @@
+import NetworkActivitiesWatcher from '~/client/utils/NetworkActivitiesWatcher';
+
+/**
+ *
+ * Fired when any {@link Amity.Client} has a session state change
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Client Events
+ */
+export const onNetworkActivities = (
+  callback: (request: Request, response: Response) => void,
+): Amity.Unsubscriber => NetworkActivitiesWatcher.getInstance().onNetworkActivities(callback);

package/src/client/utils/GlobalFileAccessType.ts

@@ -0,0 +1,23 @@
+import { FileAccessTypeEnum } from '~/@types';
+
+export class GlobalFileAccessType {
+  #fileAccessType: Amity.FileAccessType = FileAccessTypeEnum.PUBLIC;
+
+  public setFileAccessType(fileAccessType: Amity.FileAccessType) {
+    this.#fileAccessType = fileAccessType;
+  }
+
+  public getFileAccessType() {
+    return this.#fileAccessType;
+  }
+}
+
+let instance: GlobalFileAccessType;
+export default {
+  getInstance: () => {
+    if (!instance) {
+      instance = new GlobalFileAccessType();
+    }
+    return instance;
+  },
+};

package/src/client/utils/NetworkActivitiesWatcher.ts

@@ -0,0 +1,31 @@
+type NetworkActivitiesCallback = (request: Request, response: Response) => void;
+
+class NetworkActivitiesWatcher {
+  private _listener = new Map<NetworkActivitiesCallback, NetworkActivitiesCallback>();
+
+  onNetworkActivities(callback: NetworkActivitiesCallback) {
+    this._listener.set(callback, callback);
+    return () => {
+      this._listener.delete(callback);
+    };
+  }
+
+  setNetworkActivities(request: Request, response: Response) {
+    this._listener.forEach(cb => cb(request, response));
+  }
+
+  destroy() {
+    this._listener.clear();
+  }
+}
+
+let instance: NetworkActivitiesWatcher;
+
+export default {
+  getInstance: () => {
+    if (!instance) {
+      instance = new NetworkActivitiesWatcher();
+    }
+    return instance;
+  },
+};

package/src/commentRepository/observers/getComments.ts

@@ -28,7 +28,7 @@ import { CommentLiveCollectionController } from './getComments/CommentLiveCollec
  */
 export const getComments = (
   params: Amity.CommentLiveCollection,
-  callback: Amity.LiveCollectionCallback<Amity.InternalComment>,
+  callback: Amity.LiveCollectionCallback<Amity.Comment>,
   config?: Amity.LiveCollectionConfig,
 ): Amity.Unsubscriber => {
   const { log, cache } = getActiveClient();

package/src/communityRepository/utils/payload.ts

@@ -30,9 +30,13 @@ const convertCommunityUsersToUniqueObject = (
   return result;
 };
 
-export const prepareCommunityPayload = (
-  rawPayload: Amity.CommunityPayload,
-): Amity.ProcessedCommunityPayload => {
+export const convertCommunityPayload = (rawPayload: {
+  communities: Amity.RawCommunity[];
+  communityUsers: Amity.RawMembership<'community'>[];
+}): {
+  communities: Amity.Community[];
+  communityUsers: Amity.Membership<'community'>[];
+} => {
   // Unpack community payload by mapping payload field to postSetting value.
   const communities = rawPayload.communities.map<Amity.Community>(
     ({ needApprovalOnPostCreation, onlyAdminCanPost, ...restCommunityPayload }) => ({
@@ -72,6 +76,18 @@ export const prepareCommunityPayload = (
   };
 };
 
+export const prepareCommunityPayload = (
+  rawPayload: Amity.CommunityPayload,
+): Amity.ProcessedCommunityPayload => {
+  const { communities, communityUsers } = convertCommunityPayload(rawPayload);
+
+  return {
+    ...rawPayload,
+    communities,
+    communityUsers,
+  };
+};
+
 export const prepareCommunityRequest = <
   T extends {
     postSetting?: Amity.Community['postSetting'];

package/src/core/model/idResolvers.ts

@@ -18,7 +18,7 @@ const idResolvers: Resolvers = {
   channel: ({ channelInternalId }) => channelInternalId,
   subChannel: ({ subChannelId }) => subChannelId,
   channelUsers: ({ channelId, userId }) => `${channelId}#${userId}`,
-  message: ({ messageId }) => messageId,
+  message: ({ messageId, referenceId }) => referenceId ?? messageId,
 
   messagePreviewChannel: ({ channelId }) => `${channelId}`,
   messagePreviewSubChannel: ({ subChannelId }) => `${subChannelId}`,

package/src/core/transports/http.ts

@@ -5,6 +5,7 @@ import { ASCError } from '~/core/errors';
 
 import { fireEvent } from '../events';
 import { unwrapPayload } from './utils';
+import NetworkActivitiesWatcher from '~/client/utils/NetworkActivitiesWatcher';
 
 /*
  * Defined here as transport is a private module. Also, outside of this module
@@ -131,7 +132,30 @@ export const createHttpTransport = (endpoint: string) => {
   });
 
   instance.interceptors.response.use(
-    response => response,
+    response => {
+      const headers = new Headers();
+
+      Object.entries(response.headers).forEach(([key, value]) => {
+        if (typeof value === 'string') {
+          headers.append(key, value);
+        }
+      });
+
+      NetworkActivitiesWatcher.getInstance().setNetworkActivities(
+        new Request(response.request.url, {
+          method: response.request.method,
+          headers: response.request.headers,
+          body: response.request.data,
+        }),
+        new Response(response.data, {
+          status: response.status,
+          statusText: response.statusText,
+          headers,
+        }),
+      );
+
+      return response;
+    },
     error => {
       const { response } = error;
 

package/src/fileRepository/api/createFile.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /**
  * ```js
@@ -28,6 +29,9 @@ export const createFile = async <T extends Amity.FileType = any>(
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   const headers =

package/src/fileRepository/api/createImage.ts

@@ -1,5 +1,6 @@
 import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /**
  * ```js
@@ -27,6 +28,9 @@ export const createImage = async (
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   const headers =

package/src/fileRepository/api/createVideo.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /**
  * ```js
@@ -30,6 +31,9 @@ export const createVideo = async (
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   if (feedType) {

package/src/fileRepository/api/uploadFile.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /* begin_public_function
   id: file.upload.file
@@ -31,6 +32,9 @@ export const uploadFile = async <T extends Amity.FileType = any>(
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   const headers =

package/src/fileRepository/api/uploadImage.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /* begin_public_function
   id: file.upload.image
@@ -31,6 +32,9 @@ export const uploadImage = async (
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   const headers =

package/src/fileRepository/api/uploadVideo.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
 
 /* begin_public_function
   id: file.upload.video, file.upload.audio
@@ -33,6 +34,9 @@ export const uploadVideo = async (
 
   if (!files.length) throw new Error('The formData object must have a `files` key.');
 
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
   formData.append('preferredFilename', (files[0] as File).name);
 
   if (feedType) {