@amityco/ts-sdk 7.3.0 → 7.3.1-0d19ad9.0

package/dist/index.esm.js

@@ -65,7 +65,19 @@ const ContentFeedType = Object.freeze({
     CHAT: 'chat',
     POST: 'post',
     MESSAGE: 'message',
-});
+});
+var ContentFlagReasonEnum;
+(function (ContentFlagReasonEnum) {
+    ContentFlagReasonEnum["CommunityGuidelines"] = "Against community guidelines";
+    ContentFlagReasonEnum["HarassmentOrBullying"] = "Harassment or bullying";
+    ContentFlagReasonEnum["SelfHarmOrSuicide"] = "Self-harm or suicide";
+    ContentFlagReasonEnum["ViolenceOrThreateningContent"] = "Violence or threatening content";
+    ContentFlagReasonEnum["SellingRestrictedItems"] = "Selling and promoting restricted items";
+    ContentFlagReasonEnum["SexualContentOrNudity"] = "Sexual message or nudity";
+    ContentFlagReasonEnum["SpamOrScams"] = "Spam or scams";
+    ContentFlagReasonEnum["FalseInformation"] = "False information or misinformation";
+    ContentFlagReasonEnum["Others"] = "Others";
+})(ContentFlagReasonEnum || (ContentFlagReasonEnum = {}));
 
 const MessageContentType = Object.freeze({
     TEXT: 'text',
@@ -21626,6 +21638,26 @@ const commentLinkedObject = (comment) => {
         } });
 };
 
+function isAmityImagePost(post) {
+    return !!(post.data &&
+        typeof post.data !== 'string' &&
+        'fileId' in post.data &&
+        post.dataType === 'image');
+}
+function isAmityFilePost(post) {
+    return !!(post.data &&
+        typeof post.data !== 'string' &&
+        'fileId' in post.data &&
+        post.dataType === 'file');
+}
+function isAmityVideoPost(post) {
+    return !!(post.data &&
+        typeof post.data !== 'string' &&
+        'videoFileId' in post.data &&
+        'thumbnailFileId' in post.data &&
+        post.dataType === 'video');
+}
+
 const postLinkedObject = (post) => {
     return Object.assign(Object.assign({}, post), { analytics: {
             markAsViewed: () => {
@@ -21654,6 +21686,30 @@ const postLinkedObject = (post) => {
             if (!(cacheData === null || cacheData === void 0 ? void 0 : cacheData.data))
                 return;
             return userLinkedObject(cacheData.data);
+        },
+        getImageInfo() {
+            var _a, _b;
+            return isAmityImagePost(post)
+                ? (_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.fileId])) === null || _b === void 0 ? void 0 : _b.data
+                : undefined;
+        },
+        getVideoInfo() {
+            var _a, _b, _c;
+            return isAmityVideoPost(post)
+                ? (_c = pullFromCache(['file', 'get', (_b = (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.videoFileId) === null || _b === void 0 ? void 0 : _b.original])) === null || _c === void 0 ? void 0 : _c.data
+                : undefined;
+        },
+        getVideoThumbnailInfo() {
+            var _a, _b;
+            return isAmityVideoPost(post)
+                ? (_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.thumbnailFileId])) === null || _b === void 0 ? void 0 : _b.data
+                : undefined;
+        },
+        getFileInfo() {
+            var _a, _b;
+            return isAmityFilePost(post)
+                ? (_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.fileId])) === null || _b === void 0 ? void 0 : _b.data
+                : undefined;
         } });
 };
 
@@ -28693,20 +28749,33 @@ const uploadVideo = async (formData, feedType, onProgress) => {
  *
  * @param formData The data necessary to create a new {@link Amity.File<'image'>}
  * @param onProgress The callback to track the upload progress
+ * @param altText The alt text for the image
  * @returns The newly created {@link Amity.File<'image'>}
  *
  * @category File API
  * @async
  */
-const uploadImage = async (formData, onProgress) => {
+const uploadImage = async (formData, onProgress, altText) => {
     const client = getActiveClient();
     client.log('file/uploadImage', formData);
     const files = formData.getAll('files');
-    if (!files.length)
-        throw new Error('The formData object must have a `files` key.');
+    if (files === null || files === void 0 ? void 0 : files.length) {
+        console.warn('Deprecation Warning: `files` is deprecated, please use `file` instead.');
+        formData.append('preferredFilename', files[0].name);
+    }
+    else {
+        const file = formData.get('file');
+        if (!file) {
+            throw new Error('The formData object must have a `file` or `files` key');
+        }
+        formData.append('preferredFilename', file.name);
+        // alt is for single image
+        if (altText) {
+            formData.append('altText', altText);
+        }
+    }
     const accessType = GlobalFileAccessType$1.getInstance().getFileAccessType();
     formData.append('accessType', accessType);
-    formData.append('preferredFilename', files[0].name);
     const headers = 'getHeaders' in formData
         ? formData.getHeaders()
         : { 'content-type': 'multipart/form-data' };
@@ -28728,6 +28797,37 @@ const uploadImage = async (formData, onProgress) => {
 };
 /* end_public_function */
 
+/* begin_public_function
+  id: file.update.altText
+*/
+/**
+ * ```js
+ * import { FileRepository } from '@amityco/ts-sdk'
+ * const updated = await FileRepository.updateAltText(fileId, altText)
+ * ```
+ *
+ * Updates an {@link Amity.File<'image'>['altText']}.
+ *
+ * @param fileId The ID of the {@link Amity.File<'image'>} to edit
+ * @param altText The new alt text for the {@link Amity.File<'image'>}
+ * @returns the updated {@link Amity.File<'image'>} object
+ *
+ * @category File API
+ * @async
+ */
+const updateAltText = async (fileId, altText) => {
+    const client = getActiveClient();
+    client.log('file/updateAltText', altText);
+    const { data } = await client.http.put(`/api/v3/files/${fileId}`, {
+        altText,
+    });
+    const cachedAt = client.cache && Date.now();
+    if (client.cache)
+        ingestInCache({ files: [data] }, { cachedAt });
+    return true;
+};
+/* end_public_function */
+
 var index$j = /*#__PURE__*/Object.freeze({
   __proto__: null,
   getFile: getFile,
@@ -28735,7 +28835,8 @@ var index$j = /*#__PURE__*/Object.freeze({
   deleteFile: deleteFile,
   fileUrlWithSize: fileUrlWithSize,
   uploadVideo: uploadVideo,
-  uploadImage: uploadImage
+  uploadImage: uploadImage,
+  updateAltText: updateAltText
 });
 
 /**
@@ -37657,19 +37758,26 @@ const declinePost = async (postId) => {
 /**
  * ```js
  * import { PostRepository } from '@amityco/ts-sdk'
- * const flagged = await PostRepository.flagPost(postId)
+ * const flagged = await PostRepository.flagPost(postId, reason)
  * ```
  *
  * @param postId of the post to flag
+ * @param reason the reason to flag the post
  * @returns a boolean
  *
  * @category Post API
  * @async
  * */
-const flagPost = async (postId) => {
+const flagPost = async (postId, reason) => {
     const client = getActiveClient();
     client.log('post/flagPost', postId);
-    const { data: payload } = await client.http.post(`/api/v3/posts/${encodeURIComponent(postId)}/flag`);
+    const isPredefinedReason = reason &&
+        Object.entries(ContentFlagReasonEnum).some(([key, value]) => key !== ContentFlagReasonEnum.Others && value === reason);
+    const body = {
+        reason: reason && isPredefinedReason ? reason : ContentFlagReasonEnum.Others,
+        detail: reason && !isPredefinedReason ? reason : '',
+    };
+    const { data: payload } = await client.http.post(`/api/v3/posts/${encodeURIComponent(postId)}/flag`, body);
     if (client.cache) {
         ingestInCache(prepareMembershipPayload(payload, 'communityUsers'));
     }
@@ -38132,19 +38240,26 @@ const hardDeleteComment = async (commentId) => {
 /**
  * ```js
  * import { CommentRepository } from '@amityco/ts-sdk'
- * const flagged = await CommentRepository.flagComment('commentId')
+ * const flagged = await CommentRepository.flagComment(commentId, reason)
  * ```
  *
  * @param commentId The ID of the comment to flag
+ * @param reason the reason to flag the comment
  * @returns the created report result
  *
  * @category Comment API
  * @async
  * */
-const flagComment = async (commentId) => {
+const flagComment = async (commentId, reason) => {
     const client = getActiveClient();
     client.log('comment/flagComment', commentId);
-    const { data: payload } = await client.http.post(`/api/v3/comments/${encodeURIComponent(commentId)}/flag`);
+    const isPredefinedReason = reason &&
+        Object.entries(ContentFlagReasonEnum).some(([key, value]) => key !== ContentFlagReasonEnum.Others && value === reason);
+    const body = {
+        reason: reason && isPredefinedReason ? reason : ContentFlagReasonEnum.Others,
+        detail: reason && !isPredefinedReason ? reason : '',
+    };
+    const { data: payload } = await client.http.post(`/api/v3/comments/${encodeURIComponent(commentId)}/flag`, body);
     if (client.cache) {
         ingestInCache(payload);
     }
@@ -40438,7 +40553,7 @@ var index$4 = /*#__PURE__*/Object.freeze({
   getPoll: getPoll
 });
 
-const privateKey = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDHo80SecH7FuF2\nhFYnb+l26/VN8UMLXAQFLnxciNTEwkGVFMpdezlH8rU2HtUJL4RETogbAOLVY0XM\njs6sPn8G1nALmh9qeDpUtVqFOVtBHxEZ910TLOtQiunjqJKO5nWdqZ71EC3OFluR\niGQkO84BiIFbv37ub7xl3S8XarbtKoLcyVpkDHi+1wx1pgCAn6gtBUgckPL5NR8j\nLseabl3HAXQfhTCKo4tmOFM2Dxwl1IUMmIJrJg/aIU/U0tj/1Eoo7mG0JcNWX19l\nW3EecCbi0ncCJOrkUdwlBrcjaMayaX/ubEwyUeTGiLdyc4L3GRLHjyK8xgVNXRMH\nbZWJ2a5NAgMBAAECggEASxuE+35zTFO/XydKgmvIGcWL9FbgMlXb7Vcf0nBoG945\nbiz0NVc2paraIhJXc608xbYF3qLmtAE1MVBI0ORyRdBHNxY024l/6H6SH60Ed+uI\nM4ysp5ourY6Vj+DLwpdRiI9YDjqYAQDIUmhNxJP7XPhOMoZI6st+xZQBM34ic/bv\nAMSJm9OZphSp3+qXVkFZztr2mxD2EZSJJLYxi8BCdgM2qhazalbcJ6zDKHCZWVWm\n8RRxDGldyMb/237JxETzP40tAlzOZDmBAbUgEnurDJ93RVDIE3rbZUshwgeQd18a\nem096mWgvB1AIKYgsTAR3pw+V19YWAjq/glP6fz8wQKBgQD/oQq+ukKF0PRgBeM5\ngeTjSwsdGppQLmf5ndujvoiz/TpdjDEPu6R8kigQr1rG2t4K/yfdZoI8RdmJD1al\n3Q7N9hofooSy4rj6E3txzWZCHJjHad2cnCp/O26HiReGAl7wTcfTmNdiFHhZQzm5\nJBkvWAiwuvQMNfEbnXxw6/vIDwKBgQDH7fX8gsc77JLvAWgp1MaQN/sbqVb6JeT1\nFQfR8E/WFCSmzQBtNzd5KgYuCeelwr/8DyYytvN2BzCYZXp73gI1jF3YlW5jVn74\nOY6TwQ095digwo6Z0yuxopdIOApKgAkL9PRKgNrqAf3NAyMua6lOGifzjDojC3KU\nfylQmxMn4wKBgHp2B9O/H0dEBw5JQ8W0+JX6yWQz7mEjGiR2/1W+XXb8hQ1zr709\nw1r6Gb+EghRpnZ3fBpYGGbYOMFx8wKHM+N6qW3F0ReX8v2juFGE8aRSa5oYBrWzt\nU16Idjbv8hj84cZ1PJmdyvDtpYn9rpWHOZl4rxEbPvbqkIsOMyNVqdT5AoGAOSge\nmwIIU2le2FVeohbibXiToWTYKMuMmURZ5/r72AgKMmWJKbAPe+Q3wBG01/7FRBpQ\noU8Ma0HC8s6QJbliiEyIx9JwrJWd1vkdecBHONrtA4ibm/5zD2WcOllLF+FitLhi\n3qnX6+6F0IaFGFBPJrTzlv0P4dTz/OAdv52V7GECgYEA2TttOKBAqWllgOaZOkql\nLVMJVmgR7s6tLi1+cEP8ZcapV9aRbRzTAKXm4f8AEhtlG9F9kCOvHYCYGi6JaiWJ\nZkHjeex3T+eE6Di6y5Bm/Ift5jtVhJ4jCVwHOKTMej79NPUFTJfv8hCo29haBDv6\nRXFrv+T21KCcw8k3sJeJWWQ=\n-----END PRIVATE KEY-----";
+const privateKey = "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDAARz+hmBgi8pJ\nQb8LeY41gtHhk+ACMwRfhsn7GqpqRQNG2qU0755mzZuVDUqjQMGSo8THJB7O+OJs\nflbZRkFXlFoFOVNw1UpNOgwEQZ6wB9oRwzepTJAfF1sVhm/o/ixvXh1zDFNDy6yZ\npXyiiJHUVxqyjllZhxnwdvjoVtDs6hW6awG09bB9nh/TTejlUKXoAgzqVwu/1QMu\nUVViET495elEe19aUarEy+oL2iKeXCEvqda/pWNBdbieFyJvvZ08HN8dPuT88wq2\njZLEAth1vrwQ2IAa4ktaLcBQdLJgIkrbDvAiVZ8lQAjS/bq5vXQikTGvoPlC5bbn\nvuOM/3eLAgMBAAECggEAVZ+peHAghq2QVj71nX5lxsNCKaCyYwixSJBpfouTt7Rz\nE6PpzMOXFi1W1o+I22jDakuSM2SOQKqI/u0QefB0r0O/KVk5NrZHXk0mkrdYtxOp\nUgaGyf8UvmjB+8VqHrNKyZdk9qtmbnNj01kTTcAtmE4H39zPR7eR/8Rul94vaZbs\nwCnKJS3mLT3JxyGug6lxanveKkjG+CKC1nJQYWaxCJxaFSzbwXQPvDhB+TvrIbee\npd5v4EAyEJohpr+T9oDGGJkb/KARBZCtwLyB976PKJwwBA8MRVL1i5QwawuMiMq5\nUtnOnbGKtCeFzaLbNU0Qi8bqyims84EQxC6DOu1fkQKBgQDdvsoBsEhsOXV7hlIJ\naEd0eSJZVkdqimxH8uGoMM2FeNaOrcB6yBXqTSP0R3OIyf8eaY6yjRvP30ZNXcll\n/gD3O1Mu6YmWQdt1W2WA6pKOsUuPXasf0pdOF7IiFZKlSabz5YHXFqwVuqm8loaj\nsXel3YWqPVdHiankE7tz+3ssnQKBgQDdqi4TNdD1MdEpihx19jr0QjUiXW3939FK\nqp30HESPEGDGQzXdmJgif9HhZb+cJSuWaHEbjgBrYahvgCF+y6LbEpOD+D/dmT+s\nDEAQaR84sah6dokwPjV8fjBSrcVFjCS+doxv0d3p/9OUEeyUhFrY03nxtIEYkLIE\n/Zvn37b4RwKBgQCLENVFe9XfsaVhQ5r9dV2iyTlmh7qgMZG5CbTFs12hQGhm8McO\n+Z7s41YSJCFr/yq1WwP4LJDtrBw99vyQr1zRsG35tNLp3gGRNzGQSQyC2uQFVHw2\np+7mNewsfhUK/gbrXNsyFnDz6635rPlhfbII3sWuP2wWXFqkxE9CbMwR7QKBgQC6\nawDMzxmo2/iYArrkyevSuEuPVxvFwpF1RgAI6C0QVCnPE38dmdN4UB7mfHekje4W\nVEercMURidPp0cxZolCYBQtilUjAyL0vqC3In1/Ogjq6oy3FEMxSop1pKxMY5j+Q\nnoqFD+6deLUrddeNH7J3X4LSr4dSbX4JjG+tlgt+yQKBgQCuwTL4hA6KqeInQ0Ta\n9VQX5Qr8hFlqJz1gpymi/k63tW/Ob8yedbg3WWNWyShwRMFYyY9S81ITFWM95uL6\nvF3x9rmRjwElJw9PMwVu6dmf/CO0Z1wzXSp2VVD12gbrUD/0/d7MUoJ9LgC8X8f/\nn0txLHYGHbx+nf95+JUg6lV3hg==\n-----END PRIVATE KEY-----";
 /*
  * The crypto algorithm used for importing key and signing string
  */
@@ -42408,4 +42523,4 @@ var index = /*#__PURE__*/Object.freeze({
   onNotificationTraySeenUpdated: onNotificationTraySeenUpdated
 });
 
-export { API_REGIONS, index$1 as AdRepository, index$9 as CategoryRepository, index$d as ChannelRepository, index$m as Client, index$7 as CommentRepository, CommunityPostSettingMaps, CommunityPostSettings, index$a as CommunityRepository, ContentFeedType, DefaultCommunityPostSetting, index$8 as FeedRepository, FileAccessTypeEnum, index$j as FileRepository, FileType, index$3 as LiveStreamPlayer, MessageContentType, index$h as MessageRepository, index$4 as PollRepository, PostContentType, index$6 as PostRepository, index$i as ReactionRepository, index$2 as StoryRepository, index$5 as StreamRepository, index$g as SubChannelRepository, SubscriptionLevels, index$k as UserRepository, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPostTopic, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, wipeCache };
+export { API_REGIONS, index$1 as AdRepository, index$9 as CategoryRepository, index$d as ChannelRepository, index$m as Client, index$7 as CommentRepository, CommunityPostSettingMaps, CommunityPostSettings, index$a as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, DefaultCommunityPostSetting, index$8 as FeedRepository, FileAccessTypeEnum, index$j as FileRepository, FileType, index$3 as LiveStreamPlayer, MessageContentType, index$h as MessageRepository, index$4 as PollRepository, PostContentType, index$6 as PostRepository, index$i as ReactionRepository, index$2 as StoryRepository, index$5 as StreamRepository, index$g as SubChannelRepository, SubscriptionLevels, index$k as UserRepository, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPostTopic, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, wipeCache };