@amityco/ts-sdk-react-native 6.23.0 → 6.23.1-d5c2fe6.0

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersLiveCollectionController.ts

@@ -0,0 +1,152 @@
+/* eslint-disable no-use-before-define */
+import hash from 'object-hash';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { CommunityMembersPaginationController } from './CommunityMembersPaginationController';
+import { CommunityMembersQueryStreamController } from './CommunityMembersQueryStreamController';
+import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
+import {
+  onCommunityJoined,
+  onCommunityLeft,
+  onCommunityUserBanned,
+  onCommunityUserChanged,
+  onCommunityUserRoleAdded,
+  onCommunityUserRoleRemoved,
+  onCommunityUserUnbanned,
+} from '~/communityRepository/communityMembership/events';
+import {
+  filterByPropIntersection,
+  filterBySearchTerm,
+  sortByDisplayName,
+  sortByFirstCreated,
+  sortByLastCreated,
+} from '~/core/query';
+import { prepareCommunityPayload } from '~/communityRepository/utils';
+import { isNonNullable } from '~/utils';
+import { EnumCommunityMemberActions } from './enums';
+
+export class CommunityMembersLiveCollectionController extends LiveCollectionController<
+  'communityUser',
+  Amity.CommunityMemberLiveCollection,
+  Amity.Membership<'community'>,
+  CommunityMembersPaginationController
+> {
+  private queryStreamController: CommunityMembersQueryStreamController;
+
+  private query: Amity.CommunityMemberLiveCollection;
+
+  constructor(
+    query: Amity.CommunityMemberLiveCollection,
+    callback: Amity.LiveCollectionCallback<Amity.Membership<'community'>>,
+  ) {
+    const queryStreamId = hash(query);
+    const cacheKey = ['communityUsers', 'collection', queryStreamId];
+    const paginationController = new CommunityMembersPaginationController(query);
+
+    super(paginationController, queryStreamId, cacheKey, callback);
+
+    this.query = query;
+    this.queryStreamController = new CommunityMembersQueryStreamController(
+      this.query,
+      this.cacheKey,
+      this.notifyChange.bind(this),
+      prepareCommunityPayload,
+    );
+
+    this.callback = callback.bind(this);
+    this.loadPage({ initial: true });
+  }
+
+  protected setup() {
+    const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(this.cacheKey)?.data;
+    if (!collection) {
+      pushToCache(this.cacheKey, {
+        data: [],
+        params: {},
+      });
+    }
+  }
+
+  protected async persistModel(queryPayload: Amity.CommunityMembershipPayload & Amity.Pagination) {
+    await this.queryStreamController.saveToMainDB(queryPayload);
+  }
+
+  protected persistQueryStream({
+    response,
+    direction,
+    refresh,
+  }: Amity.LiveCollectionPersistQueryStreamParams<'communityUser'>) {
+    this.queryStreamController.appendToQueryStream(response, direction, refresh);
+  }
+
+  startSubscription() {
+    return this.queryStreamController.subscribeRTE([
+      { fn: onCommunityJoined, action: EnumCommunityMemberActions.OnCommunityJoined },
+      { fn: onCommunityLeft, action: EnumCommunityMemberActions.OnCommunityLeft },
+      { fn: onCommunityUserBanned, action: EnumCommunityMemberActions.OnCommunityUserBanned },
+      { fn: onCommunityUserChanged, action: EnumCommunityMemberActions.OnCommunityUserChanged },
+      { fn: onCommunityUserRoleAdded, action: EnumCommunityMemberActions.OnCommunityUserRoleAdded },
+      {
+        fn: onCommunityUserRoleRemoved,
+        action: EnumCommunityMemberActions.OnCommunityUserRoleRemoved,
+      },
+      { fn: onCommunityUserUnbanned, action: EnumCommunityMemberActions.OnCommunityUserUnbanned },
+    ]);
+  }
+
+  notifyChange({ origin, loading, error }: Amity.LiveCollectionNotifyParams) {
+    const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(this.cacheKey)?.data;
+    if (!collection) return;
+
+    const data = this.applyFilter(
+      collection.data
+        .map(id => pullFromCache<Amity.Membership<'community'>>(['communityUsers', 'get', id])!)
+        .filter(isNonNullable)
+        .map(({ data }) => data) ?? [],
+    );
+
+    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.Membership<'community'>[]) {
+    let communityMembers = filterByPropIntersection(data, 'roles', this.query.roles);
+
+    if (this.query.memberships) {
+      communityMembers = communityMembers.filter(({ communityMembership }) => {
+        const memberships: Amity.GroupMembership[] = this.query.memberships || [];
+        return memberships.includes(communityMembership);
+      });
+    }
+
+    if (this.query.search) {
+      communityMembers = filterBySearchTerm(communityMembers, this.query.search);
+    }
+
+    const sortBy = this.query.sortBy ? this.query.sortBy : 'lastCreated';
+    switch (sortBy) {
+      case 'lastCreated':
+        communityMembers = communityMembers.sort(sortByLastCreated);
+        break;
+      case 'firstCreated':
+        communityMembers = communityMembers.sort(sortByFirstCreated);
+        break;
+      case 'displayName':
+        communityMembers = communityMembers.sort((memberA, memberB) => {
+          if (!memberA.user || !memberB.user) return 0;
+          return sortByDisplayName(memberA.user, memberB.user);
+        });
+        break;
+      default:
+        break;
+    }
+
+    return communityMembers;
+  }
+}

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersPaginationController.ts

@@ -0,0 +1,26 @@
+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 CommunityMembersPaginationController extends PaginationController<
+  'communityUser',
+  Amity.CommunityMemberLiveCollection
+> {
+  async getRequest(queryParams: Amity.CommunityMemberLiveCollection, token: string | undefined) {
+    const { limit = COLLECTION_DEFAULT_PAGINATION_LIMIT, ...params } = queryParams;
+    const options = token ? { token } : { limit };
+
+    const { data: queryResponse } = await this.http.get<
+      Amity.CommunityMembershipPayload & Amity.Pagination
+    >(`/api/v3/communities/${params.communityId}/users`, {
+      params: {
+        ...params,
+        options,
+      },
+    });
+    return queryResponse;
+  }
+}

package/src/communityRepository/communityMembership/observers/getMembers/CommunityMembersQueryStreamController.ts

@@ -0,0 +1,107 @@
+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';
+import { EnumCommunityMemberActions } from './enums';
+
+export class CommunityMembersQueryStreamController extends QueryStreamController<
+  Amity.CommunityMembershipPayload,
+  Amity.CommunityMemberLiveCollection
+> {
+  private notifyChange: (params: Amity.LiveCollectionNotifyParams) => void;
+
+  private preparePayload: (
+    response: Amity.CommunityMembershipPayload,
+  ) => Amity.ProcessedCommunityMembershipPayload;
+
+  constructor(
+    query: Amity.CommunityMemberLiveCollection,
+    cacheKey: string[],
+    notifyChange: (params: Amity.LiveCollectionNotifyParams) => void,
+    preparePayload: (
+      response: Amity.CommunityMembershipPayload,
+    ) => Amity.ProcessedCommunityMembershipPayload,
+  ) {
+    super(query, cacheKey);
+    this.notifyChange = notifyChange;
+    this.preparePayload = preparePayload;
+  }
+
+  async saveToMainDB(response: Amity.CommunityMembershipPayload) {
+    const processedPayload = await this.preparePayload(response);
+
+    const client = getActiveClient();
+    const cachedAt = client.cache && Date.now();
+
+    if (client.cache) {
+      ingestInCache(processedPayload, { cachedAt });
+    }
+  }
+
+  appendToQueryStream(
+    response: Amity.CommunityMembershipPayload & Partial<Amity.Pagination>,
+    direction: Amity.LiveCollectionPageDirection,
+    refresh = false,
+  ) {
+    if (refresh) {
+      pushToCache(this.cacheKey, {
+        data: response.communityUsers.map(({ communityId, userId }) =>
+          getResolver('communityUsers')({ communityId, userId }),
+        ),
+      });
+    } else {
+      const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
+
+      const communityUsers = collection?.data ?? [];
+
+      pushToCache(this.cacheKey, {
+        ...collection,
+        data: [
+          ...new Set([
+            ...communityUsers,
+            ...response.communityUsers.map(({ communityId, userId }) =>
+              getResolver('communityUsers')({ communityId, userId }),
+            ),
+          ]),
+        ],
+      });
+    }
+  }
+
+  reactor(action: EnumCommunityMemberActions) {
+    return (community: Amity.Community, communityMembers: Amity.Membership<'community'>[]) => {
+      const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(
+        this.cacheKey,
+      )?.data;
+      if (!collection) return;
+
+      communityMembers.forEach(communityMember => {
+        const communityMemberCacheId = getResolver('communityUsers')({
+          communityId: this.query.communityId,
+          userId: communityMember.userId,
+        });
+
+        if (communityMember.communityMembership === 'none') {
+          collection.data = collection.data.filter(m => m !== communityMemberCacheId);
+        } else if (!collection.data.includes(communityMemberCacheId)) {
+          collection.data = [communityMemberCacheId, ...collection.data];
+        }
+      });
+
+      pushToCache(this.cacheKey, collection);
+      this.notifyChange({ origin: Amity.LiveDataOrigin.EVENT, loading: false });
+    };
+  }
+
+  subscribeRTE(
+    createSubscriber: {
+      fn: (
+        reactor: (channel: Amity.Community, communityUser: Amity.Membership<'community'>[]) => void,
+      ) => Amity.Unsubscriber;
+      action: EnumCommunityMemberActions;
+    }[],
+  ) {
+    return createSubscriber.map(subscriber => subscriber.fn(this.reactor(subscriber.action)));
+  }
+}

package/src/communityRepository/communityMembership/observers/getMembers/enums.ts

@@ -0,0 +1,9 @@
+export enum EnumCommunityMemberActions {
+  OnCommunityJoined = 'onCommunityJoined',
+  OnCommunityLeft = 'onCommunityLeft',
+  OnCommunityUserBanned = 'onCommunityUserBanned',
+  OnCommunityUserChanged = 'onCommunityUserChanged',
+  OnCommunityUserRoleAdded = 'onCommunityUserRoleAdded',
+  OnCommunityUserRoleRemoved = 'onCommunityUserRoleRemoved',
+  OnCommunityUserUnbanned = 'onCommunityUserUnbanned',
+}

package/src/communityRepository/communityMembership/observers/getMembers.ts

@@ -1,32 +1,13 @@
-/* eslint-disable no-use-before-define */
-import { getResolver } from '~/core/model';
-import { pullFromCache, pushToCache } from '~/cache/api';
 import { getActiveClient } from '~/client/api';
 import {
-  createQuery,
   filterByPropIntersection,
   filterBySearchTerm,
-  queryOptions,
-  runQuery,
   sortByFirstCreated,
   sortByLastCreated,
 } from '~/core/query';
-import {
-  COLLECTION_DEFAULT_CACHING_POLICY,
-  COLLECTION_DEFAULT_PAGINATION_LIMIT,
-  ENABLE_CACHE_MESSAGE,
-} from '~/utils/constants';
-import { isNonNullable } from '~/utils';
-import {
-  onCommunityJoined,
-  onCommunityLeft,
-  onCommunityUserBanned,
-  onCommunityUserChanged,
-  onCommunityUserRoleAdded,
-  onCommunityUserRoleRemoved,
-  onCommunityUserUnbanned,
-} from '../events';
-import { queryCommunityMembers } from '../api/queryCommunityMembers';
+import { ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+import { CommunityMembersLiveCollectionController } from './getMembers/CommunityMembersLiveCollectionController';
+import { dropFromCache } from '~/cache/api';
 
 /*
  * Exported for testing
@@ -92,114 +73,20 @@ export const getMembers = (
   const timestamp = Date.now();
   log(`getMembers(tmpid: ${timestamp}) > listen`);
 
-  const { limit: queryLimit, ...queryParams } = params;
-
-  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
-  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
-
-  const disposers: Amity.Unsubscriber[] = [];
-  const cacheKey = ['communityUsers', 'collection', queryParams as unknown as Amity.Serializable];
-  const cacheByCommunityIdKey = [
-    'communityUsers',
-    'collection',
-    { communityId: params.communityId },
-  ];
-
-  const responder = (data: Amity.CommunityMemberLiveCollectionCache, isEventModel = false) => {
-    const communityMembers: Amity.Membership<'community'>[] =
-      data.data
-        .map(id => pullFromCache<Amity.Membership<'community'>>(['communityUsers', 'get', id])!)
-        .filter(Boolean)
-        .map(({ data }) => data) ?? [];
-
-    callback({
-      onNextPage: onFetch,
-      data: isEventModel ? applyFilter(communityMembers, params) : communityMembers,
-      hasNextPage: !!data.params?.page,
-      loading: data.loading,
-      error: data.error,
-    });
-  };
-
-  const realtimeRouter =
-    (_: Amity.CommunityMemberActionType) =>
-    (_: Amity.Community, communityMembers: Amity.Membership<'community'>[]) => {
-      const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(cacheKey)?.data;
-      if (!collection) {
-        return;
-      }
-
-      const communityMemberCacheIds = communityMembers
-        .map(communityMember => {
-          if (params.communityId !== communityMember.communityId) {
-            return;
-          }
-
-          const communityMemberCacheId = getResolver('communityUsers')({
-            communityId: params.communityId,
-            userId: communityMember.userId,
-          });
-
-          return communityMemberCacheId;
-        })
-        .filter(isNonNullable);
-
-      collection.data = [...new Set([...communityMemberCacheIds, ...collection.data])];
-
-      pushToCache(cacheKey, collection);
-      pushToCache(cacheByCommunityIdKey, collection);
-      responder(collection, true);
-    };
-
-  const onFetch = (initial = false) => {
-    const collection = pullFromCache<Amity.CommunityMemberLiveCollectionCache>(cacheKey)?.data;
-
-    const communityMembers = collection?.data ?? [];
-
-    if (!initial && communityMembers.length > 0 && !collection?.params.page) return;
-
-    const query = createQuery(queryCommunityMembers, {
-      ...queryParams,
-      limit: initial ? limit : undefined,
-      page: !initial ? collection?.params.page : undefined,
-    });
-
-    runQuery(
-      query,
-      ({ data: result, error, loading, paging }) => {
-        const data = {
-          loading,
-          error,
-          params: { page: paging?.next },
-          data: communityMembers,
-        };
-
-        if (result) {
-          data.data = [
-            ...new Set([...communityMembers, ...result.map(getResolver('communityUsers'))]),
-          ];
-        }
-
-        pushToCache(cacheKey, data);
-        pushToCache(cacheByCommunityIdKey, data);
-
-        responder(data);
-      },
-      queryOptions(policy),
-    );
-  };
-
-  disposers.push(
-    onCommunityLeft(realtimeRouter('onLeft')),
-    onCommunityJoined(realtimeRouter('onJoin')),
-    onCommunityUserBanned(realtimeRouter('onBan')),
-    onCommunityUserUnbanned(realtimeRouter('onUnban')),
-    onCommunityUserChanged(realtimeRouter('onMemberCountChanged')),
-    onCommunityUserRoleAdded(realtimeRouter('onMemberCountChanged')),
-    onCommunityUserRoleRemoved(realtimeRouter('onMemberCountChanged')),
+  const communityMemberLiveCollection = new CommunityMembersLiveCollectionController(
+    params,
+    resp => {
+      console.log('resp', resp);
+      callback(resp);
+    },
   );
+  const disposers = communityMemberLiveCollection.startSubscription();
+
+  const cacheKey = communityMemberLiveCollection.getCacheKey();
 
-  onFetch(true);
+  disposers.push(() => {
+    dropFromCache(cacheKey);
+  });
 
   return () => {
     log(`getMembers(tmpid: ${timestamp}) > dispose`);

package/src/communityRepository/communityMembership/observers/searchMembers.ts

@@ -0,0 +1,60 @@
+import { getActiveClient } from '~/client/api';
+import { ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+import { dropFromCache } from '~/cache/api';
+import { SearchCommunityMembersLiveCollectionController } from './searchMembers/SearchCommunityMembersLiveCollectionController';
+
+/* begin_public_function
+  id: community.membership.query
+*/
+/**
+ * ```js
+ * import { searchMembers } from '@amityco/ts-sdk-react-native'
+ *
+ * let communityMembers = []
+ * const unsub = searchMembers({
+ *   communityId: Amity.Community['communityId'],
+ * }, response => merge(communityMembers, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.CommunityUser}s
+ *
+ * @param params for querying community users
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the community users
+ *
+ * @category Community Live Collection
+ */
+export const searchMembers = (
+  params: Amity.SearchCommunityMemberLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.Membership<'community'>>,
+  config?: Amity.LiveCollectionConfig,
+) => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log(ENABLE_CACHE_MESSAGE);
+  }
+
+  const timestamp = Date.now();
+  log(`getMembers(tmpid: ${timestamp}) > listen`);
+
+  const searchCommunityMemberLiveCollection = new SearchCommunityMembersLiveCollectionController(
+    params,
+    resp => {
+      callback(resp);
+    },
+  );
+  const disposers = searchCommunityMemberLiveCollection.startSubscription();
+
+  const cacheKey = searchCommunityMemberLiveCollection.getCacheKey();
+
+  disposers.push(() => {
+    dropFromCache(cacheKey);
+  });
+
+  return () => {
+    log(`getMembers(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};
+/* end_public_function */

package/src/communityRepository/observers/getCommunities/CommunitiesLiveCollectionController.ts

@@ -0,0 +1,147 @@
+/* eslint-disable no-use-before-define */
+import hash from 'object-hash';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { CommunitiesPaginationController } from './CommunitiesPaginationController';
+import { CommunitiesQueryStreamController } from './CommunitiesQueryStreamController';
+import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
+import {
+  onCommunityCreated,
+  onCommunityDeleted,
+  onCommunityUpdated,
+} from '~/communityRepository/events';
+import {
+  filterByCommunityMembership,
+  filterByPropEquality,
+  sortByDisplayName,
+  sortByFirstCreated,
+  sortByLastCreated,
+} from '~/core/query';
+import { prepareCommunityPayload } from '~/communityRepository/utils';
+import { getActiveClient } from '~/client';
+import { EnumCommunityActions } from './enums';
+
+export class CommunityLiveCollectionController extends LiveCollectionController<
+  'community',
+  Amity.CommunityLiveCollection,
+  Amity.Community,
+  CommunitiesPaginationController
+> {
+  private queryStreamController: CommunitiesQueryStreamController;
+
+  private query: Amity.CommunityLiveCollection;
+
+  constructor(
+    query: Amity.CommunityLiveCollection,
+    callback: Amity.LiveCollectionCallback<Amity.Community>,
+  ) {
+    const queryStreamId = hash(query);
+    const cacheKey = ['community', 'collection', queryStreamId];
+    const paginationController = new CommunitiesPaginationController(query);
+
+    super(paginationController, queryStreamId, cacheKey, callback);
+
+    this.query = query;
+    this.queryStreamController = new CommunitiesQueryStreamController(
+      this.query,
+      this.cacheKey,
+      this.notifyChange.bind(this),
+      prepareCommunityPayload,
+    );
+
+    this.callback = callback.bind(this);
+    this.loadPage({ initial: true });
+  }
+
+  protected setup() {
+    const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
+    if (!collection) {
+      pushToCache(this.cacheKey, {
+        data: [],
+        params: {},
+      });
+    }
+  }
+
+  protected async persistModel(queryPayload: Amity.CommunityPayload & Amity.Pagination) {
+    await this.queryStreamController.saveToMainDB(queryPayload);
+  }
+
+  protected persistQueryStream({
+    response,
+    direction,
+    refresh,
+  }: Amity.LiveCollectionPersistQueryStreamParams<'community'>) {
+    this.queryStreamController.appendToQueryStream(response, direction, refresh);
+  }
+
+  startSubscription() {
+    return this.queryStreamController.subscribeRTE([
+      { fn: onCommunityCreated, action: EnumCommunityActions.OnCommunityCreated },
+      { fn: onCommunityDeleted, action: EnumCommunityActions.OnCommunityDeleted },
+      { fn: onCommunityUpdated, action: EnumCommunityActions.OnCommunityUpdated },
+    ]);
+  }
+
+  notifyChange({ origin, loading, error }: Amity.LiveCollectionNotifyParams) {
+    const collection = pullFromCache<Amity.CommunityLiveCollectionCache>(this.cacheKey)?.data;
+    if (!collection) return;
+
+    const data = this.applyFilter(
+      collection.data
+        .map(id => pullFromCache<Amity.Community>(['community', 'get', id])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [],
+    );
+
+    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.Community[]) {
+    const { userId } = getActiveClient();
+
+    let communities = data;
+
+    if (this.query.includeDeleted) {
+      communities = filterByPropEquality(communities, 'isDeleted', false);
+    }
+
+    if (this.query.categoryId) {
+      communities = communities.filter(c => c.categoryIds?.includes(this.query.categoryId!));
+    }
+
+    if (this.query.tags) {
+      communities = communities.filter(c => c.tags?.some(t => this.query.tags?.includes(t)));
+    }
+
+    if (this.query.membership && userId) {
+      communities = filterByCommunityMembership(communities, this.query.membership, userId);
+    }
+
+    if (!this.query.displayName) {
+      const sortFn = (() => {
+        switch (this.query.sortBy) {
+          case 'firstCreated':
+            return sortByFirstCreated;
+          case 'lastCreated':
+            return sortByLastCreated;
+          case 'displayName':
+            return sortByDisplayName;
+          default:
+            return sortByLastCreated;
+        }
+      })();
+
+      communities = communities.sort(sortFn);
+    }
+
+    return communities;
+  }
+}