@amityco/ts-sdk 7.9.2-5367a1e.0 → 7.9.2-9906a74f.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 | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
+        data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataAudio | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
         dataType?: any;
         channelId: string;
         subChannelId: string;

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

@@ -0,0 +1,30 @@
+/**
+ * ```js
+ * import { PostRepository } from '@amityco/ts-sdk'
+ * const created = await PostRepository.createAudioPost({
+ *   targetType: 'user',
+ *   targetId: 'foobar',
+ *   data: { text: 'Audio Post', title: 'Audio Post Title' },
+ *   attachments: [{ type: 'audio', fileId: 'fileId123'}]
+ * }))
+ * ```
+ *
+ * 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 createAudioPost: <T extends string = "audio">(bundle: Pick<Amity.Post<T>, "targetId" | "targetType"> & Partial<Pick<Amity.Post<T>, "tags" | "metadata" | "mentionees" | "hashtags">> & {
+    data: {
+        text?: string;
+        title?: string;
+    };
+    attachments: {
+        type: T;
+        fileId: Amity.File['fileId'];
+    }[];
+}) => Promise<Amity.Cached<Amity.Post>>;
+//# sourceMappingURL=createAudioPost.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createAudioPost.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/createAudioPost.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,eAAe;UAGhB;QACJ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;;;gBAGS,UAAU,CAAC,QAAQ,CAAC;;MAGjC,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAkBlC,CAAC"}

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

@@ -10,4 +10,5 @@ export * from './flagPost';
 export * from './unflagPost';
 export * from './isPostFlaggedByMe';
 export * from './createClipPost';
+export * from './createAudioPost';
 //# 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;AAEpC,cAAc,kBAAkB,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;AACjC,cAAc,mBAAmB,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":"AAgBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAwFjE,CAAC"}
+{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IA8FjE,CAAC"}

package/dist/utils/postTypePredicate.d.ts

@@ -4,4 +4,5 @@ export declare function isAmityVideoPost(post: Amity.InternalPost): post is Amit
 export declare function isAmityLivestreamPost(post: Amity.InternalPost): post is Amity.Post<'liveStream'>;
 export declare function isAmityPollPost(post: Amity.InternalPost): post is Amity.Post<'poll'>;
 export declare function isAmityClipPost(post: Amity.InternalPost): post is Amity.Post<'clip'>;
+export declare function isAmityAudioPost(post: Amity.InternalPost): post is Amity.Post<'audio'>;
 //# 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;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAOhG;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF"}
+{"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,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAOhG;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;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,CAOtF"}

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 | Amity.ContentDataClip | undefined;
+    data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataAudio | 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",
-  "version": "7.9.2-5367a1e.0",
+  "version": "7.9.2-9906a74f.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/domains/content.ts

@@ -33,6 +33,7 @@ declare global {
       | 'json'
       | 'liveStream'
       | 'clip'
+      | 'audio'
       | string;
 
     type ContentFeedType = ValueOf<typeof ContentFeedType>;
@@ -71,6 +72,14 @@ declare global {
       displayMode?: Amity.ClipDisplayMode;
     };
 
+    type ContentDataAudio = {
+      fileId: Amity.File<'audio'>['fileId'];
+      fileURL: URL;
+      accessType: Amity.FileAccessType;
+      altText?: string;
+      attributes: { [key: string]: any };
+    };
+
     type ContentDataPoll = {
       pollId: Amity.Poll['pollId'];
     };
@@ -87,6 +96,8 @@ declare global {
       ? ContentDataImage
       : T extends 'video'
       ? ContentDataVideo
+      : T extends 'audio'
+      ? ContentDataAudio
       : T extends 'poll'
       ? ContentDataPoll
       : T extends 'liveStream'

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

@@ -3,6 +3,7 @@ export const FileType = Object.freeze({
   IMAGE: 'image',
   VIDEO: 'video',
   CLIP: 'clip',
+  AUDIO: 'audio',
 });
 
 export const VideoResolution = Object.freeze({
@@ -58,6 +59,8 @@ declare global {
 
     type ClipMetadata = Record<string, never>;
 
+    type AudioMetadata = Record<string, never>;
+
     type MetadataFor<T extends FileType> = T extends 'file'
       ? FileMetadata
       : T extends 'image'
@@ -66,6 +69,8 @@ declare global {
       ? VideoMetadata
       : T extends 'clip'
       ? ClipMetadata
+      : T extends 'audio'
+      ? AudioMetadata
       : never;
 
     type File<T extends FileType = any> = Amity.FilePayload<T>;

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

@@ -88,6 +88,7 @@ declare global {
       getPollInfo: () => Amity.Poll | undefined;
       getLivestreamInfo: () => Amity.Stream | undefined;
       getClipInfo: () => Amity.File<'clip'> | undefined;
+      getAudioInfo: () => Amity.File<'audio'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;

package/src/fileRepository/api/index.ts

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

package/src/fileRepository/api/uploadAudio.ts

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

package/src/postRepository/api/createAudioPost.ts

@@ -0,0 +1,60 @@
+import { fireEvent } from '~/core/events';
+import { postLinkedObject } from '~/utils/linkedObject/postLinkedObject';
+import { getActiveClient } from '~/client/api/activeClient';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { preparePostPayload } from '../utils/payload';
+
+/* begin_public_function
+  id: post.create.audio_post
+*/
+/**
+ * ```js
+ * import { PostRepository } from '@amityco/ts-sdk'
+ * const created = await PostRepository.createAudioPost({
+ *   targetType: 'user',
+ *   targetId: 'foobar',
+ *   data: { text: 'Audio Post', title: 'Audio Post Title' },
+ *   attachments: [{ type: 'audio', fileId: 'fileId123'}]
+ * }))
+ * ```
+ *
+ * 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 createAudioPost = async <T extends Amity.PostContentType = 'audio'>(
+  bundle: Pick<Amity.Post<T>, 'targetType' | 'targetId'> &
+    Partial<Pick<Amity.Post<T>, 'metadata' | 'mentionees' | 'tags' | 'hashtags'>> & {
+      data: {
+        text?: string;
+        title?: string;
+      };
+      attachments: {
+        type: T;
+        fileId: Amity.File['fileId'];
+      }[];
+    },
+): Promise<Amity.Cached<Amity.Post>> => {
+  const client = getActiveClient();
+  client.log('post/createAudioPost', bundle);
+
+  const { data: payload } = await client.http.post<Amity.PostPayload>('/api/v4/posts', bundle);
+
+  fireEvent('post.created', payload);
+
+  const data = preparePostPayload(payload);
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: postLinkedObject(data?.posts[0]),
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/postRepository/api/index.ts

@@ -15,3 +15,4 @@ export * from './unflagPost';
 export * from './isPostFlaggedByMe';
 
 export * from './createClipPost';
+export * from './createAudioPost';

package/src/utils/linkedObject/postLinkedObject.ts

@@ -9,6 +9,7 @@ import {
   isAmityPollPost,
   isAmityVideoPost,
   isAmityClipPost,
+  isAmityAudioPost,
 } from '../postTypePredicate';
 import { shallowClone } from '../shallowClone';
 import { streamLinkedObject } from './streamLinkedObject';
@@ -101,5 +102,11 @@ export const postLinkedObject = (post: Amity.InternalPost): Amity.Post => {
         ? pullFromCache<Amity.File<'clip'>>(['file', 'get', post?.data?.fileId])?.data
         : undefined;
     },
+
+    getAudioInfo(): Amity.File<'audio'> | undefined {
+      return isAmityAudioPost(post)
+        ? pullFromCache<Amity.File<'audio'>>(['file', 'get', post?.data?.fileId])?.data
+        : undefined;
+    },
   });
 };

package/src/utils/postTypePredicate.ts

@@ -52,3 +52,12 @@ export function isAmityClipPost(post: Amity.InternalPost): post is Amity.Post<'c
     post.dataType === 'clip'
   );
 }
+
+export function isAmityAudioPost(post: Amity.InternalPost): post is Amity.Post<'audio'> {
+  return !!(
+    post.data &&
+    typeof post.data !== 'string' &&
+    'fileId' in post.data &&
+    post.dataType === 'audio'
+  );
+}