@amityco/ts-sdk 7.30.0 → 7.30.1-a5f99b06.0

package/dist/userRepository/api/flagUserBehavior.d.ts

@@ -7,7 +7,7 @@
  * })
  * ```
  *
- * Reports a user's behavior. `reason` is required and is one of the nine
+ * Reports a user's behavior. `reason` is required and is one of the
  * `ContentFlagReasonEnum` values, sent as its canonical label. Reporter text, including
  * the explanation for `Others`, always travels in `comment`; the reason never carries text.
  *

package/dist/userRepository/utils/userReport.d.ts

@@ -26,7 +26,7 @@ export declare const normalizeUserReportComment: (apiName: string, comment: unkn
 export declare const toUserProfileReportBody: (options: unknown) => UserReportBody;
 /**
  * Validates `flagUserBehavior` options and builds its request body. `reason` must be one
- * of the nine `ContentFlagReasonEnum` values and is sent as that canonical label;
+ * of the `ContentFlagReasonEnum` values and is sent as that canonical label;
  * `reportType` is always `behavior`.
  *
  * @throws {ASCInvalidParameterError} `INVALID_PARAMETERS` when the options are malformed

package/dist/utils/contentFlag.d.ts

@@ -12,7 +12,7 @@ export declare const isLegacyContentFlagReason: (input: unknown) => input is Ami
 /**
  * Validates an `Amity.ContentFlagOptions` argument. Untyped (plain JS) callers can pass
  * anything at runtime, so the checks do not trust the declared type: the value must be a
- * plain object, `reason` must be one of the nine `ContentFlagReasonEnum` values and
+ * plain object, `reason` must be one of the `ContentFlagReasonEnum` values and
  * `detail`, when supplied, must be a string (`null` is not a valid supplied detail).
  *
  * @param apiName used in the error message, e.g. `flagPost`

package/dist/utils/contentFlagReason.d.ts

@@ -0,0 +1,32 @@
+import { ContentFlagReasonEnum } from '~/@types';
+/**
+ * ```js
+ * import { getContentFlagReasons, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+ * const reasons = getContentFlagReasons().filter(r => r !== ContentFlagReasonEnum.Others)
+ * ```
+ *
+ * Returns every report category in display order, with `Others` last. Render a report
+ * picker from this list rather than a copy, so a category added in a later SDK release
+ * appears without a UI change. Each value is also its English default label.
+ *
+ * @returns a new array on every call; mutating it does not affect the SDK
+ *
+ * @category Content Flag
+ */
+export declare const getContentFlagReasons: () => ContentFlagReasonEnum[];
+/**
+ * ```js
+ * import { getContentFlagReasonKey, ContentFlagReasonEnum } from '@amityco/ts-sdk'
+ * getContentFlagReasonKey(ContentFlagReasonEnum.ChildEndangerment) // 'child_endangerment'
+ * ```
+ *
+ * Returns the stable, cross-platform key of a report category, for building a
+ * localisation key. Never send the key to the server: flag with the enum value.
+ *
+ * @param reason a `ContentFlagReasonEnum` value
+ * @returns the category's snake_case key
+ *
+ * @category Content Flag
+ */
+export declare const getContentFlagReasonKey: (reason: ContentFlagReasonEnum) => string;
+//# sourceMappingURL=contentFlagReason.d.ts.map

package/dist/utils/contentFlagReason.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentFlagReason.d.ts","sourceRoot":"","sources":["../../src/utils/contentFlagReason.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAyBjD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qBAAqB,QAAO,qBAAqB,EACxB,CAAC;AAMvC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB,WAAY,qBAAqB,KAAG,MACtC,CAAC"}

package/dist/utils/tests/contentFlagReason.test.d.ts

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

package/dist/utils/tests/contentFlagReason.test.d.ts.map

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

package/package.json

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