@amityco/ts-sdk 0.0.1-65d7c8a.0 → 0.0.1-669cd80.0

package/src/community/api/getCommunity.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { pullFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -18,26 +18,26 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @async
  */
 export const getCommunity = async (
-  communityId: Amity.Community['communityId']
+  communityId: Amity.Community['communityId'],
 ): Promise<Amity.Cached<Amity.Community>> => {
-  const client = getActiveClient()
-  client.log('community/getCommunity', communityId)
+  const client = getActiveClient();
+  client.log('community/getCommunity', communityId);
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
   const { data } = await client.http.get<Amity.CommunityPayload>(
     `/api/v3/communities/${communityId}`,
-  )
+  );
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { communities } = data
+  const { communities } = data;
 
   return {
     data: communities.find(community => community.communityId === communityId)!,
     cachedAt,
-  }
-}
+  };
+};
 
 /**
  * ```js
@@ -53,20 +53,19 @@ export const getCommunity = async (
  * @category Community API
  */
 getCommunity.locally = (
-  communityId: Amity.Community['communityId']
+  communityId: Amity.Community['communityId'],
 ): Amity.Cached<Amity.Community> | undefined => {
-  const client = getActiveClient()
-  client.log('community/getCommunity.locally', communityId)
+  const client = getActiveClient();
+  client.log('community/getCommunity.locally', communityId);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const cached = pullFromCache<Amity.Community>(['community', 'get', communityId])
+  const cached = pullFromCache<Amity.Community>(['community', 'get', communityId]);
 
-  if (!cached)
-    return
+  if (!cached) return;
 
   return {
     data: cached.data,
     cachedAt: cached.cachedAt,
-  }
-}
+  };
+};

package/src/community/api/getRecommendedCommunities.ts

@@ -0,0 +1,87 @@
+import { getActiveClient } from '~/client/api';
+
+import { getResolver } from '~/core/model';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = await getRecommendedCommunities()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export const getRecommendedCommunities = async (
+  query?: Partial<Amity.PageLimit>,
+): Promise<Amity.Cached<Amity.Community[]>> => {
+  const client = getActiveClient();
+  client.log('channel/getRecommendedCommunities', query);
+
+  const { limit = 5 } = query ?? {};
+
+  // API-FIX: backend doesnt answer Amity.Response
+  // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
+  const { data } = await client.http.get<Amity.CommunityPayload>(
+    `/api/v3/communities/recommended`,
+    { params: { options: { limit } } },
+  );
+
+  const { communities } = data;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(data, { cachedAt });
+
+    const cacheKey = ['community', 'recommended', { params: { options: { limit } } }];
+    pushToCache(cacheKey, { communities: communities.map(getResolver('community')) });
+  }
+
+  return { data: communities, cachedAt };
+};
+
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = getRecommendedCommunities.locally()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects from cache
+ *
+ * @param query The query parameters
+ * @returns communities
+ *
+ * @category Community API
+ */
+getRecommendedCommunities.locally = (
+  query: Parameters<typeof getRecommendedCommunities>[0],
+): Amity.Cached<Amity.Community[]> | undefined => {
+  const client = getActiveClient();
+  client.log('community/getRecommendedCommunities.locally', query);
+
+  if (!client.cache) return;
+
+  const { limit = 5 } = query ?? {};
+
+  const queryKey = ['community', 'recommended', { params: { options: { limit } } }];
+  const { data, cachedAt } =
+    pullFromCache<{ communities: Pick<Amity.Community, 'communityId'>[] }>(queryKey) ?? {};
+
+  if (!data?.communities.length) return;
+
+  const communities: Amity.Community[] = data.communities
+    .map(communityId => pullFromCache<Amity.Community>(['community', 'get', communityId])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
+
+  return communities.length === data?.communities?.length
+    ? { data: communities, cachedAt }
+    : undefined;
+};

package/src/community/api/getTopTrendingCommunities.ts

@@ -0,0 +1,87 @@
+import { getActiveClient } from '~/client/api';
+
+import { getResolver } from '~/core/model';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+ * const trendingCommunities = await getTopTrendingCommunities()
+ * ```
+ *
+ * Gets a list of top trending {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export const getTopTrendingCommunities = async (
+  query?: Partial<Amity.PageLimit>,
+): Promise<Amity.Cached<Amity.Community[]>> => {
+  const client = getActiveClient();
+  client.log('channel/getTopTrendingCommunities', query);
+
+  const { limit = 5 } = query ?? {};
+
+  // API-FIX: backend doesnt answer Amity.Response
+  // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
+  const { data } = await client.http.get<Amity.CommunityPayload>(
+    `/api/v3/communities/top-trending`,
+    { params: { options: { limit } } },
+  );
+
+  const { communities } = data;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(data, { cachedAt });
+
+    const cacheKey = ['community', 'top-trending', { params: { options: { limit } } }];
+    pushToCache(cacheKey, { communities: communities.map(getResolver('community')) });
+  }
+
+  return { data: communities, cachedAt };
+};
+
+/**
+ * ```js
+ * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
+ * const communities = getTopTrendingCommunities.locally()
+ * ```
+ *
+ * Gets a list of top trending {@link Amity.Community} objects from cache
+ *
+ * @param query The query parameters
+ * @returns communities
+ *
+ * @category Community API
+ */
+getTopTrendingCommunities.locally = (
+  query: Parameters<typeof getTopTrendingCommunities>[0],
+): Amity.Cached<Amity.Community[]> | undefined => {
+  const client = getActiveClient();
+  client.log('community/getTopTrendingCommunities.locally', query);
+
+  if (!client.cache) return;
+
+  const { limit = 5 } = query ?? {};
+
+  const queryKey = ['community', 'top-trending', { params: { options: { limit } } }];
+  const { data, cachedAt } =
+    pullFromCache<{ communities: Pick<Amity.Community, 'communityId'>[] }>(queryKey) ?? {};
+
+  if (!data?.communities.length) return;
+
+  const communities: Amity.Community[] = data.communities
+    .map(communityId => pullFromCache<Amity.Community>(['community', 'get', communityId])!)
+    .filter(Boolean)
+    .map(({ data }) => data);
+
+  return communities.length === data?.communities?.length
+    ? { data: communities, cachedAt }
+    : undefined;
+};

package/src/community/api/index.ts

@@ -1,17 +1,19 @@
-export * from './queryCommunities'
-export * from './getCommunities'
-export * from './getCommunity'
+export * from './queryCommunities';
+export * from './getCommunities';
+export * from './getCommunity';
 
-export * from './createCommunity'
-export * from './updateCommunity'
-export * from './deleteCommunity'
+export * from './createCommunity';
+export * from './updateCommunity';
+export * from './deleteCommunity';
 
-export * from './joinCommunity'
-export * from './leaveCommunity'
+export * from './joinCommunity';
+export * from './leaveCommunity';
 
-export * from './queryCommunityMembers'
-export * from './addCommunityMembers'
-export * from './removeCommunityMembers'
+export * from './queryCommunityMembers';
+export * from './addCommunityMembers';
+export * from './removeCommunityMembers';
+export * from './addCommunityMembersRoles';
+export * from './removeCommunityMembersRoles';
 
-export * from './addCommunityMembersRole'
-export * from './removeCommunityMembersRole'
+export * from './getTopTrendingCommunities';
+export * from './getRecommendedCommunities';

package/src/community/api/joinCommunity.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -18,24 +18,24 @@ import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
  * @async
  */
 export const joinCommunity = async (
-  communityId: Amity.Community['communityId']
+  communityId: Amity.Community['communityId'],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('community/joinCommunity', communityId)
+  const client = getActiveClient();
+  client.log('community/joinCommunity', communityId);
 
   const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/join`,
-  )
+  );
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  MQTT_COMMUNITY_EVENT_HANDLERS['community.joined'](data)
+  fireEvent('community.joined', data);
 
-  const { communityUsers } = data
+  const { communityUsers } = data;
 
-  return !!communityUsers.find(communityUser => (
-    communityUser.communityId === communityId
-    && communityUser.communityMembership === 'member'
-  ))
-}
+  return !!communityUsers.find(
+    communityUser =>
+      communityUser.communityId === communityId && communityUser.communityMembership === 'member',
+  );
+};

package/src/community/api/leaveCommunity.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -18,24 +18,24 @@ import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
  * @async
  */
 export const leaveCommunity = async (
-  communityId: Amity.Community['communityId']
+  communityId: Amity.Community['communityId'],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('community/leaveCommunity', communityId)
+  const client = getActiveClient();
+  client.log('community/leaveCommunity', communityId);
 
   const { data } = await client.http.delete<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/leave`,
-  )
+  );
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  MQTT_COMMUNITY_EVENT_HANDLERS['community.left'](data)
+  fireEvent('community.left', data);
 
-  const { communityUsers } = data
+  const { communityUsers } = data;
 
-  return !!communityUsers.find(communityUser => (
-    communityUser.communityId === communityId
-    && communityUser.communityMembership !== 'member'
-  ))
-}
+  return !!communityUsers.find(
+    communityUser =>
+      communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
+  );
+};

package/src/community/api/queryCommunities.ts

@@ -1,9 +1,9 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { toPage, toToken } from '~/core/query'
-import { pushToCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { getResolver } from '~/core/model'
+import { toPage, toToken } from '~/core/query';
+import { pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
 
 /**
  * ```js
@@ -20,60 +20,60 @@ import { getResolver } from '~/core/model'
  * @category Community API
  * @async
  */
-export const queryCommunities = async (
-  query?: {
-    displayName?: string
-    membership?: 'all' | 'member' | 'notMember'
-    categoryId?: Amity.Category['categoryId'],
-    isDeleted?: Amity.Community['isDeleted'],
-    hasFlag?: boolean,
-    tags?: Amity.Taggable['tags'],
-    sortBy?: ('displayName' | 'firstCreated' | 'lastCreated')
-    page?: Amity.Page
-  }
-): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
-  const client = getActiveClient()
-  client.log('channel/queryCommunities', query)
+export const queryCommunities = async (query?: {
+  displayName?: string;
+  membership?: 'all' | 'member' | 'notMember';
+  categoryId?: Amity.Category['categoryId'];
+  isDeleted?: Amity.Community['isDeleted'];
+  hasFlag?: boolean;
+  tags?: Amity.Taggable['tags'];
+  sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
+  const client = getActiveClient();
+  client.log('channel/queryCommunities', query);
 
   // safe decapsulation
-  const {
-    page,
-    displayName,
-    membership,
-    ...params
-  } = query ?? {}
+  const { page, displayName, membership, ...params } = query ?? {};
 
   // API-FIX: parameters should be querystring.
   // API-FIX: backend doesnt answer Amity.Response
   // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<CommunityPayload>>>(
   const { data } = await client.http.get<Amity.CommunityPayload & Amity.Pagination>(
-    `/api/v3/communities`, { params: {
-      ...params,
-      keyword: displayName,
-      filter: membership,
-      options: {
-        token: toToken(page, 'skiplimit')
-      }
-    } }
-  )
+    `/api/v3/communities`,
+    {
+      params: {
+        ...params,
+        keyword: displayName,
+        filter: membership,
+        options: {
+          token: toToken(page, 'skiplimit'),
+        },
+      },
+    },
+  );
 
-  const { paging, ...payload } = data
-  const { communities } = payload
+  const { paging, ...payload } = data;
+  const { communities } = payload;
 
-  const cachedAt = client.cache && Date.now()
+  const cachedAt = client.cache && Date.now();
 
   if (client.cache) {
-    ingestInCache(payload as Amity.CommunityPayload, { cachedAt })
+    ingestInCache(payload as Amity.CommunityPayload, { cachedAt });
 
-    const cacheKey = ['community', 'query', { ...params, options: { ...page } } as Amity.Serializable]
-    pushToCache(cacheKey, { communities: communities.map(getResolver('community')), paging })
+    const cacheKey = [
+      'community',
+      'query',
+      { ...params, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { communities: communities.map(getResolver('community')), paging });
   }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
 
-  return { data: communities, cachedAt, prevPage, nextPage }
-}
+  return { data: communities, cachedAt, prevPage, nextPage };
+};
 
 /**
  * ```js
@@ -88,11 +88,9 @@ export const queryCommunities = async (
  *
  * @category Community API
  */
-queryCommunities.locally = (
-  query: Parameters<typeof queryCommunities>[0],
-) => {
-  const client = getActiveClient()
-  client.log('community/queryCommunities.locally', query)
+queryCommunities.locally = (query: Parameters<typeof queryCommunities>[0]) => {
+  const client = getActiveClient();
+  client.log('community/queryCommunities.locally', query);
 
   // TODO
-}
+};

package/src/community/api/queryCommunityMembers.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { toPage, toToken } from '~/core/query'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { toPage, toToken } from '~/core/query';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -16,43 +16,44 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  *
  * @category Community API
  * @async
- **/
+ * */
 export const queryCommunityMembers = async (query: {
-  communityId: string
-  membership?: ('banned' | 'member')[]
-  roles?: string[]
-  sortBy?: 'firstCreated' | 'lastCreated'
-  page?: Amity.Page
-}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<"community">>>> => {
-  const client = getActiveClient()
-  client.log('community/queryCommunityMembers', query)
+  communityId: string;
+  membership?: ('banned' | 'member')[];
+  roles?: string[];
+  sortBy?: 'firstCreated' | 'lastCreated';
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<'community'>>>> => {
+  const client = getActiveClient();
+  client.log('community/queryCommunityMembers', query);
 
-  const { page, communityId, ...params } = query ?? {}
+  const { page, communityId, ...params } = query ?? {};
 
-  const { data } = await client.http.get<
-    Amity.CommunityMembershipPayload & Amity.Pagination
-  >(`/api/v3/communities/${communityId}/users`, {
-    params: {
-      ...params,
-      options: {
-        token: toToken(page, 'skiplimit'),
+  const { data } = await client.http.get<Amity.CommunityMembershipPayload & Amity.Pagination>(
+    `/api/v3/communities/${communityId}/users`,
+    {
+      params: {
+        ...params,
+        options: {
+          token: toToken(page, 'skiplimit'),
+        },
       },
     },
-  })
+  );
 
-  const { paging, ...payload } = data
-  const { communityUsers } = payload
+  const { paging, ...payload } = data;
+  const { communityUsers } = payload;
 
-  const cachedAt = client.cache && Date.now()
+  const cachedAt = client.cache && Date.now();
   if (client.cache) {
-    ingestInCache(payload as Amity.CommunityMembershipPayload, { cachedAt })
+    ingestInCache(payload as Amity.CommunityMembershipPayload, { cachedAt });
   }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
 
-  return { data: communityUsers, nextPage, prevPage }
-}
+  return { data: communityUsers, cachedAt, nextPage, prevPage };
+};
 
 /**
  * ```js
@@ -67,11 +68,9 @@ export const queryCommunityMembers = async (query: {
  *
  * @category Post API
  */
-queryCommunityMembers.locally = (
-  query: Parameters<typeof queryCommunityMembers>[0]
-) => {
-  const client = getActiveClient()
-  client.log('community/queryCommunityMembers', query)
+queryCommunityMembers.locally = (query: Parameters<typeof queryCommunityMembers>[0]) => {
+  const client = getActiveClient();
+  client.log('community/queryCommunityMembers', query);
 
   // TODO
-}
+};

package/src/community/api/removeCommunityMembers.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -20,24 +20,23 @@ import { MQTT_COMMUNITY_EVENT_HANDLERS } from '~/community/events/utils'
  */
 export const removeCommunityMembers = async (
   communityId: Amity.Community['communityId'],
-  userIds: Amity.User['userId'][]
+  userIds: Amity.User['userId'][],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('community/removeCommunityMembers', communityId, userIds)
+  const client = getActiveClient();
+  client.log('community/removeCommunityMembers', communityId, userIds);
 
   const { data } = await client.http.delete<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/users`,
-    { data: { communityId, userIds } }
-  )
+    { data: { communityId, userIds } },
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
-  MQTT_COMMUNITY_EVENT_HANDLERS['community.userRemoved'](data)
+  fireEvent('community.userRemoved', data);
 
-  const { communityUsers } = data
+  const { communityUsers } = data;
   return !!communityUsers.find(
     communityUser =>
-      communityUser.communityId === communityId &&
-      communityUser.communityMembership !== 'member'
-  )
-}
+      communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
+  );
+};