@atlaskit/editor-plugin-annotation 0.1.0

package/dist/types/commands/index.d.ts

@@ -0,0 +1,15 @@
+import { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command } from '@atlaskit/editor-common/types';
+import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
+export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
+export declare const closeComponent: () => Command;
+export declare const clearDirtyMark: () => Command;
+export declare const removeInlineCommentNearSelection: (id: string) => Command;
+export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => Command;
+export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => Command;
+export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
+export declare const setSelectedAnnotation: (id: string) => Command;
+export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
+export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

package/dist/types/commands/transform.d.ts

@@ -0,0 +1,11 @@
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+declare const _default: {
+    addAnnotationMark: (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
+    addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
+    addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: INPUT_METHOD.SHORTCUT | INPUT_METHOD.TOOLBAR) => (transaction: Transaction, state: EditorState) => Transaction;
+    addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+};
+export default _default;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { annotationPlugin } from './plugin';
+export type { AnnotationPlugin, AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, } from './types';
+export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

package/dist/types/nodeviews/index.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import type { ForwardRef } from '@atlaskit/editor-common/react-node-view';
+import ReactNodeView from '@atlaskit/editor-common/react-node-view';
+export declare class AnnotationNodeView extends ReactNodeView {
+    createDomRef(): HTMLSpanElement;
+    getContentDOM(): {
+        dom: HTMLSpanElement;
+    };
+    render(_props: {}, forwardRef: ForwardRef): JSX.Element;
+}
+export declare const getAnnotationViewClassname: (isUnresolved: boolean, hasFocus: boolean) => string | undefined;

package/dist/types/plugin.d.ts

@@ -0,0 +1,6 @@
+import type { UpdateEvent } from '@atlaskit/editor-common/annotation';
+import { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { AnnotationInfo, AnnotationPlugin, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCreateComponentProps, InlineCommentState, InlineCommentViewComponentProps } from './types';
+export declare const annotationPlugin: AnnotationPlugin;
+export { AnnotationUpdateEmitter };
+export type { AnnotationProviders, InlineCommentAnnotationProvider, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationTypeProvider, AnnotationInfo, AnnotationState, InlineCommentState, UpdateEvent, };

package/dist/types/pm-plugins/inline-comment.d.ts

@@ -0,0 +1,3 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { InlineCommentPluginOptions, InlineCommentPluginState } from './types';
+export declare const inlineCommentPlugin: (options: InlineCommentPluginOptions) => SafePlugin<InlineCommentPluginState>;

package/dist/types/pm-plugins/keymap.d.ts

@@ -0,0 +1,3 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export declare function keymapPlugin(editorAnalyticsAPI: EditorAnalyticsAPI | undefined): SafePlugin;

package/dist/types/pm-plugins/plugin-factory.d.ts

@@ -0,0 +1,2 @@
+import type { InlineCommentPluginState } from './types';
+export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch<any>, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

package/dist/types/pm-plugins/reducer.d.ts

@@ -0,0 +1,3 @@
+import type { InlineCommentAction, InlineCommentPluginState } from './types';
+declare const _default: (pluginState: InlineCommentPluginState, action: InlineCommentAction) => InlineCommentPluginState;
+export default _default;

package/dist/types/pm-plugins/types.d.ts

@@ -0,0 +1,78 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { Dispatch, EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
+import type { PortalProviderAPI } from '@atlaskit/editor-common/portal-provider';
+import type { EditorState, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
+import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { AnnotationInfo, InlineCommentAnnotationProvider } from '../types';
+export declare enum ACTIONS {
+    UPDATE_INLINE_COMMENT_STATE = 0,
+    SET_INLINE_COMMENT_DRAFT_STATE = 1,
+    INLINE_COMMENT_UPDATE_MOUSE_STATE = 2,
+    INLINE_COMMENT_CLEAR_DIRTY_MARK = 3,
+    ADD_INLINE_COMMENT = 4,
+    INLINE_COMMENT_SET_VISIBLE = 5,
+    CLOSE_COMPONENT = 6,
+    SET_SELECTED_ANNOTATION = 7
+}
+export interface InlineCommentPluginOptions {
+    dispatch: Dispatch;
+    eventDispatcher: EventDispatcher;
+    portalProviderAPI: PortalProviderAPI;
+    provider: InlineCommentAnnotationProvider;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+}
+export interface InlineCommentMouseData {
+    isSelecting: boolean;
+}
+export type InlineCommentMap = {
+    [key: string]: boolean;
+};
+export type InlineCommentAction = {
+    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
+    data: InlineCommentMap;
+} | {
+    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
+    data: {
+        drafting: boolean;
+        editorState: EditorState;
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
+    data: {
+        mouseData: InlineCommentMouseData;
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK;
+} | {
+    type: ACTIONS.CLOSE_COMPONENT;
+} | {
+    type: ACTIONS.ADD_INLINE_COMMENT;
+    data: {
+        drafting: boolean;
+        inlineComments: InlineCommentMap;
+        editorState: EditorState;
+        selectedAnnotations: AnnotationInfo[];
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
+    data: {
+        isVisible: boolean;
+    };
+} | {
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
+};
+export type InlineCommentPluginState = {
+    annotations: InlineCommentMap;
+    selectedAnnotations: AnnotationInfo[];
+    dirtyAnnotations?: boolean;
+    mouseData: InlineCommentMouseData;
+    draftDecorationSet?: DecorationSet;
+    bookmark?: SelectionBookmark;
+    disallowOnWhitespace: boolean;
+    isInlineCommentViewClosed: boolean;
+    isVisible: boolean;
+    skipSelectionHandling: boolean;
+};

package/dist/types/toolbar.d.ts

@@ -0,0 +1,5 @@
+import type { IntlShape } from 'react-intl-next';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean) => FloatingToolbarConfig | undefined;

package/dist/types/types.d.ts

@@ -0,0 +1,100 @@
+import type React from 'react';
+import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { Slice } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { InlineCommentPluginState } from './pm-plugins/types';
+type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
+export type AnnotationPlugin = NextEditorPlugin<'annotation', {
+    pluginConfiguration: AnnotationProviders | undefined;
+    sharedState: InlineCommentPluginState | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    actions: {
+        stripNonExistingAnnotations: StripNonExistingAnnotations;
+    };
+}>;
+export type AnnotationInfo = {
+    id: string;
+    type: AnnotationTypes.INLINE_COMMENT;
+};
+type AnnotationComponentProps = {
+    /**
+     * Selected text (can be used when creating a comment)
+     */
+    textSelection?: string;
+    /**
+     * DOM element around selected text (for positioning)
+     */
+    dom?: HTMLElement;
+    /**
+     * Indicates that a draft comment was discarded/cancelled
+     */
+    onClose?: () => void;
+};
+export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
+    /**
+     * Creates an annotation mark in the document with the given id.
+     */
+    onCreate: (id: string) => void;
+};
+export type InlineCommentViewComponentProps = AnnotationComponentProps & {
+    /**
+     * Existing annotations where the cursor is placed.
+     * These are provided in order, inner-most first.
+     */
+    annotations: Array<AnnotationInfo>;
+    /**
+     * Resolves an annotation with the given ID around the selection.
+     */
+    onResolve: (id: string) => void;
+    /**
+     * Removes the annotation from the document
+     */
+    onDelete?: (id: string) => void;
+    /**
+     * Ordered list of annotation ids as shown in the document
+     */
+    annotationsList?: string[];
+};
+export interface AnnotationState<Type, State> {
+    annotationType: Type;
+    id: string;
+    state: State;
+}
+export interface AnnotationTypeProvider<Type, State> {
+    getState: (annotationIds: string[]) => Promise<AnnotationState<Type, State>[]>;
+    updateSubscriber?: AnnotationUpdateEmitter;
+    disallowOnWhitespace?: boolean;
+}
+export type InlineCommentState = {
+    resolved: boolean;
+};
+export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationTypes.INLINE_COMMENT, InlineCommentState> & {
+    createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
+    viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
+    isToolbarAbove?: boolean;
+};
+export interface AnnotationProviders {
+    inlineComment: InlineCommentAnnotationProvider;
+}
+export declare enum AnnotationSelectionType {
+    INVALID = "invalid",
+    DISABLED = "disabled",
+    VALID = "valid"
+}
+export declare const AnnotationTestIds: {
+    prefix: string;
+    floatingComponent: string;
+    floatingToolbarCreateButton: string;
+    componentSave: string;
+    componentClose: string;
+};
+export type CoordsAtPos = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+export {};

package/dist/types/ui/AnnotationViewWrapper.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+export type AnnotationViewWrapperProps = {
+    children: React.ReactNode;
+    onViewed?: () => void;
+    annotationText?: string;
+};
+export declare class AnnotationViewWrapper extends React.PureComponent<AnnotationViewWrapperProps> {
+    componentDidMount(): void;
+    render(): React.ReactNode;
+}

package/dist/types/ui/InlineCommentView.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { DispatchAnalyticsEvent, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { AnnotationProviders } from '../types';
+interface InlineCommentViewProps {
+    providers: AnnotationProviders;
+    editorView: EditorView;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+}
+export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
+export {};

package/dist/types/utils.d.ts

@@ -0,0 +1,44 @@
+import type { AnalyticsEventPayloadCallback, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
+import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
+import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import type { InlineCommentPluginState } from './pm-plugins/types';
+import type { AnnotationInfo } from './types';
+import { AnnotationSelectionType } from './types';
+export { hasAnnotationMark, containsAnyAnnotations };
+/**
+ * Finds the marks in the nodes to the left and right.
+ * @param $pos Position to center search around
+ */
+export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
+export declare const getAllAnnotations: (doc: Node) => string[];
+export declare const addDraftDecoration: (start: number, end: number) => Decoration;
+export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
+export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+/**
+ * get selection from position to apply new comment for
+ * @return bookmarked positions if they exists, otherwise current selection positions
+ */
+export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: InlineCommentPluginState | null | undefined): Selection;
+export declare const inlineCommentPluginKey: PluginKey<InlineCommentPluginState>;
+export declare const getPluginState: (state: EditorState) => InlineCommentPluginState | undefined;
+/**
+ * get payload for the open/close analytics event
+ */
+export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => AnalyticsEventPayloadCallback;
+export declare const isSelectionValid: (state: EditorState) => AnnotationSelectionType;
+export declare const hasInvalidNodes: (state: EditorState) => boolean;
+/**
+ * Checks if any of the nodes in a given selection are completely whitespace
+ * This is to conform to Confluence annotation specifications
+ */
+export declare function hasInvalidWhitespaceNode(selection: TextSelection | AllSelection, schema: Schema): boolean;
+export declare function annotationExists(annotationId: string, state: EditorState): boolean;
+export declare function stripNonExistingAnnotations(slice: Slice, state: EditorState): false | undefined;
+/**
+ * Compares two sets of annotationInfos to see if the annotations have changed
+ * This function assumes annotations will have unique id's for simplicity
+ */
+export declare function isSelectedAnnotationsChanged(oldSelectedAnnotations: AnnotationInfo[], newSelectedAnnotations: AnnotationInfo[]): boolean;

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

@@ -0,0 +1,15 @@
+import { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command } from '@atlaskit/editor-common/types';
+import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
+export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
+export declare const closeComponent: () => Command;
+export declare const clearDirtyMark: () => Command;
+export declare const removeInlineCommentNearSelection: (id: string) => Command;
+export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => Command;
+export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => Command;
+export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
+export declare const setSelectedAnnotation: (id: string) => Command;
+export declare const createAnnotation: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string, annotationType?: AnnotationTypes) => Command;
+export declare const setInlineCommentsVisibility: (isVisible: boolean) => Command;

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

@@ -0,0 +1,11 @@
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+declare const _default: {
+    addAnnotationMark: (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
+    addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
+    addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: INPUT_METHOD.SHORTCUT | INPUT_METHOD.TOOLBAR) => (transaction: Transaction, state: EditorState) => Transaction;
+    addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+    addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
+};
+export default _default;

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

@@ -0,0 +1,3 @@
+export { annotationPlugin } from './plugin';
+export type { AnnotationPlugin, AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, } from './types';
+export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import type { ForwardRef } from '@atlaskit/editor-common/react-node-view';
+import ReactNodeView from '@atlaskit/editor-common/react-node-view';
+export declare class AnnotationNodeView extends ReactNodeView {
+    createDomRef(): HTMLSpanElement;
+    getContentDOM(): {
+        dom: HTMLSpanElement;
+    };
+    render(_props: {}, forwardRef: ForwardRef): JSX.Element;
+}
+export declare const getAnnotationViewClassname: (isUnresolved: boolean, hasFocus: boolean) => string | undefined;

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

@@ -0,0 +1,6 @@
+import type { UpdateEvent } from '@atlaskit/editor-common/annotation';
+import { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { AnnotationInfo, AnnotationPlugin, AnnotationProviders, AnnotationState, AnnotationTypeProvider, InlineCommentAnnotationProvider, InlineCommentCreateComponentProps, InlineCommentState, InlineCommentViewComponentProps } from './types';
+export declare const annotationPlugin: AnnotationPlugin;
+export { AnnotationUpdateEmitter };
+export type { AnnotationProviders, InlineCommentAnnotationProvider, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationTypeProvider, AnnotationInfo, AnnotationState, InlineCommentState, UpdateEvent, };

package/dist/types-ts4.5/pm-plugins/inline-comment.d.ts

@@ -0,0 +1,3 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { InlineCommentPluginOptions, InlineCommentPluginState } from './types';
+export declare const inlineCommentPlugin: (options: InlineCommentPluginOptions) => SafePlugin<InlineCommentPluginState>;

package/dist/types-ts4.5/pm-plugins/keymap.d.ts

@@ -0,0 +1,3 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+export declare function keymapPlugin(editorAnalyticsAPI: EditorAnalyticsAPI | undefined): SafePlugin;

package/dist/types-ts4.5/pm-plugins/plugin-factory.d.ts

@@ -0,0 +1,2 @@
+import type { InlineCommentPluginState } from './types';
+export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch<any>, initialState: InlineCommentPluginState | ((state: import("prosemirror-state").EditorState) => InlineCommentPluginState)) => import("prosemirror-state").SafeStateField<InlineCommentPluginState>, createCommand: <A = import("./types").InlineCommentAction>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;

package/dist/types-ts4.5/pm-plugins/reducer.d.ts

@@ -0,0 +1,3 @@
+import type { InlineCommentAction, InlineCommentPluginState } from './types';
+declare const _default: (pluginState: InlineCommentPluginState, action: InlineCommentAction) => InlineCommentPluginState;
+export default _default;

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

@@ -0,0 +1,78 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { Dispatch, EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
+import type { PortalProviderAPI } from '@atlaskit/editor-common/portal-provider';
+import type { EditorState, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
+import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { AnnotationInfo, InlineCommentAnnotationProvider } from '../types';
+export declare enum ACTIONS {
+    UPDATE_INLINE_COMMENT_STATE = 0,
+    SET_INLINE_COMMENT_DRAFT_STATE = 1,
+    INLINE_COMMENT_UPDATE_MOUSE_STATE = 2,
+    INLINE_COMMENT_CLEAR_DIRTY_MARK = 3,
+    ADD_INLINE_COMMENT = 4,
+    INLINE_COMMENT_SET_VISIBLE = 5,
+    CLOSE_COMPONENT = 6,
+    SET_SELECTED_ANNOTATION = 7
+}
+export interface InlineCommentPluginOptions {
+    dispatch: Dispatch;
+    eventDispatcher: EventDispatcher;
+    portalProviderAPI: PortalProviderAPI;
+    provider: InlineCommentAnnotationProvider;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+}
+export interface InlineCommentMouseData {
+    isSelecting: boolean;
+}
+export type InlineCommentMap = {
+    [key: string]: boolean;
+};
+export type InlineCommentAction = {
+    type: ACTIONS.UPDATE_INLINE_COMMENT_STATE;
+    data: InlineCommentMap;
+} | {
+    type: ACTIONS.SET_INLINE_COMMENT_DRAFT_STATE;
+    data: {
+        drafting: boolean;
+        editorState: EditorState;
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;
+    data: {
+        mouseData: InlineCommentMouseData;
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_CLEAR_DIRTY_MARK;
+} | {
+    type: ACTIONS.CLOSE_COMPONENT;
+} | {
+    type: ACTIONS.ADD_INLINE_COMMENT;
+    data: {
+        drafting: boolean;
+        inlineComments: InlineCommentMap;
+        editorState: EditorState;
+        selectedAnnotations: AnnotationInfo[];
+    };
+} | {
+    type: ACTIONS.INLINE_COMMENT_SET_VISIBLE;
+    data: {
+        isVisible: boolean;
+    };
+} | {
+    type: ACTIONS.SET_SELECTED_ANNOTATION;
+    data: {
+        selectedAnnotations: AnnotationInfo[];
+    };
+};
+export type InlineCommentPluginState = {
+    annotations: InlineCommentMap;
+    selectedAnnotations: AnnotationInfo[];
+    dirtyAnnotations?: boolean;
+    mouseData: InlineCommentMouseData;
+    draftDecorationSet?: DecorationSet;
+    bookmark?: SelectionBookmark;
+    disallowOnWhitespace: boolean;
+    isInlineCommentViewClosed: boolean;
+    isVisible: boolean;
+    skipSelectionHandling: boolean;
+};

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

@@ -0,0 +1,5 @@
+import type { IntlShape } from 'react-intl-next';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean) => FloatingToolbarConfig | undefined;

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

@@ -0,0 +1,102 @@
+import type React from 'react';
+import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { Slice } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { InlineCommentPluginState } from './pm-plugins/types';
+type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
+export type AnnotationPlugin = NextEditorPlugin<'annotation', {
+    pluginConfiguration: AnnotationProviders | undefined;
+    sharedState: InlineCommentPluginState | undefined;
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>
+    ];
+    actions: {
+        stripNonExistingAnnotations: StripNonExistingAnnotations;
+    };
+}>;
+export type AnnotationInfo = {
+    id: string;
+    type: AnnotationTypes.INLINE_COMMENT;
+};
+type AnnotationComponentProps = {
+    /**
+     * Selected text (can be used when creating a comment)
+     */
+    textSelection?: string;
+    /**
+     * DOM element around selected text (for positioning)
+     */
+    dom?: HTMLElement;
+    /**
+     * Indicates that a draft comment was discarded/cancelled
+     */
+    onClose?: () => void;
+};
+export type InlineCommentCreateComponentProps = AnnotationComponentProps & {
+    /**
+     * Creates an annotation mark in the document with the given id.
+     */
+    onCreate: (id: string) => void;
+};
+export type InlineCommentViewComponentProps = AnnotationComponentProps & {
+    /**
+     * Existing annotations where the cursor is placed.
+     * These are provided in order, inner-most first.
+     */
+    annotations: Array<AnnotationInfo>;
+    /**
+     * Resolves an annotation with the given ID around the selection.
+     */
+    onResolve: (id: string) => void;
+    /**
+     * Removes the annotation from the document
+     */
+    onDelete?: (id: string) => void;
+    /**
+     * Ordered list of annotation ids as shown in the document
+     */
+    annotationsList?: string[];
+};
+export interface AnnotationState<Type, State> {
+    annotationType: Type;
+    id: string;
+    state: State;
+}
+export interface AnnotationTypeProvider<Type, State> {
+    getState: (annotationIds: string[]) => Promise<AnnotationState<Type, State>[]>;
+    updateSubscriber?: AnnotationUpdateEmitter;
+    disallowOnWhitespace?: boolean;
+}
+export type InlineCommentState = {
+    resolved: boolean;
+};
+export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationTypes.INLINE_COMMENT, InlineCommentState> & {
+    createComponent?: React.ComponentType<InlineCommentCreateComponentProps>;
+    viewComponent?: React.ComponentType<InlineCommentViewComponentProps>;
+    isToolbarAbove?: boolean;
+};
+export interface AnnotationProviders {
+    inlineComment: InlineCommentAnnotationProvider;
+}
+export declare enum AnnotationSelectionType {
+    INVALID = "invalid",
+    DISABLED = "disabled",
+    VALID = "valid"
+}
+export declare const AnnotationTestIds: {
+    prefix: string;
+    floatingComponent: string;
+    floatingToolbarCreateButton: string;
+    componentSave: string;
+    componentClose: string;
+};
+export type CoordsAtPos = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+export {};

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

@@ -0,0 +1,10 @@
+import React from 'react';
+export type AnnotationViewWrapperProps = {
+    children: React.ReactNode;
+    onViewed?: () => void;
+    annotationText?: string;
+};
+export declare class AnnotationViewWrapper extends React.PureComponent<AnnotationViewWrapperProps> {
+    componentDidMount(): void;
+    render(): React.ReactNode;
+}

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

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { DispatchAnalyticsEvent, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { AnnotationProviders } from '../types';
+interface InlineCommentViewProps {
+    providers: AnnotationProviders;
+    editorView: EditorView;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+}
+export declare function InlineCommentView({ providers, editorView, editorAnalyticsAPI, dispatchAnalyticsEvent, }: InlineCommentViewProps): JSX.Element | null;
+export {};