@amityco/ts-sdk 7.2.1-3663404.0 → 7.2.1-50ce75a.0

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":"AAKA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAiCjE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.2.1-03663404.0",
+  "version": "7.2.1-50ce75a.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

@@ -55,29 +55,7 @@ declare global {
 
     // API-FIX: backend should return a payload like { files: Amity.File<T>[] }
     type CreateFilePayload<T extends Amity.FileType = any> = Amity.File<T>[];
-
-    type VideoFileExtraPayload = {
-      feedType: Amity.ContentFeedType;
-      status: Amity.VideoTranscodingStatus;
-      videoUrl?: { [name in Amity.VideoResolution]?: string } | null;
-    };
-
-    type FilePayload<T extends Amity.FileType = any> = {
-      fileId: string;
-      type: T;
-      altText?: string;
-      fileUrl: string;
-      attributes: {
-        name: string;
-        extension: string;
-        size: string;
-        mimeType: string;
-        metadata: Amity.MetadataFor<T>;
-      };
-      accessType: Amity.FileAccessType;
-    } & (T extends 'video' ? Amity.VideoFileExtraPayload : unknown) &
-      Amity.Timestamps &
-      Amity.SoftDelete;
+    type FilePayload<T extends Amity.FileType = any> = Amity.File<T>;
 
     type RolePayload = {
       roles: Amity.Role[];

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

@@ -31,7 +31,7 @@ declare global {
       image9_16: string;
       callToAction: string;
       callToActionUrl: string;
-      targets: Amity.AdTarget;
+      target: Amity.AdTarget;
       startAt: Amity.timestamp;
       endAt?: Amity.timestamp;
       createdAt: Amity.timestamp;

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

@@ -63,6 +63,26 @@ declare global {
       ? VideoMetadata
       : never;
 
-    type File<T extends FileType = any> = Amity.FilePayload<T>;
+    type VideoFileExtraPayload = {
+      feedType: Amity.ContentFeedType;
+      status: VideoTranscodingStatus;
+      videoUrl?: { [name in VideoResolution]?: string } | null;
+    };
+
+    type File<T extends FileType = any> = {
+      fileId: string;
+      type: T;
+      fileUrl: string;
+      attributes: {
+        name: string;
+        extension: string;
+        size: string;
+        mimeType: string;
+        metadata: MetadataFor<T>;
+      };
+      accessType: FileAccessType;
+    } & (T extends 'video' ? VideoFileExtraPayload : unknown) &
+      Amity.Timestamps &
+      Amity.SoftDelete;
   }
 }

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

@@ -61,10 +61,6 @@ declare global {
       analytics: {
         markAsViewed: () => void;
       };
-      getImageInfo: () => Amity.File<'image'> | undefined;
-      getVideoInfo: () => Amity.File<'video'> | undefined;
-      getVideoThumbnailInfo: () => Amity.File<'image'> | undefined;
-      getFileInfo: () => Amity.File<'file'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;

package/src/fileRepository/api/index.ts

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

package/src/fileRepository/api/uploadImage.ts

@@ -16,46 +16,27 @@ import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
  *
  * @param formData The data necessary to create a new {@link Amity.File<'image'>}
  * @param onProgress The callback to track the upload progress
- * @param altText The alt text for the image
  * @returns The newly created {@link Amity.File<'image'>}
  *
  * @category File API
  * @async
  */
-
 export const uploadImage = async (
   formData: FormData,
   onProgress?: (percent: number) => void,
-  altText?: string,
 ): Promise<Amity.Cached<Amity.File<'image'>[]>> => {
   const client = getActiveClient();
   client.log('file/uploadImage', formData);
 
   const files = formData.getAll('files');
 
-  if (files?.length) {
-    console.warn('Deprecation Warning: `files` is deprecated, please use `file` instead.');
-
-    formData.append('preferredFilename', (files[0] as File).name);
-  } else {
-    const file = formData.get('file') as File;
-
-    if (!file) {
-      throw new Error('The formData object must have a `file` or `files` key');
-    }
-
-    formData.append('preferredFilename', file.name);
-
-    // alt is for single image
-    if (altText) {
-      formData.append('altText', altText);
-    }
-  }
+  if (!files.length) throw new Error('The formData object must have a `files` key.');
 
   const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-
   formData.append('accessType', accessType);
 
+  formData.append('preferredFilename', (files[0] as File).name);
+
   const headers =
     'getHeaders' in formData
       ? (formData as any).getHeaders()

package/src/utils/linkedObject/postLinkedObject.ts

@@ -2,19 +2,16 @@ 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';
 
 export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
   return {
     ...post,
-
     analytics: {
       markAsViewed: () => {
         const analyticsEngineInstance = AnalyticsEngine.getInstance();
         analyticsEngineInstance.markPostAsViewed(post.postId);
       },
     },
-
     get latestComments(): (Amity.Comment | null)[] {
       if (!post.comments) return [];
       return (
@@ -33,36 +30,10 @@ export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
           .filter(Boolean) || []
       );
     },
-
     get creator(): Amity.User | undefined {
       const cacheData = pullFromCache<Amity.User>(['user', 'get', post.postedUserId]);
       if (!cacheData?.data) return;
       return userLinkedObject(cacheData.data);
     },
-
-    getImageInfo(): Amity.File<'image'> | undefined {
-      return isAmityImagePost(post)
-        ? pullFromCache<Amity.File<'image'>>(['file', 'get', post?.data?.fileId])?.data
-        : undefined;
-    },
-
-    getVideoInfo(): Amity.File<'video'> | undefined {
-      return isAmityVideoPost(post)
-        ? pullFromCache<Amity.File<'video'>>(['file', 'get', post?.data?.videoFileId?.original])
-            ?.data
-        : undefined;
-    },
-
-    getVideoThumbnailInfo(): Amity.File<'image'> | undefined {
-      return isAmityVideoPost(post)
-        ? pullFromCache<Amity.File<'image'>>(['file', 'get', post?.data?.thumbnailFileId])?.data
-        : undefined;
-    },
-
-    getFileInfo(): Amity.File<'file'> | undefined {
-      return isAmityFilePost(post)
-        ? pullFromCache<Amity.File<'file'>>(['file', 'get', post?.data?.fileId])?.data
-        : undefined;
-    },
   };
 };

package/dist/fileRepository/api/updateAltText.d.ts

@@ -1,17 +0,0 @@
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const updated = await FileRepository.updateAltText(fileId, altText)
- * ```
- *
- * Updates an {@link Amity.File<'image'>['altText']}.
- *
- * @param fileId The ID of the {@link Amity.File<'image'>} to edit
- * @param altText The new alt text for the {@link Amity.File<'image'>}
- * @returns the updated {@link Amity.File<'image'>} object
- *
- * @category File API
- * @async
- */
-export declare const updateAltText: (fileId: Amity.File['fileId'], altText: string) => Promise<boolean>;
-//# sourceMappingURL=updateAltText.d.ts.map

package/dist/fileRepository/api/updateAltText.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateAltText.d.ts","sourceRoot":"","sources":["../../../src/fileRepository/api/updateAltText.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,WAChB,UAAU,CAAC,QAAQ,CAAC,WACnB,MAAM,KACd,QAAQ,OAAO,CAajB,CAAC"}

package/dist/utils/postTypePredicate.d.ts

@@ -1,4 +0,0 @@
-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'>;
-//# sourceMappingURL=postTypePredicate.d.ts.map

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

@@ -1 +0,0 @@
-{"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"}

package/src/fileRepository/api/updateAltText.ts

@@ -1,39 +0,0 @@
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { getActiveClient } from '~/client';
-
-/* begin_public_function
-  id: file.update.altText
-*/
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const updated = await FileRepository.updateAltText(fileId, altText)
- * ```
- *
- * Updates an {@link Amity.File<'image'>['altText']}.
- *
- * @param fileId The ID of the {@link Amity.File<'image'>} to edit
- * @param altText The new alt text for the {@link Amity.File<'image'>}
- * @returns the updated {@link Amity.File<'image'>} object
- *
- * @category File API
- * @async
- */
-export const updateAltText = async (
-  fileId: Amity.File['fileId'],
-  altText: string,
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('file/updateAltText', altText);
-
-  const { data } = await client.http.put<Amity.FilePayload<'image'>>(`/api/v3/files/${fileId}`, {
-    altText,
-  });
-
-  const cachedAt = client.cache && Date.now();
-
-  if (client.cache) ingestInCache({ files: [data] }, { cachedAt });
-
-  return true;
-};
-/* end_public_function */

package/src/utils/postTypePredicate.ts

@@ -1,27 +0,0 @@
-export function isAmityImagePost(post: Amity.InternalPost): post is Amity.Post<'image'> {
-  return !!(
-    post.data &&
-    typeof post.data !== 'string' &&
-    'fileId' in post.data &&
-    post.dataType === 'image'
-  );
-}
-
-export function isAmityFilePost(post: Amity.InternalPost): post is Amity.Post<'file'> {
-  return !!(
-    post.data &&
-    typeof post.data !== 'string' &&
-    'fileId' in post.data &&
-    post.dataType === 'file'
-  );
-}
-
-export function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'video'> {
-  return !!(
-    post.data &&
-    typeof post.data !== 'string' &&
-    'videoFileId' in post.data &&
-    'thumbnailFileId' in post.data &&
-    post.dataType === 'video'
-  );
-}