@amityco/ts-sdk 7.27.1-23f628a8.0 → 7.27.1-2f09d30a.0

package/dist/@types/domains/content.d.ts

@@ -19,6 +19,17 @@ export declare enum ContentFlagReasonEnum {
 declare global {
     namespace Amity {
         type ContentFlagReason = Exclude<`${ContentFlagReasonEnum}`, `${ContentFlagReasonEnum.Others}`> | (string & {});
+        /**
+         * Input for the reason-bearing `CommentRepository.flagComment` overload: one
+         * payload-free category plus optional reporter context. Arbitrary custom
+         * strings are not accepted here; use `ContentFlagReasonEnum.Others` and put
+         * the text in `detail`. `detail` is forwarded unchanged (the backend enforces
+         * the 300-character limit) and is omitted from the request when `undefined`.
+         */
+        type CommentFlagOptions = {
+            reason: ContentFlagReasonEnum;
+            detail?: string;
+        };
         type ContentType = 'text' | 'image' | 'file' | 'video' | 'poll' | 'json' | 'liveStream' | 'clip' | 'audio' | string;
         type ContentFeedType = ValueOf<typeof ContentFeedType>;
         type ContentDataText = {

package/dist/@types/domains/content.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/content.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;EAM1B,CAAC;AAEH,oBAAY,qBAAqB;IAC/B,mBAAmB,iCAAiC;IACpD,oBAAoB,2BAA2B;IAC/C,iBAAiB,yBAAyB;IAC1C,4BAA4B,oCAAoC;IAChE,sBAAsB,2CAA2C;IACjE,qBAAqB,6BAA6B;IAClD,WAAW,kBAAkB;IAC7B,gBAAgB,wCAAwC;IACxD,MAAM,WAAW;CAClB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,iBAAiB,GAClB,OAAO,CAAC,GAAG,qBAAqB,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,CAAC,GACtE,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;QAElB,KAAK,WAAW,GACZ,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,YAAY,GACZ,MAAM,GACN,OAAO,GACP,MAAM,CAAC;QAEX,KAAK,eAAe,GAAG,OAAO,CAAC,OAAO,eAAe,CAAC,CAAC;QAEvD,KAAK,eAAe,GAAG;YACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YACtB,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;SACtC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF,KAAK,UAAU,GAAG;YAChB,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;YACvB,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;SACxC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB;;;;eAIG;YACH,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YACtD,WAAW,EAAE;iBACV,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC;aACvD,CAAC;SACH,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC/C,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;YACrC,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,WAAW,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC;SACrC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO,EAAE,GAAG,CAAC;YACb,UAAU,EAAE,KAAK,CAAC,cAAc,CAAC;YACjC,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC;SACpC,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC9B,CAAC;QAEF,KAAK,iBAAiB,GAAG;YACvB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SACpC,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC3B,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACnC,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QAEF,KAAK,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,MAAM,GACtD,eAAe,GACf,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,YAAY,GACtB,iBAAiB,GACjB,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,MAAM,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,CAAC,SAAS,MAAM,GAChB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,KAAK,CAAC;QAEV,KAAK,OAAO,CAAC,CAAC,SAAS,WAAW,IAAI;YAEpC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACb,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB,CAAC;QAEF,KAAK,kBAAkB,GAAG;YACxB,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,OAAO,CAAC;SAClB,CAAC;QAEF,KAAK,mBAAmB,GAAG;YACzB,WAAW,EAAE,OAAO,CAAC;YACrB,OAAO,EAAE,OAAO,CAAC;YACjB,kBAAkB,EAAE,MAAM,CAAC;YAC3B,eAAe,EAAE;gBACf,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;gBACrC,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;aACtC,CAAC;SACH,CAAC;QAEF,KAAK,cAAc,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC,SAAS,MAAM,GAC5E,kBAAkB,GAClB,CAAC,SAAS,OAAO,GACjB,mBAAmB,GACnB,KAAK,CAAC;KACX;CACF"}
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/content.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;EAM1B,CAAC;AAEH,oBAAY,qBAAqB;IAC/B,mBAAmB,iCAAiC;IACpD,oBAAoB,2BAA2B;IAC/C,iBAAiB,yBAAyB;IAC1C,4BAA4B,oCAAoC;IAChE,sBAAsB,2CAA2C;IACjE,qBAAqB,6BAA6B;IAClD,WAAW,kBAAkB;IAC7B,gBAAgB,wCAAwC;IACxD,MAAM,WAAW;CAClB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,iBAAiB,GAClB,OAAO,CAAC,GAAG,qBAAqB,EAAE,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,CAAC,GACtE,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;QAElB;;;;;;WAMG;QACH,KAAK,kBAAkB,GAAG;YACxB,MAAM,EAAE,qBAAqB,CAAC;YAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,CAAC;QAEF,KAAK,WAAW,GACZ,MAAM,GACN,OAAO,GACP,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,YAAY,GACZ,MAAM,GACN,OAAO,GACP,MAAM,CAAC;QAEX,KAAK,eAAe,GAAG,OAAO,CAAC,OAAO,eAAe,CAAC,CAAC;QAEvD,KAAK,eAAe,GAAG;YACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YACtB,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;SACtC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF,KAAK,UAAU,GAAG;YAChB,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;YACvB,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;SACxC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB;;;;eAIG;YACH,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YACtD,WAAW,EAAE;iBACV,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC;aACvD,CAAC;SACH,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC/C,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;YACrC,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,WAAW,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC;SACrC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO,EAAE,GAAG,CAAC;YACb,UAAU,EAAE,KAAK,CAAC,cAAc,CAAC;YACjC,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC;SACpC,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC9B,CAAC;QAEF,KAAK,iBAAiB,GAAG;YACvB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SACpC,CAAC;QAEF,KAAK,eAAe,GAAG;YACrB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC3B,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACnC,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QAEF,KAAK,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,MAAM,GACtD,eAAe,GACf,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,YAAY,GACtB,iBAAiB,GACjB,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,MAAM,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,CAAC,SAAS,MAAM,GAChB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,KAAK,CAAC;QAEV,KAAK,OAAO,CAAC,CAAC,SAAS,WAAW,IAAI;YAEpC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACb,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB,CAAC;QAEF,KAAK,kBAAkB,GAAG;YACxB,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,OAAO,CAAC;SAClB,CAAC;QAEF,KAAK,mBAAmB,GAAG;YACzB,WAAW,EAAE,OAAO,CAAC;YACrB,OAAO,EAAE,OAAO,CAAC;YACjB,kBAAkB,EAAE,MAAM,CAAC;YAC3B,eAAe,EAAE;gBACf,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;gBACrC,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC;aACtC,CAAC;SACH,CAAC;QAEF,KAAK,cAAc,CAAC,CAAC,SAAS,WAAW,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC,SAAS,MAAM,GAC5E,kBAAkB,GAClB,CAAC,SAAS,OAAO,GACjB,mBAAmB,GACnB,KAAK,CAAC;KACX;CACF"}

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

@@ -1,15 +1,82 @@
+declare type FlagComment = {
+    /**
+     * ```js
+     * import { CommentRepository } from '@amityco/ts-sdk'
+     * const flagged = await CommentRepository.flagComment(commentId)
+     * ```
+     *
+     * Flags a comment without a reason. The report is sent as `Others` with an empty detail.
+     *
+     * @param commentId The ID of the comment to flag
+     * @returns `true` when the report was created
+     */
+    (commentId: Amity.Comment['commentId'], reason?: undefined): Promise<boolean>;
+    /**
+     * ```js
+     * import { CommentRepository, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+     * const flagged = await CommentRepository.flagComment(commentId, {
+     *   reason: ContentFlagReasonEnum.SpamOrScams,
+     *   detail: 'Repeated promotional links',
+     * })
+     * ```
+     *
+     * Flags a comment with a category and optional reporter context. Any category,
+     * including `Others`, may carry a `detail`. `detail` is sent unchanged and omitted
+     * when not supplied; the backend enforces its 300-character limit.
+     *
+     * @param commentId The ID of the comment to flag
+     * @param options `reason` is a `ContentFlagReasonEnum` value; `detail` is optional free text
+     * @returns `true` when the report was created
+     * @throws {ASCError} `INVALID_PARAMETERS` when `options` is malformed, before any request is made
+     */
+    (commentId: Amity.Comment['commentId'], options: Amity.CommentFlagOptions): Promise<boolean>;
+    /**
+     * ```js
+     * import { CommentRepository } from '@amityco/ts-sdk'
+     * const flagged = await CommentRepository.flagComment(commentId, reason)
+     * ```
+     *
+     * @deprecated Pass an options object instead: `flagComment(commentId, { reason, detail })`.
+     * A predefined string maps to `{ reason: <value>, detail: '' }`; a custom string maps to
+     * `{ reason: 'Others', detail: <string> }`. Migrate a custom string to
+     * `{ reason: ContentFlagReasonEnum.Others, detail: customString }`. This mapping is
+     * unchanged and stays available throughout the current major version.
+     *
+     * @param commentId The ID of the comment to flag
+     * @param reason a predefined `ContentFlagReasonEnum` value or a custom string
+     * @returns `true` when the report was created
+     */
+    (commentId: Amity.Comment['commentId'], reason?: Amity.ContentFlagReason): Promise<boolean>;
+};
 /**
  * ```js
- * import { CommentRepository } from '@amityco/ts-sdk'
- * const flagged = await CommentRepository.flagComment(commentId, reason)
+ * import { CommentRepository, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+ *
+ * // No reason: sent as Others with an empty detail.
+ * await CommentRepository.flagComment(commentId)
+ *
+ * // Category plus optional reporter context (any category, including Others).
+ * await CommentRepository.flagComment(commentId, {
+ *   reason: ContentFlagReasonEnum.SpamOrScams,
+ *   detail: 'Repeated promotional links',
+ * })
  * ```
  *
+ * Reports a comment to moderation. Three call shapes are accepted (see the overloads):
+ * id-only, an options object, and the deprecated legacy reason string. The public
+ * name only dispatches on the input shape; the two implementations are kept separate
+ * so the legacy path is untouched by the new contract:
+ *
+ * - `undefined` or a string → `flagCommentLegacy` (unchanged legacy mapping)
+ * - anything else → `flagCommentWithOptions` (validated `{ reason, detail? }`)
+ *
  * @param commentId The ID of the comment to flag
- * @param reason the reason to flag the comment
- * @returns the created report result
+ * @param input an options object `{ reason, detail? }`, a legacy reason string, or nothing
+ * @returns `true` when the report was created
  *
  * @category Comment API
  * @async
  * */
-export declare const flagComment: (commentId: Amity.Comment['commentId'], reason?: Amity.ContentFlagReason) => Promise<boolean>;
+export declare const flagComment: FlagComment;
+export {};
 //# 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":"AASA;;;;;;;;;;;;KAYK;AACL,eAAO,MAAM,WAAW,cACX,aAAa,CAAC,WAAW,CAAC,WAC5B,MAAM,iBAAiB,KAC/B,QAAQ,OAAO,CA2BjB,CAAC"}
+{"version":3,"file":"flagComment.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/flagComment.ts"],"names":[],"mappings":"AAGA,aAAK,WAAW,GAAG;IACjB;;;;;;;;;;OAUG;IACH,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9E;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7F;;;;;;;;;;;;;;;OAeG;IACH,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7F,CAAC;AAKF;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA4BK;AACL,eAAO,MAAM,WAAW,EAAE,WAMoB,CAAC"}

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

@@ -0,0 +1,16 @@
+/**
+ * Legacy `flagComment(commentId, reason?)` implementation, kept verbatim so existing
+ * callers keep the exact request body they had before the options contract existed:
+ *
+ * - predefined `ContentFlagReasonEnum` value → `{ reason: <value>, detail: '' }`
+ * - any other non-empty string (including the literal `'Others'`) → `{ reason: 'Others', detail: <string> }`
+ * - `undefined` or `''` → `{ reason: 'Others', detail: '' }`
+ *
+ * Not exported from the public API. It is reached through the deprecated
+ * `CommentRepository.flagComment(commentId, reason)` overload; see `flagComment.ts`.
+ *
+ * @deprecated Use `flagCommentWithOptions` (the `{ reason, detail? }` contract) for new code.
+ * This path stays available throughout the current major version.
+ */
+export declare const flagCommentLegacy: (commentId: Amity.Comment['commentId'], reason?: Amity.ContentFlagReason) => Promise<boolean>;
+//# sourceMappingURL=flagCommentLegacy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"flagCommentLegacy.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/flagCommentLegacy.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACjB,aAAa,CAAC,WAAW,CAAC,WAC5B,MAAM,iBAAiB,KAC/B,QAAQ,OAAO,CA2BjB,CAAC"}

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

@@ -0,0 +1,13 @@
+/**
+ * New `flagComment(commentId, { reason, detail? })` implementation. Any category,
+ * including `Others`, may carry a `detail`. `detail` is forwarded unchanged (empty and
+ * whitespace-only strings included) and omitted from the request body when `undefined`;
+ * the backend enforces the 300-character limit.
+ *
+ * Not exported from the public API. It is reached through the
+ * `CommentRepository.flagComment(commentId, options)` overload; see `flagComment.ts`.
+ *
+ * @throws {ASCError} `INVALID_PARAMETERS` when `options` is malformed, before any request is made
+ */
+export declare const flagCommentWithOptions: (commentId: Amity.Comment['commentId'], options: Amity.CommentFlagOptions) => Promise<boolean>;
+//# sourceMappingURL=flagCommentWithOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"flagCommentWithOptions.d.ts","sourceRoot":"","sources":["../../../src/commentRepository/api/flagCommentWithOptions.ts"],"names":[],"mappings":"AAuCA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,cACtB,aAAa,CAAC,WAAW,CAAC,WAC5B,MAAM,kBAAkB,KAChC,QAAQ,OAAO,CAmBjB,CAAC"}

package/dist/commentRepository/api/tests/integration/flagCommentLegacy.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flagCommentLegacy.integration.test.d.ts.map

package/dist/commentRepository/api/tests/integration/flagCommentLegacy.integration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flagCommentLegacy.integration.test.d.ts","sourceRoot":"","sources":["../../../../../src/commentRepository/api/tests/integration/flagCommentLegacy.integration.test.ts"],"names":[],"mappings":""}

package/dist/commentRepository/api/tests/integration/flagCommentWithOptions.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flagCommentWithOptions.integration.test.d.ts.map

package/dist/commentRepository/api/tests/integration/flagCommentWithOptions.integration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flagCommentWithOptions.integration.test.d.ts","sourceRoot":"","sources":["../../../../../src/commentRepository/api/tests/integration/flagCommentWithOptions.integration.test.ts"],"names":[],"mappings":""}

package/dist/index.cjs.js

@@ -27110,23 +27110,21 @@ const declineComment = async (commentId, reason) => {
 };
 /* end_public_function */
 
-/* begin_public_function
-  id: comment.flag
-*/
 /**
- * ```js
- * import { CommentRepository } from '@amityco/ts-sdk'
- * const flagged = await CommentRepository.flagComment(commentId, reason)
- * ```
+ * Legacy `flagComment(commentId, reason?)` implementation, kept verbatim so existing
+ * callers keep the exact request body they had before the options contract existed:
  *
- * @param commentId The ID of the comment to flag
- * @param reason the reason to flag the comment
- * @returns the created report result
+ * - predefined `ContentFlagReasonEnum` value → `{ reason: <value>, detail: '' }`
+ * - any other non-empty string (including the literal `'Others'`) → `{ reason: 'Others', detail: <string> }`
+ * - `undefined` or `''` → `{ reason: 'Others', detail: '' }`
  *
- * @category Comment API
- * @async
- * */
-const flagComment = async (commentId, reason) => {
+ * Not exported from the public API. It is reached through the deprecated
+ * `CommentRepository.flagComment(commentId, reason)` overload; see `flagComment.ts`.
+ *
+ * @deprecated Use `flagCommentWithOptions` (the `{ reason, detail? }` contract) for new code.
+ * This path stays available throughout the current major version.
+ */
+const flagCommentLegacy = async (commentId, reason) => {
     const client = getActiveClient();
     client.log('comment/flagComment', commentId);
     const isPredefinedReason = reason &&
@@ -27142,6 +27140,87 @@ const flagComment = async (commentId, reason) => {
     fireEvent('comment.flagged', payload);
     return !!payload;
 };
+
+const FLAG_REASONS = Object.values(exports.ContentFlagReasonEnum);
+const invalidOptions = (message) => new ASCError(`flagComment: ${message}`, 800110 /* Amity.ClientError.INVALID_PARAMETERS */, "error" /* Amity.ErrorLevel.ERROR */);
+/**
+ * Validates the options object before any request is made. Untyped (plain JS) callers
+ * can pass anything at runtime, so the checks do not trust the declared type:
+ * the argument must be a plain object, `reason` must be one of the nine
+ * `ContentFlagReasonEnum` values and `detail`, when supplied, must be a string.
+ */
+const validateFlagCommentOptions = (options) => {
+    if (typeof options !== 'object' || options === null || Array.isArray(options)) {
+        throw invalidOptions('expected an options object `{ reason, detail? }`');
+    }
+    const { reason, detail } = options;
+    if (typeof reason !== 'string' || !FLAG_REASONS.includes(reason)) {
+        throw invalidOptions('`reason` must be a `ContentFlagReasonEnum` value');
+    }
+    if (detail !== undefined && typeof detail !== 'string') {
+        throw invalidOptions('`detail` must be a string when supplied');
+    }
+    return { reason: reason, detail };
+};
+/**
+ * New `flagComment(commentId, { reason, detail? })` implementation. Any category,
+ * including `Others`, may carry a `detail`. `detail` is forwarded unchanged (empty and
+ * whitespace-only strings included) and omitted from the request body when `undefined`;
+ * the backend enforces the 300-character limit.
+ *
+ * Not exported from the public API. It is reached through the
+ * `CommentRepository.flagComment(commentId, options)` overload; see `flagComment.ts`.
+ *
+ * @throws {ASCError} `INVALID_PARAMETERS` when `options` is malformed, before any request is made
+ */
+const flagCommentWithOptions = async (commentId, options) => {
+    const client = getActiveClient();
+    client.log('comment/flagComment', commentId);
+    const { reason, detail } = validateFlagCommentOptions(options);
+    const body = detail === undefined ? { reason } : { reason, detail };
+    const { data: payload } = await client.http.post(`/api/v3/comments/${encodeURIComponent(commentId)}/flag`, body);
+    if (client.cache) {
+        ingestInCache(payload);
+    }
+    fireEvent('comment.flagged', payload);
+    return !!payload;
+};
+
+/* begin_public_function
+  id: comment.flag
+*/
+/**
+ * ```js
+ * import { CommentRepository, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+ *
+ * // No reason: sent as Others with an empty detail.
+ * await CommentRepository.flagComment(commentId)
+ *
+ * // Category plus optional reporter context (any category, including Others).
+ * await CommentRepository.flagComment(commentId, {
+ *   reason: ContentFlagReasonEnum.SpamOrScams,
+ *   detail: 'Repeated promotional links',
+ * })
+ * ```
+ *
+ * Reports a comment to moderation. Three call shapes are accepted (see the overloads):
+ * id-only, an options object, and the deprecated legacy reason string. The public
+ * name only dispatches on the input shape; the two implementations are kept separate
+ * so the legacy path is untouched by the new contract:
+ *
+ * - `undefined` or a string → `flagCommentLegacy` (unchanged legacy mapping)
+ * - anything else → `flagCommentWithOptions` (validated `{ reason, detail? }`)
+ *
+ * @param commentId The ID of the comment to flag
+ * @param input an options object `{ reason, detail? }`, a legacy reason string, or nothing
+ * @returns `true` when the report was created
+ *
+ * @category Comment API
+ * @async
+ * */
+const flagComment = (commentId, input) => input === undefined || typeof input === 'string'
+    ? flagCommentLegacy(commentId, input)
+    : flagCommentWithOptions(commentId, input);
 /* end_public_function */
 
 /* begin_public_function

package/dist/index.esm.js

@@ -27110,23 +27110,21 @@ const declineComment = async (commentId, reason) => {
 };
 /* end_public_function */
 
-/* begin_public_function
-  id: comment.flag
-*/
 /**
- * ```js
- * import { CommentRepository } from '@amityco/ts-sdk'
- * const flagged = await CommentRepository.flagComment(commentId, reason)
- * ```
+ * Legacy `flagComment(commentId, reason?)` implementation, kept verbatim so existing
+ * callers keep the exact request body they had before the options contract existed:
  *
- * @param commentId The ID of the comment to flag
- * @param reason the reason to flag the comment
- * @returns the created report result
+ * - predefined `ContentFlagReasonEnum` value → `{ reason: <value>, detail: '' }`
+ * - any other non-empty string (including the literal `'Others'`) → `{ reason: 'Others', detail: <string> }`
+ * - `undefined` or `''` → `{ reason: 'Others', detail: '' }`
  *
- * @category Comment API
- * @async
- * */
-const flagComment = async (commentId, reason) => {
+ * Not exported from the public API. It is reached through the deprecated
+ * `CommentRepository.flagComment(commentId, reason)` overload; see `flagComment.ts`.
+ *
+ * @deprecated Use `flagCommentWithOptions` (the `{ reason, detail? }` contract) for new code.
+ * This path stays available throughout the current major version.
+ */
+const flagCommentLegacy = async (commentId, reason) => {
     const client = getActiveClient();
     client.log('comment/flagComment', commentId);
     const isPredefinedReason = reason &&
@@ -27142,6 +27140,87 @@ const flagComment = async (commentId, reason) => {
     fireEvent('comment.flagged', payload);
     return !!payload;
 };
+
+const FLAG_REASONS = Object.values(ContentFlagReasonEnum);
+const invalidOptions = (message) => new ASCError(`flagComment: ${message}`, 800110 /* Amity.ClientError.INVALID_PARAMETERS */, "error" /* Amity.ErrorLevel.ERROR */);
+/**
+ * Validates the options object before any request is made. Untyped (plain JS) callers
+ * can pass anything at runtime, so the checks do not trust the declared type:
+ * the argument must be a plain object, `reason` must be one of the nine
+ * `ContentFlagReasonEnum` values and `detail`, when supplied, must be a string.
+ */
+const validateFlagCommentOptions = (options) => {
+    if (typeof options !== 'object' || options === null || Array.isArray(options)) {
+        throw invalidOptions('expected an options object `{ reason, detail? }`');
+    }
+    const { reason, detail } = options;
+    if (typeof reason !== 'string' || !FLAG_REASONS.includes(reason)) {
+        throw invalidOptions('`reason` must be a `ContentFlagReasonEnum` value');
+    }
+    if (detail !== undefined && typeof detail !== 'string') {
+        throw invalidOptions('`detail` must be a string when supplied');
+    }
+    return { reason: reason, detail };
+};
+/**
+ * New `flagComment(commentId, { reason, detail? })` implementation. Any category,
+ * including `Others`, may carry a `detail`. `detail` is forwarded unchanged (empty and
+ * whitespace-only strings included) and omitted from the request body when `undefined`;
+ * the backend enforces the 300-character limit.
+ *
+ * Not exported from the public API. It is reached through the
+ * `CommentRepository.flagComment(commentId, options)` overload; see `flagComment.ts`.
+ *
+ * @throws {ASCError} `INVALID_PARAMETERS` when `options` is malformed, before any request is made
+ */
+const flagCommentWithOptions = async (commentId, options) => {
+    const client = getActiveClient();
+    client.log('comment/flagComment', commentId);
+    const { reason, detail } = validateFlagCommentOptions(options);
+    const body = detail === undefined ? { reason } : { reason, detail };
+    const { data: payload } = await client.http.post(`/api/v3/comments/${encodeURIComponent(commentId)}/flag`, body);
+    if (client.cache) {
+        ingestInCache(payload);
+    }
+    fireEvent('comment.flagged', payload);
+    return !!payload;
+};
+
+/* begin_public_function
+  id: comment.flag
+*/
+/**
+ * ```js
+ * import { CommentRepository, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+ *
+ * // No reason: sent as Others with an empty detail.
+ * await CommentRepository.flagComment(commentId)
+ *
+ * // Category plus optional reporter context (any category, including Others).
+ * await CommentRepository.flagComment(commentId, {
+ *   reason: ContentFlagReasonEnum.SpamOrScams,
+ *   detail: 'Repeated promotional links',
+ * })
+ * ```
+ *
+ * Reports a comment to moderation. Three call shapes are accepted (see the overloads):
+ * id-only, an options object, and the deprecated legacy reason string. The public
+ * name only dispatches on the input shape; the two implementations are kept separate
+ * so the legacy path is untouched by the new contract:
+ *
+ * - `undefined` or a string → `flagCommentLegacy` (unchanged legacy mapping)
+ * - anything else → `flagCommentWithOptions` (validated `{ reason, detail? }`)
+ *
+ * @param commentId The ID of the comment to flag
+ * @param input an options object `{ reason, detail? }`, a legacy reason string, or nothing
+ * @returns `true` when the report was created
+ *
+ * @category Comment API
+ * @async
+ * */
+const flagComment = (commentId, input) => input === undefined || typeof input === 'string'
+    ? flagCommentLegacy(commentId, input)
+    : flagCommentWithOptions(commentId, input);
 /* end_public_function */
 
 /* begin_public_function