@amityco/ts-sdk 7.25.1-c3c4e7d7.0 → 7.25.1-ca99345f.0

package/dist/index.cjs.js

@@ -4556,6 +4556,9 @@ const onChannelSetUserMuted = (callback) => {
     return () => dispose(callback);
 };
 
+/* begin_public_function
+  id: channel.get-my-membership
+*/
 const getMyMembership = (channelId, callback) => {
     const { _id: userId } = getActiveUser();
     if (!userId)
@@ -7303,10 +7306,14 @@ const onNetworkActivities = (callback) => NetworkActivitiesWatcher$1.getInstance
  *
  * @category Client Events
  */
+/* begin_public_function
+  id: core.onVisitorUsageLimitReached
+*/
 const onVisitorUsageLimitReached = (callback) => {
     const client = getActiveClient();
     return createEventSubscriber(client, 'client/onVisitorUsageLimitReached', 'visitorUsageLimitReached', callback);
 };
+/* end_public_function */
 
 /**
  * ```js
@@ -8766,6 +8773,9 @@ const CONTENT_TYPE_CONFIG = {
  * @category Client API
  * @async
  */
+/* begin_public_function
+  id: core_client.getShareableLinkConfiguration
+*/
 const getShareableLinkConfiguration = async () => {
     var _a, _b;
     const client = getActiveClient();
@@ -8791,6 +8801,7 @@ const getShareableLinkConfiguration = async () => {
         },
     };
 };
+/* end_public_function */
 
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
@@ -9439,6 +9450,9 @@ const removeFunctionProperties = (obj) => {
  *
  * @category Message Live Object
  */
+/* begin_public_function
+  id: client.get-user-unread
+*/
 const getUserUnread = (callback) => {
     const { _id: userId } = getActiveUser();
     if (!userId)
@@ -11333,6 +11347,9 @@ class JoinRequestsLiveCollectionController extends LiveCollectionController {
  * @category joinRequest Live Collection
  *
  */
+/* begin_public_function
+  id: community.get-join-requests
+*/
 const getJoinRequests = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -13895,6 +13912,9 @@ class RSVPLiveCollectionController extends LiveCollectionController {
  * @category RSVP Live Collection
  *
  */
+/* begin_public_function
+  id: event.get-rsvps
+*/
 const getRSVPs = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache)
@@ -15187,6 +15207,9 @@ const queryReachUser = async ({ viewId, viewedType, limit, token, }) => {
     return response.data;
 };
 
+/* begin_public_function
+  id: user.get-reached-users
+*/
 const getReachedUsers = (params, callback) => {
     // Pre-defined function to avoid undefined function call
     let onFetch = (initial = false) => undefined;
@@ -15431,7 +15454,7 @@ const fileUrlWithSize = (fileUrl, size) => {
 };
 
 /* begin_public_function
-  id: file.upload.video, file.upload.audio
+  id: file.upload.video
 */
 /**
  * ```js
@@ -17602,6 +17625,7 @@ class ReactionLiveCollectionController extends LiveCollectionController {
 /* eslint-disable no-use-before-define */
 /* begin_public_function
   id: reaction.query
+  spec: SDK/API/reaction/getReactions/v1.md
 */
 /**
  * ```js
@@ -17811,7 +17835,7 @@ const getPostReport = async ({ client, referenceId, }) => {
 };
 const getUserReport = async ({ client, referenceId, }) => {
     var _a;
-    const { data } = await client.http.get(`/api/v3/users/${referenceId}/isflagbyme`);
+    const { data } = await client.http.get(`/api/v3/users/${referenceId}/isFlagByMe`);
     const { result, isFlagByMe } = data !== null && data !== void 0 ? data : {};
     return (_a = result !== null && result !== void 0 ? result : isFlagByMe) !== null && _a !== void 0 ? _a : false;
 };
@@ -19464,6 +19488,7 @@ class MessageLiveCollectionController extends LiveCollectionController {
 
 /* begin_public_function
   id: message.query
+  spec: SDK/API/message/getMessages/v1.md
 */
 /**
  * ```js
@@ -20094,6 +20119,7 @@ class SubChannelLiveCollectionController extends LiveCollectionController {
 /* eslint-disable no-use-before-define */
 /* begin_public_function
   id: subchannel.query
+  spec: SDK/API/subChannel/getSubChannels/v1.md
 */
 /**
  * ```js
@@ -21038,6 +21064,7 @@ class ChannelLiveCollectionController extends LiveCollectionController {
 /* eslint-disable no-use-before-define */
 /* begin_public_function
   id: channel.query
+  spec: SDK/API/channel/getChannels/v1.md
 */
 /**
  * ```js
@@ -23548,6 +23575,7 @@ const applyFilter = (data, params) => {
 };
 /* begin_public_function
   id: community.membership.query
+  spec: API/community/get-members/v2.md
 */
 /**
  * ```js
@@ -23768,6 +23796,7 @@ class SearchCommunityMembersLiveCollectionController extends LiveCollectionContr
 
 /* begin_public_function
   id: community.membership.query
+  spec: API/community/get-members/v2.md
 */
 /**
  * ```js
@@ -23913,7 +23942,7 @@ class SearchCommunityLiveCollectionController extends LiveCollectionController {
 }
 
 /* begin_public_function
-  id: community.query
+  id: community.search
 */
 /**
  * ```js
@@ -24705,6 +24734,9 @@ class SemanticSearchCommunityLiveCollectionController extends LiveCollectionCont
  * @category Posts Live Collection
  *
  */
+/* begin_public_function
+  id: community.semantic-search
+*/
 const semanticSearchCommunities = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -25314,7 +25346,7 @@ var index$f = /*#__PURE__*/Object.freeze({
 });
 
 /* begin_public_function
-  id: feed.query.global_feed
+  id: feed.query.global_feed.page
 */
 /**
  *
@@ -26394,6 +26426,7 @@ class CommentLiveCollectionController extends LiveCollectionController {
 
 /* begin_public_function
   id: comment.query
+  spec: API/comment/getComments/v2.md
 */
 /**
  * ```js
@@ -26568,6 +26601,10 @@ const generateCommentSubscriptions$1 = (cacheKey) => {
         action: EnumPostActions.OnPostUpdated,
     }));
 };
+/* begin_public_function
+  id: feed.get-global-feed-subscriptions
+*/
+/** Returns RTE subscriptions for use by Amity.LiveCollectionCallback-based feed controllers. */
 const getGlobalFeedSubscriptions = (cacheKey) => {
     return [
         { fn: onPostCreated, action: EnumPostActions.OnPostCreated },
@@ -27282,6 +27319,10 @@ const commentEventHandler = (callback, eventHandler, cacheKey, resolveId) => {
         callback(comment);
     });
 };
+/* begin_public_function
+  id: post.generate-comment-subscriptions
+*/
+/** Returns RTE subscriptions for use by Amity.LiveCollectionCallback-based post controllers. */
 const generateCommentSubscriptions = ({ cacheKey, resolveId, }) => {
     const eventHandlers = [
         onCommentCreated,
@@ -28837,6 +28878,7 @@ class PostLiveCollectionController extends LiveCollectionController {
 
 /* begin_public_function
   id: post.query
+  spec: API/post/query/v2.md
 */
 /**
  * ```js
@@ -29014,6 +29056,9 @@ class PinnedPostLiveCollectionController extends LiveCollectionController {
  * @category Pined Posts Live Collection
  *
  */
+/* begin_public_function
+  id: post.get-pinned-posts
+*/
 const getPinnedPosts = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -29160,6 +29205,9 @@ class GlobalPinnedPostLiveCollectionController extends LiveCollectionController
  * @category Pined Posts Live Collection
  *
  */
+/* begin_public_function
+  id: post.get-global-pinned-posts
+*/
 const getGlobalPinnedPosts = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -29393,6 +29441,9 @@ class SemanticSearchPostLiveCollectionController extends LiveCollectionControlle
  * @category Posts Live Collection
  *
  */
+/* begin_public_function
+  id: post.semantic-search
+*/
 const semanticSearchPosts = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -29602,7 +29653,8 @@ class SearchPostLiveCollectionController extends LiveCollectionController {
 }
 
 /* begin_public_function
-  id: post.query
+  id: post.query.by_hashtag
+  spec: API/post/query/v2.md
 */
 /**
  * ```js
@@ -29853,31 +29905,6 @@ const getBroadcasterData = async (roomId) => {
 };
 /* end_public_function */
 
-/* begin_public_function
-  id: room.getRecordedUrl
-*/
-/**
- * ```js
- * import { getRecordedUrl } from '@amityco/ts-sdk'
- * const recordedUrl = await getRecordedUrl('roomId')
- * ```
- *
- * Gets the recorded URL for a room
- *
- * @param roomId The ID of the room to get recorded URL for
- * @returns The recorded URL information
- *
- * @category Room API
- * @async
- */
-const getRecordedUrl = async (roomId) => {
-    const client = getActiveClient();
-    client.log('room/getRecordedUrl', { roomId });
-    const { data } = await client.http.get(`/api/v1/rooms/${roomId}/recorded`);
-    return data;
-};
-/* end_public_function */
-
 /* begin_public_function
   id: room.removeParticipant
 */
@@ -30584,6 +30611,10 @@ var EnumRoomActions;
 const convertToRoomEventPayload = (eventHandler) => (callback) => eventHandler((payload) => {
     callback(payload.room);
 });
+/* begin_public_function
+  id: room.get-room-subscription
+*/
+/** Returns RTE subscriptions for use by Amity.LiveCollectionCallback-based room controllers. */
 // TODO: confirm related events
 const getRoomSubscription = () => [
     {
@@ -30640,6 +30671,9 @@ const getRoomSubscription = () => [
     },
 ];
 
+/* begin_public_function
+  id: room.get
+*/
 const getRoom = (roomId, callback) => {
     return liveObject(roomId, callback, '_id', getRoomById, [
         onRoomEndBroadcasting,
@@ -30854,7 +30888,6 @@ var index$c = /*#__PURE__*/Object.freeze({
     deleteRoom: deleteRoom,
     stopRoom: stopRoom,
     getBroadcasterData: getBroadcasterData,
-    getRecordedUrl: getRecordedUrl,
     removeParticipant: removeParticipant,
     leaveRoom: leaveRoom,
     AmityRoomAnalytics: AmityRoomAnalytics,
@@ -33007,33 +33040,74 @@ const softDeleteStory = async (storyId) => {
     return result;
 };
 
-const onStoryUpdated = (callback) => {
+const onStoryCreated = (callback) => {
     const client = getActiveClient();
     const filter = async (payload) => {
         // Apply the necessary field for story payload
-        const convertPayload = convertRawStoryToInternal(payload);
+        const convertPayload = convertRawStoryToInternal(payload, true);
         ingestInCache(convertPayload);
         callback(convertPayload.stories);
     };
-    const disposers = [createEventSubscriber(client, 'onStoryUpdated', 'story.updated', filter)];
+    const disposers = [createEventSubscriber(client, 'onStoryCreated', 'story.created', filter)];
     return () => {
         disposers.forEach(fn => fn());
     };
 };
-const onStoryUpdatedLocal = (callback) => {
+const onStoryCreatedLocal = (callback) => {
     const client = getActiveClient();
     const filter = async (payload) => {
         ingestInCache(payload);
         callback(payload.stories);
     };
     const disposers = [
-        createEventSubscriber(client, 'onStoryUpdated', 'local.story.updated', filter),
+        createEventSubscriber(client, 'onStoryCreated', 'local.story.created', filter),
     ];
     return () => {
         disposers.forEach(fn => fn());
     };
 };
 
+const onStoryDeleted = (callback) => {
+    const client = getActiveClient();
+    const filter = async (payload) => {
+        const convertPayload = convertRawStoryToInternal(payload);
+        ingestInCache(convertPayload);
+        callback(convertPayload.stories);
+    };
+    const disposer = [createEventSubscriber(client, 'onStoryDeleted', 'story.deleted', filter)];
+    return () => {
+        disposer.forEach(fn => fn());
+    };
+};
+const onStoryDeletedLocal = (callback) => {
+    const client = getActiveClient();
+    const filter = async (payload) => {
+        ingestInCache(payload);
+        callback(payload.stories);
+    };
+    const disposer = [createEventSubscriber(client, 'onStoryDeleted', 'local.story.deleted', filter)];
+    return () => {
+        disposer.forEach(fn => fn());
+    };
+};
+
+const onStoryError = (callback) => {
+    const client = getActiveClient();
+    const filter = async (payload) => {
+        ingestInCache(payload);
+        callback(payload.stories);
+    };
+    return createEventSubscriber(client, 'onStoryError', 'local.story.error', filter);
+};
+
+const onStoryLocalDataUpdated = (callback) => {
+    const client = getActiveClient();
+    const filter = (payload) => {
+        callback(payload);
+    };
+    return createEventSubscriber(client, 'onStoryLocalDataUpdated', 'local.story.reload', filter);
+};
+
 const onStoryReactionAdded = (callback) => {
     const client = getActiveClient();
     const filter = async (payload) => {
@@ -33094,6 +33168,33 @@ const onStoryReactionRemovedLocal = (callback) => {
     };
 };
 
+const onStoryUpdated = (callback) => {
+    const client = getActiveClient();
+    const filter = async (payload) => {
+        // Apply the necessary field for story payload
+        const convertPayload = convertRawStoryToInternal(payload);
+        ingestInCache(convertPayload);
+        callback(convertPayload.stories);
+    };
+    const disposers = [createEventSubscriber(client, 'onStoryUpdated', 'story.updated', filter)];
+    return () => {
+        disposers.forEach(fn => fn());
+    };
+};
+const onStoryUpdatedLocal = (callback) => {
+    const client = getActiveClient();
+    const filter = async (payload) => {
+        ingestInCache(payload);
+        callback(payload.stories);
+    };
+    const disposers = [
+        createEventSubscriber(client, 'onStoryUpdated', 'local.story.updated', filter),
+    ];
+    return () => {
+        disposers.forEach(fn => fn());
+    };
+};
+
 const updateLocalLastStoryExpires = (stories) => {
     stories.forEach(story => {
         const currentCache = pullFromCache(["story-expire" /* STORY_KEY_CACHE.EXPIRE */, story.targetId]);
@@ -33140,74 +33241,6 @@ const getActiveStoriesByTarget$1 = async ({ targetType, targetId, options, }) =>
     };
 };
 
-const onStoryCreated = (callback) => {
-    const client = getActiveClient();
-    const filter = async (payload) => {
-        // Apply the necessary field for story payload
-        const convertPayload = convertRawStoryToInternal(payload, true);
-        ingestInCache(convertPayload);
-        callback(convertPayload.stories);
-    };
-    const disposers = [createEventSubscriber(client, 'onStoryCreated', 'story.created', filter)];
-    return () => {
-        disposers.forEach(fn => fn());
-    };
-};
-const onStoryCreatedLocal = (callback) => {
-    const client = getActiveClient();
-    const filter = async (payload) => {
-        ingestInCache(payload);
-        callback(payload.stories);
-    };
-    const disposers = [
-        createEventSubscriber(client, 'onStoryCreated', 'local.story.created', filter),
-    ];
-    return () => {
-        disposers.forEach(fn => fn());
-    };
-};
-
-const onStoryDeleted = (callback) => {
-    const client = getActiveClient();
-    const filter = async (payload) => {
-        const convertPayload = convertRawStoryToInternal(payload);
-        ingestInCache(convertPayload);
-        callback(convertPayload.stories);
-    };
-    const disposer = [createEventSubscriber(client, 'onStoryDeleted', 'story.deleted', filter)];
-    return () => {
-        disposer.forEach(fn => fn());
-    };
-};
-const onStoryDeletedLocal = (callback) => {
-    const client = getActiveClient();
-    const filter = async (payload) => {
-        ingestInCache(payload);
-        callback(payload.stories);
-    };
-    const disposer = [createEventSubscriber(client, 'onStoryDeleted', 'local.story.deleted', filter)];
-    return () => {
-        disposer.forEach(fn => fn());
-    };
-};
-
-const onStoryError = (callback) => {
-    const client = getActiveClient();
-    const filter = async (payload) => {
-        ingestInCache(payload);
-        callback(payload.stories);
-    };
-    return createEventSubscriber(client, 'onStoryError', 'local.story.error', filter);
-};
-
-const onStoryLocalDataUpdated = (callback) => {
-    const client = getActiveClient();
-    const filter = (payload) => {
-        callback(payload);
-    };
-    return createEventSubscriber(client, 'onStoryLocalDataUpdated', 'local.story.reload', filter);
-};
-
 /**
  * ```js
  * import { StoryRepository } from '@amityco/js-sdk';
@@ -33228,6 +33261,9 @@ const onStoryLocalDataUpdated = (callback) => {
  *
  * @category SubChannel Live Object
  */
+/* begin_public_function
+  id: story.get-active-stories-by-target
+*/
 const getActiveStoriesByTarget = (params, callback) => {
     const { log, cache } = getActiveClient();
     const disposers = [];
@@ -33366,6 +33402,9 @@ const getActiveStoriesByTarget = (params, callback) => {
 };
 
 const getSingleItemFromArray = (func) => (callback) => func((result) => callback(result[0]));
+/* begin_public_function
+  id: story.get-by-story-id
+*/
 const getStoryByStoryId = (storyId, callback) => {
     return liveObject(storyId, data => {
         if (!(data === null || data === void 0 ? void 0 : data.data)) {
@@ -33401,6 +33440,9 @@ const getTargetsByTargetIds$1 = async (targets) => {
     };
 };
 
+/* begin_public_function
+  id: story.get-target-by-id
+*/
 const getTargetById = (params, callback) => {
     return liveObject(
     // @TODO: Now I put @ts-ignore here because I don't know how to fix this, it always say that params is not assignable to `NEVER`
@@ -33416,6 +33458,9 @@ const getTargetById = (params, callback) => {
     }, []);
 };
 
+/* begin_public_function
+  id: story.get-targets-by-target-ids
+*/
 const getTargetsByTargetIds = (params, callback) => {
     const { log, cache } = getActiveClient();
     const disposers = [];
@@ -33858,6 +33903,18 @@ var index$6 = /*#__PURE__*/Object.freeze({
     createVideoStory: createVideoStory,
     hardDeleteStory: hardDeleteStory,
     softDeleteStory: softDeleteStory,
+    onStoryCreated: onStoryCreated,
+    onStoryCreatedLocal: onStoryCreatedLocal,
+    onStoryDeleted: onStoryDeleted,
+    onStoryDeletedLocal: onStoryDeletedLocal,
+    onStoryError: onStoryError,
+    onStoryLocalDataUpdated: onStoryLocalDataUpdated,
+    onStoryReactionAdded: onStoryReactionAdded,
+    onStoryReactionAddedLocal: onStoryReactionAddedLocal,
+    onStoryReactionRemoved: onStoryReactionRemoved,
+    onStoryReactionRemovedLocal: onStoryReactionRemovedLocal,
+    onStoryUpdated: onStoryUpdated,
+    onStoryUpdatedLocal: onStoryUpdatedLocal,
     getActiveStoriesByTarget: getActiveStoriesByTarget,
     getStoryByStoryId: getStoryByStoryId,
     getTargetById: getTargetById,
@@ -34168,6 +34225,9 @@ class NotificationTrayItemsLiveCollectionController extends LiveCollectionContro
  * @category Notification tray items Live Collection
  *
  */
+/* begin_public_function
+  id: notification-tray.get-items
+*/
 const getNotificationTrayItems = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -34500,6 +34560,9 @@ class MyInvitationsLiveCollectionController extends LiveCollectionController {
  * @category My Community Invitations Live Collection
  *
  */
+/* begin_public_function
+  id: invitation.get-my-community-invitations
+*/
 const getMyCommunityInvitations = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache) {
@@ -34552,6 +34615,8 @@ const getMyCommunityInvitations = (params, callback, config) => {
  *
  * @category Invitation Observable
  */
+// NOTE: Invitation events use a streaming event pattern; callback is Amity.Listener rather than
+// Amity.LiveObjectCallback or Amity.LiveCollectionCallback as this is not a LiveObject/LiveCollection.
 const getInvitations = (params, callback) => {
     const { _id: userId } = getCurrentUser();
     if (!userId)
@@ -34708,6 +34773,11 @@ const onLiveReactionCreatedLocal = (callback) => {
  *
  * @category Live Reaction Observable
  */
+/* begin_public_function
+  id: live-reaction.get-reactions
+*/
+// NOTE: Live reactions use a streaming event pattern; callback is Amity.Listener rather than
+// Amity.LiveObjectCallback or Amity.LiveCollectionCallback as this is not a LiveObject/LiveCollection.
 // TODO: confirm return type for this observable property
 const getReactions = (postId, callback) => {
     const { _id: userId } = getActiveUser();
@@ -35061,6 +35131,9 @@ class EventLiveCollectionController extends LiveCollectionController {
  * @category Event Live Collection
  *
  */
+/* begin_public_function
+  id: event.get-events
+*/
 const getEvents = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache)
@@ -35081,7 +35154,7 @@ class MyEventPaginationController extends PaginationController {
     async getRequest(queryParams, token) {
         const { limit = COLLECTION_DEFAULT_PAGINATION_LIMIT } = queryParams, params = __rest(queryParams, ["limit"]);
         const options = token ? { token } : { limit };
-        const { data: response } = await this.http.get(`/api/v1/events/me/rsvps`, { params: Object.assign(Object.assign({}, params), { options }) });
+        const { data: response } = await this.http.get(`/api/v1/events/me/rsvp`, { params: Object.assign(Object.assign({}, params), { options }) });
         return response;
     }
 }
@@ -35198,6 +35271,9 @@ class MyEventLiveCollectionController extends LiveCollectionController {
  * @category Event Live Collection
  *
  */
+/* begin_public_function
+  id: event.get-my-events
+*/
 const getMyEvents = (params, callback, config) => {
     const { log, cache } = getActiveClient();
     if (!cache)
@@ -35276,6 +35352,7 @@ getProduct$1.locally = (productId) => {
 
 /* begin_public_function
   id: product.get
+  spec: API/product/get/v1.md
 */
 /**
  * ```js
@@ -35399,6 +35476,7 @@ class SearchProductLiveCollectionController extends LiveCollectionController {
 
 /* begin_public_function
   id: product.search
+  spec: API/product/search/v2.md
 */
 /**
  * ```js