@amityco/ts-sdk 7.31.1-e63a36d.0 → 7.32.1-0c1c3831.0

package/dist/index.esm.js

@@ -21,6 +21,7 @@ var AmityAutoSubscription;
     AmityAutoSubscription["NETWORK"] = "network";
     AmityAutoSubscription["LIVESTREAM"] = "livestream";
     AmityAutoSubscription["BLOCK"] = "block";
+    AmityAutoSubscription["USER"] = "user";
 })(AmityAutoSubscription || (AmityAutoSubscription = {}));
 
 var UserTypeEnum;
@@ -176,6 +177,7 @@ const PostContentType = Object.freeze({
     AUDIO: 'audio',
     ROOM: 'room',
     EVENT: 'event',
+    GIF: 'gif',
 });
 const PostStructureType = Object.freeze({
     TEXT: 'text',
@@ -185,6 +187,8 @@ const PostStructureType = Object.freeze({
     AUDIO: 'audio',
     MIXED: 'mixed',
     EVENT: 'event',
+    /** A post that holds only GIFs. GIFs beside other media make the post `mixed`. */
+    GIF: 'gif',
 });
 
 var InvitationTypeEnum;
@@ -344,8 +348,8 @@ var AmityLiveViewerCountMode;
 
 function getVersion() {
     try {
-        // the string ''v7.31.0-esm'' should be replaced by actual value by @rollup/plugin-replace
-        return 'v7.31.0-esm';
+        // the string ''v7.32.0-esm'' should be replaced by actual value by @rollup/plugin-replace
+        return 'v7.32.0-esm';
     }
     catch (error) {
         return '__dev__';
@@ -2730,6 +2734,7 @@ const TOPICS = {
     ],
     [AmityAutoSubscription.LIVESTREAM]: [getLiveStreamTopic],
     [AmityAutoSubscription.BLOCK]: [getMyFollowersTopic, getMyFollowingsTopic],
+    [AmityAutoSubscription.USER]: [() => getUserTopic(getActiveUser())], // global ban
 };
 const DEFAULT_TOPICS = [
     AmityAutoSubscription.CHAT,
@@ -27741,8 +27746,40 @@ getCommentByIds.locally = (commentIds) => {
     };
 };
 
+const GIF_OPTIONAL_KEYS = ['width', 'height'];
+/*
+ * The server refuses a GIF attachment that carries `null` or any key it does not know, so the
+ * request keeps `type`, `url` and only the optional fields that have a value. The SDK does not
+ * check the values themselves: the server answers 400 for a bad one.
+ */
+const toGifAttachmentPayload = (gif) => {
+    const payload = { type: 'gif', url: gif.url };
+    GIF_OPTIONAL_KEYS.forEach(key => {
+        const value = gif[key];
+        if (value !== undefined && value !== null)
+            Object.assign(payload, { [key]: value });
+    });
+    return payload;
+};
+/* Builds each GIF from its known keys; every other attachment is sent as the caller gave it. */
+const toAttachmentsPayload = (attachments) => attachments.map(attachment => attachment.type === 'gif'
+    ? toGifAttachmentPayload(attachment)
+    : attachment);
+
+/*
+ * The data types the server lists for a comment, known before it answers: one per attachment
+ * type, plus `text` when there is text. Sorted, as the server sorts them.
+ */
+const commentDataTypesOf = (text, attachments) => {
+    const types = new Set((attachments !== null && attachments !== void 0 ? attachments : []).map(attachment => attachment.type));
+    if (text)
+        types.add('text');
+    return [...types].sort();
+};
+
 const getLocalCommentId = () => uuid();
 const createCommentOptimistic = (bundle) => {
+    var _a;
     const client = getActiveClient();
     if (!client.cache)
         return;
@@ -27777,6 +27814,7 @@ const createCommentOptimistic = (bundle) => {
         targetId: '',
         targetType: 'community',
         dataType: 'text',
+        dataTypes: commentDataTypesOf((_a = bundle.data) === null || _a === void 0 ? void 0 : _a.text, bundle.attachments),
         syncState: "syncing" /* Amity.SyncState.Syncing */,
         // In a gated community the optimistic object stays out of public collections until the
         // response settles the status; the author's own view still updates through the local event
@@ -27823,12 +27861,15 @@ const createCommentOptimistic = (bundle) => {
 const createComment = async (bundle, isOptimistic = true) => {
     const client = getActiveClient();
     client.log('comment/createComment', Object.assign(Object.assign({}, bundle), { isOptimistic }));
+    // A GIF is sent with its known keys only; the server refuses `null` and unknown keys.
+    const request = bundle.attachments
+        ? Object.assign(Object.assign({}, bundle), { attachments: toAttachmentsPayload(bundle.attachments) }) : bundle;
     // Without a local comment the server assigns the id; with one, the same id travels through the
     // optimistic object, the response and every realtime event so each step recognises it.
-    const optimisticData = isOptimistic ? createCommentOptimistic(bundle) : undefined;
+    const optimisticData = isOptimistic ? createCommentOptimistic(request) : undefined;
     const commentId = optimisticData === null || optimisticData === void 0 ? void 0 : optimisticData.commentId;
     try {
-        const { data: payload } = await client.http.post('/api/v3/comments', Object.assign(Object.assign({}, bundle), { commentId }));
+        const { data: payload } = await client.http.post('/api/v3/comments', Object.assign(Object.assign({}, request), { commentId }));
         // BE always returns an array of comments If it got record 0 from BE it might have a problem on creation logic
         if (payload.comments.length === 0)
             throw new Error('Comment not created');
@@ -27921,9 +27962,16 @@ const createComment = async (bundle, isOptimistic = true) => {
  * const updated = await CommentRepository.updateComment(commentId, {
  *   data: { text: 'hello world' }
  * })
+ *
+ * // Replace the GIF, or remove it and keep the text
+ * await CommentRepository.updateComment(commentId, {
+ *   attachments: [{ type: 'gif', url: 'https://media.giphy.com/media/l0MYt5jPR6QX5pnqM/giphy.gif' }],
+ * })
+ * await CommentRepository.updateComment(commentId, { attachments: [] })
  * ```
  *
- * Updates an {@link Amity.Comment}
+ * Updates an {@link Amity.Comment}. `attachments` replaces the current ones, `[]` removes them,
+ * and leaving `attachments` out keeps them as they are.
  *
  * @param commentId The ID of the {@link Amity.Comment} to edit
  * @param patch The patch data to apply
@@ -27937,7 +27985,10 @@ const updateComment = async (commentId, patch) => {
     const client = getActiveClient();
     client.log('user/updateComment', patch);
     const previous = (_a = pullFromCache(['comment', 'get', commentId])) === null || _a === void 0 ? void 0 : _a.data;
-    const { data: payload } = await client.http.put(`/api/v3/comments/${encodeURIComponent(commentId)}`, patch);
+    // A GIF is sent with its known keys only; the server refuses `null` and unknown keys.
+    const body = patch.attachments
+        ? Object.assign(Object.assign({}, patch), { attachments: toAttachmentsPayload(patch.attachments) }) : patch;
+    const { data: payload } = await client.http.put(`/api/v3/comments/${encodeURIComponent(commentId)}`, body);
     const data = prepareCommentPayload(payload);
     const updated = data.comments.find(comment => comment.commentId === commentId);
     const cachedAt = client.cache && Date.now();
@@ -30404,6 +30455,19 @@ getPostByIds.locally = (postIds) => {
     };
 };
 
+/*
+ * The `attachments` a post create or edit sends. A GIF goes with its known keys only and never
+ * with product tags (both a 400). A file takes its product tags from the map, as before.
+ */
+const preparePostAttachments = (attachments, attachmentProductTags) => attachments === null || attachments === void 0 ? void 0 : attachments.map(attachment => {
+    if (attachment.type === 'gif') {
+        return toGifAttachmentPayload(attachment);
+    }
+    if (!attachmentProductTags || !attachment.fileId)
+        return attachment;
+    return Object.assign(Object.assign({}, attachment), { productTags: attachmentProductTags.get(attachment.fileId) });
+});
+
 /* begin_public_function
   id: post.create.text_post, post.create.image_post, post.create.file_post, post.create.video_post, post.create.poll_post, post.create.livestream_post, post.create.custom_post
 */
@@ -30433,17 +30497,7 @@ const createPost = async (bundle) => {
         delete bundle.dataType;
     }
     const { attachments, attachmentProductTags } = bundle, rest = __rest(bundle, ["attachments", "attachmentProductTags"]);
-    const processedAttachments = attachments && attachments.length > 0 && bundle.attachmentProductTags
-        ? attachments.map(attachment => {
-            var _a;
-            /* c8 ignore next */
-            const productTags = (_a = bundle.attachmentProductTags) === null || _a === void 0 ? void 0 : _a.get(attachment.fileId);
-            if (productTags)
-                return Object.assign(Object.assign({}, attachment), { productTags });
-            /* c8 ignore next */
-            return attachment;
-        })
-        : attachments;
+    const processedAttachments = preparePostAttachments(attachments, attachmentProductTags);
     const { data: payload } = await client.http.post('/api/v4/posts', Object.assign(Object.assign({}, rest), { attachments: processedAttachments }));
     fireEvent('post.created', payload);
     const data = preparePostPayload(payload);
@@ -30469,7 +30523,9 @@ const createPost = async (bundle) => {
  * })
  * ```
  *
- * Updates an {@link Amity.Post}
+ * Updates an {@link Amity.Post}. `attachments` is the full list to keep: a GIF is matched by its
+ * `url`, so send each kept GIF back with its link and size as read from `childrenPosts`; an
+ * attachment left out is deleted, `[]` removes them all, and leaving `attachments` out keeps them.
  *
  * @param postId The ID of the {@link Amity.Post} to edit
  * @param patch The patch data to apply
@@ -30482,17 +30538,7 @@ const editPost = async (postId, patch) => {
     const client = getActiveClient();
     client.log('user/editPost', patch);
     const { attachments } = patch;
-    const processedAttachments = attachments && attachments.length > 0 && patch.attachmentProductTags
-        ? attachments.map(attachment => {
-            var _a;
-            /* c8 ignore next */
-            const productTags = (_a = patch.attachmentProductTags) === null || _a === void 0 ? void 0 : _a.get(attachment.fileId);
-            if (productTags)
-                return Object.assign(Object.assign({}, attachment), { productTags });
-            /* c8 ignore next */
-            return attachment;
-        })
-        : attachments;
+    const processedAttachments = preparePostAttachments(attachments, patch.attachmentProductTags);
     const { data: payload } = await client.http.put(`/api/v4/posts/${encodeURIComponent(postId)}`, Object.assign(Object.assign({}, patch), { attachments: processedAttachments }));
     const data = prepareMembershipPayload(payload, 'communityUsers');
     const cachedAt = client.cache && Date.now();
@@ -30976,11 +31022,14 @@ const createAudioPost = async (bundle) => {
  *     { fileId: "file1", type: "image" },
  *     { fileId: "file2", type: "video" },
  *     { fileId: "file3", type: "audio" },
- *     { fileId: "file4", type: "file" }
+ *     { fileId: "file4", type: "file" },
+ *     { type: "gif", url: "https://media.giphy.com/media/l0MYt5jPR6QX5pnqM/giphy.gif", width: 480, height: 270 }
  *   ],
  * })
  * ```
  *
+ * A post holds 1 to 10 attachments. A GIF is a link, not a file, and takes no product tags.
+ *
  * Creates an {@link Amity.Post}
  *
  * @param bundle The data necessary to create a new {@link Amity.Post}
@@ -30994,17 +31043,7 @@ const createMixedMediaPost = async (bundle) => {
     const client = getActiveClient();
     client.log('post/createMixedMediaPost', bundle);
     const { attachments, attachmentProductTags } = bundle, rest = __rest(bundle, ["attachments", "attachmentProductTags"]);
-    const processedAttachments = attachments && attachments.length > 0 && bundle.attachmentProductTags
-        ? attachments.map(attachment => {
-            var _a;
-            /* c8 ignore next */
-            const productTags = (_a = bundle.attachmentProductTags) === null || _a === void 0 ? void 0 : _a.get(attachment.fileId);
-            if (productTags)
-                return Object.assign(Object.assign({}, attachment), { productTags });
-            /* c8 ignore next */
-            return attachment;
-        })
-        : /* c8 ignore next */ attachments;
+    const processedAttachments = preparePostAttachments(attachments, attachmentProductTags);
     const { data: payload } = await client.http.post('/api/v4/posts', Object.assign(Object.assign({}, rest), { attachments: processedAttachments }));
     fireEvent('post.created', payload);
     const data = preparePostPayload(payload);
@@ -31521,6 +31560,10 @@ class PostLiveCollectionController extends LiveCollectionController {
  *
  * Observe all mutations on a list of {@link Amity.Post} for a given target object
  *
+ * GIF posts come back on every API version. This query is on v5, so `dataTypes: ['gif']` filters
+ * them; a post with GIFs beside other media is `mixed` and is hidden unless
+ * `includeMixedStructure` is `true`.
+ *
  * @param params.targetType the type of the target
  * @param params.targetId the ID of the target
  * @param callback the function to call when new data are available