@amityco/ts-sdk 7.3.1-e2dead4.0 → 7.4.1-9b7bc08.0

package/dist/commentRepository/api/flagComment.d.ts

@@ -1,14 +1,15 @@
 /**
  * ```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
  * */
-export declare const flagComment: (commentId: Amity.Comment['commentId']) => Promise<boolean>;
+export declare const flagComment: (commentId: Amity.Comment['commentId'], reason?: Amity.ContentFlagReason) => Promise<boolean>;
 //# sourceMappingURL=flagComment.d.ts.map

package/dist/commentRepository/api/flagComment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flagComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/flagComment.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;KAWK;AACL,eAAO,MAAM,WAAW,cAAqB,aAAa,CAAC,WAAW,CAAC,KAAG,QAAQ,OAAO,CAexF,CAAC"}
+{"version":3,"file":"flagComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/flagComment.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;KAYK;AACL,eAAO,MAAM,WAAW,cACX,aAAa,CAAC,WAAW,CAAC,WAC5B,MAAM,iBAAiB,KAC/B,QAAQ,OAAO,CA2BjB,CAAC"}

package/dist/index.cjs.js

@@ -114,8 +114,8 @@ const PostContentType = Object.freeze({
 
 function getVersion() {
     try {
-        // the string ''v7.3.0-cjs'' should be replaced by actual value by @rollup/plugin-replace
-        return 'v7.3.0-cjs';
+        // the string ''v7.4.0-cjs'' should be replaced by actual value by @rollup/plugin-replace
+        return 'v7.4.0-cjs';
     }
     catch (error) {
         return '__dev__';
@@ -15921,25 +15921,19 @@ getDeliveredUsers.locally = (query) => {
 /**
  * ```js
  * import { MessageRepository } from '@amityco/ts-sdk'
- * const flagged = await MessageRepository.flagMessage(messageId, reason)
+ * const flagged = await MessageRepository.flagMessage(messageId)
  * ```
  *
  * @param messageId of the message to flag
- * @param reason the reason to flag the message
  * @returns the created report result
  *
  * @category Message API
  * @async
  * */
-const flagMessage = async (messageId, reason) => {
+const flagMessage = async (messageId) => {
     const client = getActiveClient();
     client.log('message/flag', messageId);
-    const isPredefinedReason = Object.entries(exports.ContentFlagReasonEnum).some(([key, value]) => key !== exports.ContentFlagReasonEnum.Others && value === reason);
-    const body = {
-        reason: isPredefinedReason ? reason : exports.ContentFlagReasonEnum.Others,
-        detail: isPredefinedReason ? '' : reason,
-    };
-    const { data: payload } = await client.http.post(`/api/v5/messages/${encodeURIComponent(messageId)}/flags`, body);
+    const { data: payload } = await client.http.post(`/api/v5/messages/${encodeURIComponent(messageId)}/flags`);
     if (client.cache) {
         const messagePayload = await prepareMessagePayload(payload);
         ingestInCache(messagePayload);
@@ -21672,19 +21666,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(exports.ContentFlagReasonEnum).some(([key, value]) => key !== exports.ContentFlagReasonEnum.Others && value === reason);
+    const body = {
+        reason: reason && isPredefinedReason ? reason : exports.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'));
     }
@@ -22147,19 +22148,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(exports.ContentFlagReasonEnum).some(([key, value]) => key !== exports.ContentFlagReasonEnum.Others && value === reason);
+    const body = {
+        reason: reason && isPredefinedReason ? reason : exports.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);
     }

package/dist/index.esm.js

@@ -99,8 +99,8 @@ const PostContentType = Object.freeze({
 
 function getVersion() {
     try {
-        // the string ''v7.3.0-esm'' should be replaced by actual value by @rollup/plugin-replace
-        return 'v7.3.0-esm';
+        // the string ''v7.4.0-esm'' should be replaced by actual value by @rollup/plugin-replace
+        return 'v7.4.0-esm';
     }
     catch (error) {
         return '__dev__';
@@ -32013,25 +32013,19 @@ getDeliveredUsers.locally = (query) => {
 /**
  * ```js
  * import { MessageRepository } from '@amityco/ts-sdk'
- * const flagged = await MessageRepository.flagMessage(messageId, reason)
+ * const flagged = await MessageRepository.flagMessage(messageId)
  * ```
  *
  * @param messageId of the message to flag
- * @param reason the reason to flag the message
  * @returns the created report result
  *
  * @category Message API
  * @async
  * */
-const flagMessage = async (messageId, reason) => {
+const flagMessage = async (messageId) => {
     const client = getActiveClient();
     client.log('message/flag', messageId);
-    const isPredefinedReason = Object.entries(ContentFlagReasonEnum).some(([key, value]) => key !== ContentFlagReasonEnum.Others && value === reason);
-    const body = {
-        reason: isPredefinedReason ? reason : ContentFlagReasonEnum.Others,
-        detail: isPredefinedReason ? '' : reason,
-    };
-    const { data: payload } = await client.http.post(`/api/v5/messages/${encodeURIComponent(messageId)}/flags`, body);
+    const { data: payload } = await client.http.post(`/api/v5/messages/${encodeURIComponent(messageId)}/flags`);
     if (client.cache) {
         const messagePayload = await prepareMessagePayload(payload);
         ingestInCache(messagePayload);
@@ -37764,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'));
     }
@@ -38239,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);
     }