@amityco/ts-sdk 7.9.3-3043b851.0 → 7.9.3-9d4caef6.0

package/dist/utils/linkedObject/channelLinkedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"channelLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/channelLinkedObject.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,mBAAmB,YAAa,MAAM,eAAe,KAAG,MAAM,OAyB1E,CAAC"}
+{"version":3,"file":"channelLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/channelLinkedObject.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,mBAAmB,YAAa,MAAM,eAAe,KAAG,MAAM,OAmC1E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.9.3-3043b851.0",
+  "version": "7.9.3-9d4caef6.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/domains/channel.ts

@@ -103,6 +103,10 @@ declare global {
       myMembership: (
         callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>,
       ) => Amity.Unsubscriber;
+      getMembership: (
+        userId: Amity.User['userId'],
+        callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>,
+      ) => Amity.Unsubscriber;
     };
 
     type QueryChannels = {

package/src/channelRepository/api/unmuteChannel.ts

@@ -3,7 +3,6 @@ import { getActiveClient } from '~/client/api';
 /* begin_public_function
   id: channel.unmute
 */
-const CHANNEL_UNMUTE_PERIOD = 0;
 /**
  * ```js
  * import { ChannelRepository } from '@amityco/ts-sdk'
@@ -18,15 +17,14 @@ const CHANNEL_UNMUTE_PERIOD = 0;
  * @category Channel API
  * @async
  */
+const CHANNEL_UNMUTE_PERIOD = 0; // Setting mute period as 0 is the same as unmuting the channel
+
 export const unmuteChannel = async (channelId: Amity.Channel['channelId']): Promise<boolean> => {
   const client = getActiveClient();
   client.log('channel/unmuteChannel', channelId);
 
   const { data } = await client.http.put<{ success: boolean }>(
     `/api/v2/channel/${encodeURIComponent(channelId)}/mute`,
-    /*
-     * Setting mute period as 0 is the same as unmuting the channel
-     */
     { mutePeriod: CHANNEL_UNMUTE_PERIOD },
   );
 

package/src/channelRepository/internalApi/getMembership.ts

@@ -0,0 +1,45 @@
+import { ASCApiError } from '~/core/errors';
+import { pullFromCache } from '~/cache/api/pullFromCache';
+import { getActiveClient } from '~/client/api/activeClient';
+
+/**
+ *
+ * get membership of user in a channel from cache
+ *
+ * @returns the {@link Amity.Membership<'channel'>} objects
+ *
+ * @category Channel API
+ * @async
+ */
+
+type GetMembershipParams = {
+  channelId: string;
+  userId: Amity.User['userId'];
+};
+
+export const getMembership = ({
+  channelId,
+  userId,
+}: GetMembershipParams): Amity.Cached<Amity.Membership<'channel'>> => {
+  const client = getActiveClient();
+  client.log('channel/getMembership.locally');
+
+  const cacheChannelUser = pullFromCache<Amity.Membership<'channel'>>([
+    'channelUsers',
+    'get',
+    `${channelId}#${userId}`,
+  ]);
+
+  if (!cacheChannelUser) {
+    throw new ASCApiError(
+      'Item not found!',
+      Amity.ServerError.ITEM_NOT_FOUND,
+      Amity.ErrorLevel.ERROR,
+    );
+  }
+
+  return {
+    data: cacheChannelUser.data,
+    cachedAt: cacheChannelUser.cachedAt,
+  };
+};

package/src/channelRepository/observers/getMembership.ts

@@ -0,0 +1,89 @@
+import { getMembership as _getMembership } from '../internalApi/getMembership';
+import { ASCApiError } from '~/core/errors';
+import { getActiveClient } from '~/client/api/activeClient';
+import { isEqual } from '~/utils/isEqual';
+import { createQuery, runQuery } from '~/core/query';
+import {
+  UNSYNCED_OBJECT_CACHED_AT_MESSAGE,
+  UNSYNCED_OBJECT_CACHED_AT_VALUE,
+} from '~/utils/constants';
+import { channelMemberLinkedObject } from '~/utils/linkedObject/channelMemberLinkedObject';
+import { onChannelMemberBanned, onChannelMemberUnbanned } from '../events';
+import { onChannelSetUserMuted } from '../events/onChannelSetUserMuted';
+
+type GetMembership = {
+  channelId: string;
+  userId: Amity.User['userId'];
+  callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>;
+};
+
+export const getMembership = ({
+  channelId,
+  userId,
+  callback,
+}: GetMembership): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log('This observable object need the cache data!');
+  }
+
+  const timestamp = Date.now();
+  log(`liveMembership(tmpid: ${timestamp}) > listen`);
+
+  const disposers: Amity.Unsubscriber[] = [];
+
+  let isUnsyncedModel = false;
+
+  let model: Amity.Membership<'channel'> | undefined;
+
+  const dispatcher = (data: Amity.LiveObject<Amity.Membership<'channel'> | undefined>) => {
+    callback({ ...data, data: data.data ? channelMemberLinkedObject(data.data) : data.data });
+  };
+
+  const realtimeRouter = (_: Amity.StaticInternalChannel, __: Amity.RawMembership<'channel'>) => {
+    const { data } = _getMembership({ channelId, userId });
+
+    if (isEqual(model, data)) return;
+
+    dispatcher({ loading: false, data });
+  };
+
+  const onFetch = () => {
+    const query = createQuery(async () => _getMembership({ channelId, userId }));
+
+    runQuery(query, ({ error, data, loading, origin, cachedAt }) => {
+      if (cachedAt === UNSYNCED_OBJECT_CACHED_AT_VALUE) {
+        dispatcher({
+          data,
+          origin,
+          loading: false,
+          error: new ASCApiError(
+            UNSYNCED_OBJECT_CACHED_AT_MESSAGE,
+            Amity.ClientError.DISALOOW_UNSYNCED_OBJECT,
+            Amity.ErrorLevel.ERROR,
+          ),
+        });
+
+        isUnsyncedModel = true;
+        disposers.forEach(fn => fn());
+      } else if (!isUnsyncedModel) {
+        dispatcher({ loading, data, origin, error });
+      }
+
+      if (error) {
+        disposers.forEach(fn => fn());
+      }
+    });
+  };
+
+  disposers.push(onChannelMemberBanned(realtimeRouter));
+  disposers.push(onChannelMemberUnbanned(realtimeRouter));
+  disposers.push(onChannelSetUserMuted(realtimeRouter));
+
+  onFetch();
+
+  return () => {
+    disposers.forEach(fn => fn());
+  };
+};

package/src/client/api/loginAsBot.ts

@@ -14,7 +14,6 @@ import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
 
 import SessionWatcher from '../utils/SessionWatcher';
 import { setBotClientToken } from '../utils/setBotClientToken';
-import { setCurrentUserType } from './getCurrentUserType';
 import { setCurrentUser } from '../utils/setCurrentUser';
 
 /*

package/src/client/api/loginAsVisitor.ts

@@ -6,7 +6,6 @@ import { logout } from './logout';
 
 import { getActiveClient } from './activeClient';
 import { terminateClient } from './terminateClient';
-import { setActiveUser } from './activeUser';
 
 import { onTokenExpired } from '../events/onTokenExpired';
 import { onTokenTerminated } from '../events/onTokenTerminated';
@@ -14,7 +13,6 @@ import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
 
 import SessionWatcher from '../utils/SessionWatcher';
 import { setVisitorClientToken } from '../utils/setVisitorClientToken';
-import { setCurrentUserType } from './getCurrentUserType';
 import { setCurrentUser } from '../utils/setCurrentUser';
 
 /*

package/src/client/utils/setVisitorClientToken.ts

@@ -1,6 +1,5 @@
 import { getActiveClient } from '../api/activeClient';
 import { setSessionState } from '../api/setSessionState';
-import { getToken } from '../api/getToken';
 import { getVisitorToken } from '../api/getVisitorToken';
 
 /**

package/src/utils/linkedObject/channelLinkedObject.ts

@@ -3,6 +3,7 @@ import { shallowClone } from '../shallowClone';
 import { queryCache } from '~/cache/api';
 import { channelMemberLinkedObject } from './channelMemberLinkedObject';
 import { getMyMembership } from '~/channelRepository/observers/getMyMembership';
+import { getMembership } from '~/channelRepository/observers/getMembership';
 
 export const channelLinkedObject = (channel: Amity.InternalChannel): Amity.Channel => {
   let previewMembers: Amity.Membership<'channel'>[] = [];
@@ -28,5 +29,15 @@ export const channelLinkedObject = (channel: Amity.InternalChannel): Amity.Chann
     previewMembers,
     myMembership: (callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>) =>
       getMyMembership(channel.channelId, callback),
+    getMembership: (
+      userId: Amity.User['userId'],
+      callback: Amity.LiveObjectCallback<Amity.Membership<'channel'> | undefined>,
+    ) => {
+      getMembership({
+        channelId: channel.channelId,
+        userId,
+        callback,
+      });
+    },
   });
 };