@amityco/ts-sdk-react-native 7.6.0 → 7.7.0

package/dist/messagePreview/utils/getSubChannelMessagePreviewWithUser.d.ts

@@ -3,7 +3,7 @@ export declare const getSubChannelMessagePreviewWithUser: (subChannel: Amity.Sub
         user: Amity.InternalUser | undefined;
         messagePreviewId: string;
         subChannelName: string;
-        data?: string | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Record<string, unknown> | undefined;
+        data?: string | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | Record<string, unknown> | undefined;
         dataType?: any;
         channelId: string;
         subChannelId: string;

package/dist/postRepository/api/createClipPost.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```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 declare const createClipPost: <T extends string>(bundle: Pick<Amity.Post<T>, "targetType" | "targetId"> & Partial<Pick<Amity.Post<T>, "metadata" | "tags" | "mentionees">> & {
+    data: {
+        [k: string]: any;
+    };
+    attachments: {
+        type: T;
+        fileId: Amity.File['fileId'];
+        displayMode?: Amity.ClipDisplayMode | undefined;
+        isMuted?: boolean | undefined;
+    }[];
+}) => Promise<Amity.Cached<Amity.Post>>;
+//# sourceMappingURL=createClipPost.d.ts.map

package/dist/postRepository/api/createClipPost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createClipPost.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/createClipPost.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc;;;;;;gBAMX,UAAU,CAAC,QAAQ,CAAC;;;;MAKjC,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAmBlC,CAAC"}

package/dist/postRepository/api/index.d.ts

@@ -9,4 +9,5 @@ export * from './declinePost';
 export * from './flagPost';
 export * from './unflagPost';
 export * from './isPostFlaggedByMe';
+export * from './createClipPost';
 //# sourceMappingURL=index.d.ts.map

package/dist/postRepository/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAE/B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAE3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAE9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAE/B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAE3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAE9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,kBAAkB,CAAC"}

package/dist/utils/linkedObject/postLinkedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IA6DjE,CAAC"}
+{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAmEjE,CAAC"}

package/dist/utils/postTypePredicate.d.ts

@@ -1,4 +1,5 @@
 export declare function isAmityImagePost(post: Amity.InternalPost): post is Amity.Post<'image'>;
 export declare function isAmityFilePost(post: Amity.InternalPost): post is Amity.Post<'file'>;
 export declare function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'video'>;
+export declare function isAmityClipPost(post: Amity.InternalPost): post is Amity.Post<'clip'>;
 //# sourceMappingURL=postTypePredicate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"postTypePredicate.d.ts","sourceRoot":"","sources":["../../src/utils/postTypePredicate.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAQtF"}
+{"version":3,"file":"postTypePredicate.d.ts","sourceRoot":"","sources":["../../src/utils/postTypePredicate.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAQtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF"}

package/dist/utils/tests/dummy/comment.d.ts

@@ -23,7 +23,7 @@ export declare const generateComment: (params?: Partial<Amity.InternalComment>)
     referenceType: Amity.CommentReferenceType;
     dataType?: any;
     dataTypes?: any[] | undefined;
-    data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | undefined;
+    data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
     metadata?: Record<string, any> | undefined;
     flagCount: number;
     hashFlag: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk-react-native",
-  "version": "7.6.0",
+  "version": "7.7.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/core/payload.ts

@@ -78,7 +78,7 @@ declare global {
         metadata: Amity.MetadataFor<T>;
       };
       accessType: Amity.FileAccessType;
-    } & (T extends 'video' ? Amity.VideoFileExtraPayload : unknown) &
+    } & (T extends 'video' | 'clip' ? Amity.VideoFileExtraPayload : unknown) &
       Amity.Timestamps &
       Amity.SoftDelete;
 

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

@@ -32,6 +32,7 @@ declare global {
       | 'poll'
       | 'json'
       | 'liveStream'
+      | 'clip'
       | string;
 
     type ContentFeedType = ValueOf<typeof ContentFeedType>;
@@ -62,6 +63,13 @@ declare global {
       };
     };
 
+    type ContentDataClip = {
+      thumbnailFileId: Amity.File<'image'>['fileId'];
+      fileId: Amity.File<'clip'>['fileId'];
+      isMuted?: boolean;
+      displayMode?: Amity.ClipDisplayMode;
+    };
+
     type ContentDataPoll = {
       pollId: Amity.Poll['pollId'];
     };
@@ -82,6 +90,8 @@ declare global {
       ? ContentDataPoll
       : T extends 'liveStream'
       ? ContentDataStream
+      : T extends 'clip'
+      ? ContentDataClip
       : T extends 'json'
       ? Record<string, unknown>
       : T extends string

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

@@ -11,8 +11,9 @@ declare global {
     } & Amity.Timestamps;
 
     type QueryGlobalFeed = {
-      dataType?: 'video' | 'image' | 'file' | 'liveStream';
+      dataTypes?: ('video' | 'image' | 'file' | 'liveStream' | 'clip')[];
       queryToken?: string;
+      resolveParent?: boolean;
     };
   }
 }

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

@@ -2,6 +2,7 @@ export const FileType = Object.freeze({
   FILE: 'file',
   IMAGE: 'image',
   VIDEO: 'video',
+  CLIP: 'clip',
 });
 
 export const VideoResolution = Object.freeze({
@@ -55,12 +56,16 @@ declare global {
 
     type VideoMetadata = Record<string, never>;
 
+    type ClipMetadata = Record<string, never>;
+
     type MetadataFor<T extends FileType> = T extends 'file'
       ? FileMetadata
       : T extends 'image'
       ? ImageMetadata
       : T extends 'video'
       ? VideoMetadata
+      : T extends 'clip'
+      ? ClipMetadata
       : never;
 
     type File<T extends FileType = any> = Amity.FilePayload<T>;

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

@@ -5,6 +5,7 @@ export const PostContentType = Object.freeze({
   VIDEO: 'video',
   LIVESTREAM: 'liveStream',
   POLL: 'poll',
+  CLIP: 'clip',
 });
 
 declare global {
@@ -82,10 +83,13 @@ declare global {
       getVideoInfo: () => Amity.File<'video'> | undefined;
       getVideoThumbnailInfo: () => Amity.File<'image'> | undefined;
       getFileInfo: () => Amity.File<'file'> | undefined;
+      getClipInfo: () => Amity.File<'clip'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;
 
+    type ClipDisplayMode = 'fill' | 'fit';
+
     type QueryPosts = {
       targetId: string;
       targetType: Amity.InternalPost['targetType'];

package/src/communityRepository/api/getCommunity.ts

@@ -5,7 +5,6 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { saveCommunityUsers } from '~/communityRepository/utils/saveCommunityUsers';
 import { prepareCommunityPayload } from '../utils';
-import { LinkedObject } from '~/utils/linkedObject';
 
 /**
  * ```js
@@ -23,8 +22,6 @@ import { LinkedObject } from '~/utils/linkedObject';
  */
 export const getCommunity = async (
   communityId: Amity.Community['communityId'],
-  type?: Amity.JoinRequestType,
-  includeDiscoverablePrivateCommunity?: boolean,
 ): Promise<Amity.Cached<Amity.InternalCommunity>> => {
   const client = getActiveClient();
   client.log('community/getCommunity', communityId);
@@ -32,12 +29,6 @@ export const getCommunity = async (
   // API-FIX: endpoint should not be /list, parameters should be querystring.
   const { data: payload } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/${communityId}`,
-    {
-      params: {
-        type: 'communityJoinRequest',
-        includeDiscoverablePrivateCommunity: includeDiscoverablePrivateCommunity ?? true,
-      },
-    },
   );
 
   const data = prepareCommunityPayload(payload);

package/src/feedRepository/api/getCustomRankingGlobalFeed.ts

@@ -23,7 +23,7 @@ import { LinkedObject } from '~/utils/linkedObject';
  * @async
  * */
 export const getCustomRankingGlobalFeed = async (query?: {
-  dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[];
+  dataTypes?: ('video' | 'image' | 'file' | 'liveStream' | 'clip')[];
   limit?: number;
   queryToken?: string;
 }): Promise<

package/src/feedRepository/api/queryGlobalFeed.ts

@@ -32,7 +32,7 @@ export const queryGlobalFeed = async (
   const client = getActiveClient();
   client.log('feed/queryGlobalFeed', query);
 
-  const { queryToken, ...params } = query ?? {};
+  const { queryToken, dataTypes, resolveParent, ...params } = query ?? {};
 
   const options = (() => {
     if (queryToken) return { token: queryToken };
@@ -44,6 +44,8 @@ export const queryGlobalFeed = async (
     {
       params: {
         ...params,
+        dataTypes,
+        resolveParent: resolveParent ?? true,
         options,
       },
     },

package/src/fileRepository/api/index.ts

@@ -5,3 +5,4 @@ export * from './fileUrlWithSize';
 export * from './uploadVideo';
 export * from './uploadImage';
 export * from './updateAltText';
+export * from './uploadClip';

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/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/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/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/postTypePredicate.ts

@@ -25,3 +25,12 @@ 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 &&
+    post.dataType === 'clip'
+  );
+}