@amityco/ts-sdk 7.1.1-dbdbe662.0 → 7.1.1-e23f973a.0

package/dist/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine.d.ts

@@ -1,33 +0,0 @@
-export declare class LegacyMessageReadReceiptSyncEngine {
-    private client;
-    private isActive;
-    private MAX_RETRY;
-    private JOB_QUEUE_SIZE;
-    private jobQueue;
-    private timer;
-    private RECEIPT_SYNC_INTERVAL;
-    constructor();
-    startSyncReadReceipt(): void;
-    syncReadReceipts(): void;
-    private getUnsyncJobs;
-    private getReadReceipt;
-    private markReadApi;
-    private removeSynedReceipt;
-    private startObservingReadReceiptQueue;
-    private stopObservingReadReceiptQueue;
-    onSessionEstablished(): void;
-    onSessionDestroyed(): void;
-    onTokenExpired(): void;
-    onNetworkOffline(): void;
-    onNetworkOnline(): void;
-    markRead(subChannelId: string, segment: number): void;
-    private enqueueReadReceipt;
-    private getSyncJob;
-    private enqueueJob;
-    private removeJobFromQueue;
-}
-declare const _default: {
-    getInstance: () => LegacyMessageReadReceiptSyncEngine;
-};
-export default _default;
-//# sourceMappingURL=legacyReadReceiptSyncEngine.d.ts.map

package/dist/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"legacyReadReceiptSyncEngine.d.ts","sourceRoot":"","sources":["../../../../src/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine.ts"],"names":[],"mappings":"AAMA,qBAAa,kCAAkC;IAC7C,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,QAAQ,CAAQ;IAExB,OAAO,CAAC,SAAS,CAAK;IAEtB,OAAO,CAAC,cAAc,CAAO;IAE7B,OAAO,CAAC,QAAQ,CAAwC;IAExD,OAAO,CAAC,KAAK,CAA2B;IAGxC,OAAO,CAAC,qBAAqB,CAAK;;IASlC,oBAAoB;IAQpB,gBAAgB,IAAI,IAAI;IASxB,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,cAAc;YA2BR,WAAW;IA8BzB,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,8BAA8B;IAOtC,OAAO,CAAC,6BAA6B;IAgBrC,oBAAoB,IAAI,IAAI;IAI5B,kBAAkB,IAAI,IAAI;IAK1B,cAAc,IAAI,IAAI;IAKtB,gBAAgB,IAAI,IAAI;IAKxB,eAAe,IAAI,IAAI;IAKvB,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAoBrD,OAAO,CAAC,kBAAkB;IAsC1B,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,kBAAkB;CAM3B;;;;AAID,wBAME"}

package/dist/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler.d.ts

@@ -1,3 +0,0 @@
-declare const _default: () => () => void;
-export default _default;
-//# sourceMappingURL=legacyReadReceiptSyncEngineOnLoginHandler.d.ts.map

package/dist/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"legacyReadReceiptSyncEngineOnLoginHandler.d.ts","sourceRoot":"","sources":["../../../../src/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler.ts"],"names":[],"mappings":";AAGA,wBAiBE"}

package/dist/marker/events/onChannelUnreadInfoUpdatedLocal.d.ts

@@ -1,12 +0,0 @@
-/**
- * Internal used only
- *
- * Fired when an {@link Amity.channelUnreadInfo} has been updated.
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category ChannelMarker Events
- */
-export declare const onChannelUnreadInfoUpdatedLocal: (callback: Amity.Listener<Amity.Events['local.channelUnreadInfo.updated']>) => Amity.Unsubscriber;
-//# sourceMappingURL=onChannelUnreadInfoUpdatedLocal.d.ts.map

package/dist/marker/events/onChannelUnreadInfoUpdatedLocal.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"onChannelUnreadInfoUpdatedLocal.d.ts","sourceRoot":"","sources":["../../../src/marker/events/onChannelUnreadInfoUpdatedLocal.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B,aAChC,MAAM,QAAQ,CAAC,MAAM,MAAM,CAAC,iCAAiC,CAAC,CAAC,KACxE,MAAM,YAaR,CAAC"}

package/src/channelRepository/api/markChannelsAsReadBySegment.ts

@@ -1,29 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-
-/**
- *
- * Mark subChannel as read by readToSegment
- *
- * @param subChannelIds the IDs of the {@link Amity.SubChannel} to update
- * @param readToSegment the segment to mark as read
- * @returns a success boolean if the {@link Amity.SubChannel} was updated
- *
- * @category Channel API
- * @async
- */
-
-export const markChannelsAsReadBySegment = async (
-  readings: {
-    channelId: Amity.Channel['channelId'];
-    readToSegment: number;
-  }[],
-): Promise<boolean> => {
-  const client = getActiveClient();
-
-  try {
-    await client.http.post<Amity.MarkAsReadPayload>('api/v3/channels/seen', { channels: readings });
-    return true;
-  } catch (e) {
-    return false;
-  }
-};

package/src/channelRepository/internalApi/getTotalChannelsUnread.ts

@@ -1,38 +0,0 @@
-import { queryCache } from '~/cache/api';
-import { getActiveClient } from '~/client/api/activeClient';
-
-/**
- *
- * Calculate user unread from {@link Amity.ChannelUnread} objects
- *
- * @returns the {@link Amity.UserUnread} objects
- *
- * @category Channel API
- * @async
- */
-
-export const getTotalChannelsUnread = (): Amity.Cached<Amity.UserUnread> => {
-  const client = getActiveClient();
-  client.log('channel/getTotalChannelsUnread.locally');
-
-  const cachedChannelsUnread =
-    queryCache<Amity.ChannelUnread>(['channelUnread', 'get'])?.filter(({ data }) => {
-      return !data.isDeleted;
-    }) || [];
-
-  const totalChannelsUnread: Amity.UserUnread = cachedChannelsUnread?.reduce(
-    (acc, { data }) => {
-      acc.unreadCount += data.unreadCount;
-      acc.isMentioned = acc.isMentioned || data.isMentioned;
-      return acc;
-    },
-    { unreadCount: 0, isMentioned: false as boolean },
-  ) || { unreadCount: 0, isMentioned: false };
-
-  const cachedAt = client.cache && Date.now();
-
-  return {
-    data: totalChannelsUnread,
-    cachedAt,
-  };
-};

package/src/channelRepository/observers/getTotalChannelsUnread.ts

@@ -1,129 +0,0 @@
-import { getActiveUser } from '~/client/api/activeUser';
-import { getTotalChannelsUnread as _getTotalChannelsUnread } from '../internalApi/getTotalChannelsUnread';
-import { onChannelUnreadUpdatedLocal } from '../events/onChannelUnreadUpdatedLocal';
-import { ASCApiError, ASCError } from '~/core/errors';
-import { getActiveClient } from '~/client';
-import { convertGetterPropsToStatic } from '~/utils/object';
-import { createQuery, runQuery } from '~/core/query';
-import {
-  UNSYNCED_OBJECT_CACHED_AT_MESSAGE,
-  UNSYNCED_OBJECT_CACHED_AT_VALUE,
-} from '~/utils/constants';
-import { isEqual } from '~/utils/isEqual';
-
-/* begin_public_function
-  id: totalChannelsUnread.get
-*/
-/**
- * ```js
- * import { ChannelRepository } from '@amityco/ts-sdk';
- *
- * let totalChannelsUnread;
- *
- * const unsubscribe = ChannelRepository.getTotalChannelsUnread(response => {
- *   unread = response.data;
- * });
- * ```
- *
- * Observe all mutation on a given {@link Amity.UserUnread}
- *
- * @returns An {@link Amity.UserUnread} function to run when willing to stop observing the message
- *
- * @category User Unread Live Object
- *
- */
-
-export const getTotalChannelsUnread = (
-  callback: Amity.LiveObjectCallback<Amity.UserUnread | undefined>,
-): Amity.Unsubscriber => {
-  const { _id: userId } = getActiveUser();
-
-  if (!userId)
-    throw new ASCError(
-      'The _id has not been defined in ActiveUser',
-      Amity.ClientError.UNKNOWN_ERROR,
-      Amity.ErrorLevel.ERROR,
-    );
-
-  const { log, cache } = getActiveClient();
-
-  if (!cache) {
-    console.log('For using Live Object feature you need to enable Cache!');
-  }
-
-  const timestamp = Date.now();
-  log(`liveTotalChannelsUnread(tmpid: ${timestamp}) > listen`);
-
-  const disposers: Amity.Unsubscriber[] = [];
-
-  let isUnsyncedModel = false; // for messages
-
-  let model: Amity.UserUnread | undefined;
-
-  const dispatcher = (data: Amity.LiveObject<Amity.UserUnread | undefined>) => {
-    const { data: userUnread } = data;
-
-    const callbackModel = userUnread
-      ? {
-          unreadCount: userUnread.unreadCount,
-          isMentioned: userUnread.isMentioned,
-        }
-      : undefined;
-
-    model = callbackModel ? convertGetterPropsToStatic(callbackModel) : callbackModel;
-
-    callback({
-      data: callbackModel
-        ? { ...callbackModel, isMentioned: callbackModel.isMentioned }
-        : callbackModel,
-
-      loading: data.loading,
-      error: data.error,
-    });
-  };
-
-  const realtimeRouter = (userUnread: Amity.UserUnread) => {
-    if (isEqual(model, userUnread)) return;
-
-    dispatcher({
-      loading: false,
-      data: userUnread,
-    });
-  };
-
-  const onFetch = () => {
-    const query = createQuery(async () => _getTotalChannelsUnread());
-
-    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(onChannelUnreadUpdatedLocal(realtimeRouter));
-
-  onFetch();
-
-  return () => {
-    disposers.forEach(fn => fn());
-  };
-};

package/src/channelRepository/utils/getLegacyChannelUnread.ts

@@ -1,5 +0,0 @@
-import { pullFromCache } from '~/cache/api/pullFromCache';
-
-export const getLegacyChannelUnread = (channelId: string) => {
-  return pullFromCache<Amity.ChannelUnreadInfo>(['channelUnread', 'get', channelId])?.data;
-};

package/src/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine.ts

@@ -1,267 +0,0 @@
-import { pullFromCache, pushToCache, queryCache } from '~/cache/api';
-import { getActiveClient } from '../../api/activeClient';
-import { markAsReadBySegment } from '~/subChannelRepository/api/markAsReadBySegment';
-import { reCalculateChannelUnreadInfo } from '~/marker/utils/reCalculateChannelUnreadInfo';
-import { fireEvent } from '~/core/events';
-
-export class LegacyMessageReadReceiptSyncEngine {
-  private client: Amity.Client;
-
-  private isActive = true;
-
-  private MAX_RETRY = 3;
-
-  private JOB_QUEUE_SIZE = 120;
-
-  private jobQueue: Amity.LegacyReadReceiptSyncJob[] = [];
-
-  private timer: NodeJS.Timer | undefined;
-
-  // Interval for message read receipt sync in seconds
-  private RECEIPT_SYNC_INTERVAL = 1;
-
-  constructor() {
-    this.client = getActiveClient();
-    // Get remaining unsync read receipts from cache
-    this.getUnsyncJobs();
-  }
-
-  //  Call this when client call client.login
-  startSyncReadReceipt() {
-    // Start timer when start receipt sync
-    this.timer = setInterval(() => {
-      this.syncReadReceipts();
-    }, this.RECEIPT_SYNC_INTERVAL * 1000);
-  }
-
-  // Read receipt observer handling
-  syncReadReceipts(): void {
-    if (this.jobQueue.length === 0 || this.isActive === false) return;
-
-    const readReceipt = this.getReadReceipt();
-    if (readReceipt) {
-      this.markReadApi(readReceipt);
-    }
-  }
-
-  private getUnsyncJobs(): void {
-    // Get all read receipts that has latestSyncSegment < latestSegment
-    const readReceipts = queryCache<Amity.LegacyReadReceipt>(['legacyReadReceipt'])?.filter(
-      ({ data }) => {
-        return data.latestSyncSegment < data.latestSegment;
-      },
-    );
-
-    // Enqueue unsync read receipts to the job queue
-    readReceipts?.forEach(({ data: readReceipt }) => {
-      this.enqueueReadReceipt(readReceipt.subChannelId, readReceipt.latestSegment);
-    });
-  }
-
-  private getReadReceipt(): Amity.LegacyReadReceiptSyncJob | undefined {
-    // Get first read receipt in queue
-    const syncJob = this.jobQueue[0];
-
-    if (!syncJob) return;
-    // Skip when it's syncing
-    if (syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) return;
-
-    // Get readReceipt from cache by subChannelId
-    const readReceipt = pullFromCache<Amity.LegacyReadReceipt>([
-      'legacyReadReceipt',
-      syncJob.subChannelId,
-    ])?.data;
-
-    if (!readReceipt) return;
-
-    if (readReceipt?.latestSegment > readReceipt?.latestSyncSegment) {
-      syncJob.segment = readReceipt.latestSegment;
-      return syncJob;
-    }
-    // Clear all synced job in job queue
-    this.removeSynedReceipt(readReceipt.subChannelId, readReceipt.latestSegment);
-
-    // Recursion getReadReceipt() until get unsync read receipt or job queue is empty
-    return this.getReadReceipt();
-  }
-
-  private async markReadApi(syncJob: Amity.LegacyReadReceiptSyncJob): Promise<void> {
-    const newSyncJob = syncJob;
-    newSyncJob.syncState = Amity.ReadReceiptSyncState.SYNCING;
-
-    const { subChannelId, segment } = newSyncJob;
-
-    const response = await markAsReadBySegment({ subChannelId, readToSegment: segment });
-
-    if (response) {
-      this.removeSynedReceipt(syncJob.subChannelId, syncJob.segment);
-
-      const readReceiptCache = pullFromCache<Amity.LegacyReadReceipt>([
-        'legacyReadReceipt',
-        subChannelId,
-      ])?.data;
-
-      pushToCache(['legacyReadReceipt', subChannelId], {
-        ...readReceiptCache,
-        latestSyncSegment: segment,
-      });
-    } else if (!response) {
-      if (newSyncJob.retryCount > this.MAX_RETRY) {
-        this.removeJobFromQueue(newSyncJob);
-      } else {
-        newSyncJob.retryCount += 1;
-        newSyncJob.syncState = Amity.ReadReceiptSyncState.CREATED;
-      }
-    }
-  }
-
-  private removeSynedReceipt(subChannelId: string, segment: number) {
-    const syncJobs = this.jobQueue;
-
-    syncJobs.forEach(job => {
-      if (job.subChannelId === subChannelId && job.segment <= segment) {
-        this.removeJobFromQueue(job);
-      }
-    });
-  }
-
-  private startObservingReadReceiptQueue(): void {
-    if (this.client.isUnreadCountEnabled) {
-      this.isActive = true;
-      this.startSyncReadReceipt();
-    }
-  }
-
-  private stopObservingReadReceiptQueue(): void {
-    this.isActive = false;
-
-    const syncJobs = this.jobQueue;
-    syncJobs.map(job => {
-      if (job.syncState === Amity.ReadReceiptSyncState.SYNCING) {
-        return { ...job, syncState: Amity.ReadReceiptSyncState.CREATED };
-      }
-
-      return job;
-    });
-
-    if (this.timer) clearInterval(this.timer);
-  }
-
-  // Session Management
-  onSessionEstablished(): void {
-    this.startObservingReadReceiptQueue();
-  }
-
-  onSessionDestroyed(): void {
-    this.stopObservingReadReceiptQueue();
-    this.jobQueue = [];
-  }
-
-  onTokenExpired(): void {
-    this.stopObservingReadReceiptQueue();
-  }
-
-  // Network Connection Management
-  onNetworkOffline(): void {
-    // Stop observing to the read receipt queue.
-    this.stopObservingReadReceiptQueue();
-  }
-
-  onNetworkOnline(): void {
-    // Resume observing to the read receipt queue.
-    this.startObservingReadReceiptQueue();
-  }
-
-  markRead(subChannelId: string, segment: number): void {
-    // Step 1: Optimistic update of subChannelUnreadInfo.readToSegment to message.segment
-    const cacheKey = ['subChannelUnreadInfo', 'get', subChannelId];
-    const subChannelUnreadInfo = pullFromCache<Amity.SubChannelUnreadInfo>(cacheKey)?.data;
-
-    if (subChannelUnreadInfo && segment > subChannelUnreadInfo.readToSegment) {
-      subChannelUnreadInfo.readToSegment = segment;
-      subChannelUnreadInfo.unreadCount = Math.max(subChannelUnreadInfo.lastSegment - segment, 0);
-
-      const channelUnreadInfo = reCalculateChannelUnreadInfo(subChannelUnreadInfo.channelId);
-      fireEvent('local.channelUnreadInfo.updated', channelUnreadInfo);
-
-      pushToCache(cacheKey, subChannelUnreadInfo);
-      fireEvent('local.subChannelUnread.updated', subChannelUnreadInfo);
-    }
-
-    // Step 2: Enqueue the read receipt
-    this.enqueueReadReceipt(subChannelId, segment);
-  }
-
-  private enqueueReadReceipt(subChannelId: string, segment: number): void {
-    const readReceipt = pullFromCache<Amity.LegacyReadReceipt>([
-      'legacyReadReceipt',
-      subChannelId,
-    ])?.data;
-
-    // Create new read receipt if it's not exists and add job to queue
-    if (!readReceipt) {
-      const readReceiptSubChannel: Amity.LegacyReadReceipt = {
-        subChannelId,
-        latestSegment: segment,
-        latestSyncSegment: 0,
-      };
-
-      pushToCache(['legacyReadReceipt', subChannelId], readReceiptSubChannel);
-    } else if (readReceipt.latestSegment < segment) {
-      pushToCache(['legacyReadReceipt', subChannelId], { ...readReceipt, latestSegment: segment });
-    } else if (readReceipt.latestSyncSegment >= segment) {
-      // Skip the job when lastSyncSegment > = segment
-      return;
-    }
-
-    let syncJob: Amity.LegacyReadReceiptSyncJob | null = this.getSyncJob(subChannelId);
-
-    if (syncJob === null || syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) {
-      syncJob = {
-        subChannelId,
-        segment,
-        syncState: Amity.ReadReceiptSyncState.CREATED,
-        retryCount: 0,
-      };
-
-      this.enqueueJob(syncJob);
-    } else if (syncJob.segment < segment) {
-      syncJob.segment = segment;
-    }
-  }
-
-  private getSyncJob(subChannelId: string): Amity.LegacyReadReceiptSyncJob | null {
-    const syncJobs = this.jobQueue;
-
-    const targetJob = syncJobs.find(job => job.subChannelId === subChannelId);
-
-    return targetJob || null;
-  }
-
-  private enqueueJob(syncJob: Amity.LegacyReadReceiptSyncJob) {
-    if (this.jobQueue.length < this.JOB_QUEUE_SIZE) {
-      this.jobQueue.push(syncJob);
-    } else {
-      // Remove oldest job when queue reach maximum capacity
-      this.jobQueue.shift();
-      this.jobQueue.push(syncJob);
-    }
-  }
-
-  private removeJobFromQueue(item: Amity.LegacyReadReceiptSyncJob) {
-    const index = this.jobQueue.indexOf(item);
-    if (index > -1) {
-      this.jobQueue.splice(index, 1);
-    }
-  }
-}
-
-let instance: LegacyMessageReadReceiptSyncEngine | null = null;
-
-export default {
-  getInstance: () => {
-    if (!instance) instance = new LegacyMessageReadReceiptSyncEngine();
-
-    return instance;
-  },
-};

package/src/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler.ts

@@ -1,21 +0,0 @@
-import { onSessionStateChange } from '~/client/events/onSessionStateChange';
-import LegacyReadReceiptSyncEngine from '~/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine';
-
-export default () => {
-  const readReceiptSyncEngine = LegacyReadReceiptSyncEngine.getInstance();
-  readReceiptSyncEngine.startSyncReadReceipt();
-
-  onSessionStateChange(state => {
-    if (state === Amity.SessionStates.ESTABLISHED) {
-      readReceiptSyncEngine.onSessionEstablished();
-    } else if (state === Amity.SessionStates.TOKEN_EXPIRED) {
-      readReceiptSyncEngine.onTokenExpired();
-    } else {
-      readReceiptSyncEngine.onSessionDestroyed();
-    }
-  });
-
-  return () => {
-    readReceiptSyncEngine.onSessionDestroyed();
-  };
-};

package/src/marker/events/onChannelUnreadInfoUpdatedLocal.ts

@@ -1,29 +0,0 @@
-import { getActiveClient } from '~/client/api/activeClient';
-import { createEventSubscriber } from '~/core/events';
-
-/**
- * Internal used only
- *
- * Fired when an {@link Amity.channelUnreadInfo} has been updated.
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category ChannelMarker Events
- */
-export const onChannelUnreadInfoUpdatedLocal = (
-  callback: Amity.Listener<Amity.Events['local.channelUnreadInfo.updated']>,
-): Amity.Unsubscriber => {
-  const client = getActiveClient();
-
-  const filter = (payload: Amity.Events['local.channelUnreadInfo.updated']) => {
-    callback(payload);
-  };
-
-  return createEventSubscriber(
-    client,
-    'channelMarker/onChannelUnreadInfoUpdatedLocal',
-    'local.channelUnreadInfo.updated',
-    filter,
-  );
-};