@amityco/ts-sdk 6.10.0 → 6.10.1-50f2392.0

package/dist/subChannelRepository/api/querySubChannels.d.ts

@@ -13,7 +13,7 @@
  * @async
  */
 export declare const querySubChannels: {
-    (query: Amity.QuerySubChannels): Promise<Amity.Cached<Amity.Paged<Amity.SubChannel>>>;
+    (query: Amity.QuerySubChannels): Promise<Amity.Cached<Amity.Paged<Amity.SubChannel>> & Amity.Pagination>;
     /**
      * ```js
      * import { querySubChannels } from '@amityco/ts-sdk'
@@ -27,6 +27,6 @@ export declare const querySubChannels: {
      *
      * @category Channel API
      */
-    locally(query: Parameters<typeof querySubChannels>[0]): Amity.Cached<Amity.Paged<Amity.SubChannel>> | undefined;
+    locally(query: Parameters<typeof querySubChannels>[0]): Amity.Cached<Amity.Paged<Amity.SubChannel> & Amity.Pagination> | undefined;
 };
 //# sourceMappingURL=querySubChannels.d.ts.map

package/dist/subChannelRepository/api/querySubChannels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querySubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/api/querySubChannels.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB;YACpB,MAAM,gBAAgB,GAC5B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,CAAC;IA4CvD;;;;;;;;;;;;OAYG;mBAEM,WAAW,uBAAuB,CAAC,CAAC,CAAC,CAAC,GAC5C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,GAAG,SAAS;CAlBzD,CAAC"}
+{"version":3,"file":"querySubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/api/querySubChannels.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB;YACpB,MAAM,gBAAgB,GAC5B,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,UAAU,CAAC;IAwD1E;;;;;;;;;;;;OAYG;mBAEM,WAAW,uBAAuB,CAAC,CAAC,CAAC,CAAC,GAC5C,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,UAAU,CAAC,GAAG,MAAM,UAAU,CAAC,GAAG,SAAS;CAlB5E,CAAC"}

package/dist/subChannelRepository/observers/getSubChannels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getSubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/observers/getSubChannels.ts"],"names":[],"mappings":"AA4BA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,WACjB,MAAM,wBAAwB,YAC5B,MAAM,sBAAsB,CAAC,MAAM,UAAU,CAAC,WAC/C,MAAM,oBAAoB,eAqHpC,CAAC"}
+{"version":3,"file":"getSubChannels.d.ts","sourceRoot":"","sources":["../../../src/subChannelRepository/observers/getSubChannels.ts"],"names":[],"mappings":"AA4BA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,WACjB,MAAM,wBAAwB,YAC5B,MAAM,sBAAsB,CAAC,MAAM,UAAU,CAAC,WAC/C,MAAM,oBAAoB,eAsHpC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "6.10.0",
+  "version": "6.10.1-50f2392.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/events.ts

@@ -152,6 +152,8 @@ declare global {
 
     type LocalEvents = {
       'local.channel.updated': MakeRequired<Amity.ProcessedChannelPayload, 'channels'>;
+      'local.channel-moderator.role-added': Amity.ProcessedChannelPayload;
+      'local.channel-moderator.role-removed': Amity.ProcessedChannelPayload;
       'local.message.created': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
       'local.message.updated': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
       'local.message.deleted': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;

package/src/@types/core/query.ts

@@ -47,12 +47,12 @@ declare global {
 
     type Snapshot<T> = (T extends Amity.Cached<infer T2>
       ? T2 extends Amity.Paged<infer T3, infer T4>
-        ? { data: T3[] | undefined } & Amity.Pages<T4> & {
+        ? { data: T3[] | undefined } & Amity.Pages<T4> & { paging?: Amity.Pagination['paging'] } & {
               cachedAt?: Amity.CacheOptions['cachedAt'];
             }
         : { data: T2 } & { cachedAt?: Amity.CacheOptions['cachedAt'] }
       : T extends Amity.Paged<infer T3, infer T4>
-      ? { data: T3[] | undefined } & Amity.Pages<T4>
+      ? { data: T3[] | undefined } & Amity.Pages<T4> & { paging?: Amity.Pagination['paging'] }
       : { data: T | undefined }) &
       SnapshotOptions;
 

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

@@ -11,7 +11,9 @@ declare global {
       | 'onMemberAdded'
       | 'onMemberRemoved'
       | 'onChannelMemberBanned'
-      | 'onChannelMemberUnbanned';
+      | 'onChannelMemberUnbanned'
+      | 'onChannelMemberRoleAdded'
+      | 'onChannelMemberRoleRemoved';
 
     type ChannelActionType =
       | 'onFetch'

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

@@ -39,13 +39,14 @@ declare global {
       excludeDefaultSubChannel?: boolean;
       includeDeleted?: boolean;
       page?: Amity.Page;
+      pageToken?: string;
     };
 
     type SubChannelLiveCollection = Amity.LiveCollectionParams<Omit<QuerySubChannels, 'page'>>;
 
     type SubChannelLiveCollectionCache = Amity.LiveCollectionCache<
       Amity.SubChannel,
-      Pick<QuerySubChannels, 'page'>
+      Pick<QuerySubChannels, 'page'> & { paging?: Amity.Pagination['paging'] }
     >;
   }
 }

package/src/channelRepsitory/channelMembership/observers/getMembers.ts

@@ -22,6 +22,8 @@ import {
   onChannelMemberAdded,
   onChannelMemberBanned,
   onChannelMemberRemoved,
+  onChannelMemberRoleAdded,
+  onChannelMemberRoleRemoved,
   onChannelMemberUnbanned,
 } from '../../events';
 import { queryChannelMembers } from '../api/queryChannelMembers';
@@ -206,6 +208,8 @@ export const getMembers = (
     onChannelMemberRemoved(realtimeRouter('onMemberRemoved')),
     onChannelMemberBanned(realtimeRouter('onChannelMemberBanned')),
     onChannelMemberUnbanned(realtimeRouter('onChannelMemberUnbanned')),
+    onChannelMemberRoleAdded(realtimeRouter('onChannelMemberRoleAdded')),
+    onChannelMemberRoleRemoved(realtimeRouter('onChannelMemberRoleRemoved')),
   );
 
   onFetch(true);

package/src/channelRepsitory/channelModeration/api/addRole.ts

@@ -3,6 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../../utils';
+import { fireEvent } from '~/core/events';
 
 /* begin_public_function
   id: channel.moderation.add_roles
@@ -40,6 +41,8 @@ export const addRole = async (
 
   if (client.cache) ingestInCache(data);
 
+  fireEvent('local.channel-moderator.role-added', data);
+
   const { channelUsers } = data;
   return !!channelUsers.find(
     channelUser => channelUser.channelId === channelId && channelUser.roles.includes(roleId),

package/src/channelRepsitory/channelModeration/api/removeRole.ts

@@ -3,6 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareChannelPayload } from '../../utils';
+import { fireEvent } from '~/core/events';
 
 /* begin_public_function
   id: channel.moderation.remove_roles
@@ -40,6 +41,8 @@ export const removeRole = async (
 
   if (client.cache) ingestInCache(data);
 
+  fireEvent('local.channel-moderator.role-removed', data);
+
   const { channelUsers } = data;
   return !!channelUsers.find(
     channelUser => channelUser.channelId === channelId && !channelUser.roles.includes(roleId),

package/src/channelRepsitory/events/index.ts

@@ -11,3 +11,6 @@ export * from './onChannelMemberRemoved';
 
 export * from './onChannelMemberBanned';
 export * from './onChannelMemberUnbanned';
+
+export * from './onChannelMemberRoleAdded';
+export * from './onChannelMemberRoleRemoved';

package/src/channelRepsitory/events/onChannelMemberRoleAdded.ts

@@ -0,0 +1,35 @@
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+
+/**
+ * ```js
+ * import { onChannelMemberRoleAdded } from '@amityco/ts-sdk'
+ * const dispose = onChannelMemberRoleAdded((channel, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when any {@link Amity.channelUsers} 's role has been added to any {@link Amity.Channel}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Channel Events
+ */
+export const onChannelMemberRoleAdded = (
+  callback: (channel: Amity.Channel, member: Amity.Membership<'channel'>) => void,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = async (payload: Amity.ProcessedChannelPayload) => {
+    const { channels, channelUsers } = payload;
+    callback(channels[0], channelUsers.find(channelUser => channelUser.membership === 'member')!);
+  };
+
+  return createEventSubscriber(
+    client,
+    'onChannelMemberRoleAdded',
+    'local.channel-moderator.role-added',
+    filter,
+  );
+};

package/src/channelRepsitory/events/onChannelMemberRoleRemoved.ts

@@ -0,0 +1,41 @@
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+
+import { prepareChannelPayload } from '../utils';
+
+/**
+ * ```js
+ * import { onChannelMemberRoleRemoved } from '@amityco/ts-sdk'
+ * const dispose = onChannelMemberRoleRemoved((channel, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when any {@link Amity.channelUsers} 's role has been deleted to any {@link Amity.Channel}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Channel Events
+ */
+export const onChannelMemberRoleRemoved = (
+  callback: (channel: Amity.Channel, member: Amity.Membership<'channel'>) => void,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = async (payload: Amity.ChannelMembershipPayload) => {
+    const preparedPayload = await prepareChannelPayload(payload);
+    const { channels, channelUsers } = preparedPayload;
+
+    ingestInCache(preparedPayload);
+    callback(channels[0], channelUsers.find(channelUser => channelUser.membership === 'member')!);
+  };
+
+  return createEventSubscriber(
+    client,
+    'onChannelMemberRoleRemoved',
+    'local.channel-moderator.role-removed',
+    filter,
+  );
+};

package/src/commentRepository/api/isCommentFlaggedByMe.ts

@@ -1,5 +1,4 @@
 import { getActiveClient } from '~/client/api/activeClient';
-import { synchronousWSCall } from '~/core/transports';
 
 /* begin_public_function
   id: comment.check_flag_by_me
@@ -22,14 +21,10 @@ export const isCommentFlaggedByMe = async (
   const client = getActiveClient();
   client.log('comment/isCommentFlaggedByMe', commentId);
 
-  const { result, isFlagByMe } =
-    (await synchronousWSCall<{
-      result?: boolean;
-      isFlagByMe?: boolean;
-    }>(client, 'v3/comment.isflagbyme', {
-      commentId,
-    })) ?? {};
+  const {
+    data: { result },
+  } = await client.http.get(`/api/v3/comments/${commentId}/isflagbyme`);
 
-  return result ?? isFlagByMe ?? false;
+  return result;
 };
 /* end_public_function */

package/src/commentRepository/api/queryComments.ts

@@ -30,7 +30,7 @@ export const queryComments = async (
   const { page = { limit: 10 }, includeDeleted, ...params } = query;
 
   const options = {
-    type: params.sortBy ? 'pagination' : undefined,
+    type: params.sortBy || query.page?.limit ? 'pagination' : undefined,
     token: toToken(page, params.sortBy ? 'skiplimit' : 'afterbefore'),
   };
   // const filterByParentId = query.parentId !== undefined

package/src/commentRepository/observers/getComments.ts

@@ -146,7 +146,7 @@ export const getComments = (
       query,
       ({ data: result, error, loading, prevPage, nextPage }) => {
         // depend on sortBy value we have two different pagination type
-        const page = queryParams.sortBy ? nextPage : prevPage;
+        const page = queryParams.sortBy || params?.limit ? nextPage : prevPage;
 
         const data = {
           loading,

package/src/core/query/paging.ts

@@ -42,7 +42,9 @@ export const isAfterBeforeRaw = (
  *
  * @hidden
  */
-export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged<T, any> => {
+export const isPaged = <T extends unknown>(
+  payload: any,
+): payload is Amity.Paged<T, any> & { paging?: Amity.Pagination['paging'] } => {
   return (
     payload?.hasOwnProperty('data') &&
     payload?.hasOwnProperty('nextPage') &&

package/src/subChannelRepository/api/querySubChannels.ts

@@ -24,11 +24,17 @@ import { convertQueryParams, prepareSubChannelPayload } from '../utils';
  */
 export const querySubChannels = async (
   query: Amity.QuerySubChannels,
-): Promise<Amity.Cached<Amity.Paged<Amity.SubChannel>>> => {
+): Promise<Amity.Cached<Amity.Paged<Amity.SubChannel>> & Amity.Pagination> => {
   const client = getActiveClient();
   client.log('channel/querySubChannels', query);
 
-  const { page = { limit: 10 }, channelId, includeDeleted, ...params } = convertQueryParams(query);
+  const {
+    page = { limit: 10 },
+    channelId,
+    includeDeleted,
+    pageToken,
+    ...params
+  } = convertQueryParams(query);
 
   const response = await client.http.get<Amity.SubChannelPayload & Amity.Pagination>(
     `/api/v5/message-feeds/channel/${channelId}`,
@@ -37,7 +43,7 @@ export const querySubChannels = async (
         ...params,
         isDeleted: inferIsDeleted(includeDeleted),
         options: {
-          token: toToken(page, 'afterbefore'),
+          token: pageToken || toToken(page, 'afterbefore'),
         },
       },
     },
@@ -64,7 +70,13 @@ export const querySubChannels = async (
   const nextPage = toPage(paging.next);
   const prevPage = toPage(paging.previous);
 
-  return { data: subChannels, cachedAt, prevPage, nextPage };
+  return {
+    data: subChannels,
+    cachedAt,
+    prevPage,
+    nextPage,
+    paging,
+  };
 };
 /* end_public_function */
 
@@ -83,7 +95,7 @@ export const querySubChannels = async (
  */
 querySubChannels.locally = (
   query: Parameters<typeof querySubChannels>[0],
-): Amity.Cached<Amity.Paged<Amity.SubChannel>> | undefined => {
+): Amity.Cached<Amity.Paged<Amity.SubChannel> & Amity.Pagination> | undefined => {
   const client = getActiveClient();
   client.log('channel/querySubChannels.locally', query);
 
@@ -114,6 +126,6 @@ querySubChannels.locally = (
   const nextPage = toPage(data?.paging.next);
 
   return subChannels.length === data?.subChannels?.length
-    ? { data: subChannels, cachedAt, prevPage, nextPage }
+    ? { data: subChannels, cachedAt, prevPage, nextPage, paging: data?.paging }
     : undefined;
 };

package/src/subChannelRepository/observers/getSubChannels.ts

@@ -76,7 +76,7 @@ export const getSubChannels = (
     callback({
       onNextPage: onFetch,
       data: subChannels,
-      hasNextPage: !!data.params?.page,
+      hasNextPage: !!data.params?.paging?.next,
       loading: data.loading,
       error: data.error,
     });
@@ -107,22 +107,23 @@ export const getSubChannels = (
   const onFetch = () => {
     const subChannels = snapshot ? snapshot.data : [];
 
-    if (subChannels.length > 0 && !snapshot?.params.page) {
+    if (subChannels.length > 0 && !snapshot?.params?.paging?.next) {
       return;
     }
 
     const query = createQuery(querySubChannels, {
       ...queryParams,
       page: snapshot?.params.page ? { ...snapshot?.params.page, limit } : { limit },
+      pageToken: snapshot?.params?.paging?.next,
     });
 
     runQuery(
       query,
-      ({ data: result, error, loading, nextPage: page }) => {
+      ({ data: result, error, loading, nextPage: page, paging }) => {
         snapshot = {
           loading,
           error,
-          params: { page },
+          params: { page, paging },
           data: result ? merge(subChannels, result.map(convertGetterPropsToStatic)) : subChannels,
         };