@amityco/ts-sdk 7.10.1-c2a9783.0 → 7.10.1-ec1ce4a3.0

package/src/fileRepository/api/uploadImage.ts

@@ -1,86 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/* begin_public_function
-  id: file.upload.image
-*/
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const created = await FileRepository.uploadImage(formData)
- * ```
- *
- * Creates an {@link Amity.File<'image'>}
- *
- * @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);
-    }
-  }
-
-  const accessType = GlobalFileAccessType.getInstance().getFileAccessType();
-
-  formData.append('accessType', accessType);
-
-  const headers =
-    'getHeaders' in formData
-      ? (formData as any).getHeaders()
-      : { 'content-type': 'multipart/form-data' };
-
-  const { data } = await client.upload.post<Amity.CreateFilePayload<'image'>>(
-    '/api/v4/images',
-    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/fileRepository/api/uploadVideo.ts

@@ -1,73 +0,0 @@
-import { getActiveClient } from '~/client/api';
-
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import GlobalFileAccessType from '~/client/utils/GlobalFileAccessType';
-
-/* begin_public_function
-  id: file.upload.video, file.upload.audio
-*/
-/**
- * ```js
- * import { FileRepository } from '@amityco/ts-sdk'
- * const created = await FileRepository.uploadVideo(formData)
- * ```
- *
- * Creates an {@link Amity.File<'video'>}
- *
- * @param formData The data necessary to create a new {@link Amity.File<'video'>}
- * @param feedType The {@link Amity.File<'video'>} feed type
- * @param onProgress The callback to track the upload progress
- * @returns The newly uploaded {@link Amity.File<'video'>}
- *
- * @category File API
- * @async
- */
-export const uploadVideo = async (
-  formData: FormData,
-  feedType?: Amity.ContentFeedType,
-  onProgress?: (percent: number) => void,
-): Promise<Amity.Cached<Amity.File<'video'>[]>> => {
-  const client = getActiveClient();
-  client.log('file/uploadVideo', formData);
-
-  const files = formData.getAll('files');
-
-  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);
-
-  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<'video'>>(
-    '/api/v4/videos',
-    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/fileRepository/index.ts

@@ -1 +0,0 @@
-export * from './api';

package/src/group/utils/index.ts

@@ -1 +0,0 @@
-export * from './withUser';

package/src/group/utils/test/withUsers.test.ts

@@ -1,103 +0,0 @@
-import { disableCache, enableCache } from '~/cache/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { withUser, withUsers } from '~/group/utils';
-import { baseMembership, user11, user12 } from '~/utils/tests';
-
-const users = [user11, user12];
-
-const member1: Amity.RawMembership<Amity.GroupType> = { ...baseMembership, userId: user11.userId };
-const mappedMember1: Amity.Membership<Amity.GroupType> = { ...member1, user: user11 };
-const unmapableMember1: Amity.Membership<Amity.GroupType> = { ...member1, user: undefined };
-
-const member2: Amity.RawMembership<Amity.GroupType> = { ...baseMembership, userId: user12.userId };
-const mappedMember2: Amity.Membership<Amity.GroupType> = { ...member2, user: user12 };
-const unmapableMember2: Amity.Membership<Amity.GroupType> = { ...member2, user: undefined };
-
-const members1: Amity.RawMembership<Amity.GroupType>[] = [member1, member2];
-const mappedMembers1: Amity.Membership<Amity.GroupType>[] = [mappedMember1, mappedMember2];
-const unmapableMembers1: Amity.Membership<Amity.GroupType>[] = [unmapableMember1, unmapableMember2];
-
-describe('withUser', () => {
-  test('should return mapped member', () => {
-    expect.assertions(2);
-    enableCache();
-    ingestInCache({ users });
-
-    expect(withUser(member1)).toEqual(mappedMember1);
-    expect(withUser(member2)).toEqual(mappedMember2);
-
-    disableCache();
-  });
-
-  test('`.user` should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(withUser(member1)).toEqual(unmapableMember1);
-  });
-
-  test('`.user` should return error member', () => {
-    expect.assertions(2);
-    enableCache();
-    ingestInCache({ users });
-
-    expect(withUser(member1)).toEqual(mappedMember1);
-    expect(withUser(member2)).toEqual(mappedMember2);
-
-    disableCache();
-  });
-
-  test('`.user` should return undefined when user not exist', () => {
-    enableCache();
-    ingestInCache({ users });
-    const member: Amity.RawMembership<Amity.GroupType> = {
-      ...member1,
-      userId: 'not-exist-user-id',
-    };
-    const expected: Amity.Membership<Amity.GroupType> = {
-      ...member,
-      user: undefined,
-    };
-
-    expect(withUser(member)).toEqual(expected);
-
-    disableCache();
-  });
-});
-
-describe('withUsers', () => {
-  test('should return mapped members', () => {
-    enableCache();
-    ingestInCache({ users });
-
-    expect(withUsers(members1)).toEqual(mappedMembers1);
-
-    disableCache();
-  });
-
-  test('`.user` should return undefined if cache disabled', () => {
-    disableCache();
-
-    expect(withUsers(members1)).toEqual(unmapableMembers1);
-  });
-
-  test('`.user` should return undefined when some user not exist', () => {
-    enableCache();
-    ingestInCache({ users });
-    const members: Amity.RawMembership<Amity.GroupType>[] = [
-      ...members1,
-      { ...member1, userId: 'not-exist-user-id' },
-    ];
-    const expected = [
-      ...mappedMembers1,
-      {
-        ...unmapableMember1,
-        userId: 'not-exist-user-id',
-        user: undefined,
-      },
-    ];
-
-    expect(withUsers(members)).toEqual(expected);
-
-    disableCache();
-  });
-});

package/src/group/utils/withUser.ts

@@ -1,135 +0,0 @@
-import { pullFromCache } from '~/cache/api/pullFromCache';
-import { getActiveClient } from '~/client/api/activeClient';
-
-/**
- * Attach user object to membership model
- * - If cache is not enabled, set user to undefined ({..., user: undefined})
- * - If user object is not found in cache, set user to undefined
- * ({..., user: undefined})
- * - If a user is found in the cache, it attaches the user from the cache
- * ({..., user: { userId, displayName,... }})
- *
- * @param member The membership model object
- * @returns The membership model object that is already mapped to user
- * @hidden
- */
-export const convertRawMembershipToMembership = <T extends Amity.GroupType>(
-  member: Amity.RawMembership<T>,
-): Amity.Membership<T> => {
-  return {
-    ...member,
-    get user() {
-      const client = getActiveClient();
-
-      if (!client.cache) return undefined;
-
-      const userCache = pullFromCache<Amity.InternalUser>(['user', 'get', member.userId])?.data;
-
-      if (!userCache) {
-        return undefined;
-      }
-
-      return userCache;
-    },
-  };
-};
-
-/**
- * Attach user object to membership model
- * - If cache is not enabled, set user to undefined ({..., user: undefined})
- * - If user object is not found in cache, set user to undefined
- * ({..., user: undefined})
- * - If a user is found in the cache, it attaches the user from the cache
- * ({..., user: { userId, displayName,... }})
- *
- * @param member The membership model object
- * @param userIdProp The user ID prop name of membership object
- * @param userProp The user prop name of destination object
- * @returns The membership model object that is already mapped to user
- * @hidden
- */
-export const withUser = <
-  M extends Record<any, any>,
-  I extends keyof M = 'userId',
-  U extends string = 'user',
->(
-  member: M,
-  userIdProp: I = <I>'userId',
-  userProp: U = <U>'user',
-): Record<U, Amity.InternalUser | undefined> & M => {
-  // If the user prop already exists, do not overwrite.
-  if (member[userProp]) return member;
-
-  return {
-    get [userProp]() {
-      const client = getActiveClient();
-
-      if (!client.cache) return undefined;
-
-      const userCache = pullFromCache<Amity.InternalUser>([
-        'user',
-        'get',
-        member[userIdProp],
-      ])?.data;
-
-      if (!userCache) {
-        return undefined;
-      }
-
-      return userCache;
-    },
-    ...member,
-  };
-};
-
-/**
- * Mapping membership model with user object
- *
- * @param members The membership model objects
- * @param userIdProp The user ID prop name of membership object
- * @param userProp The user prop name of destination object
- * @returns The membership model objects that is already
- * mapped to users
- * @hidden
- */
-export const withUsers = <
-  M extends Record<any, any>[],
-  I extends keyof M[number] = 'userId',
-  U extends string = 'user',
->(
-  members: M,
-  userIdProp: I = <I>'userId',
-  userProp: U = <U>'user',
-): (Record<U, Amity.InternalUser | undefined> & M[number])[] => {
-  return members?.map(member => withUser(member, userIdProp, userProp)) ?? members;
-};
-
-/**
- * Transform members prop in any payload with attached users members
- *
- * @param payload The payload contain members prop
- * @param memberProp A name of members prop
- * @param userIdProp The user ID prop name of membership object
- * @param userProp The user prop name of destination object
- * @returns The transforming payload
- * @hidden
- */
-export const prepareMembershipPayload = <
-  P extends Record<any, any>,
-  M extends keyof P,
-  I extends keyof P[M][number] = 'userId',
-  U extends string = 'user',
->(
-  payload: P,
-  memberProp: M,
-  userIdProp: I = <I>'userId',
-  userProp: U = <U>'user',
-): Omit<P, M> & Record<M, (Record<U, Amity.InternalUser | undefined> & P[M][number])[]> => {
-  const { [memberProp]: memberPayload, ...rest } = payload;
-  const members = withUsers(memberPayload, userIdProp, userProp);
-
-  return {
-    ...rest,
-    ...{ [memberProp]: members },
-  };
-};

package/src/index.ts

@@ -1,59 +0,0 @@
-// types
-export * from './@types';
-
-export * from './version';
-
-// sdk core
-export * from './core/query';
-export * from './core/subscription';
-export * from './cache/api';
-
-export * as Client from './client';
-export { API_REGIONS } from './client/utils/endpoints';
-
-// asc core
-export * as UserRepository from './userRepository';
-
-export * as FileRepository from './fileRepository';
-
-export * from './role/api';
-
-// // asc partials
-export * as ReactionRepository from './reactionRepository';
-
-export * from './report/api';
-
-// // asc messaging
-export * as ChannelRepository from './channelRepository';
-export * as MessageRepository from './messageRepository';
-export * as SubChannelRepository from './subChannelRepository';
-
-export * from './marker/events';
-
-// // asc social
-export * as CommunityRepository from './communityRepository';
-export * as CategoryRepository from './categoryRepository';
-export * as FeedRepository from './feedRepository';
-export * as PostRepository from './postRepository';
-export * as CommentRepository from './commentRepository';
-export * as StreamRepository from './streamRepository';
-
-export * as PollRepository from './pollRepository';
-
-export * as LiveStreamPlayer from './liveStreamPlayer';
-
-export * as StoryRepository from './storyRepository';
-
-// Premium Ads
-export * as AdRepository from './adRepository';
-
-// // external apis
-export * from './external/api';
-
-export * as notificationTray from './notificationTray';
-
-export * as InvitationRepository from './invitationRepository';
-
-export * as LiveReactionRepository from './liveReactionRepository';
-
-export { GET_WATCHER_URLS } from './utils/linkedObject/streamLinkedObject';

package/src/invitationRepository/events/index.ts

@@ -1,3 +0,0 @@
-export * from './onLocalInvitationCreated';
-export * from './onLocalInvitationUpdated';
-export * from './onLocalInvitationDeleted';

package/src/invitationRepository/events/onLocalInvitationCreated.ts

@@ -1,33 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { createEventSubscriber } from '~/core/events';
-
-/**
- * ```js
- * import { onLocalInvitationCreated } from '@amityco/ts-sdk'
- * const dispose = onLocalInvitationCreated(data => {
- *   // ...
- * })
- * ```
- *
- * Fired when an {@link Amity.InvitationPayload} has been created
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Invitation Events
- */
-export const onLocalInvitationCreated = (
-  callback: Amity.Listener<Amity.InternalInvitation[]>,
-): Amity.Unsubscriber => {
-  const client = getActiveClient();
-
-  const disposers = [
-    createEventSubscriber(client, 'onLocalInvitationCreated', 'local.invitation.created', payload =>
-      callback(payload),
-    ),
-  ];
-
-  return () => {
-    disposers.forEach(fn => fn());
-  };
-};

package/src/invitationRepository/events/onLocalInvitationDeleted.ts

@@ -1,33 +0,0 @@
-import { createEventSubscriber } from '~/core/events';
-import { getActiveClient } from '~/client/api/activeClient';
-
-/**
- * ```js
- * import { onLocalInvitationDeleted } from '@amityco/ts-sdk'
- * const dispose = onLocalInvitationDeleted(data => {
- *   // ...
- * })
- * ```
- *
- * Fired when an {@link Amity.InvitationPayload} has been deleted
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Invitation Events
- */
-export const onLocalInvitationDeleted = (
-  callback: Amity.Listener<Amity.InternalInvitation[]>,
-): Amity.Unsubscriber => {
-  const client = getActiveClient();
-
-  const disposers = [
-    createEventSubscriber(client, 'onLocalInvitationDeleted', 'local.invitation.deleted', payload =>
-      callback(payload),
-    ),
-  ];
-
-  return () => {
-    disposers.forEach(fn => fn());
-  };
-};

package/src/invitationRepository/events/onLocalInvitationUpdated.ts

@@ -1,33 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { createEventSubscriber } from '~/core/events';
-
-/**
- * ```js
- * import { onLocalInvitationUpdated } from '@amityco/ts-sdk'
- * const dispose = onLocalInvitationUpdated(data => {
- *   // ...
- * })
- * ```
- *
- * Fired when an {@link Amity.InvitationPayload} has been updated
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Invitation Events
- */
-export const onLocalInvitationUpdated = (
-  callback: Amity.Listener<Amity.InternalInvitation[]>,
-): Amity.Unsubscriber => {
-  const client = getActiveClient();
-
-  const disposers = [
-    createEventSubscriber(client, 'onLocalInvitationUpdated', 'local.invitation.updated', payload =>
-      callback(payload),
-    ),
-  ];
-
-  return () => {
-    disposers.forEach(fn => fn());
-  };
-};

package/src/invitationRepository/index.ts

@@ -1,2 +0,0 @@
-export * from './events';
-export * from './observers';

package/src/invitationRepository/internalApi/acceptInvitation.ts

@@ -1,45 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { getActiveClient } from '~/client/api/activeClient';
-import { pullFromCache, upsertInCache } from '~/cache/api';
-import { InvitationStatusEnum } from '~/@types';
-
-/* begin_public_function
-  id: invitation.accept
-*/
-/**
- * ```js
- * import { acceptInvitation } from '@amityco/ts-sdk'
- * const isAccepted = await acceptInvitation(invitationId)
- * ```
- *
- * Accepts a {@link Amity.Invitation} object
- *
- * @param invitationId the {@link Amity.Invitation} to accept
- * @returns A success boolean if the {@link Amity.Invitation} was accepted
- *
- * @category Invitation API
- * @async
- */
-export const acceptInvitation = async (invitationId: Amity.Invitation['_id']): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('invitation/acceptInvitation', invitationId);
-
-  const { data } = await client.http.post<{ success: boolean }>(
-    `/api/v1/invitations/${invitationId}/accept`,
-  );
-
-  const invitation = pullFromCache<Amity.InternalInvitation>([
-    'invitation',
-    'get',
-    invitationId,
-  ])?.data;
-
-  if (invitation) {
-    upsertInCache(['invitation', 'get', invitationId], { status: InvitationStatusEnum.Approved });
-
-    fireEvent('local.invitation.updated', [invitation]);
-  }
-
-  return data.success;
-};
-/* end_public_function */

package/src/invitationRepository/internalApi/createInvitations.ts

@@ -1,52 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { getActiveClient } from '~/client/api/activeClient';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { prepareInvitationPayload } from '../utils';
-
-/* begin_public_function
-  id: invitation.createInvitations
-*/
-/**
- * ```js
- * import { createInvitations } from '@amityco/ts-sdk'
- * const created = await createInvitations({
- *  type: string,
- *  targetType: string,
- *  targetId: string,
- *  userIds: string[]
- * }))
- * ```
- *
- * Creates an {@link Amity.Invitation}
- *
- * @param bundle The data necessary to create a new {@link Amity.Invitation}
- * @returns The newly created {@link Amity.Invitation}
- *
- * @category Invitation API
- * @async
- */
-export const createInvitations = async (
-  bundle: Amity.CreateInvitations,
-): Promise<Amity.Cached<Amity.InternalInvitation[]>> => {
-  const client = getActiveClient();
-  client.log('invitation/createInvitations', bundle);
-
-  const { data: payload } = await client.http.post<Amity.InvitationPayload>(
-    '/api/v1/invitations',
-    bundle,
-  );
-
-  const data = prepareInvitationPayload(payload);
-
-  const cachedAt = client.cache && Date.now();
-
-  if (client.cache) ingestInCache(data, { cachedAt });
-
-  fireEvent('local.invitation.created', data.invitations);
-
-  return {
-    data: data.invitations,
-    cachedAt,
-  };
-};
-/* end_public_function */