@amityco/ts-sdk 7.5.1-d432304.0 → 7.5.1

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

@@ -1,119 +0,0 @@
-export {};
-
-export const enum InvitationTypeEnum {
-  CommunityMemberInvite = 'communityMemberInvite',
-  LivestreamInvite = 'livestreamInvite',
-}
-
-export const enum InvitationStatusEnum {
-  Pending = 'pending',
-  Approved = 'approved',
-  Rejected = 'rejected',
-  Cancelled = 'cancelled',
-}
-
-export const enum InvitationSortByEnum {
-  FirstCreated = 'firstCreated',
-  LastCreated = 'lastCreated',
-}
-
-declare global {
-  namespace Amity {
-    type InvitationType = InvitationTypeEnum;
-
-    type InvitationStatus = InvitationStatusEnum;
-
-    type InvitationTargetType = Extract<Amity.Domain, 'community'>;
-
-    type InvitationTargetMap = {
-      community: Amity.InternalCommunity;
-    };
-
-    type InvitationTarget<T extends InvitationTargetType> = InvitationTargetMap[T];
-
-    type InvitationSortBy = InvitationSortByEnum;
-
-    type InvitationDomain<T extends Amity.InvitationTargetType = Amity.InvitationTargetType> =
-      T extends 'community' ? { communityId: string } : { communityId?: string };
-
-    type RawInvitation = {
-      _id: string;
-      networkId: string;
-      type: Amity.InvitationType;
-      targetId: string;
-      targetType: Amity.InvitationTargetType;
-      userId: string;
-      status: Amity.InvitationStatus;
-      respondedAt: Amity.timestamp;
-      createdBy: string;
-      invitationId: string;
-      invitedUserId: string;
-      invitedUserInternalId: string;
-      invitedUserPublicId: string;
-      inviterUserId: string;
-      inviterUserInternalId: string;
-      inviterUserPublicId: string;
-    } & Amity.Timestamps &
-      Amity.InvitationDomain<Amity.InvitationTargetType>;
-
-    type InternalInvitation = Omit<RawInvitation, 'createdBy'> & {
-      createdById: string;
-    };
-
-    type Invitation = Omit<Amity.InternalInvitation, 'createdBy'> &
-      Amity.InvitationLinkedObject & {
-        user?: Amity.User;
-        createdById: string;
-        createdBy?: Amity.User;
-        target?: Amity.InvitationTarget<Amity.InvitationTargetType>;
-      };
-
-    type QueryInvitations = {
-      targetId: string;
-      statuses?: string[];
-      token?: Amity.Token;
-      type: Amity.InvitationType;
-      sortBy?: Amity.InvitationSortBy;
-      limit?: Amity.PageLimit['limit'];
-      targetType: Amity.InvitationTargetType;
-    };
-
-    type InvitationLiveCollection = Amity.LiveCollectionParams<Omit<QueryInvitations, 'limit'>>;
-
-    type InvitationLiveCollectionCache = Amity.LiveCollectionCache<
-      Amity.InternalInvitation['_id'],
-      Pick<QueryInvitations, 'limit'>
-    >;
-
-    type QueryMyInvitations = {
-      targetId?: string;
-      token?: Amity.Token;
-      type?: Amity.InvitationType;
-      sortBy?: Amity.InvitationSortBy;
-      limit?: Amity.PageLimit['limit'];
-      statuses?: InvitationStatusEnum[];
-      targetType?: Amity.InvitationTargetType;
-    };
-
-    type MyInvitationsLiveCollection = Amity.LiveCollectionParams<
-      Omit<QueryMyInvitations, 'limit'>
-    >;
-
-    type MyInvitationsLiveCollectionCache = Amity.LiveCollectionCache<
-      Amity.InternalInvitation['_id'],
-      Pick<QueryMyInvitations, 'limit'>
-    >;
-
-    type InvitationLinkedObject = {
-      accept: () => Promise<void>;
-      reject: () => Promise<void>;
-    };
-
-    type CreateInvitations = {
-      type: Amity.InvitationType;
-      targetType: Amity.InvitationTargetType;
-      targetId: string;
-      userIds: string[];
-    };
-  }
-}

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

@@ -1,66 +0,0 @@
-export {};
-
-export const enum JoinRequestStatusEnum {
-  Pending = 'pending',
-  Approved = 'approved',
-  Rejected = 'rejected',
-  Cancelled = 'cancelled',
-}
-
-export const enum JoinResultStatusEnum {
-  Success = 'success',
-  Pending = 'pending',
-}
-
-declare global {
-  namespace Amity {
-    type JoinRequestStatus = JoinRequestStatusEnum;
-
-    type JoinResultStatus = JoinResultStatusEnum;
-
-    type JoinRequestType = 'communityJoinRequest';
-
-    type JoinResult = {
-      status: Amity.JoinResultStatus;
-      request?: Amity.JoinRequest;
-    };
-
-    type RawJoinRequest = {
-      _id: string;
-      createdAt: Amity.timestamp;
-      joinRequestId: string;
-      networkId: string;
-
-      requestorId: string;
-      requestorInternalId: string;
-      requestorPublicId: string;
-
-      respondedAt: Amity.timestamp | null;
-      responderId: string | null;
-      responderInternalId: string | null;
-      responderPublicId: string | null;
-
-      status: Amity.JoinRequestStatus;
-      targetId: string;
-      targetType: string;
-      type: Amity.JoinRequestType;
-      updatedAt: Amity.timestamp;
-      userId: string;
-    };
-
-    type InternalJoinRequest = Omit<RawJoinRequest, '_id'>;
-
-    type JoinRequest = Omit<Amity.InternalJoinRequest, 'responderId'> &
-      Amity.JoinRequestLinkedObject & {
-        user?: Amity.User;
-        feeds?: Amity.Feed[];
-        files?: Amity.File[];
-      };
-
-    type JoinRequestLinkedObject = {
-      cancel: () => Promise<void>;
-      approve: () => Promise<void>;
-      reject: () => Promise<void>;
-    };
-  }
-}

package/src/communityRepository/communityMembership/events/onLocalCommunityJoin.ts

@@ -1,20 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { createEventSubscriber } from '~/core/events';
-
-export const onLocalCommunityJoin = (
-  callback: (joinRequest: Amity.InternalJoinRequest) => void,
-) => {
-  const client = getActiveClient();
-
-  const filter = async (rawPayload: Amity.InternalJoinRequest[]) => {
-    callback(rawPayload[0]);
-  };
-
-  const disposers = [
-    createEventSubscriber(client, 'onCommunityUpdate', 'v4.local.community.joined', filter),
-  ];
-
-  return () => {
-    disposers.forEach(fn => fn());
-  };
-};

package/src/communityRepository/internalAPI/getMyJoinRequest.ts

@@ -1,43 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
-import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
-
-/* begin_public_function
-  id: community.getMyJoinRequest
-*/
-/**
- * ```js
- * import { community } from '@amityco/ts-sdk'
- * const isJoined = await community.getMyJoinRequest('foobar')
- * ```
- *
- * Joins a {@link Amity.Community} object
- *
- * @param communityId the {@link Amity.Community} to join
- * @returns A success boolean if the {@link Amity.Community} was joined
- *
- * @category Community API
- * @async
- */
-export const getMyJoinRequest = async (
-  communityId: Amity.Community['communityId'],
-): Promise<Amity.Cached<Amity.JoinRequest | undefined>> => {
-  const client = getActiveClient();
-  client.log('community/myJoinRequest', communityId);
-
-  const { data: payload } = await client.http.get<Amity.CommunityJoinRequestPayload>(
-    `/api/v4/communities/${communityId}/join/me`,
-  );
-
-  const data = prepareCommunityJoinRequestPayload(payload);
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache(data, { cachedAt });
-
-  return {
-    data: data.joinRequests[0] ? joinRequestLinkedObject(data.joinRequests[0]) : undefined,
-    cachedAt,
-  };
-};
-/* end_public_function */

package/src/communityRepository/internalAPI/joinCommunity.ts

@@ -1,66 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { pullFromCache } from '~/cache/api/pullFromCache';
-import { upsertInCache } from '~/cache/api/upsertInCache';
-import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
-import { fireEvent } from '~/core/events';
-import { JoinRequestStatusEnum, JoinResultStatusEnum } from '~/@types/domains/joinRequest';
-import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
-
-/* begin_public_function
-  id: community.join
-*/
-/**
- * ```js
- * import { community } from '@amityco/ts-sdk'
- * const isJoined = await community.join('foobar')
- * ```
- *
- * Joins a {@link Amity.Community} object
- *
- * @param communityId the {@link Amity.Community} to join
- * @returns A status join result
- *
- * @category Community API
- * @async
- */
-export const joinRequest = async (
-  communityId: Amity.Community['communityId'],
-): Promise<Amity.JoinResult> => {
-  const client = getActiveClient();
-  client.log('community/joinRequest', communityId);
-
-  const { data: payload } = await client.http.post<Amity.CommunityJoinRequestPayload>(
-    `/api/v4/communities/${communityId}/join`,
-  );
-
-  const data = prepareCommunityJoinRequestPayload(payload);
-
-  const cachedAt = client.cache && Date.now();
-  if (client.cache) ingestInCache(data, { cachedAt });
-
-  const status =
-    data.joinRequests[0].status === JoinRequestStatusEnum.Approved
-      ? JoinResultStatusEnum.Success
-      : JoinResultStatusEnum.Pending;
-
-  if (status === JoinResultStatusEnum.Success && client.cache) {
-    const community = pullFromCache<Amity.Community>(['community', 'get', communityId])?.data;
-
-    if (community) {
-      const updatedCommunity = {
-        ...community,
-        isJoined: true,
-      };
-
-      upsertInCache(['community', 'get', communityId], updatedCommunity);
-    }
-  }
-
-  fireEvent('v4.local.community.joined', data.joinRequests);
-
-  return status === JoinResultStatusEnum.Success
-    ? { status }
-    : { status, request: joinRequestLinkedObject(data.joinRequests[0]) };
-};
-/* end_public_function */

package/src/communityRepository/joinRequest/events/index.ts

@@ -1,3 +0,0 @@
-export * from './onJoinRequestCreated';
-export * from './onJoinRequestUpdated';
-export * from './onJoinRequestDeleted';

package/src/communityRepository/joinRequest/events/onJoinRequestCreated.ts

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

package/src/communityRepository/joinRequest/events/onJoinRequestDeleted.ts

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

package/src/communityRepository/joinRequest/events/onJoinRequestUpdated.ts

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

package/src/communityRepository/joinRequest/internalAPI/approveJoinRequest.ts

@@ -1,52 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { getActiveClient } from '~/client/api/activeClient';
-import { pullFromCache, upsertInCache } from '~/cache/api';
-import { JoinRequestStatusEnum } from '~/@types/domains/joinRequest';
-
-/* begin_public_function
-  id: joinRequest.approve
-*/
-/**
- * ```js
- * import { joinRequest } from '@amityco/ts-sdk'
- * const isAccepted = await joinRequest.approve()
- * ```
- *
- * Accepts a {@link Amity.JoinRequest} object
- *
- * @param joinRequest the {@link Amity.JoinRequest} to accept
- * @returns A success boolean if the {@link Amity.JoinRequest} was accepted
- *
- * @category Join Request API
- * @async
- */
-export const approveJoinRequest = async (
-  joinRequest: Amity.InternalJoinRequest,
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('joinRequest/approveJoinRequest', joinRequest.joinRequestId);
-
-  const { data } = await client.http.post<{ success: boolean }>(
-    `/api/v4/communities/${joinRequest.targetId}/join/approve`,
-    {
-      userId: joinRequest.requestorInternalId,
-    },
-  );
-
-  const joinRequestCache = pullFromCache<Amity.InternalJoinRequest>([
-    'joinRequest',
-    'get',
-    joinRequest.joinRequestId,
-  ])?.data;
-
-  if (joinRequestCache) {
-    upsertInCache(['joinRequest', 'get', joinRequest.joinRequestId], {
-      status: JoinRequestStatusEnum.Approved,
-    });
-
-    fireEvent('local.joinRequest.updated', [joinRequestCache]);
-  }
-
-  return data.success;
-};
-/* end_public_function */

package/src/communityRepository/joinRequest/internalAPI/cancelJoinRequest.ts

@@ -1,46 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { dropFromCache, pullFromCache } from '~/cache/api';
-import { getActiveClient } from '~/client/api/activeClient';
-
-/* begin_public_function
-  id: joinRequest.cancel
-*/
-/**
- * ```js
- * import { joinRequest } from '@amityco/ts-sdk'
- * const isCanceled = await joinRequest.cancel()
- * ```
- *
- * Cancels a {@link Amity.JoinRequest} object
- *
- * @param joinRequest the {@link Amity.JoinRequest} to cancel
- * @returns A success boolean if the {@link Amity.JoinRequest} was canceled
- *
- * @category Join Request API
- * @async
- */
-export const cancelJoinRequest = async (
-  joinRequest: Amity.InternalJoinRequest,
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('joinRequest/cancelJoinRequest', joinRequest.joinRequestId);
-
-  const { data } = await client.http.delete<{ success: boolean }>(
-    `/api/v4/communities/${joinRequest.targetId}/join`,
-  );
-
-  const joinRequestCache = pullFromCache<Amity.InternalJoinRequest>([
-    'joinRequest',
-    'get',
-    joinRequest.joinRequestId,
-  ])?.data;
-
-  if (joinRequestCache) {
-    dropFromCache(['joinRequest', 'get', joinRequest.joinRequestId]);
-
-    fireEvent('local.joinRequest.deleted', [joinRequestCache]);
-  }
-
-  return data.success;
-};
-/* end_public_function */

package/src/communityRepository/joinRequest/internalAPI/rejectJoinRequest.ts

@@ -1,52 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { pullFromCache, upsertInCache } from '~/cache/api';
-import { getActiveClient } from '~/client/api/activeClient';
-import { JoinRequestStatusEnum } from '~/@types/domains/joinRequest';
-
-/* begin_public_function
-  id: joinRequest.reject
-*/
-/**
- * ```js
- * import { joinRequest } from '@amityco/ts-sdk'
- * const isRejected = await joinRequest.reject()
- * ```
- *
- * Rejects a {@link Amity.JoinRequest} object
- *
- * @param joinRequest the {@link Amity.JoinRequest} to reject
- * @returns A success boolean if the {@link Amity.JoinRequest} was rejected
- *
- * @category Join Request API
- * @async
- */
-export const rejectJoinRequest = async (
-  joinRequest: Amity.InternalJoinRequest,
-): Promise<boolean> => {
-  const client = getActiveClient();
-  client.log('joinRequest/rejectJoinRequest', joinRequest.joinRequestId);
-
-  const { data } = await client.http.post<{ success: boolean }>(
-    `/api/v4/communities/${joinRequest.targetId}/join/reject`,
-    {
-      userId: joinRequest.requestorInternalId,
-    },
-  );
-
-  const joinRequestCache = pullFromCache<Amity.InternalJoinRequest>([
-    'joinRequest',
-    'get',
-    joinRequest.joinRequestId,
-  ])?.data;
-
-  if (joinRequestCache) {
-    upsertInCache(['joinRequest', 'get', joinRequest.joinRequestId], {
-      status: JoinRequestStatusEnum.Rejected,
-    });
-
-    fireEvent('local.joinRequest.updated', [joinRequestCache]);
-  }
-
-  return data.success;
-};
-/* end_public_function */