@amityco/ts-sdk 7.5.3-d52ed38.0 → 7.5.3

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,49 +0,0 @@
-import { fireEvent } from '~/core/events';
-import { pullFromCache, upsertInCache } from '~/cache/api';
-import { getActiveClient } from '~/client/api/activeClient';
-import { JoinRequestStatusEnum } from '~/@types';
-
-/* 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) {
-    upsertInCache(['joinRequest', 'get', joinRequest.joinRequestId], {
-      status: JoinRequestStatusEnum.Cancelled,
-    });
-
-    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 */

package/src/communityRepository/observers/getJoinRequestList/JoinRequestListLiveCollectionController.ts

@@ -1,135 +0,0 @@
-import hash from 'object-hash';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { JoinRequestListPaginationController } from './JoinRequestListPaginationController';
-import { JoinRequestListQueryStreamController } from './JoinRequestListQueryStreamController';
-import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
-import { sortByFirstCreated, sortByLastCreated } from '~/core/query';
-import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
-import { EnumJoinRequestAction } from './enum';
-import { isNonNullable } from '~/utils';
-import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
-import {
-  onJoinRequestCreated,
-  onJoinRequestDeleted,
-  onJoinRequestUpdated,
-} from '~/communityRepository/joinRequest/events/';
-import { onLocalCommunityJoin } from '~/communityRepository/communityMembership';
-
-export class JoinRequestListLiveCollectionController extends LiveCollectionController<
-  'joinRequest',
-  Amity.JoinRequestListLiveCollection,
-  Amity.JoinRequest,
-  JoinRequestListPaginationController
-> {
-  private queryStreamController: JoinRequestListQueryStreamController;
-
-  private query: Amity.JoinRequestListLiveCollection;
-
-  constructor(
-    query: Amity.JoinRequestListLiveCollection,
-    callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
-  ) {
-    const queryStreamId = hash(query);
-    const cacheKey = ['joinRequestList', 'collection', queryStreamId];
-    const paginationController = new JoinRequestListPaginationController(query);
-
-    super(paginationController, queryStreamId, cacheKey, callback);
-
-    this.query = query;
-    this.queryStreamController = new JoinRequestListQueryStreamController(
-      this.query,
-      this.cacheKey,
-      this.notifyChange.bind(this),
-      prepareCommunityJoinRequestPayload,
-    );
-
-    this.callback = callback.bind(this);
-    this.loadPage({ initial: true });
-  }
-
-  protected setup() {
-    const collection = pullFromCache<Amity.JoinRequestListLiveCollectionCache>(this.cacheKey)?.data;
-
-    if (!collection) {
-      pushToCache(this.cacheKey, {
-        data: [],
-        params: this.query,
-      });
-    }
-  }
-
-  protected async persistModel(queryPayload: Amity.CommunityJoinRequestPayload & Amity.Pagination) {
-    await this.queryStreamController.saveToMainDB(queryPayload);
-  }
-
-  protected persistQueryStream({
-    response,
-    direction,
-    refresh,
-  }: Amity.LiveCollectionPersistQueryStreamParams<'joinRequest'>) {
-    const joinRequestResponse = response as unknown as Amity.CommunityJoinRequestPayload &
-      Partial<Amity.Pagination>;
-    this.queryStreamController.appendToQueryStream(joinRequestResponse, direction, refresh);
-  }
-
-  startSubscription() {
-    return this.queryStreamController.subscribeRTE([
-      { fn: onJoinRequestCreated, action: EnumJoinRequestAction.OnLocalJoinRequestCreated },
-      { fn: onJoinRequestUpdated, action: EnumJoinRequestAction.OnLocalJoinRequestUpdated },
-      { fn: onJoinRequestDeleted, action: EnumJoinRequestAction.OnLocalJoinRequestUpdated },
-      {
-        fn: onLocalCommunityJoin,
-        action: EnumJoinRequestAction.OnLocalJoinRequestUpdated,
-      },
-    ]);
-  }
-
-  notifyChange({ origin, loading, error }: Amity.LiveCollectionNotifyParams) {
-    const collection = pullFromCache<Amity.JoinRequestListLiveCollectionCache>(this.cacheKey)?.data;
-
-    if (!collection) return;
-
-    const data = this.applyFilter(
-      collection.data
-        .map(id => pullFromCache<Amity.InternalJoinRequest>(['joinRequest', 'get', id])!)
-        .filter(isNonNullable)
-        .map(({ data }) => data)
-        .map(joinRequestLinkedObject),
-    );
-
-    if (!this.shouldNotify(data) && origin === 'event') return;
-
-    this.callback({
-      onNextPage: () => this.loadPage({ direction: Amity.LiveCollectionPageDirection.NEXT }),
-      data,
-      hasNextPage: !!this.paginationController.getNextToken(),
-      loading,
-      error,
-    });
-  }
-
-  applyFilter(data: Amity.JoinRequest[]) {
-    let joinRequest = data;
-
-    if (this.query.communityIds && this.query.communityIds.length > 0) {
-      joinRequest = joinRequest.filter(joinRequest =>
-        this.query.communityIds.some(id => id === joinRequest.targetId),
-      );
-    }
-
-    const sortFn = (() => {
-      switch (this.query.sortBy) {
-        case 'firstCreated':
-          return sortByFirstCreated;
-        case 'lastCreated':
-          return sortByLastCreated;
-        default:
-          return sortByLastCreated;
-      }
-    })();
-
-    joinRequest = joinRequest.sort(sortFn);
-
-    return joinRequest;
-  }
-}

package/src/communityRepository/observers/getJoinRequestList/JoinRequestListPaginationController.ts

@@ -1,30 +0,0 @@
-import { PaginationController } from '~/core/liveCollection/PaginationController';
-import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
-
-/**
- * TODO: handle cache receive cache option, and cache policy
- * TODO: check if querybyIds is supported
- */
-export class JoinRequestListPaginationController extends PaginationController<
-  'joinRequest',
-  Amity.JoinRequestListLiveCollection
-> {
-  async getRequest(queryParams: Amity.JoinRequestListLiveCollection, token: string | undefined) {
-    const { limit = COLLECTION_DEFAULT_PAGINATION_LIMIT, communityIds, ...params } = queryParams;
-    const options = token ? { token } : { limit };
-
-    const encodedChannelIds = communityIds.map(communityId => encodeURIComponent(communityId));
-
-    const { data: queryResponse } = await this.http.get<
-      Amity.CommunityJoinRequestPayload & Amity.Pagination
-    >(`/api/v4/communities/join/requests`, {
-      params: {
-        ...params,
-        options,
-        communityIds: encodedChannelIds,
-      },
-    });
-
-    return queryResponse;
-  }
-}

package/src/communityRepository/observers/getJoinRequestList/JoinRequestListQueryStreamController.ts

@@ -1,116 +0,0 @@
-import { QueryStreamController } from '~/core/liveCollection/QueryStreamController';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { ingestInCache } from '~/cache/api/ingestInCache';
-import { getResolver } from '~/core/model';
-import { getActiveClient } from '~/client/api/activeClient';
-import { EnumJoinRequestAction } from './enum';
-
-export class JoinRequestListQueryStreamController extends QueryStreamController<
-  Amity.CommunityJoinRequestPayload,
-  Amity.JoinRequestListLiveCollection
-> {
-  private notifyChange: (params: Amity.LiveCollectionNotifyParams) => void;
-
-  private preparePayload: (
-    response: Amity.CommunityJoinRequestPayload,
-  ) => Amity.ProcessedJoinRequestPayload;
-
-  constructor(
-    query: Amity.JoinRequestListLiveCollection,
-    cacheKey: string[],
-    notifyChange: (params: Amity.LiveCollectionNotifyParams) => void,
-    preparePayload: (
-      response: Amity.CommunityJoinRequestPayload,
-    ) => Amity.ProcessedJoinRequestPayload,
-  ) {
-    super(query, cacheKey);
-    this.notifyChange = notifyChange;
-    this.preparePayload = preparePayload;
-  }
-
-  async saveToMainDB(response: Amity.CommunityJoinRequestPayload) {
-    const processedPayload = await this.preparePayload(response);
-
-    const client = getActiveClient();
-    const cachedAt = client.cache && Date.now();
-
-    if (client.cache) {
-      ingestInCache(processedPayload, { cachedAt });
-    }
-  }
-
-  appendToQueryStream(
-    response: Amity.CommunityJoinRequestPayload & Partial<Amity.Pagination>,
-    direction: Amity.LiveCollectionPageDirection,
-    refresh = false,
-  ) {
-    if (refresh) {
-      pushToCache(this.cacheKey, {
-        data: response.joinRequests.map(joinRequest =>
-          getResolver('joinRequest')({ joinRequestId: joinRequest._id }),
-        ),
-      });
-    } else {
-      const collection = pullFromCache<Amity.JoinRequestListLiveCollectionCache>(
-        this.cacheKey,
-      )?.data;
-
-      const joinRequests = collection?.data ?? [];
-
-      pushToCache(this.cacheKey, {
-        ...collection,
-        data: [
-          ...new Set([
-            ...joinRequests,
-            ...response.joinRequests.map(joinRequest =>
-              getResolver('joinRequest')({ joinRequestId: joinRequest._id }),
-            ),
-          ]),
-        ],
-      });
-    }
-  }
-
-  reactor(action: EnumJoinRequestAction) {
-    return (joinRequest: Amity.InternalJoinRequest[] | Amity.InternalJoinRequest) => {
-      const collection = pullFromCache<Amity.JoinRequestListLiveCollectionCache>(
-        this.cacheKey,
-      )?.data;
-      if (!collection) return;
-
-      const isArrayJoinRequest = Array.isArray(joinRequest);
-
-      const joinRequestIds = (isArrayJoinRequest ? joinRequest : [joinRequest]).map(
-        jr => jr.joinRequestId,
-      );
-
-      if (action === EnumJoinRequestAction.OnLocalJoinRequestUpdated) {
-        const isExist = collection.data.find(id => joinRequestIds.includes(id));
-
-        if (!isExist) return;
-      }
-
-      if (action === EnumJoinRequestAction.OnLocalJoinRequestCreated) {
-        collection.data = [...new Set([...joinRequestIds, ...collection.data])];
-      }
-
-      if (action === EnumJoinRequestAction.OnLocalJoinRequestDeleted) {
-        collection.data = collection.data.filter(id => !joinRequestIds.includes(id));
-      }
-
-      pushToCache(this.cacheKey, collection);
-      this.notifyChange({ origin: Amity.LiveDataOrigin.EVENT, loading: false });
-    };
-  }
-
-  subscribeRTE(
-    createSubscriber: {
-      fn: (
-        reactor: Amity.Listener<Amity.InternalJoinRequest[] | Amity.InternalJoinRequest>,
-      ) => Amity.Unsubscriber;
-      action: EnumJoinRequestAction;
-    }[],
-  ) {
-    return createSubscriber.map(subscriber => subscriber.fn(this.reactor(subscriber.action)));
-  }
-}

package/src/communityRepository/observers/getJoinRequestList/enum.ts

@@ -1,5 +0,0 @@
-export enum EnumJoinRequestAction {
-  OnLocalJoinRequestCreated = 'OnLocalJoinRequestCreated',
-  OnLocalJoinRequestUpdated = 'OnLocalJoinRequestUpdated',
-  OnLocalJoinRequestDeleted = 'OnLocalJoinRequestDeleted',
-}

package/src/communityRepository/observers/getJoinRequestList.ts

@@ -1,51 +0,0 @@
-import { dropFromCache } from '~/cache/api/dropFromCache';
-import { getActiveClient } from '~/client/api/activeClient';
-import { ENABLE_CACHE_MESSAGE } from '~/utils/constants';
-import { JoinRequestListLiveCollectionController } from './getJoinRequestList/JoinRequestListLiveCollectionController';
-
-/* begin_public_function
-  id: community.getJoinRequestList
-*/
-/**
- * Get Join Requests
- *
- * @param params the query parameters
- * @param callback the callback to be called when the join request are updated
- * @returns joinRequest[]
- *
- * @category joinRequestList Live Collection
- *
- */
-export const getJoinRequestList = (
-  params: Amity.JoinRequestListLiveCollection,
-  callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
-  config?: Amity.LiveCollectionConfig,
-) => {
-  const { log, cache } = getActiveClient();
-
-  if (!cache) {
-    console.log(ENABLE_CACHE_MESSAGE);
-  }
-
-  const timestamp = Date.now();
-  log(`getJoinRequestList: (tmpid: ${timestamp}) > listen`);
-
-  const joinRequestListLiveCollection = new JoinRequestListLiveCollectionController(
-    params,
-    callback,
-  );
-
-  const disposers = joinRequestListLiveCollection.startSubscription();
-
-  const cacheKey = joinRequestListLiveCollection.getCacheKey();
-
-  disposers.push(() => {
-    dropFromCache(cacheKey);
-  });
-
-  return () => {
-    log(`getJoinRequestList (tmpid: ${timestamp}) > dispose`);
-    disposers.forEach(fn => fn());
-  };
-};
-/* end_public_function */

package/src/communityRepository/observers/getJoinRequests/JoinRequestsLiveCollectionController.ts

@@ -1,126 +0,0 @@
-import hash from 'object-hash';
-import { pullFromCache, pushToCache } from '~/cache/api';
-import { JoinRequestsPaginationController } from './JoinRequestsPaginationController';
-import { JoinRequestsQueryStreamController } from './JoinRequestsQueryStreamController';
-import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
-import { sortByFirstCreated, sortByLastCreated } from '~/core/query';
-import { prepareCommunityJoinRequestPayload } from '~/communityRepository/utils';
-import { EnumJoinRequestAction } from './enum';
-import { isNonNullable } from '~/utils';
-import { joinRequestLinkedObject } from '~/utils/linkedObject/joinRequestLinkedObject';
-import {
-  onJoinRequestCreated,
-  onJoinRequestDeleted,
-  onJoinRequestUpdated,
-} from '~/communityRepository/joinRequest/events/';
-
-export class JoinRequestsLiveCollectionController extends LiveCollectionController<
-  'joinRequest',
-  Amity.JoinRequestLiveCollection,
-  Amity.JoinRequest,
-  JoinRequestsPaginationController
-> {
-  private queryStreamController: JoinRequestsQueryStreamController;
-
-  private query: Amity.JoinRequestLiveCollection;
-
-  constructor(
-    query: Amity.JoinRequestLiveCollection,
-    callback: Amity.LiveCollectionCallback<Amity.JoinRequest>,
-  ) {
-    const queryStreamId = hash(query);
-    const cacheKey = ['joinRequest', 'collection', queryStreamId];
-    const paginationController = new JoinRequestsPaginationController(query);
-
-    super(paginationController, queryStreamId, cacheKey, callback);
-
-    this.query = query;
-    this.queryStreamController = new JoinRequestsQueryStreamController(
-      this.query,
-      this.cacheKey,
-      this.notifyChange.bind(this),
-      prepareCommunityJoinRequestPayload,
-    );
-
-    this.callback = callback.bind(this);
-    this.loadPage({ initial: true });
-  }
-
-  protected setup() {
-    const collection = pullFromCache<Amity.JoinRequestLiveCollectionCache>(this.cacheKey)?.data;
-    if (!collection) {
-      pushToCache(this.cacheKey, {
-        data: [],
-        params: this.query,
-      });
-    }
-  }
-
-  protected async persistModel(queryPayload: Amity.CommunityJoinRequestPayload & Amity.Pagination) {
-    await this.queryStreamController.saveToMainDB(queryPayload);
-  }
-
-  protected persistQueryStream({
-    response,
-    direction,
-    refresh,
-  }: Amity.LiveCollectionPersistQueryStreamParams<'joinRequest'>) {
-    const joinRequestResponse = response as unknown as Amity.CommunityJoinRequestPayload &
-      Partial<Amity.Pagination>;
-    this.queryStreamController.appendToQueryStream(joinRequestResponse, direction, refresh);
-  }
-
-  startSubscription() {
-    return this.queryStreamController.subscribeRTE([
-      { fn: onJoinRequestCreated, action: EnumJoinRequestAction.OnLocalJoinRequestCreated },
-      { fn: onJoinRequestUpdated, action: EnumJoinRequestAction.OnLocalJoinRequestUpdated },
-      { fn: onJoinRequestDeleted, action: EnumJoinRequestAction.OnLocalJoinRequestDeleted },
-    ]);
-  }
-
-  notifyChange({ origin, loading, error }: Amity.LiveCollectionNotifyParams) {
-    const collection = pullFromCache<Amity.JoinRequestLiveCollectionCache>(this.cacheKey)?.data;
-    if (!collection) return;
-
-    const data = this.applyFilter(
-      collection.data
-        .map(id => pullFromCache<Amity.InternalJoinRequest>(['joinRequest', 'get', id])!)
-        .filter(isNonNullable)
-        .map(({ data }) => data)
-        .map(joinRequestLinkedObject),
-    );
-
-    if (!this.shouldNotify(data) && origin === 'event') return;
-
-    this.callback({
-      onNextPage: () => this.loadPage({ direction: Amity.LiveCollectionPageDirection.NEXT }),
-      data,
-      hasNextPage: !!this.paginationController.getNextToken(),
-      loading,
-      error,
-    });
-  }
-
-  applyFilter(data: Amity.JoinRequest[]) {
-    let joinRequest = data;
-
-    if (this.query.status) {
-      joinRequest = joinRequest.filter(joinRequest => joinRequest.status === this.query.status);
-    }
-
-    const sortFn = (() => {
-      switch (this.query.sortBy) {
-        case 'firstCreated':
-          return sortByFirstCreated;
-        case 'lastCreated':
-          return sortByLastCreated;
-        default:
-          return sortByLastCreated;
-      }
-    })();
-
-    joinRequest = joinRequest.sort(sortFn);
-
-    return joinRequest;
-  }
-}

package/src/communityRepository/observers/getJoinRequests/JoinRequestsPaginationController.ts

@@ -1,26 +0,0 @@
-import { PaginationController } from '~/core/liveCollection/PaginationController';
-import { COLLECTION_DEFAULT_PAGINATION_LIMIT } from '~/utils/constants';
-
-/**
- * TODO: handle cache receive cache option, and cache policy
- * TODO: check if querybyIds is supported
- */
-export class JoinRequestsPaginationController extends PaginationController<
-  'joinRequest',
-  Amity.JoinRequestLiveCollection
-> {
-  async getRequest(queryParams: Amity.JoinRequestLiveCollection, token: string | undefined) {
-    const { limit = COLLECTION_DEFAULT_PAGINATION_LIMIT, communityId, ...params } = queryParams;
-    const options = token ? { token } : { limit };
-
-    const { data: queryResponse } = await this.http.get<
-      Amity.CommunityJoinRequestPayload & Amity.Pagination
-    >(`/api/v4/communities/${communityId}/join`, {
-      params: {
-        ...params,
-        options,
-      },
-    });
-    return queryResponse;
-  }
-}