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

package/src/comment/api/deleteComment.ts

@@ -9,6 +9,9 @@ import { scheduleTask } from '~/core/microtasks';
 
 import { getComment } from './getComment';
 
+/* begin_public_function
+  id: comment.soft_delete, comment.hard_delete
+*/
 /**
  * ```js
  * import { deleteComment } from '@amityco/ts-sdk'
@@ -75,3 +78,4 @@ export const deleteComment = async (
 
   return deleted;
 };
+/* end_public_function */

package/src/comment/api/getComment.ts

@@ -6,6 +6,9 @@ import { isInTombstone } from '~/cache/api/isInTombstone';
 import { checkIfShouldGoesToTombstone } from '~/cache/utils';
 import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
+/* begin_public_function
+  id: comment.get
+*/
 /**
  * ```js
  * import { getComment } from '@amityco/ts-sdk'
@@ -54,6 +57,7 @@ export const getComment = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/getComments.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: comment.get_by_ids
+*/
 /**
  * ```js
  * import { getComments } from '@amityco/ts-sdk'
@@ -38,6 +41,7 @@ export const getComments = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/queryComments.ts

@@ -5,6 +5,9 @@ import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
 
+/* begin_public_function
+  id: comment.query
+*/
 /**
  * ```js
  * import { queryComments } from '@amityco/ts-sdk'
@@ -70,6 +73,7 @@ export const queryComments = async (
 
   return { data: comments, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/comment/api/updateComment.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: comment.update_comment
+*/
 /**
  * ```js
  * import { updateComment } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const updateComment = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/community/api/addCommunityMembers.ts

@@ -4,6 +4,9 @@ import { fireEvent } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.add_members
+*/
 /**
  * ```js
  * import { addCommunityMembers } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const addCommunityMembers = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/addCommunityMembersRoles.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.moderation.add_roles
+*/
 /**
  * ```js
  * import { addCommunityMembersRoles } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const addCommunityMembersRoles = async (
       roleIds.some(role => communityUser.roles.includes(role)),
   );
 };
+/* end_public_function */

package/src/community/api/createCommunity.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.create
+*/
 /**
  * ```js
  * import { createCommunity } from '@amityco/ts-sdk'
@@ -57,3 +60,4 @@ export const createCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/community/api/deleteCommunity.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { fireEvent } from '~/core/events';
 import { getCommunity } from './getCommunity';
 
+/* begin_public_function
+  id: community.delete
+*/
 /**
  * ```js
  * import { deleteCommunity } from '@amityco/ts-sdk'
@@ -39,3 +42,4 @@ export const deleteCommunity = async (
 
   return deleted.data;
 };
+/* end_public_function */

package/src/community/api/getCommunity.ts

@@ -5,6 +5,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.get
+*/
 /**
  * ```js
  * import { getCommunity } from '@amityco/ts-sdk'
@@ -42,6 +45,7 @@ export const getCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getRecommendedCommunities.ts

@@ -6,6 +6,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query.recommended_communities
+*/
 /**
  * ```js
  * import { getRecommendedCommunities } from '@amityco/ts-sdk'
@@ -49,6 +52,7 @@ export const getRecommendedCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getTopTrendingCommunities.ts

@@ -6,6 +6,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query.trending_communities
+*/
 /**
  * ```js
  * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
@@ -49,6 +52,7 @@ export const getTopTrendingCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/joinCommunity.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.join
+*/
 /**
  * ```js
  * import { joinCommunity } from '@amityco/ts-sdk'
@@ -42,3 +45,4 @@ export const joinCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/leaveCommunity.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.leave
+*/
 /**
  * ```js
  * import { leaveCommunity } from '@amityco/ts-sdk'
@@ -42,3 +45,4 @@ export const leaveCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
   );
 };
+/* end_public_function */

package/src/community/api/queryCommunities.ts

@@ -7,6 +7,9 @@ import { getResolver } from '~/core/model';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query
+*/
 /**
  * ```js
  * import { queryCommunities } from '@amityco/ts-sdk'
@@ -71,6 +74,7 @@ export const queryCommunities = async (
 
   return { data: communities, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/queryCommunityMembers.ts

@@ -6,6 +6,9 @@ import { toPage, toToken } from '~/core/query';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.query
+*/
 /**
  * ```js
  * import { queryCommunityMembers } from '@amityco/ts-sdk'
@@ -66,6 +69,7 @@ export const queryCommunityMembers = async (
 
   return { data: communityUsers, cachedAt, nextPage, prevPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/removeCommunityMembers.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.remove_member
+*/
 /**
  * ```js
  * import { removeCommunityMembers } from '@amityco/ts-sdk'
@@ -44,3 +47,4 @@ export const removeCommunityMembers = async (
       communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
   );
 };
+/* end_public_function */

package/src/community/api/removeCommunityMembersRoles.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.moderation.remove_roles
+*/
 /**
  * ```js
  * import { removeCommunityMembersRoles } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const removeCommunityMembersRoles = async (
       !roleIds.some(role => communityUser.roles.includes(role)),
   );
 };
+/* end_public_function */

package/src/community/api/updateCommunity.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.update
+*/
 /**
  * ```js
  * import { updateCommunity } from '@amityco/ts-sdk'
@@ -49,3 +52,4 @@ export const updateCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */

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

@@ -7,6 +7,9 @@ const getCacheKey = (userId: Amity.User['userId']) => [
   `${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'
@@ -49,6 +52,7 @@ export const getFollowInfo = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

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/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'
@@ -44,7 +49,7 @@ export const createMessage = async <T extends Amity.MessageContentType>(
   const client = getActiveClient();
   client.log('message/createMessage', bundle);
 
-  const referenceId = uniqueId;
+  const referenceId = uniqueId || getLocalId();
   uniqueId = undefined;
 
   const { data: payload } = await client.http.post<Amity.MessagePayload>('/api/v5/messages', {
@@ -100,9 +105,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 = getLocalId();
+  const bundleWithMessageId = { messageId: uniqueId, uniqueId, ...bundle };
 
   client.log('message/createMessage.optimistically', bundleWithMessageId);
 
@@ -148,3 +152,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