@atlaskit/collab-provider 7.6.3 → 8.0.0

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

@@ -1,2 +0,0 @@
-export { Provider } from './provider';
-export type { CollabConnectedPayload, CollabDisconnectedPayload, CollabErrorPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabEvents, Socket, } from './types';

package/dist/types-ts4.0/provider/catchup.d.ts

@@ -1,9 +0,0 @@
-import type { CatchupOptions } from '../types';
-import { Mapping, Step } from 'prosemirror-transform';
-/**
- * Rebase the steps based on the mapping pipeline.
- * Some steps could be lost, if they are no longer
- * invalid after rebased.
- */
-export declare function rebaseSteps(steps: Step[], mapping: Mapping): Step[];
-export declare const catchup: (opt: CatchupOptions) => Promise<void>;

package/dist/types-ts4.0/provider/index.d.ts

@@ -1,124 +0,0 @@
-import { EditorState, Transaction } from 'prosemirror-state';
-import { Emitter } from '../emitter';
-import { CollabEditProvider, ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { Config, Metadata, CollabEvents } from '../types';
-import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
-export declare const CATCHUP_THROTTLE: number;
-export declare const MAX_STEP_REJECTED_ERROR = 15;
-declare type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'setup' | 'send' | 'sendMessage'>;
-export declare class Provider extends Emitter<CollabEvents> implements BaseEvents {
-    private participants;
-    private channel;
-    private config;
-    private getState;
-    private metadata;
-    private stepRejectCounter;
-    private analyticsClient?;
-    private isChannelInitialized;
-    private onSyncUpError?;
-    private sessionId?;
-    private clientId?;
-    private userId?;
-    private participantUpdateTimeout?;
-    private presenceUpdateTimeout?;
-    private disconnectedAt?;
-    constructor(config: Config);
-    private initializeChannel;
-    /**
-     * Called by collab plugin in editor when it's ready to
-     * initialize a collab session.
-     */
-    initialize(getState: () => EditorState): this;
-    setup({ getState, onSyncUpError, }: {
-        getState: () => EditorState;
-        onSyncUpError?: SyncUpErrorFunction;
-    }): this;
-    /**
-     * We can use this function to throttle/delay
-     * Any send steps operation
-     *
-     * The getState function will return the current EditorState
-     * from the EditorView.
-     */
-    private sendStepsFromCurrentState;
-    /**
-     * Send steps from transaction to other participants
-     */
-    send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState): void;
-    /**
-     * Called when we receive steps from the service
-     */
-    private onStepsAdded;
-    private throttledCatchup;
-    private fitlerQueue;
-    private updateDocumentWithMetadata;
-    private applyLocalsteps;
-    private getCurrentPmVersion;
-    private getUnconfirmedSteps;
-    /**
-     * Called when:
-     *   * session established(offline -> online)
-     *   * try to accept steps but version is behind.
-     */
-    private catchup;
-    private onErrorHandled;
-    private pauseQueue?;
-    private queue;
-    private queueSteps;
-    private processQueue;
-    private processSteps;
-    /**
-     * Send messages, such as telepointers, to other participants.
-     */
-    sendMessage(data: any): void;
-    private sendPresence;
-    /**
-     * Called when a participant joins the session.
-     *
-     * We keep track of participants internally in this class, 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
-     *
-     */
-    private onPresenceJoined;
-    private onPresence;
-    /**
-     * Called when a metadata is changed.
-     *
-     */
-    private onMetadataChanged;
-    /**
-     * Called when a participant leaves the session.
-     *
-     * We emit the `presence` event to update the active avatars in the editor.
-     */
-    private onParticipantLeft;
-    /**
-     * Called when we receive an update event from another participant.
-     */
-    private onParticipantUpdated;
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
-    private onParticipantTelepointer;
-    private updateParticipant;
-    /**
-     * Keep list of participants up to date. Filter out inactive users etc.
-     */
-    private updateParticipants;
-    private emitTelepointersFromSteps;
-    private disconnectedReasonMapper;
-    private onDisconnected;
-    destroy(): this;
-    disconnect(): this;
-    setTitle(title: string, broadcast?: boolean): void;
-    setEditorWidth(editorWidth: string, broadcast?: boolean): void;
-    setMetadata(metadata: Metadata): void;
-    getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
-    /**
-     * Unsubscribe from all events emitted by this provider.
-     */
-    unsubscribeAll(): this;
-}
-export {};

package/dist/types-ts4.0/socket-io-provider.d.ts

@@ -1,4 +0,0 @@
-import { Provider } from './provider';
-import { Socket, Config, ProductInformation } from './types';
-export declare function createSocketIOSocket(url: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation): Socket;
-export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

package/dist/types-ts4.0/types.d.ts

@@ -1,170 +0,0 @@
-import type { Transaction } from 'prosemirror-state';
-import type { Step } from 'prosemirror-transform';
-import type { CollabParticipant, CollabEventTelepointerData as EditorCollabTelepointerData, CollabEventConnectionData as EditorCollabConnetedData, CollabEventInitData as EditorCollabInitData, CollabEventRemoteData as EditorCollabData, CollabEventPresenceData as EditorCollabPresenceData } from '@atlaskit/editor-common/collab';
-import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-import type { Manager } from 'socket.io-client';
-import type { DisconnectReason } from './disconnected-reason-mapper';
-export interface Storage {
-    get(key: string): Promise<string>;
-    set(key: string, value: string): Promise<void>;
-    delete(key: string): Promise<void>;
-}
-export interface Config {
-    url: string;
-    documentAri: string;
-    lifecycle?: Lifecycle;
-    storage?: Storage;
-    need404?: boolean;
-    createSocket: (path: string, auth?: (cb: (data: object) => void) => void, productInfo?: ProductInformation) => Socket;
-    analyticsClient?: AnalyticsWebClient;
-    getUser?(userId: string): Promise<Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
-        userId: string;
-    }>;
-    permissionTokenRefresh?: () => Promise<string>;
-    productInfo?: ProductInformation;
-}
-interface SimpleEventEmitter {
-    on(event: string, fn: Function): SimpleEventEmitter;
-}
-export interface Socket extends SimpleEventEmitter {
-    id: string;
-    connect(): Socket;
-    emit(event: string, ...args: any[]): Socket;
-    close(): Socket;
-    io?: Manager;
-}
-export declare type LifecycleEvents = 'save' | 'restore';
-export declare type EventHandler = () => void;
-export interface Lifecycle {
-    on(event: LifecycleEvents, handler: EventHandler): void;
-}
-export declare type CollabConnectedPayload = EditorCollabConnetedData;
-export interface CollabDisconnectedPayload {
-    reason: DisconnectReason;
-    sid: string;
-}
-export interface CollabErrorPayload {
-    status: number;
-    code: string;
-    message: string;
-    reason?: string;
-}
-export interface CollabInitPayload extends EditorCollabInitData {
-    doc: any;
-    version: number;
-    userId?: string;
-    metadata?: Metadata;
-}
-export interface CollabDataPayload extends EditorCollabData {
-    version: number;
-    json: StepJson[];
-    userIds: string[];
-}
-export declare type CollabTelepointerPayload = EditorCollabTelepointerData;
-export declare type CollabPresencePayload = EditorCollabPresenceData;
-export declare type CollabMetadataPayload = Metadata;
-export declare type CollabLocalStepsPayload = {
-    steps: Step[];
-};
-export interface CollabEvents {
-    'metadata:changed': CollabMetadataPayload;
-    init: CollabInitPayload;
-    connected: CollabConnectedPayload;
-    disconnected: CollabDisconnectedPayload;
-    data: CollabDataPayload;
-    telepointer: CollabTelepointerPayload;
-    presence: CollabPresencePayload;
-    'local-steps': CollabLocalStepsPayload;
-    error: CollabErrorPayload;
-    entity: any;
-}
-export interface Metadata {
-    [key: string]: string | number | boolean;
-}
-export declare type InitPayload = {
-    doc: any;
-    version: number;
-    userId?: string;
-    metadata?: Metadata;
-};
-export declare type PresencePayload = {
-    sessionId: string;
-    userId: string;
-    clientId: string;
-    timestamp: number;
-};
-export declare type TelepointerPayload = PresencePayload & {
-    selection: {
-        type: 'textSelection' | 'nodeSelection';
-        anchor: number;
-        head: number;
-    };
-};
-export declare type StepJson = {
-    from?: number;
-    to?: number;
-    stepType?: string;
-    clientId: string;
-    userId: string;
-};
-export declare type StepsPayload = {
-    version: number;
-    steps: StepJson[];
-};
-export declare type ErrorPayload = {
-    message: string;
-    data?: {
-        status: number;
-        code?: string;
-        meta?: string | {
-            description: string;
-            reason?: string;
-        };
-    };
-};
-export declare type ChannelEvent = {
-    connected: {
-        sid: string;
-        initialized: boolean;
-    };
-    init: InitPayload;
-    reconnected: null;
-    'presence:joined': PresencePayload;
-    presence: PresencePayload;
-    'participant:left': PresencePayload;
-    'participant:telepointer': TelepointerPayload;
-    'participant:updated': PresencePayload;
-    'steps:commit': StepsPayload & {
-        userId: string;
-    };
-    'steps:added': StepsPayload;
-    'metadata:changed': Metadata;
-    error: ErrorPayload;
-    disconnect: {
-        reason: string;
-    };
-};
-export interface CatchupResponse {
-    doc?: string;
-    version?: number;
-    stepMaps?: any[];
-    metadata?: Metadata;
-}
-export interface CatchupOptions {
-    getCurrentPmVersion: () => number;
-    fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>;
-    fitlerQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
-    getUnconfirmedSteps: () => {
-        version: number;
-        steps: Step<any>[];
-        clientID: string | number;
-        origins: Transaction<any>[];
-    } | null | undefined;
-    updateDocumentWithMetadata: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
-    applyLocalsteps: (steps: Step[]) => void;
-}
-export declare type ProductInformation = {
-    product: string;
-    subProduct?: string;
-};
-export {};

package/dist/types-ts4.0/version-wrapper.d.ts

@@ -1,3 +0,0 @@
-export declare const name: string;
-export declare const version: string;
-export declare const nextMajorVersion: () => string;