@atlaskit/editor-plugin-collab-edit 0.1.0

package/dist/types/participants.d.ts

@@ -0,0 +1,18 @@
+import type { CollabParticipant } from '@atlaskit/editor-common/collab';
+export interface ReadOnlyParticipants {
+    get(sessionId: string): CollabParticipant | undefined;
+    toArray(): ReadonlyArray<CollabParticipant>;
+    eq(other: ReadOnlyParticipants): boolean;
+}
+export declare class Participants implements ReadOnlyParticipants {
+    private participants;
+    constructor(participants?: Map<string, CollabParticipant>);
+    add(data: CollabParticipant[]): Participants;
+    remove(sessionIds: string[]): Participants;
+    update(sessionId: string, lastActive: number): Participants;
+    updateCursorPos(sessionId: string, cursorPos: number): Participants;
+    toArray(): CollabParticipant[];
+    get(sessionId: string): CollabParticipant | undefined;
+    size(): number;
+    eq(other: Participants): boolean;
+}

package/dist/types/plugin-key.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { PluginState as CollabPluginState } from './plugin-state';
+export declare const pluginKey: PluginKey<CollabPluginState>;

package/dist/types/plugin-state.d.ts

@@ -0,0 +1,25 @@
+import { TELEPOINTER_DIM_CLASS } from '@atlaskit/editor-common/collab';
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { ReadOnlyParticipants } from './participants';
+import { Participants } from './participants';
+export { TELEPOINTER_DIM_CLASS };
+/**
+ * Returns position where it's possible to place a decoration.
+ */
+export declare const getValidPos: (tr: ReadonlyTransaction, pos: number) => number;
+export declare class PluginState {
+    private decorationSet;
+    private participants;
+    private onError;
+    private sid?;
+    isReady: boolean;
+    get decorations(): DecorationSet;
+    get activeParticipants(): ReadOnlyParticipants;
+    get sessionId(): string | undefined;
+    constructor(decorations: DecorationSet, participants: Participants, sessionId?: string, collabInitalised?: boolean, onError?: (err: Error) => void);
+    getInitial(sessionId: string): string;
+    apply(tr: ReadonlyTransaction): PluginState;
+    static eq(a: PluginState, b: PluginState): boolean;
+    static init(config: any): PluginState;
+}

package/dist/types/plugin.d.ts

@@ -0,0 +1,11 @@
+import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
+import { pluginKey } from './plugin-key';
+import { PluginState } from './plugin-state';
+import type { PrivateCollabEditOptions, ProviderCallback } from './types';
+import type { collabEditPlugin } from './index';
+export { PluginState, pluginKey };
+export declare const createPlugin: (dispatch: Dispatch, providerFactory: ProviderFactory, providerResolver: (value: CollabEditProvider) => void, collabProviderCallback: ProviderCallback, options: PrivateCollabEditOptions, featureFlags: FeatureFlags, pluginInjectionApi: ExtractInjectionAPI<typeof collabEditPlugin> | undefined) => SafePlugin<PluginState>;

package/dist/types/types.d.ts

@@ -0,0 +1,8 @@
+import type { CollabEditOptions, CollabEditProvider, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
+export type { InviteToEditComponentProps, InviteToEditButtonProps, CollabInviteToEditProps, CollabAnalyticsProps, } from '@atlaskit/editor-common/collab';
+export type PrivateCollabEditOptions = CollabEditOptions & {
+    sanitizePrivateContent?: boolean;
+    onSyncUpError?: SyncUpErrorFunction;
+};
+export type ProviderCallback = <ReturnType>(codeToExecute: (provider: CollabEditProvider) => ReturnType | undefined, onError?: (err: Error) => void) => Promise<ReturnType | undefined> | undefined;
+export type ProviderBuilder = (collabEditProviderPromise: Promise<CollabEditProvider>) => ProviderCallback;

package/dist/types/utils.d.ts

@@ -0,0 +1,16 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CollabEditOptions, CollabParticipant, Color } from '@atlaskit/editor-common/collab';
+import { colors } from '@atlaskit/editor-common/collab';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+export { Color, colors };
+export declare const findPointers: (id: string, decorations: DecorationSet) => Decoration[];
+export declare function getAvatarColor(str: string): {
+    index: number;
+    color: Color;
+};
+export declare const createTelepointers: (from: number, to: number, sessionId: string, isSelection: boolean, initial: string) => Decoration[];
+export declare const replaceDocument: (doc: any, state: EditorState, version?: number, options?: CollabEditOptions, reserveCursor?: boolean) => import("prosemirror-state").Transaction;
+export declare const scrollToCollabCursor: (editorView: EditorView, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
+export declare const getPositionOfTelepointer: (sessionId: string, decorationSet: DecorationSet) => undefined | number;

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

@@ -0,0 +1,11 @@
+import type { CollabEventConnectionData, CollabEventInitData, CollabEventPresenceData, CollabEventRemoteData, CollabSendableSelection, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { PrivateCollabEditOptions } from './types';
+export declare const handleInit: (initData: CollabEventInitData, view: EditorView, options?: PrivateCollabEditOptions) => void;
+export declare const handleConnection: (connectionData: CollabEventConnectionData, view: EditorView) => void;
+export declare const handlePresence: (presenceData: CollabEventPresenceData, view: EditorView) => void;
+export declare const applyRemoteData: (remoteData: CollabEventRemoteData, view: EditorView, options: PrivateCollabEditOptions) => void;
+export declare const applyRemoteSteps: (json: any[], view: EditorView, userIds?: (number | string)[], options?: PrivateCollabEditOptions) => void;
+export declare const handleTelePointer: (telepointerData: CollabTelepointerPayload, view: EditorView) => void;
+export declare const getSendableSelection: (selection: Selection) => CollabSendableSelection;

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

@@ -0,0 +1,6 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const addSynchronyErrorAnalytics: (state: EditorState, tr: Transaction, featureFlags: FeatureFlags, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => (error: Error) => Transaction;
+export type EntityEventType = 'error' | 'disconnected';
+export declare const addSynchronyEntityAnalytics: (state: EditorState, tr: Transaction) => (type: EntityEventType, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Transaction;

package/dist/types-ts4.5/events/handlers.d.ts

@@ -0,0 +1,24 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CollabEditProvider, CollabEventConnectionData, CollabEventInitData, CollabEventLocalStepData, CollabEventPresenceData, CollabEventRemoteData, CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { PrivateCollabEditOptions } from '../types';
+export type SynchronyEntity = {
+    on: (evt: 'disconnected' | 'error', handler: (...args: any) => void) => void;
+    off: (evt: 'disconnected' | 'error', handler: (...args: any) => void) => void;
+};
+export interface CollabHandlers {
+    initHandler: (data: CollabEventInitData) => void;
+    connectedHandler: (data: CollabEventConnectionData) => void;
+    dataHandler: (data: CollabEventRemoteData) => void;
+    presenceHandler: (data: CollabEventPresenceData) => void;
+    telepointerHandler: (data: CollabTelepointerPayload) => void;
+    localStepsHandler: (data: CollabEventLocalStepData) => void;
+    errorHandler: (error: any) => void;
+    entityHandler: ({ entity }: {
+        entity: SynchronyEntity;
+    }) => void;
+}
+export type Cleanup = () => void;
+export declare const subscribe: (currentDeps_0: EditorView, currentDeps_1: CollabEditProvider<import("@atlaskit/editor-common/collab").CollabEvents>, currentDeps_2: PrivateCollabEditOptions, currentDeps_3: FeatureFlags, currentDeps_4?: ProviderFactory | undefined, currentDeps_5?: EditorAnalyticsAPI | undefined) => Cleanup;

package/dist/types-ts4.5/events/initialize.d.ts

@@ -0,0 +1,16 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { PrivateCollabEditOptions } from '../types';
+import type { Cleanup } from './handlers';
+type Props = {
+    view: EditorView;
+    options: PrivateCollabEditOptions;
+    providerFactory: ProviderFactory;
+    featureFlags: FeatureFlags;
+    editorAnalyticsApi: EditorAnalyticsAPI | undefined;
+};
+export declare const initialize: ({ options, providerFactory, view, featureFlags, editorAnalyticsApi, }: Props) => (provider: CollabEditProvider) => Cleanup;
+export {};

package/dist/types-ts4.5/events/send-transaction.d.ts

@@ -0,0 +1,11 @@
+import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+type Props = {
+    originalTransaction: Readonly<Transaction>;
+    transactions: readonly Transaction[];
+    oldEditorState: EditorState;
+    newEditorState: EditorState;
+    useNativePlugin: boolean;
+};
+export declare const sendTransaction: ({ originalTransaction, transactions, oldEditorState, newEditorState, useNativePlugin, }: Props) => (provider: CollabEditProvider) => void;
+export {};

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

@@ -0,0 +1,29 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { ReadOnlyParticipants } from './participants';
+import { pluginKey } from './plugin';
+import type { PrivateCollabEditOptions } from './types';
+export { pluginKey };
+import type { Color } from './utils';
+export type { PluginState } from './plugin-state';
+export type { CollabInviteToEditProps, InviteToEditComponentProps, PrivateCollabEditOptions, } from './types';
+export type { ReadOnlyParticipants } from './participants';
+export type CollabEditPlugin = NextEditorPlugin<'collabEdit', {
+    pluginConfiguration: PrivateCollabEditOptions;
+    dependencies: [
+        OptionalPlugin<FeatureFlagsPlugin>,
+        OptionalPlugin<AnalyticsPlugin>
+    ];
+    sharedState: {
+        activeParticipants: ReadOnlyParticipants | undefined;
+        sessionId: string | undefined;
+    } | undefined;
+    actions: {
+        getAvatarColor: (str: string) => {
+            index: number;
+            color: Color;
+        };
+    };
+}>;
+export declare const collabEditPlugin: CollabEditPlugin;

package/dist/types-ts4.5/native-collab-provider-plugin.d.ts

@@ -0,0 +1,7 @@
+import type { CollabEditProvider, CollabEvents } from '@atlaskit/editor-common/collab';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const nativeCollabProviderPlugin: ({ providerPromise, }: {
+    providerPromise: Promise<CollabEditProvider>;
+}) => SafePlugin<CollabEditProvider<CollabEvents> | null>;
+export declare const getCollabProvider: (editorState: EditorState) => CollabEditProvider | null;

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

@@ -0,0 +1,18 @@
+import type { CollabParticipant } from '@atlaskit/editor-common/collab';
+export interface ReadOnlyParticipants {
+    get(sessionId: string): CollabParticipant | undefined;
+    toArray(): ReadonlyArray<CollabParticipant>;
+    eq(other: ReadOnlyParticipants): boolean;
+}
+export declare class Participants implements ReadOnlyParticipants {
+    private participants;
+    constructor(participants?: Map<string, CollabParticipant>);
+    add(data: CollabParticipant[]): Participants;
+    remove(sessionIds: string[]): Participants;
+    update(sessionId: string, lastActive: number): Participants;
+    updateCursorPos(sessionId: string, cursorPos: number): Participants;
+    toArray(): CollabParticipant[];
+    get(sessionId: string): CollabParticipant | undefined;
+    size(): number;
+    eq(other: Participants): boolean;
+}

package/dist/types-ts4.5/plugin-key.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { PluginState as CollabPluginState } from './plugin-state';
+export declare const pluginKey: PluginKey<CollabPluginState>;

package/dist/types-ts4.5/plugin-state.d.ts

@@ -0,0 +1,25 @@
+import { TELEPOINTER_DIM_CLASS } from '@atlaskit/editor-common/collab';
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { ReadOnlyParticipants } from './participants';
+import { Participants } from './participants';
+export { TELEPOINTER_DIM_CLASS };
+/**
+ * Returns position where it's possible to place a decoration.
+ */
+export declare const getValidPos: (tr: ReadonlyTransaction, pos: number) => number;
+export declare class PluginState {
+    private decorationSet;
+    private participants;
+    private onError;
+    private sid?;
+    isReady: boolean;
+    get decorations(): DecorationSet;
+    get activeParticipants(): ReadOnlyParticipants;
+    get sessionId(): string | undefined;
+    constructor(decorations: DecorationSet, participants: Participants, sessionId?: string, collabInitalised?: boolean, onError?: (err: Error) => void);
+    getInitial(sessionId: string): string;
+    apply(tr: ReadonlyTransaction): PluginState;
+    static eq(a: PluginState, b: PluginState): boolean;
+    static init(config: any): PluginState;
+}

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

@@ -0,0 +1,11 @@
+import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
+import { pluginKey } from './plugin-key';
+import { PluginState } from './plugin-state';
+import type { PrivateCollabEditOptions, ProviderCallback } from './types';
+import type { collabEditPlugin } from './index';
+export { PluginState, pluginKey };
+export declare const createPlugin: (dispatch: Dispatch, providerFactory: ProviderFactory, providerResolver: (value: CollabEditProvider) => void, collabProviderCallback: ProviderCallback, options: PrivateCollabEditOptions, featureFlags: FeatureFlags, pluginInjectionApi: ExtractInjectionAPI<typeof collabEditPlugin> | undefined) => SafePlugin<PluginState>;

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

@@ -0,0 +1,8 @@
+import type { CollabEditOptions, CollabEditProvider, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
+export type { InviteToEditComponentProps, InviteToEditButtonProps, CollabInviteToEditProps, CollabAnalyticsProps, } from '@atlaskit/editor-common/collab';
+export type PrivateCollabEditOptions = CollabEditOptions & {
+    sanitizePrivateContent?: boolean;
+    onSyncUpError?: SyncUpErrorFunction;
+};
+export type ProviderCallback = <ReturnType>(codeToExecute: (provider: CollabEditProvider) => ReturnType | undefined, onError?: (err: Error) => void) => Promise<ReturnType | undefined> | undefined;
+export type ProviderBuilder = (collabEditProviderPromise: Promise<CollabEditProvider>) => ProviderCallback;

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

@@ -0,0 +1,16 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CollabEditOptions, CollabParticipant, Color } from '@atlaskit/editor-common/collab';
+import { colors } from '@atlaskit/editor-common/collab';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+export { Color, colors };
+export declare const findPointers: (id: string, decorations: DecorationSet) => Decoration[];
+export declare function getAvatarColor(str: string): {
+    index: number;
+    color: Color;
+};
+export declare const createTelepointers: (from: number, to: number, sessionId: string, isSelection: boolean, initial: string) => Decoration[];
+export declare const replaceDocument: (doc: any, state: EditorState, version?: number, options?: CollabEditOptions, reserveCursor?: boolean) => import("prosemirror-state").Transaction;
+export declare const scrollToCollabCursor: (editorView: EditorView, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
+export declare const getPositionOfTelepointer: (sessionId: string, decorationSet: DecorationSet) => undefined | number;

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@atlaskit/editor-plugin-collab-edit",
+  "version": "0.1.0",
+  "description": "Collab Edit plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: Collaboration",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "EditorPluginCollabEdit",
+      "category": "Components"
+    }
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^76.35.0",
+    "@atlaskit/editor-plugin-analytics": "0.4.4",
+    "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@babel/runtime": "^7.0.0",
+    "memoize-one": "^6.0.0",
+    "prosemirror-collab": "1.3.1"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@af/integration-testing": "*",
+    "@af/visual-regression": "*",
+    "@atlaskit/editor-plugin-mentions": "^0.1.0",
+    "@atlaskit/editor-plugin-text-formatting": "^0.4.0",
+    "@atlaskit/editor-plugin-type-ahead": "^0.9.0",
+    "@atlaskit/editor-plugin-unsupported-content": "^0.2.0",
+    "@atlaskit/editor-test-helpers": "^18.15.0",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/synchrony-test-helpers": "^2.3.0",
+    "@atlaskit/util-data-test": "^17.8.0",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}