@amityco/ts-sdk-react-native/src/@types/domains/client.ts

Amity Social Cloud Typescript SDK

import { AxiosInstance } from 'axios';
import { Emitter } from 'mitt';

export const enum MembershipAcceptanceTypeEnum {
  AUTOMATIC = 'automatic',
  INVITATION = 'invitation',
}

declare global {
  namespace Amity {
    type Logger = (topic: string, ...args: any[]) => void;

    type MembershipAcceptanceType = MembershipAcceptanceTypeEnum;

    const enum TokenTerminationReason {
      GLOBAL_BAN = 'globalBan',
      USER_DELETED = 'userDeleted',
      UNAUTHORIZED = 'unauthorized',
    }

    const enum SessionStates {
      NOT_LOGGED_IN = 'notLoggedIn',

      ESTABLISHING = 'establishing',
      ESTABLISHED = 'established',

      TOKEN_EXPIRED = 'tokenExpired',
      /*
       * Terminated is slightly different from NOT_LOGGED_IN:
       *
       * After established, upon receiving the termination code, the SDK will move to terminated.
       * Unlike tokenExpired that users can regain SDK usability by giving an auth token.
       * This state represents unrecoverable failures. The app must manually re-login with a valid user.
       *
       * For more details, please check tech spec:
       * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#terminated
       */
      TERMINATED = 'terminated',
    }

    const enum RTEConnectionStateEnum {
      CONNECTING = 'connecting', // actively establishing a connection (initial or reconnection)
      CONNECTED = 'connected', // connected to broker
      RECONNECTING = 'reconnecting', // lost connection and attempting to reconnect
      DISCONNECTED = 'disconnected', // disconnected (not currently connected, and not automatically reconnecting)
      DISCONNECTING = 'disconnecting', // disconnected (not currently connected, and not automatically reconnecting)
    }

    type RTEConnectionState = `${Amity.RTEConnectionStateEnum}`;

    type Client = {
      version: string;

      log: Logger;
      http: AxiosInstance;
      upload: AxiosInstance;
      mqtt?: Amity.MqttClient;
      emitter: Emitter<Amity.Events>;

      hasPermission: (permission: string) => Amity.PermissionChecker;
      validateUrls: (urls: string[]) => Promise<boolean>;
      validateTexts: (texts: string[]) => Promise<boolean>;

      sessionState: Amity.SessionStates;
      sessionHandler?: Amity.SessionHandler;

      cache?: Amity.Cache;

      apiKey?: string;
      userId?: string;

      token?: Amity.Tokens;

      isUnreadCountEnabled: boolean;

      useLegacyUnreadCount: boolean;

      use: () => void;

      accessTokenExpiryWatcher: (sessionHandler: Amity.SessionHandler) => Amity.Unsubscriber;

      onRTEConnectionStateChange: (
        callback: (state: Amity.RTEConnectionState) => void,
      ) => (() => void) | undefined;

      getFeedSettings: () => Promise<Amity.FeedSettings>;
      getSocialSettings: () => Promise<Amity.SocialSettings>;
      getMessagePreviewSetting: (refresh?: boolean) => Promise<Amity.MessagePreviewSetting>;

      getMarkerSyncConsistentMode: () => boolean;

      prefixDeviceIdKey?: string;
    };

    type Device = {
      deviceId: string;
      deviceInfo: {
        kind: 'node' | 'web';
        model?: string;
        sdkVersion: string;
      };
    };

    type Tokens = {
      accessToken: string;
      // issuedAt, expiresAt is in iso Date format
      issuedAt: string;
      expiresAt: string;
    };

    type AccessTokenRenewal = {
      renew: () => void;
      renewWithAuthToken: (authToken: string) => void;
      unableToRetrieveAuthToken: () => void;
    };

    interface SessionHandler {
      sessionWillRenewAccessToken(renewal: AccessTokenRenewal): void;
    }

    type ChatSettings = {
      enabled: boolean;
      mention: {
        isAllowMentionedChannelEnabled: boolean;
      };
      messagePreview: {
        enabled: boolean;
        isIncludeDeleted: boolean;
      };
    };

    type ShareableLinkConfiguration = {
      domain: string;
      patterns: Record<string, string>;
    };

    type FeedSettings = {
      [name in Amity.ContentFeedType]?: Amity.ContentSetting[];
    };

    type SocialSettings = {
      enabled: boolean;
      isAllowEditPostWhenReviewingEnabled: boolean;
      isFollowWithRequestEnabled: boolean;
      globalFeed: {
        showCommunityPost: boolean;
        showEveryonePost: boolean;
        showFollowingPost: boolean;
        showMyPost: boolean;
        showOnlyMyFeed: boolean;
      };
      story: {
        allowAllUserToCreateStory: boolean;
        expiryTimeMinutes: number;
      };
      userPrivacySetting: 'public' | 'private';
      membershipAcceptance: Amity.MembershipAcceptanceType;
    };

    type ConnectClientParams = {
      userId: Amity.InternalUser['userId'];
      displayName?: Amity.InternalUser['displayName'];
      authToken?: string;
      deviceId?: Amity.Device['deviceId'];
    };

    type ConnectClientConfig = {
      disableRTE: boolean;
    };

    type ActiveUser = Pick<Amity.InternalUser, '_id' | 'userId' | 'path' | 'displayName'>;

    type UserUnread = Pick<Amity.UserMarker, 'unreadCount'> & {
      isMentioned: boolean;
    };
  }
}