@amityco/ts-sdk 7.5.3-d6ee46d.0 → 7.5.4-2d34fd5f.0

package/src/fileRepository/api/uploadClip.ts

@@ -0,0 +1,71 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
+
+/* begin_public_function
+  id: file.upload.clip
+*/
+/**
+ * ```js
+ * import { FileRepository } from '@amityco/ts-sdk'
+ * const created = await FileRepository.uploadClip(formData)
+ * ```
+ *
+ * Creates an {@link Amity.File}
+ *
+ * @param formData The data necessary to create a new {@link Amity.File}
+ * @param onProgress The callback to track the upload progress
+ * @returns The newly created {@link Amity.File}
+ *
+ * @category File API
+ * @async
+ */
+export const uploadClip = async (
+  formData: FormData,
+  feedType?: Amity.ContentFeedType,
+  onProgress?: (percent: number) => void,
+): Promise<Amity.Cached<Amity.File<'clip'>[]>> => {
+  const client = getActiveClient();
+  client.log('file/uploadClip', formData);
+
+  const file = formData.get('files');
+
+  if (!file) throw new Error('The formData object must have a `files` key.');
+
+  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
+  formData.append('accessType', accessType);
+
+  formData.append('preferredFilename', (file as File).name);
+
+  if (feedType) {
+    formData.append('feedType', feedType);
+  }
+
+  const headers =
+    'getHeaders' in formData
+      ? (formData as any).getHeaders()
+      : { 'content-type': 'multipart/form-data' };
+
+  const { data } = await client.upload.post<Amity.CreateFilePayload<'clip'>>(
+    '/api/v4/clips',
+    formData,
+    {
+      headers,
+      onUploadProgress({ loaded, total = 100 }) {
+        onProgress && onProgress(Math.round((loaded * 100) / total));
+      },
+    },
+  );
+
+  // API-FIX: payload should be serialized properly
+  // const { files } = data
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache({ files: data }, { cachedAt });
+
+  return {
+    data,
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/postRepository/api/createClipPost.ts

@@ -0,0 +1,62 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+import { prepareMembershipPayload } from '~/group/utils';
+import { LinkedObject } from '~/utils/linkedObject';
+
+/* begin_public_function
+  id: post.create.clip_post
+*/
+/**
+ * ```js
+ * import { PostRepository } from '@amityco/ts-sdk'
+ * const created = await PostRepository.createClipPost({
+ *   targetType: 'user',
+ *   targetId: 'foobar',
+ *   dataType: 'clip',
+ *   data: { text: 'hello world' },
+ *   attachments: [{ type: 'clip', fileId: 'fileId123', displayMode: 'fill', isMuted: false }]
+ * }))
+ * ```
+ *
+ * Creates an {@link Amity.Post}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Post}
+ * @returns The newly created {@link Amity.Post}
+ *
+ * @category Post API
+ * @async
+ */
+export const createClipPost = async <T extends Amity.PostContentType | string>(
+  bundle: Pick<Amity.Post<T>, 'targetType' | 'targetId'> &
+    Partial<Pick<Amity.Post<T>, 'metadata' | 'mentionees' | 'tags'>> & {
+      data: { [k: string]: any };
+      attachments: {
+        type: T;
+        fileId: Amity.File['fileId'];
+        displayMode?: Amity.ClipDisplayMode;
+        isMuted?: boolean;
+      }[];
+    },
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/createPost', bundle);
+
+  const { data: payload } = await client.http.post<Amity.PostPayload>('/api/v4/posts', bundle);
+
+  fireEvent('post.created', payload);
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { posts } = data;
+
+  return {
+    data: LinkedObject.post(posts[0]),
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/postRepository/api/getPost.ts

@@ -22,7 +22,9 @@ import { LinkedObject } from '~/utils/linkedObject';
  * @category Post API
  * @async
  */
-export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cached<Amity.Post>> => {
+export const getPost = async (
+  postId: Amity.Post['postId'],
+): Promise<Amity.Cached<Amity.InternalPost>> => {
   const client = getActiveClient();
   client.log('post/getPost', postId);
 
@@ -54,7 +56,7 @@ export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cache
   const result = posts.find(post => post.postId === postId)!;
 
   return {
-    data: LinkedObject.post(result),
+    data: result,
     cachedAt,
   };
 };
@@ -72,7 +74,7 @@ export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cache
  *
  * @category Post API
  */
-getPost.locally = (postId: Amity.Post['postId']): Amity.Cached<Amity.Post> | undefined => {
+getPost.locally = (postId: Amity.Post['postId']): Amity.Cached<Amity.InternalPost> | undefined => {
   const client = getActiveClient();
   client.log('post/getPost.locally', postId);
 
@@ -83,7 +85,7 @@ getPost.locally = (postId: Amity.Post['postId']): Amity.Cached<Amity.Post> | und
   if (!cached) return;
 
   return {
-    data: LinkedObject.post(cached.data),
+    data: cached.data,
     cachedAt: cached.cachedAt,
   };
 };

package/src/postRepository/api/index.ts

@@ -13,3 +13,5 @@ export * from './declinePost';
 export * from './flagPost';
 export * from './unflagPost';
 export * from './isPostFlaggedByMe';
+
+export * from './createClipPost';

package/src/postRepository/api/queryPosts.ts

@@ -43,7 +43,7 @@ export const queryPosts = async (
   // API-FIX: parameters should be querystring. (1)
   // API-FIX: backend should answer Amity.Response (2)
   // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.PostPayload>>>(
-  const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(`/api/v4/posts`, {
+  const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(`/api/v5/posts`, {
     params: {
       ...params,
       isDeleted: inferIsDeleted(includeDeleted),

package/src/postRepository/observers/getPost.ts

@@ -85,12 +85,12 @@ export const getPost = (
     onPostFlagged,
     (callback: Amity.Listener<Amity.InternalPost>) => {
       return onPostReactionAdded((post: Amity.InternalPost) => {
-        callback(LinkedObject.post(post));
+        callback(post);
       });
     },
     (callback: Amity.Listener<Amity.InternalPost>) => {
       return onPostReactionRemoved((post: Amity.InternalPost) => {
-        callback(LinkedObject.post(post));
+        callback(post);
       });
     },
     onPostUnflagged,

package/src/postRepository/observers/getPosts/PostPaginationController.ts

@@ -23,7 +23,7 @@ export class PostPaginationController extends PaginationController<
     const options = token ? { ...baseOptions, token } : { ...baseOptions, limit };
 
     const { data: queryResponse } = await this.http.get<Amity.PostPayload & Amity.Pagination>(
-      `/api/v4/posts`,
+      `/api/v5/posts`,
       {
         params: {
           ...params,

package/src/reactionRepository/api/addReaction.ts

@@ -59,7 +59,7 @@ export const addReaction = async (
       referenceId,
     ]);
 
-    if (!model) return true;
+    if (!model || model.data.myReactions?.includes(reactionName)) return true;
 
     const updatedModel = {
       ...model.data,

package/src/userRepository/observers/getBlockedUsers.ts

@@ -12,10 +12,10 @@ import { BlockedUserLiveCollectionController } from './getBlockedUsers/BlockedUs
  * const unblockedUser = await UserRepository.blockUser('userId')
  * ```
  *
- * Blocks a {@link Amity.InternalUser}
+ * Blocks a {@link Amity.User}
  *
- * @param params The params to get blocked {@link Amity.InternalUser}s
- * @param callback to recieve updates on unblocked {@link Amity.InternalUser}s
+ * @param params The params to get blocked {@link Amity.User}s
+ * @param callback to recieve updates on unblocked {@link Amity.User}s
  * @returns {@link Amity.Unsubscriber} to unsubscribe from collection
  *
  * @category Post API
@@ -23,7 +23,7 @@ import { BlockedUserLiveCollectionController } from './getBlockedUsers/BlockedUs
  */
 export const getBlockedUsers = (
   params: Amity.BlockedUsersLiveCollection,
-  callback: Amity.LiveCollectionCallback<Amity.InternalUser>,
+  callback: Amity.LiveCollectionCallback<Amity.User>,
   config?: Amity.LiveCollectionConfig,
 ): Amity.Unsubscriber => {
   const { log, cache } = getActiveClient();

package/src/utils/linkedObject/postLinkedObject.ts

@@ -2,7 +2,12 @@ import { pullFromCache } from '~/cache/api';
 import { commentLinkedObject } from '~/utils/linkedObject/commentLinkedObject';
 import AnalyticsEngine from '../../analytic/service/analytic/AnalyticsEngine';
 import { userLinkedObject } from './userLinkedObject';
-import { isAmityFilePost, isAmityImagePost, isAmityVideoPost } from '../postTypePredicate';
+import {
+  isAmityClipPost,
+  isAmityFilePost,
+  isAmityImagePost,
+  isAmityVideoPost,
+} from '../postTypePredicate';
 
 export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
   return {
@@ -64,5 +69,11 @@ export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
         ? pullFromCache<Amity.File<'file'>>(['file', 'get', post?.data?.fileId])?.data
         : undefined;
     },
+
+    getClipInfo(): Amity.File<'clip'> | undefined {
+      return isAmityClipPost(post)
+        ? pullFromCache<Amity.File<'clip'>>(['file', 'get', post?.data?.fileId])?.data
+        : undefined;
+    },
   };
 };

package/src/utils/linkedObject/streamLinkedObject.ts

@@ -9,7 +9,7 @@ export const streamLinkedObject = (stream: Amity.InternalStream): Amity.Stream =
     },
     get post() {
       if (stream.referenceType !== 'post') return;
-      return pullFromCache<Amity.Post>(['post', 'get', stream.referenceId])?.data;
+      return pullFromCache<Amity.InternalPost>(['post', 'get', stream.referenceId])?.data;
     },
     get community() {
       if (stream.targetType !== 'community') return;

package/src/utils/postTypePredicate.ts

@@ -25,3 +25,13 @@ export function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'
     post.dataType === 'video'
   );
 }
+
+export function isAmityClipPost(post: Amity.InternalPost): post is Amity.Post<'clip'> {
+  return !!(
+    post.data &&
+    typeof post.data !== 'string' &&
+    'fileId' in post.data &&
+    'thumbnailFileId' in post.data &&
+    post.dataType === 'clip'
+  );
+}