@amityco/ts-sdk 7.2.1-b894bb3a.0 → 7.2.1-c3db7142.0

package/dist/messageRepository/api/flagMessage.d.ts

@@ -1,14 +1,15 @@
 /**
  * ```js
  * import { MessageRepository } from '@amityco/ts-sdk'
- * const flagged = await MessageRepository.flagMessage(messageId)
+ * const flagged = await MessageRepository.flagMessage(messageId, reason)
  * ```
  *
  * @param messageId of the message to flag
+ * @param reason the reason to flag the message
  * @returns the created report result
  *
  * @category Message API
  * @async
  * */
-export declare const flagMessage: (messageId: Amity.Message['messageId']) => Promise<boolean>;
+export declare const flagMessage: (messageId: Amity.Message['messageId'], reason: Amity.ContentFlagReason) => Promise<boolean>;
 //# sourceMappingURL=flagMessage.d.ts.map

package/dist/messageRepository/api/flagMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flagMessage.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/flagMessage.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;KAWK;AACL,eAAO,MAAM,WAAW,cAAqB,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,QAAQ,OAAO,CAgBxF,CAAC"}
+{"version":3,"file":"flagMessage.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/flagMessage.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;KAYK;AACL,eAAO,MAAM,WAAW,cACX,MAAM,OAAO,CAAC,WAAW,CAAC,UAC7B,MAAM,iBAAiB,KAC9B,QAAQ,OAAO,CA0BjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.2.1-b894bb3a.0",
+  "version": "7.2.1-c3db7142.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/domains/ad.ts

@@ -31,7 +31,7 @@ declare global {
       image9_16: string;
       callToAction: string;
       callToActionUrl: string;
-      targets: Amity.AdTarget;
+      target: Amity.AdTarget;
       startAt: Amity.timestamp;
       endAt?: Amity.timestamp;
       createdAt: Amity.timestamp;

package/src/@types/domains/content.ts

@@ -6,8 +6,24 @@ export const ContentFeedType = Object.freeze({
   MESSAGE: 'message',
 });
 
+export enum ContentFlagReasonEnum {
+  CommunityGuidelines = 'Against community guidelines',
+  HarassmentOrBullying = 'Harassment or bullying',
+  SelfHarmOrSuicide = 'Self-harm or suicide',
+  ViolenceOrThreateningContent = 'Violence or threatening content',
+  SellingRestrictedItems = 'Selling and promoting restricted items',
+  SexualContentOrNudity = 'Sexual message or nudity',
+  SpamOrScams = 'Spam or scams',
+  FalseInformation = 'False information or misinformation',
+  Others = 'Others',
+}
+
 declare global {
   namespace Amity {
+    type ContentFlagReason =
+      | Exclude<`${ContentFlagReasonEnum}`, `${ContentFlagReasonEnum.Others}`>
+      | (string & {});
+
     type ContentType = 'text' | 'image' | 'file' | 'video' | 'poll' | 'json' | string;
 
     type ContentFeedType = ValueOf<typeof ContentFeedType>;

package/src/messageRepository/api/flagMessage.ts

@@ -1,8 +1,7 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
-
+import { ContentFlagReasonEnum } from '~/@types';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getActiveClient } from '~/client/api/activeClient';
 import { prepareMessagePayload } from '~/messageRepository/utils';
 
 /* begin_public_function
@@ -11,21 +10,35 @@ import { prepareMessagePayload } from '~/messageRepository/utils';
 /**
  * ```js
  * import { MessageRepository } from '@amityco/ts-sdk'
- * const flagged = await MessageRepository.flagMessage(messageId)
+ * const flagged = await MessageRepository.flagMessage(messageId, reason)
  * ```
  *
  * @param messageId of the message to flag
+ * @param reason the reason to flag the message
  * @returns the created report result
  *
  * @category Message API
  * @async
  * */
-export const flagMessage = async (messageId: Amity.Message['messageId']): Promise<boolean> => {
+export const flagMessage = async (
+  messageId: Amity.Message['messageId'],
+  reason: Amity.ContentFlagReason,
+): Promise<boolean> => {
   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<Amity.MessagePayload>(
     `/api/v5/messages/${encodeURIComponent(messageId)}/flags`,
+    body,
   );
 
   if (client.cache) {