@atlaskit/collab-provider 20.0.15 → 20.0.17

package/dist/types-ts4.5/helpers/const.d.ts

@@ -1,324 +0,0 @@
-import type { ProviderError } from '@atlaskit/editor-common/collab';
-export declare enum EVENT_ACTION {
-    CONNECTION = "connection",// https://data-portal.internal.atlassian.com/analytics/registry/43970
-    CATCHUP = "catchup",// https://data-portal.internal.atlassian.com/analytics/registry/44016
-    DOCUMENT_INIT = "documentInit",// https://data-portal.internal.atlassian.com/analytics/registry/43971
-    ADD_STEPS = "addSteps",// https://data-portal.internal.atlassian.com/analytics/registry/43972
-    UPDATE_PARTICIPANTS = "updateParticipants",// https://data-portal.internal.atlassian.com/analytics/registry/45634
-    UPDATE_DOCUMENT = "updateDocument",// https://data-portal.internal.atlassian.com/analytics/registry/58213
-    COMMIT_UNCONFIRMED_STEPS = "commitUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/46501
-    REINITIALISE_DOCUMENT = "reinitialiseDocument",// https://data-portal.internal.atlassian.com/analytics/registry/50231
-    ERROR = "error",// https://data-portal.internal.atlassian.com/analytics/registry/51790
-    PUBLISH_PAGE = "publishPage",// https://data-portal.internal.atlassian.com/analytics/registry/50235
-    GET_CURRENT_STATE = "getCurrentState",// https://data-portal.internal.atlassian.com/analytics/registry/50783
-    INVALIDATE_TOKEN = "invalidateToken",// https://data-portal.internal.atlassian.com/analytics/registry/50444
-    SEND_STEPS_RETRY = "sendStepsRetry",// https://data-portal.internal.atlassian.com/analytics/registry/53598
-    CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",// https://data-portal.internal.atlassian.com/analytics/registry/53723
-    DROPPED_STEPS = "droppedStepInCatchup",// https://data-portal.internal.atlassian.com/analytics/registry/53724
-    WEBSOCKET_MESSAGE_VOLUME_METRIC = "websocketMessageVolumeMetric",// https://data-portal.internal.atlassian.com/analytics/registry/53596
-    PROVIDER_INITIALIZED = "providerInitialized",// https://data-portal.internal.atlassian.com/analytics/registry/54714
-    RECONNECTION = "providerReconnection",// https://data-portal.internal.atlassian.com/analytics/registry/73992
-    PROVIDER_SETUP = "providerSetup",// https://data-portal.internal.atlassian.com/analytics/registry/54715
-    HAS_UNCONFIRMED_STEPS = "hasUnconfirmedSteps",// https://data-portal.internal.atlassian.com/analytics/registry/56141
-    OUT_OF_SYNC = "outOfSync",// https://data-portal.internal.atlassian.com/analytics/registry/74993
-    STEPS_REBASED = "stepsRebased",// https://data-portal.internal.atlassian.com/analytics/registry/76616
-    POLLING_FALLBACK = "pollingFallback",
-    PROCESS_STEPS = "processSteps"
-}
-export declare enum EVENT_STATUS {
-    SUCCESS = "SUCCESS",
-    FAILURE = "FAILURE",
-    INFO = "INFO",
-    SUCCESS_10x_SAMPLED = "SUCCESS_10x_SAMPLED"
-}
-export declare enum ADD_STEPS_TYPE {
-    ACCEPTED = "ACCEPTED",
-    REJECTED = "REJECTED",
-    ERROR = "ERROR"
-}
-export type DocumentUpdateErrorAttributes = {
-    caller?: string;
-    docHasContent?: boolean;
-    editorVersion?: number;
-    isDocContentValid?: boolean;
-    isDocTruthy?: boolean;
-    newVersion?: number;
-};
-export type CantSyncUpErrorAttributes = {
-    unconfirmedStepsInfo: string;
-};
-export type ErrorAnalyticsEvent = {
-    attributes: {
-        documentAri?: string;
-        errorCode?: string;
-        errorMessage: string;
-        errorName?: string;
-        errorStack?: string;
-        errorStatus?: string;
-        mappedError?: ProviderError;
-        originalErrorMessage: string | undefined;
-        subProduct?: string;
-    } & DocumentUpdateErrorAttributes;
-    eventAction: EVENT_ACTION.ERROR;
-    nonPrivacySafeAttributes?: {
-        error: unknown;
-    };
-};
-export type BaseActionAnalyticsEventAttributes = {
-    documentAri?: string;
-    subProduct?: string;
-};
-type InvalidateTokenAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        reason?: string;
-        usedCachedToken?: boolean;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.INVALIDATE_TOKEN;
-};
-type AddStepsSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-        stepType?: {
-            [key: string]: number;
-        };
-        type: ADD_STEPS_TYPE.ACCEPTED;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.ADD_STEPS;
-};
-type AddStepsFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-        type: ADD_STEPS_TYPE.REJECTED | ADD_STEPS_TYPE.ERROR;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.ADD_STEPS;
-};
-type ReInitDocFailAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        numUnconfirmedSteps: number;
-        triggeredByCatchup?: boolean;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.REINITIALISE_DOCUMENT;
-};
-type ReInitDocSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        numUnconfirmedSteps: number;
-        triggeredByCatchup?: boolean;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.REINITIALISE_DOCUMENT;
-};
-type ConnectionSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.CONNECTION;
-};
-type ConnectionFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.CONNECTION;
-};
-type CatchUpSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.CATCHUP;
-};
-type CatchUpFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.CATCHUP;
-};
-type CatchUpDroppedStepsEvent = {
-    attributes: {
-        numOfDroppedSteps: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.DROPPED_STEPS;
-};
-type DocumentInitSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        hasTitle: boolean;
-        latency?: number;
-        resetReason?: string;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.DOCUMENT_INIT;
-};
-type UpdateParticipantsSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        participants: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.UPDATE_PARTICIPANTS;
-};
-type CommitUnconfirmedStepsSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-        numUnconfirmedSteps?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS;
-};
-type CommitUnconfirmedStepsFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-        numUnconfirmedSteps?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS;
-};
-type PublishPageSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.PUBLISH_PAGE;
-};
-type PublishPageFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.PUBLISH_PAGE;
-};
-type GetCurrentStateSuccessAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.GET_CURRENT_STATE;
-};
-type GetCurrentStateFailureAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.FAILURE;
-        latency?: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.GET_CURRENT_STATE;
-};
-type SendStepsRetryAnalyticsEvent = {
-    attributes: {
-        count: number;
-        eventStatus: EVENT_STATUS.INFO;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
-};
-type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.INFO;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
-};
-type WebsocketMessageVolumeMetricEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.INFO;
-        messageCount: number;
-        messageSize: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC;
-};
-type ProviderInitializedAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.INFO;
-        isBuffered?: boolean;
-        isPreinitializing: boolean;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.PROVIDER_INITIALIZED;
-};
-type ProviderSetupAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.INFO;
-        hasState: boolean;
-        isPreinitializing: boolean;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.PROVIDER_SETUP;
-};
-type ProviderHasUnconfirmedStepsAnalyticsEvent = {
-    attributes: {
-        numUnconfirmedSteps: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.HAS_UNCONFIRMED_STEPS;
-};
-type UpdateDocumentAnalyticsEvent = {
-    attributes: {
-        docHasContent: boolean;
-        editorVersion: number;
-        eventStatus: EVENT_STATUS.SUCCESS;
-        isDocContentValid: boolean;
-        isDocTruthy: boolean;
-        newVersion: number;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.UPDATE_DOCUMENT;
-};
-type ReconnectionAnalyticsEvent = {
-    attributes: {
-        disconnectionPeriodSeconds: number;
-        eventStatus: EVENT_STATUS.SUCCESS;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.RECONNECTION;
-};
-type OutOfSyncAnalyticsEvent = {
-    attributes: {
-        catchupReason: CatchupEventReason | undefined;
-        eventStatus: EVENT_STATUS.FAILURE;
-        obfuscatedDoc: {
-            [key: string]: number;
-        };
-        obfuscatedSteps: {
-            [key: string]: number;
-        }[];
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.OUT_OF_SYNC;
-};
-type StepsRebasedAnalyticsEvent = {
-    attributes: {
-        clientID: 'string';
-        eventStatus: EVENT_STATUS.INFO;
-        obfuscatedRebasedSteps: {
-            [key: string]: number;
-        }[];
-        obfuscatedRemoteSteps: {
-            [key: string]: number;
-        }[];
-        obfuscatedUnconfirmedSteps: {
-            [key: string]: number;
-        }[];
-        userId: 'string';
-        versionAfter: 'string';
-        versionBefore: 'string';
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.STEPS_REBASED;
-};
-type PollingFallbackAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.INFO;
-        url: 'string';
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.POLLING_FALLBACK;
-};
-type ProcessStepsAnalyticsEvent = {
-    attributes: {
-        eventStatus: EVENT_STATUS.SUCCESS;
-    } & BaseActionAnalyticsEventAttributes;
-    eventAction: EVENT_ACTION.PROCESS_STEPS;
-};
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent | ReconnectionAnalyticsEvent | OutOfSyncAnalyticsEvent | StepsRebasedAnalyticsEvent | PollingFallbackAnalyticsEvent | ProcessStepsAnalyticsEvent;
-export declare const ACK_MAX_TRY = 60;
-export declare const CONFLUENCE = "confluence";
-/** Enumerable for attaching a reason to catchup (v2) call(s) */
-export declare enum CatchupEventReason {
-    STEPS_ADDED = "onStepsAdded",
-    STEPS_REJECTED = "onStepsRejected",
-    PROCESS_STEPS = "processSteps",
-    RECONNECTED = "reconnected"
-}
-export {};

package/dist/types-ts4.5/helpers/utils.d.ts

@@ -1,72 +0,0 @@
-import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import type { ProductInformation } from '../types';
-import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { StepJson } from '@atlaskit/editor-common/collab';
-import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
-import { CustomError } from '../errors/custom-errors';
-export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
-export declare function sleep(ms: number): Promise<any>;
-export declare const isAIProviderID: (id: string) => boolean;
-export declare const getProduct: (productInfo?: ProductInformation) => string;
-export declare const getSubProduct: (productInfo?: ProductInformation) => string;
-export type UGCFreeStepDetails = {
-    contentTypes: string;
-    stepSizeInBytes?: number;
-    type: string;
-};
-export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;
-export declare const getStepTypes: (stepJson: StepJson) => {
-    contentTypes: string | null;
-    type: string;
-};
-export declare const getStepsAdfWithObfuscation: (stepJson: StepJson) => ADFEntity[] | null;
-export declare const getDocAdfWithObfuscation: (doc: ProseMirrorNode) => ADFEntity | null;
-export declare const getDocAdfWithObfuscationFromJSON: (docJson: JSONDocNode) => ADFEntity | null;
-export declare const getStepPositions: (stepJson: StepJson) => {
-    from?: number | undefined;
-    gapFrom?: number | undefined;
-    gapTo?: number | undefined;
-    insert?: number | undefined;
-    pos?: number | undefined;
-    to?: number | undefined;
-};
-export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number | undefined) => {
-    stepContent: ADFEntity[] | null;
-    stepMetadata: {
-        createdOffline?: boolean;
-        prevStepId?: string;
-        rebased?: boolean;
-        reqId?: string;
-        schemaVersion?: string;
-        source?: string;
-        stepId?: string;
-        traceId?: string;
-        unconfirmedStepAfterRecovery?: boolean;
-    } | undefined;
-    stepPositions: {
-        from?: number | undefined;
-        gapFrom?: number | undefined;
-        gapTo?: number | undefined;
-        insert?: number | undefined;
-        pos?: number | undefined;
-        to?: number | undefined;
-    };
-    stepType: {
-        contentTypes: string | null;
-        type: string;
-    };
-}[];
-export declare function logObfuscatedSteps(oldState: EditorState | null, newState: EditorState): Promise<CustomError | {
-    stepsFromNewState: string;
-    stepsFromOldState: string;
-}>;
-export declare function toObfuscatedSteps(steps: readonly ProseMirrorStep[]): Promise<string>;
-/**
- * Copied from confluence/next/packages/graphql/src/utils/gcpDomainUtils.ts
- * Checks if the current domain is a GCP tenant matching the pattern: .*-cdp-{cdp-id}\.jira-dev\.com
- * @param {string | undefined} hostname optional hostname to evaluate
- * @returns {boolean} true if the domain matches the GCP tenant pattern
- */
-export declare function isGCPtenant(hostname?: string): boolean;

package/dist/types-ts4.5/index.d.ts

@@ -1 +0,0 @@
-export { Provider } from './provider';

package/dist/types-ts4.5/metadata/metadata-service.d.ts

@@ -1,25 +0,0 @@
-import type { Metadata, CollabEvents } from '@atlaskit/editor-common/collab';
-export declare class MetadataService {
-    private providerEmitCallback;
-    private broadcastMetadata;
-    private metadata;
-    constructor(providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcastMetadata: (metadata: Metadata) => void);
-    getMetaData: () => Metadata;
-    getTitle: () => string;
-    /**
-     * Called when a metadata is changed externally from other clients/backend.
-     */
-    onMetadataChanged: (metadata?: Metadata) => void;
-    setTitle(title: string, broadcast?: boolean): void;
-    setEditorWidth(editorWidth: string, broadcast?: boolean): void;
-    /**
-     * Updates the local metadata and broadcasts the metadata to other clients/backend.
-     * @param metadata
-     */
-    setMetadata: (metadata: Metadata) => void;
-    /**
-     * Emits a change in document's metadata
-     * @param metadata
-     */
-    updateMetadata: (metadata: Metadata | undefined) => void;
-}

package/dist/types-ts4.5/namespace/namespace-service.d.ts

@@ -1,14 +0,0 @@
-import type { NamespaceStatus } from '../types';
-/**
- * Allows us to keep track of any namespace changes from the server.
- * @param isNamespaceLocked - whether the namespace is locked or not, defaults to false
- */
-export declare class NamespaceService {
-    private isNamespaceLocked;
-    constructor(isNamespaceLocked?: boolean);
-    getIsNamespaceLocked: () => boolean;
-    /**
-     * ESS-2916 namespace status event- lock/unlock
-     */
-    onNamespaceStatusChanged: ({ isLocked, waitTimeInMs, timestamp, }: NamespaceStatus) => Promise<void>;
-}

package/dist/types-ts4.5/participants/participants-helper.d.ts

@@ -1,35 +0,0 @@
-import type { ProviderParticipant } from '@atlaskit/editor-common/collab';
-import type { PresencePayload } from '../types';
-import type { ParticipantsState } from './participants-state';
-export declare const PARTICIPANT_UPDATE_INTERVAL: number;
-export type ParticipantsMap = Map<string, ProviderParticipant>;
-type UserType = Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email' | 'isGuest'>;
-export type GetUserType = ((userId: string) => Promise<UserType>) | undefined;
-export type GetUsersType = ((userIds: string[]) => Promise<UserType[]>) | undefined;
-export type BatchProps = {
-    /** Defaults to {@link #DEFAULT_BATCH_FETCH_SIZE} if none provided **/
-    batchSize?: number;
-    /** how often the debounce should run. Defaults to {@link ./participants-service#DEFAULT_FETCH_USERS_INTERVAL} if none provided **/
-    debounceTime?: number;
-    getUsers?: GetUsersType;
-    onError?: (error: unknown) => void;
-    /** when to stop fetching users. eg. if this = 5, we won't attempt to hydrate more than 5 **/
-    participantsLimit?: number;
-};
-export declare const createParticipantFromPayload: (payload: PresencePayload & {
-    userId: string;
-}, getUser: GetUserType) => Promise<ProviderParticipant>;
-/**
- * Will use the getUsers callback from batchProps to fetch users
- *
- * 1. Determine all the participants that need to be hydrated
- * 2. Only fetch a subset of those participants based on batchSize
- * 3. Of the users fetched, find all of those users' sessions and mark those entries as hydrated
- *
- * @param participantsState
- * @param batchProps
- * @returns
- * @example
- */
-export declare const fetchParticipants: (participantsState: ParticipantsState, batchProps: BatchProps) => Promise<ProviderParticipant[]>;
-export {};

package/dist/types-ts4.5/participants/participants-service.d.ts

@@ -1,200 +0,0 @@
-import type { CollabEventPresenceData, CollabTelepointerPayload, CollabPresenceActivityChangePayload, ProviderParticipant, StepJson, UserPermitType } from '@atlaskit/editor-common/collab';
-import type AnalyticsHelper from '../analytics/analytics-helper';
-import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload, FetchAnonymousAsset } from '../types';
-import type { BatchProps, GetUserType } from './participants-helper';
-import { ParticipantsState } from './participants-state';
-import type { ParticipantFilter } from './participants-state';
-export declare const SINGLE_COLLAB_MODE = "single";
-export declare const MULTI_COLLAB_MODE = "collab";
-/**
- * This service is responsible for handling presence and participant events, as well as sending them on to the editor or NCS.
- * @param analyticsHelper Analytics helper instance
- * @param participantsState Starts with no participants, only add this when testing
- * @param emit Emit from the Provider class (to the editor)
- * @param getUser Callback to get user data from the editor
- * @param channelBroadcast Broadcast from the Channel class (to NCS)
- * @param sendPresenceJoined Callback to Channel class
- */
-export declare class ParticipantsService {
-    private analyticsHelper;
-    private emit;
-    private getUser;
-    private batchProps;
-    private channelBroadcast;
-    private sendPresenceJoined;
-    private getPresenceData;
-    private setUserId;
-    private getAIProviderActiveIds?;
-    private fetchAnonymousAsset?;
-    private participantUpdateTimeout;
-    private presenceUpdateTimeout;
-    private presenceFetchTimeout;
-    private currentlyPollingFetchUsers;
-    private hasBatchFetchError;
-    private participantsState;
-    /**
-     * constructor
-     *
-     * @param analyticsHelper
-     * @param participantsState
-     * @param emit
-     * @param getUser
-     * @param batchProps
-     * @param channelBroadcast
-     * @param sendPresenceJoined
-     * @param getPresenceData
-     * @param setUserId
-     * @param getAIProviderActiveIds
-     * @param fetchAnonymousAsset
-     * @example
-     */
-    constructor(analyticsHelper: AnalyticsHelper | undefined, participantsState: ParticipantsState | undefined, emit: (evt: 'presence' | 'telepointer' | 'disconnected' | 'presence:changed', data: CollabEventPresenceData | CollabTelepointerPayload | CollabEventDisconnectedData | CollabPresenceActivityChangePayload) => void, getUser: GetUserType, batchProps: BatchProps | undefined, channelBroadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, sendPresenceJoined: () => void, getPresenceData: () => PresenceData, setUserId: (id: string) => void, getAIProviderActiveIds?: (() => string[]) | undefined, fetchAnonymousAsset?: FetchAnonymousAsset | undefined);
-    sendPresenceActivityChanged: () => void;
-    sendAIProviderChanged: (payload: {
-        action: "add" | "remove";
-        clientId: string | number;
-        permit?: UserPermitType;
-        providerId?: string;
-        sessionId: string;
-        userId: string;
-    }) => void;
-    private buildAIProviderPresencePayload;
-    private sendAIProviderParticipantUpdated;
-    private sendAIProviderParticipantLeft;
-    private sendAIProvidersPresence;
-    private hasPresenceActivityChanged;
-    private handleAnonymousUser;
-    /**
-     * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
-     * @param payload Payload from incoming socket event
-     * @example
-     */
-    private updateParticipantEager;
-    /**
-     * Will update participant state without attempting to hydrate the participant, which is handled in {@link #batchFetchUsers}
-     * Here's the TLDR of what this method handles
-     *
-     * 1. If participant that joined is anonymous, update state, emit event and return
-     * 2. If incoming participant is new, update state and emit event
-     * 3. If incoming participant is not new, update previous state with new values (timestamp, activity)
-     *
-     * @param payload Payload from incoming socket event
-     * @example
-     */
-    private updateParticipantLazy;
-    onParticipantUpdated: (payload: PresencePayload) => Promise<void>;
-    /**
-     * Called when a participant leaves the session.
-     * We emit the `presence` event to update the active avatars in the editor.
-     * @param payload
-     * @example
-     */
-    onParticipantLeft: (payload: PresencePayload) => void;
-    disconnect: (reason: string, sessionId: string | undefined) => void;
-    /**
-     * Updates when users were last active
-     * @param userIds Users in most recent steps
-     * @example
-     */
-    updateLastActive: (userIds?: string[]) => void;
-    /**
-     * Called on receiving steps, emits each step's telepointer
-     * @param steps Steps to extract telepointers from
-     * @example
-     */
-    emitTelepointersFromSteps(steps: StepJson[]): void;
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     * @param payload
-     * @param thisSessionId
-     * @example
-     */
-    onParticipantTelepointer: (payload: TelepointerPayload, thisSessionId: string | undefined) => void;
-    /**
-     * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
-     * Needs to be kicked off in the Provider.
-     * @param sessionId SessionId from provider's connection
-     * @example
-     */
-    startInactiveRemover: (sessionId: string | undefined) => void;
-    enrichParticipants: (props: BatchProps) => Promise<void>;
-    /**
-     * a debounce so we can wait until participants join before hydrating the user and perform batch calls in a timely manner.
-     *
-     * if {@link BatchProps#participantsLimit} is supplied
-     *  1. Fetch users until we've reached the participantsLimit
-     *  2. If there are no more participants to hydrate and we haven't reached the participantsLimit, stop polling
-     *  3. If we've reached our participantLimit, stop polling
-     *
-     * if no {@link BatchProps#participantsLimit} is supplied
-     *  1. Fetch users until there are no more participants to hydrate
-     * @example
-     */
-    batchFetchUsers: () => Promise<void>;
-    /**
-     * We want to give some time for users to initially join before attempting to fetch users
-     * otherwise we'll always make at least 2 calls if there's more than 1 participant
-     * @example
-     */
-    initializeFirstBatchFetchUsers: () => Promise<void>;
-    /**
-     * Keep list of participants up to date. Filter out inactive users etc.
-     * @param sessionId
-     * @example
-     */
-    private filterInactive;
-    /**
-     * Wrapper function to emit with error handling and analytics
-     * @param data Data to emit
-     * @param emit Emit function from Provider
-     * @param errorMessage
-     * @example
-     */
-    private emitPresence;
-    /**
-     * Wrapper function to emit with error handling and analytics
-     * @param data Data to emit
-     * @param emit Emit function from Provider
-     * @param errorMessage
-     * @example
-     */
-    private emitTelepointer;
-    /**
-     * Wrapper function to emit with error handling and analytics
-     * @param data Data to emit
-     * @param errorMessage Error message for analytics
-     * @example
-     */
-    private emitPresenceActivityChange;
-    /**
-     * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
-     * @example
-     */
-    clearTimers: () => void;
-    private sendPresence;
-    /**
-     * Called when a participant joins the session.
-     *
-     * We keep track of participants internally, and emit the `presence` event to update
-     * the active avatars in the editor.
-     * This method will be triggered from backend to notify all participants to exchange presence
-     * @param payload
-     * @example
-     */
-    onPresenceJoined: (payload: PresencePayload) => void;
-    /**
-     * Called when the current user joins the session.
-     *
-     * This will send both a 'presence' event and a 'participant:updated' event.
-     * This updates both the avatars and the participants list.
-     * @param payload
-     * @example
-     */
-    onPresence: (payload: PresencePayload) => void;
-    getParticipants: () => ProviderParticipant[];
-    getUniqueParticipantSize: () => number;
-    getUniqueParticipants: (filter: ParticipantFilter) => ProviderParticipant[];
-    getAIProviderParticipants: () => ProviderParticipant[];
-    getCollabMode: () => "collab" | "single";
-}