@amityco/ts-sdk 7.5.3 → 7.5.4-2d34fd5f.0

package/src/communityRepository/observers/searchCommunities/SearchCommunitiesQueryStreamController.ts

@@ -60,7 +60,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.SearchCommunityLiveCollectionCache>(
         this.cacheKey,
       )?.data;
@@ -73,7 +73,7 @@ export class CommunitiesQueryStreamController extends QueryStreamController<
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (channel: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (channel: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

package/src/communityRepository/observers/semanticSearch/SemanticSearchCommunityLiveCollectionController.ts

@@ -15,6 +15,7 @@ import {
   onLocalCommunityJoined,
   onLocalCommunityLeft,
   onCommunityUserChanged,
+  onLocalCommunityJoin,
 } from '~/communityRepository/communityMembership';
 
 import { isNonNullable } from '~/utils';
@@ -24,6 +25,7 @@ import { prepareSemanticSearchCommunityPayload } from '~/communityRepository/uti
 import { getActiveClient } from '~/client';
 import { EnumCommunityMemberActions } from '~/communityRepository/communityMembership/observers/getMembers/enums';
 import { filterByCommunityMembership } from '~/core/query';
+import { convertEventPayload } from '~/utils/event';
 
 export class SemanticSearchCommunityLiveCollectionController extends LiveCollectionController<
   'semanticSearchCommunity',
@@ -94,6 +96,10 @@ export class SemanticSearchCommunityLiveCollectionController extends LiveCollect
       { fn: onCommunityUserChanged, action: EnumCommunityMemberActions.OnMemberCountChanged },
       { fn: onLocalCommunityJoined, action: EnumCommunityMemberActions.OnCommunityJoined },
       { fn: onLocalCommunityLeft, action: EnumCommunityMemberActions.OnCommunityLeft },
+      {
+        fn: convertEventPayload(onLocalCommunityJoin, 'targetId', 'community'),
+        action: EnumCommunityActions.OnCommunityUpdated,
+      },
     ]);
   }
 

package/src/communityRepository/observers/semanticSearch/SemanticSearchCommunityPaginationController.ts

@@ -29,6 +29,7 @@ export class SemanticSearchCommunityPaginationController extends PaginationContr
         ...params,
         filter: communityMembershipStatus ?? AmityCommunityMemberStatusFilter.ALL,
         options,
+        includeDiscoverablePrivateCommunity: params.includeDiscoverablePrivateCommunity ?? true,
       },
     });
     return queryResponse;

package/src/communityRepository/observers/semanticSearch/SemanticSearchCommunityQueryStreamController.ts

@@ -63,7 +63,7 @@ export class SemanticSearchCommunityQueryStreamController extends QueryStreamCon
   }
 
   reactor(action: EnumCommunityActions | EnumCommunityMemberActions) {
-    return (community: Amity.Community) => {
+    return (community: Amity.InternalCommunity) => {
       const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
       if (!collection) return;
 
@@ -77,7 +77,7 @@ export class SemanticSearchCommunityQueryStreamController extends QueryStreamCon
 
   subscribeRTE(
     createSubscriber: {
-      fn: (reactor: (community: Amity.Community) => void) => Amity.Unsubscriber;
+      fn: (reactor: (community: Amity.InternalCommunity) => void) => Amity.Unsubscriber;
       action: EnumCommunityActions | EnumCommunityMemberActions;
     }[],
   ) {

package/src/communityRepository/utils/communityWithMembership.ts

@@ -1,5 +1,5 @@
 import { pullFromCache } from '~/cache/api';
-import { getActiveUser } from '~/client';
+import { getActiveUser } from '~/client/api/activeUser';
 
 /*
  * verifies membership status
@@ -12,7 +12,7 @@ function isMember(membership: Amity.Membership<'community'>['communityMembership
  * checks if currently logged in user is part of the community
  */
 function isCurrentUserPartOfCommunity(
-  c: Amity.Community,
+  c: Amity.InternalCommunity,
   m: Amity.Membership<'community'>,
 ): boolean {
   const { userId } = getActiveUser();
@@ -28,11 +28,15 @@ function isCurrentUserPartOfCommunity(
  * Althought this can be calculated, it's not scalable.
  */
 export function updateMembershipStatus(
-  communities: Amity.Community[],
+  communities: Amity.RawCommunity[],
   communityUsers: Amity.Membership<'community'>[],
-): Amity.Community[] {
+): Amity.InternalCommunity[] {
   return communities.map(c => {
-    const cachedCommunity = pullFromCache<Amity.Community>(['community', 'get', c.communityId]);
+    const cachedCommunity = pullFromCache<Amity.InternalCommunity>([
+      'community',
+      'get',
+      c.communityId,
+    ]);
     if (cachedCommunity?.data && cachedCommunity?.data.hasOwnProperty('isJoined')) {
       return {
         ...cachedCommunity.data,

package/src/communityRepository/utils/payload.ts

@@ -1,5 +1,6 @@
 import { CommunityPostSettingMaps, DefaultCommunityPostSetting } from '~/@types';
 import { updateMembershipStatus } from './communityWithMembership';
+import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
 
 const getMatchPostSetting = (value: {
   needApprovalOnPostCreation: Amity.RawCommunity['needApprovalOnPostCreation'];
@@ -13,7 +14,7 @@ const getMatchPostSetting = (value: {
   ) ?? DefaultCommunityPostSetting;
 
 export function addPostSetting({ communities }: { communities: Amity.RawCommunity[] }) {
-  return communities.map<Amity.Community>(
+  return communities.map<Amity.InternalCommunity>(
     ({ needApprovalOnPostCreation, onlyAdminCanPost, ...restCommunityPayload }) => ({
       postSetting: getMatchPostSetting({
         needApprovalOnPostCreation,
@@ -29,10 +30,13 @@ export const prepareCommunityPayload = (
 ): Amity.ProcessedCommunityPayload => {
   const communitiesWithPostSetting = addPostSetting({ communities: rawPayload.communities });
 
+  // Convert users to internal format
+  const internalUsers = rawPayload.users.map(convertRawUserToInternalUser);
+
   // map users with community
   const mappedCommunityUsers: Array<Amity.Membership<'community'>> = rawPayload.communityUsers.map(
     communityUser => {
-      const user = rawPayload.users.find(user => user.userId === communityUser.userId)!;
+      const user = internalUsers.find(user => user.userId === communityUser.userId)!;
 
       return {
         ...communityUser,
@@ -48,11 +52,33 @@ export const prepareCommunityPayload = (
 
   return {
     ...rawPayload,
+    users: rawPayload.users.map(convertRawUserToInternalUser),
     communities: communityWithMembershipStatus,
     communityUsers: mappedCommunityUsers,
   };
 };
 
+export const prepareCommunityJoinRequestPayload = (
+  rawPayload: Amity.CommunityJoinRequestPayload,
+): Amity.ProcessedJoinRequestPayload => {
+  const mappedJoinRequests: Array<Amity.InternalJoinRequest> = rawPayload.joinRequests.map(
+    joinRequest => {
+      return {
+        ...joinRequest,
+        joinRequestId: joinRequest._id,
+      };
+    },
+  );
+
+  const users = rawPayload.users.map(convertRawUserToInternalUser);
+
+  return {
+    ...rawPayload,
+    joinRequests: mappedJoinRequests,
+    users,
+  };
+};
+
 export const prepareCommunityMembershipPayload = (
   rawPayload: Amity.CommunityMembershipPayload,
 ): Amity.ProcessedCommunityMembershipPayload => {

package/src/core/liveCollection/PaginationController.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 
 export abstract class PaginationController<
   TPayloadDomain extends keyof Amity.Payloads,

package/src/core/liveCollection/PaginationNoPageController.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { getActiveClient } from '~/client/api';
+import { getActiveClient } from '~/client/api/activeClient';
 
 export abstract class PaginationNoPageController<
   TPayloadDomain extends keyof Amity.Payloads,

package/src/core/model/idResolvers.ts

@@ -64,6 +64,9 @@ const idResolvers: Resolvers = {
 
   notificationTrayItem: ({ _id }) => _id,
   notificationTraySeen: ({ userId }) => userId,
+
+  invitation: ({ _id }) => _id,
+  joinRequest: ({ joinRequestId }) => joinRequestId,
 };
 
 /**

package/src/core/model/index.ts

@@ -54,6 +54,9 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   pins: 'pin',
 
   notificationTrayItems: 'notificationTrayItem',
+
+  invitations: 'invitation',
+  joinRequests: 'joinRequest',
 };
 
 /** hidden */

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

@@ -51,3 +51,5 @@ export * as AdRepository from './adRepository';
 export * from './external/api';
 
 export * as notificationTray from './notificationTray';
+
+export * as InvitationRepository from './invitationRepository';

package/src/invitationRepository/events/index.ts

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

package/src/invitationRepository/events/onLocalInvitationCreated.ts

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,33 @@
+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

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

package/src/invitationRepository/internalApi/acceptInvitation.ts

@@ -0,0 +1,45 @@
+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

@@ -0,0 +1,52 @@
+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 */

package/src/invitationRepository/internalApi/getInvitation.ts

@@ -0,0 +1,47 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMyInvitationsPayload } from '../utils/prepareMyInvitationsPayload';
+import { invitationLinkedObject } from '~/utils/linkedObject/invitationLinkedObject';
+
+/* begin_public_function
+  id: invitation.get
+*/
+/**
+ * ```js
+ * import { getInvitation } from '@amityco/ts-sdk'
+ * const { invitation } = await getInvitation(targetType, targetId)
+ * ```
+ *
+ * Get a {@link Amity.Invitation} object
+ *
+ * @param targetType The type of the target of the {@link Amity.Invitation}
+ * @param targetId The ID of the target of the {@link Amity.Invitation}
+ * @returns A {@link Amity.Invitation} object
+ *
+ * @category Invitation API
+ * @async
+ */
+export const getInvitation = async (
+  targetType: Amity.Invitation['targetType'],
+  targetId: Amity.Invitation['targetId'],
+): Promise<Amity.Cached<Amity.Invitation | undefined>> => {
+  const client = getActiveClient();
+  client.log('invitation/getInvitation', targetType, targetId);
+
+  const { data: payload } = await client.http.get<Amity.MyInvitationsPayload>(
+    `/api/v1/invitations/me`,
+    { params: { targetType, targetId } },
+  );
+
+  const data = prepareMyInvitationsPayload(payload);
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: data.invitations[0] ? invitationLinkedObject(data.invitations[0]) : undefined,
+    cachedAt,
+  };
+};
+/* end_public_function */

package/src/invitationRepository/internalApi/index.ts

@@ -0,0 +1,3 @@
+export * from './createInvitations';
+export * from './acceptInvitation';
+export * from './rejectInvitation';

package/src/invitationRepository/internalApi/rejectInvitation.ts

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