@amityco/ts-sdk 0.0.1-beta.40 → 0.0.1-beta.42.1

package/src/core/model/index.ts

@@ -33,8 +33,17 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
 };
 
 /** hidden */
-export const hasUpdates = (prevData: Amity.UpdatedAt, nextData: Amity.UpdatedAt): boolean => {
-  return new Date(prevData.updatedAt!) < new Date(nextData.updatedAt!);
+export const hasUpdates = <T extends Amity.Model>(prevData: T, nextData: T): boolean => {
+  if ('updatedAt' in prevData && 'updatedAt' in nextData) {
+    return new Date(prevData.updatedAt!) < new Date(nextData.updatedAt!);
+  }
+
+  /*
+   * hasUpdates is used to identify the latest object among many. If the object
+   * does not extend ${Amity.UpdatedAt}, then there is no way to differentiate.
+   * So it is considered by default that the object hasUpdates
+   */
+  return true;
 };
 
 /** hidden */

package/src/core/transports/http.ts

@@ -38,6 +38,11 @@ export const createHttpTransport = (endpoint: string) => {
   });
 
   instance.interceptors.request.use(config => {
+    // do not check expiration for token creation url
+    if (config.url === '/api/v4/sessions') {
+      return config;
+    }
+
     // check global.ts for the extension of AxiosRequestConfig
     const tokenExpiry = config.metadata?.tokenExpiry;
 

package/src/core/transports/test/http.test.ts

@@ -3,6 +3,7 @@ import nock from 'nock';
 import { ASCApiError, ASCUnknownError } from '~/core/errors';
 import { createFileFormData } from '~/utils/tests';
 
+import { getPastDate } from '~/core/model';
 import { createHttpTransport } from '../http';
 
 const baseUrl = 'https://non-exist.domain';
@@ -68,5 +69,16 @@ describe('core/transports', () => {
 
       await expect(instance.post('/foo', formData)).resolves.not.toThrow();
     });
+
+    test('should not check token expiration for token creation url', async () => {
+      const expectedResolveValue = { foo: 'bar' };
+      nock(baseUrl).get('/api/v4/sessions').reply(200, expectedResolveValue);
+
+      const instance = createHttpTransport(baseUrl);
+      instance.defaults.metadata = { tokenExpiry: getPastDate() };
+
+      const expected = expect.objectContaining({ data: expectedResolveValue });
+      await expect(instance.get('/api/v4/sessions')).resolves.toEqual(expected);
+    });
   });
 });

package/src/feed/api/queryGlobalFeed.ts

@@ -6,6 +6,9 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: feed.query.global_feed
+*/
 /**
  * ```js
  * import { queryGlobalFeed } from '@amityco/ts-sdk'
@@ -66,6 +69,7 @@ export const queryGlobalFeed = async (query?: {
 
   return { data: posts, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/file/api/createFile.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: file.upload.file
+*/
 /**
  * ```js
  * import { createFile } from '@amityco/ts-sdk'
@@ -50,5 +53,6 @@ export const createFile = async <T extends Amity.FileType = any>(
     cachedAt,
   };
 };
+/* end_public_function */
 
 // TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/createImage.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: file.upload.image
+*/
 /**
  * ```js
  * import { createImage } from '@amityco/ts-sdk'
@@ -54,5 +57,6 @@ export const createImage = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 // TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/createVideo.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: file.upload.video
+*/
 /**
  * ```js
  * import { createVideo } from '@amityco/ts-sdk'
@@ -60,5 +63,6 @@ export const createVideo = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 // TODO: consider doing local creation with URL.createObjectURL()

package/src/file/api/deleteFile.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 
 import { dropFromCache } from '~/cache/api';
 
+/* begin_public_function
+  id: file.delete
+*/
 /**
  * ```js
  * import { deleteFile } from '@amityco/ts-sdk'
@@ -29,3 +32,4 @@ export const deleteFile = async (
 
   return { success: true };
 };
+/* end_public_function */

package/src/file/api/getFile.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
+/* begin_public_function
+  id: file.get
+*/
 /**
  * ```js
  * import { getFile } from '@amityco/ts-sdk'
@@ -36,6 +39,7 @@ export const getFile = async <T extends Amity.FileType = any>(
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/follow/api/acceptFollower.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: user.relationship.accept_follow
+*/
 /**
  * ```js
  * import { acceptFollower } from '@amityco/ts-sdk'
@@ -32,3 +35,4 @@ export const acceptFollower = async (userId: Amity.User['userId']): Promise<bool
 
   return true;
 };
+/* end_public_function */

package/src/follow/api/declineFollower.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: user.relationship.decline_follow
+*/
 /**
  * ```js
  * import { declineFollower } from '@amityco/ts-sdk'
@@ -32,3 +35,4 @@ export const declineFollower = async (userId: Amity.User['userId']): Promise<boo
 
   return true;
 };
+/* end_public_function */

package/src/follow/api/follow.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: user.relationship.follow
+*/
 /**
  * ```js
  * import { follow } from '@amityco/ts-sdk'
@@ -39,3 +42,4 @@ export const follow = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/follow/api/getFollowInfo.ts

@@ -1,12 +1,9 @@
 import { getActiveClient } from '~/client/api';
 import { pullFromCache, pushToCache } from '~/cache/api';
 
-const getCacheKey = (userId: Amity.User['userId']) => [
-  'followInfo',
-  'get',
-  `${getActiveClient().userId}#${userId}`,
-];
-
+/* begin_public_function
+  id: user.relationship.get_follow_info, user.relationship.get_my_follow_info
+*/
 /**
  * ```js
  * import { getFollowInfo } from '@amityco/ts-sdk'
@@ -41,7 +38,9 @@ export const getFollowInfo = async (
       : data.followCounts[0];
 
   if (client.cache) {
-    pushToCache(getCacheKey(userId), followInfo, { cachedAt });
+    pushToCache(['followInfo', 'get', userId], followInfo, {
+      cachedAt,
+    });
   }
 
   return {
@@ -49,6 +48,7 @@ export const getFollowInfo = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js
@@ -73,7 +73,7 @@ getFollowInfo.locally = (
     return;
   }
 
-  const cached = pullFromCache<Amity.FollowInfo>(getCacheKey(userId));
+  const cached = pullFromCache<Amity.FollowInfo>(['followInfo', 'get', userId]);
 
   if (!cached) {
     return;

package/src/follow/api/queryFollowers.ts

@@ -1,5 +1,8 @@
 import { queryFollows } from './utils';
 
+/* begin_public_function
+  id: user.relationship.query_my_followers, user.relationship.query_followers
+*/
 /**
  * ```js
  * import { queryFollowers } from '@amityco/ts-sdk'
@@ -18,6 +21,7 @@ export const queryFollowers = async (
   query: Amity.QueryFollowers,
 ): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>> =>
   queryFollows('followers', query);
+/* end_public_function */
 
 /**
  * ```js

package/src/follow/api/queryFollowings.ts

@@ -1,5 +1,8 @@
 import { queryFollows } from './utils';
 
+/* begin_public_function
+  id: user.relationship.query_my_followings, user.relationship.query_followings
+*/
 /**
  * ```js
  * import { queryFollowings } from '@amityco/ts-sdk'
@@ -18,6 +21,7 @@ export const queryFollowings = async (
   query: Amity.QueryFollowings,
 ): Promise<Amity.Cached<Amity.Paged<Amity.FollowStatus, Amity.PageRaw>>> =>
   queryFollows('following', query);
+/* end_public_function */
 
 /**
  * ```js

package/src/follow/api/unfollow.ts

@@ -2,6 +2,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: user.relationship.unfollow
+*/
 /**
  * ```js
  * import { unfollow } from '@amityco/ts-sdk'
@@ -32,3 +35,4 @@ export const unfollow = async (userId: Amity.User['userId']): Promise<boolean> =
 
   return true;
 };
+/* end_public_function */

package/src/follow/observers/index.ts

@@ -4,3 +4,4 @@ export * from './observeFollowings';
 
 export * from './liveFollowers';
 export * from './liveFollowings';
+export * from './liveFollowInfo';

package/src/follow/observers/liveFollowInfo.ts

@@ -0,0 +1,29 @@
+import { liveObject } from '~/utils/liveObject';
+import { getFollowInfo } from '../api';
+import { onFollowInfoUpdated } from '../events';
+
+/**
+ * ```js
+ * import { liveFollowInfo } from '@amityco/ts-sdk';
+ *
+ * let followInfo;
+ *
+ * const unsubscribe = liveFollowInfo(userId, response => {
+ *   followInfo = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.FollowCount} object
+ *
+ * @param userId the ID of the current user
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing
+ *
+ * @category FollowInfo Live Object
+ */
+export const liveFollowInfo = (
+  userId: Amity.FollowInfo['userId'],
+  callback: Amity.LiveObjectCallback<Amity.FollowInfo>,
+): Amity.Unsubscriber => {
+  return liveObject(userId, callback, 'userId', getFollowInfo, [onFollowInfoUpdated]);
+};

package/src/follow/observers/tests/liveFollowInfo.test.ts

@@ -0,0 +1,198 @@
+import { disableCache, enableCache } from '~/cache/api';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  follow21,
+  follow11,
+  user11,
+  pause,
+  date,
+} from '~/utils/tests';
+
+import { liveFollowInfo } from '../liveFollowInfo';
+
+const FOLLOWING_COUNT = 2;
+const getFollowInfoMePayload = ({
+  userId = user11.userId,
+  followerCount = 0,
+  pendingCount = 0,
+  followingCount = FOLLOWING_COUNT,
+} = {}): Amity.FollowInfoMePayload => {
+  return {
+    followCounts: [
+      {
+        userId,
+        followerCount,
+        pendingCount,
+        followingCount,
+      },
+    ],
+  };
+};
+
+const getFollowMeStatusPayload = (
+  status: Amity.FollowStatus['status'] = follow11.status,
+): Amity.FollowStatusPayload => {
+  return {
+    follows: [
+      {
+        from: follow11.from,
+        to: follow11.to,
+        status,
+        createdAt: date,
+        updatedAt: date,
+      },
+    ],
+  };
+};
+
+const getFollowStatusPayload = (
+  status: Amity.FollowStatus['status'] = follow21.status,
+): Amity.FollowStatusPayload => {
+  return {
+    follows: [
+      {
+        from: follow21.from,
+        to: follow21.to,
+        status,
+        createdAt: date,
+        updatedAt: date,
+      },
+    ],
+  };
+};
+
+describe('liveFollowInfo > me', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  const tests: [
+    string,
+    keyof Amity.MqttFollowEvents,
+    Amity.FollowStatusPayload,
+    Amity.FollowInfoMePayload,
+  ][] = [
+    [
+      'it should update follow info collection on accepted',
+      'follow.accepted',
+      getFollowMeStatusPayload('accepted'),
+      getFollowInfoMePayload({ userId: user11.userId, followingCount: FOLLOWING_COUNT + 1 }),
+    ],
+    [
+      'it should update follow info collection on unfollowed',
+      'follow.unfollowed',
+      getFollowMeStatusPayload('none'),
+      getFollowInfoMePayload({ userId: user11.userId, followingCount: FOLLOWING_COUNT - 1 }),
+    ],
+    [
+      'it should update follow info collection on requestDeclined',
+      'follow.requestDeclined',
+      getFollowMeStatusPayload('none'),
+      getFollowInfoMePayload({ userId: user11.userId, followingCount: FOLLOWING_COUNT }),
+    ],
+    [
+      'it should update follow info collection on followerDeleted',
+      'follow.followerDeleted',
+      getFollowMeStatusPayload('none'),
+      getFollowInfoMePayload({ userId: user11.userId, followingCount: FOLLOWING_COUNT - 1 }),
+    ],
+  ];
+
+  test.each(tests)('%s', async (description, event, payload, payloadFrom) => {
+    const callback = jest.fn();
+    client.http.get = jest
+      .fn()
+      .mockResolvedValue({ data: getFollowInfoMePayload() })
+      .mockResolvedValueOnce({ data: payloadFrom })
+      .mockResolvedValueOnce({ data: payloadFrom });
+
+    const unsub = liveFollowInfo(user11.userId, callback);
+    await pause();
+
+    client.emitter.emit(event, payload);
+    await pause();
+
+    expect(callback).toHaveBeenCalled();
+
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: payloadFrom.followCounts[0],
+        loading: false,
+      }),
+    );
+
+    unsub();
+  });
+});
+
+describe('liveFollowInfo > other', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  const tests: [
+    string,
+    keyof Amity.MqttFollowEvents,
+    Amity.FollowStatusPayload,
+    Amity.FollowInfoMePayload,
+  ][] = [
+    [
+      'it should update follow info collection on accepted',
+      'follow.accepted',
+      getFollowStatusPayload('accepted'),
+      getFollowInfoMePayload({ userId: follow21.from, followingCount: FOLLOWING_COUNT + 1 }),
+    ],
+    [
+      'it should update follow info collection on unfollowed',
+      'follow.unfollowed',
+      getFollowStatusPayload('none'),
+      getFollowInfoMePayload({ userId: follow21.from, followingCount: FOLLOWING_COUNT - 1 }),
+    ],
+    [
+      'it should update follow info collection on requestDeclined',
+      'follow.requestDeclined',
+      getFollowStatusPayload('none'),
+      getFollowInfoMePayload({ userId: follow21.from, followingCount: FOLLOWING_COUNT }),
+    ],
+    [
+      'it should update follow info collection on followerDeleted',
+      'follow.followerDeleted',
+      getFollowStatusPayload('none'),
+      getFollowInfoMePayload({ userId: follow21.from, followingCount: FOLLOWING_COUNT - 1 }),
+    ],
+  ];
+
+  test.each(tests)('%s', async (description, event, payload, payloadFrom) => {
+    const callback = jest.fn();
+    client.http.get = jest
+      .fn()
+      .mockResolvedValue({ data: getFollowInfoMePayload({ userId: follow21.from }) })
+      .mockResolvedValueOnce({ data: payloadFrom })
+      .mockResolvedValueOnce({ data: payloadFrom });
+
+    const unsub = liveFollowInfo(follow21.from, callback);
+    await pause();
+
+    client.emitter.emit(event, payload);
+    await pause();
+
+    expect(callback).toHaveBeenCalled();
+
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: payloadFrom.followCounts[0],
+        loading: false,
+      }),
+    );
+
+    unsub();
+  });
+});

package/src/message/api/createMessage.ts

@@ -7,9 +7,14 @@ import { upsertInCache, pullFromCache, pushToCache, dropFromCache } from '~/cach
 
 import { convertParams, prepareMessagePayload } from '../utils';
 
+const getLocalId = () => `LOCAL_${uuid()}`;
+
 // FIXME: temp solution
 let uniqueId: string | undefined;
 
+/* begin_public_function
+  id: message.create.text_message, message.create.image_message, message.create.file_message, message.create.video_message, message.create.audio_message, message.create.custom_message
+*/
 /**
  * ```js
  * import { createMessage, createQuery, runQuery } from '@amityco/ts-sdk'
@@ -39,12 +44,23 @@ export const createMessage = async <T extends Amity.MessageContentType>(
   > & {
     data?: Amity.Message<T>['data'];
     fileId?: Amity.File['fileId'];
+    // Custom referenceId is a workaround for the case:
+    // User wants to create an image message. He should
+    // - create and show dummy message in ui
+    // - upload image to get fileId, while uploading show a spinner in dummy message in ui
+    // - call createMessage and pass fileId
+    // - replace dummy message with the actual message received from backend
+    // Custom referenceId is needed to make relation between dummy message and actual message.
+    // TODO: passing file src into createMessage so that sdk uploads files itself,
+    // returns the dummy message bound with the file to eliminate the need to create
+    // the dummy message on the user side,
+    referenceId?: string;
   },
 ): Promise<Amity.Cached<Amity.Message>> => {
   const client = getActiveClient();
   client.log('message/createMessage', bundle);
 
-  const referenceId = uniqueId;
+  const referenceId = bundle.referenceId || uniqueId || getLocalId();
   uniqueId = undefined;
 
   const { data: payload } = await client.http.post<Amity.MessagePayload>('/api/v5/messages', {
@@ -86,9 +102,10 @@ export const createMessage = async <T extends Amity.MessageContentType>(
  *
  * @category Message API
  */
-createMessage.optimistically = (
-  bundle: Parameters<typeof createMessage>[0],
-): Amity.Cached<Amity.Message> | undefined => {
+createMessage.optimistically = ({
+  referenceId,
+  ...bundle
+}: Parameters<typeof createMessage>[0]): Amity.Cached<Amity.Message> | undefined => {
   const client = getActiveClient();
 
   if (!client.cache) return;
@@ -100,9 +117,8 @@ createMessage.optimistically = (
    * Updated to handle client requirement to add messageId while uploading
    * message with image. Temporary!
    */
-  const localId = `LOCAL_${uuid()}`;
-  uniqueId = localId;
-  const bundleWithMessageId = { messageId: localId, uniqueId: localId, ...bundle };
+  uniqueId = referenceId || getLocalId();
+  const bundleWithMessageId = { messageId: uniqueId, uniqueId, ...bundle };
 
   client.log('message/createMessage.optimistically', bundleWithMessageId);
 
@@ -148,3 +164,4 @@ createMessage.optimistically = (
     data: message,
   };
 };
+/* end_public_function */

package/src/message/api/deleteMessage.ts

@@ -4,6 +4,9 @@ import { fireEvent } from '~/core/events';
 
 import { getMessage } from './getMessage';
 
+/* begin_public_function
+  id: message.soft_delete
+*/
 /**
  * ```js
  * import { deleteMessage } from '@amityco/ts-sdk'
@@ -74,3 +77,4 @@ deleteMessage.optimistically = (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/message/api/getMessage.ts

@@ -9,6 +9,9 @@ import { checkIfShouldGoesToTombstone } from '~/cache/utils';
 import { pushToTombstone } from '~/cache/api/pushToTombstone';
 import { convertResponseFromRaw } from '../utils';
 
+/* begin_public_function
+  id: message.get
+*/
 /**
  * ```js
  * import { getMessage } from '@amityco/ts-sdk'
@@ -67,6 +70,7 @@ export const getMessage = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/message/api/queryMessages.ts

@@ -7,6 +7,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 import { convertQueryParams, convertResponseFromRaw } from '../utils';
 
+/* begin_public_function
+  id: message.query
+*/
 /**
  * ```js
  * import { queryMessages } from '@amityco/ts-sdk'
@@ -58,6 +61,7 @@ export const queryMessages = async (
 
   return { data: messages, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js