@atlaskit/editor-core 188.7.0 → 188.7.3

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

@@ -0,0 +1,40 @@
+import type { ResolvedPos, Mark, Node, Slice, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey, TextSelection, AllSelection } from '@atlaskit/editor-prosemirror/state';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import type { AnnotationInfo } from './types';
+import { AnnotationSelectionType } from './types';
+import type { InlineCommentPluginState } from './pm-plugins/types';
+import type { INPUT_METHOD } from '../analytics';
+import type { AnalyticsEventPayloadCallback } from '../analytics/utils';
+/**
+ * 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 hasAnnotationMark(node: Node, state: EditorState): boolean;
+export declare function annotationExists(annotationId: string, state: EditorState): boolean;
+export declare function containsAnyAnnotations(slice: Slice, state: EditorState): boolean;
+export declare function stripNonExistingAnnotations(slice: Slice, state: EditorState): false | undefined;

package/dist/types-ts4.5/plugins/avatar-group/index.d.ts

@@ -0,0 +1,14 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { CollabEditOptions } from '@atlaskit/editor-common/collab';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+type Config = {
+    collabEdit?: CollabEditOptions;
+    takeFullWidth: boolean;
+};
+declare const avatarGroup: NextEditorPlugin<'avatarGroup', {
+    pluginConfiguration: Config;
+    dependencies: [
+        FeatureFlagsPlugin
+    ];
+}>;
+export default avatarGroup;

package/dist/types-ts4.5/plugins/avatar-group/messages.d.ts

@@ -0,0 +1,7 @@
+export declare const avatarGroupMessages: {
+    editors: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/plugins/avatar-group/ui/AvatarGroupPluginWrapper.d.ts

@@ -0,0 +1,15 @@
+import { jsx } from '@emotion/react';
+import type { EventDispatcher } from '../../../event-dispatcher';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { CollabEditOptions } from '@atlaskit/editor-common/collab';
+import type { DispatchAnalyticsEvent } from '../../analytics';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+declare const AvatarGroupPluginWrapper: (props: {
+    collabEdit?: CollabEditOptions | undefined;
+    editorView: EditorView;
+    eventDispatcher: EventDispatcher<any>;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent | undefined;
+    takeFullWidth: boolean;
+    featureFlags: FeatureFlags;
+}) => jsx.JSX.Element;
+export default AvatarGroupPluginWrapper;

package/dist/types-ts4.5/plugins/before-primaryToolbar/index.d.ts

@@ -0,0 +1,8 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+type Config = {
+    beforePrimaryToolbarComponents?: any;
+};
+declare const beforePrimaryToolbar: NextEditorPlugin<'beforePrimaryToolbar', {
+    pluginConfiguration: Config;
+}>;
+export default beforePrimaryToolbar;

package/dist/types-ts4.5/plugins/before-primaryToolbar/ui/BeforePrimaryToolbarWrapper.d.ts

@@ -0,0 +1,5 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const BeforePrimaryToolbarWrapper: (props: {
+    beforePrimaryToolbarComponents: any;
+}) => jsx.JSX.Element;

package/dist/types-ts4.5/plugins/better-type-history/index.d.ts

@@ -0,0 +1,13 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export type BetterTypeHistoryAPI = {
+    flagPasteEvent: (transaction: Transaction) => Transaction;
+};
+/**
+ * This plugin is aiming to improve undo behaviour for some of our more custom applications, very specific text
+ * paste events, splitting blocks of text, new lines.
+ */
+declare const betterTypeHistory: NextEditorPlugin<'betterTypeHistory', {
+    actions: BetterTypeHistoryAPI;
+}>;
+export default betterTypeHistory;

package/dist/types-ts4.5/plugins/better-type-history/pm-plugins/main.d.ts

@@ -0,0 +1,3 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+declare const _default: () => SafePlugin<any>;
+export default _default;

package/dist/types-ts4.5/plugins/better-type-history/pm-plugins/plugin-key.d.ts

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const pluginKey: PluginKey<any>;

package/dist/types-ts4.5/plugins/breakout/commands/remove-breakout.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from '../../../types';
+export declare function removeBreakout(): Command;

package/dist/types-ts4.5/plugins/breakout/commands/set-breakout-mode.d.ts

@@ -0,0 +1,3 @@
+import type { BreakoutMode } from '@atlaskit/editor-common/types';
+import type { Command } from '../../../types';
+export declare function setBreakoutMode(mode: BreakoutMode): Command;

package/dist/types-ts4.5/plugins/breakout/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const BreakoutCssClassName: {
+    BREAKOUT_MARK: string;
+    BREAKOUT_MARK_DOM: string;
+};

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

@@ -0,0 +1,14 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+import type { BreakoutPluginState } from './types';
+interface BreakoutPluginOptions {
+    allowBreakoutButton?: boolean;
+}
+declare const breakoutPlugin: NextEditorPlugin<'breakout', {
+    pluginConfiguration: BreakoutPluginOptions | undefined;
+    dependencies: [
+        WidthPlugin
+    ];
+    sharedState: Partial<BreakoutPluginState>;
+}>;
+export default breakoutPlugin;

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

@@ -0,0 +1,5 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { BreakoutPluginState } from './types';
+export declare const pluginKey: PluginKey<BreakoutPluginState>;
+export declare const getPluginState: (state: EditorState) => BreakoutPluginState | undefined;

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

@@ -0,0 +1,4 @@
+import type { ContentNodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+export interface BreakoutPluginState {
+    breakoutNode: ContentNodeWithPos | undefined;
+}

package/dist/types-ts4.5/plugins/breakout/ui/LayoutButton.d.ts

@@ -0,0 +1,17 @@
+/** @jsx jsx */
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+export interface Props {
+    editorView: EditorView;
+    mountPoint?: HTMLElement;
+    node: PMNode | null;
+    boundariesElement?: HTMLElement;
+    scrollableElement?: HTMLElement;
+    handleClick?: Function;
+}
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types-ts4.5/plugins/breakout/utils/find-breakout-node.d.ts

@@ -0,0 +1,9 @@
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
+import type { ContentNodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+/**
+ * Find the nearest parent node to the selection that supports breakout, or if the nearest
+ * matching parent node is the doc, return undefined.
+ * For depth, if a node is selected and supports breakout, return the depth of the node.
+ * @param selection Current editor selection
+ */
+export declare function findSupportedNodeForBreakout(selection: Selection): ContentNodeWithPos | undefined;

package/dist/types-ts4.5/plugins/breakout/utils/get-breakout-mode.d.ts

@@ -0,0 +1,7 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { BreakoutMode } from '@atlaskit/editor-common/types';
+/**
+ * Get the current mode of the breakout at the selection
+ * @param state Current EditorState
+ */
+export declare function getBreakoutMode(state: EditorState): BreakoutMode | undefined;

package/dist/types-ts4.5/plugins/breakout/utils/is-breakout-mark-allowed.d.ts

@@ -0,0 +1,9 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Check if breakout should be allowed for the current selection. If a node is selected,
+ * can this node be broken out, if text, can the enclosing parent node be broken out.
+ *
+ * Currently breakout of a node is not possible if it's nested in anything but the document, however
+ * this logic supports this changing.
+ */
+export declare function isBreakoutMarkAllowed(state: EditorState): boolean;

package/dist/types-ts4.5/plugins/breakout/utils/is-supported-node.d.ts

@@ -0,0 +1,6 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Check if breakout can be applied to a node
+ * @param node Node to check
+ */
+export declare function isSupportedNodeForBreakout(node: PMNode): boolean;

package/dist/types-ts4.5/plugins/clear-marks-on-change-to-empty-document/index.d.ts

@@ -0,0 +1,7 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export declare const pluginKey: PluginKey<any>;
+export declare function createPlugin(): SafePlugin;
+declare const clearMarksOnChangeToEmptyDocumentPlugin: NextEditorPlugin<'clearMarksOnEmptyDoc'>;
+export default clearMarksOnChangeToEmptyDocumentPlugin;

package/dist/types-ts4.5/plugins/code-bidi-warning/index.d.ts

@@ -0,0 +1,8 @@
+import type { NextEditorPlugin, EditorProps } from '../../types';
+type Config = {
+    appearance: EditorProps['appearance'];
+};
+declare const codeBidiWarning: NextEditorPlugin<'codeBidiWarning', {
+    pluginConfiguration: Config;
+}>;
+export default codeBidiWarning;

package/dist/types-ts4.5/plugins/code-bidi-warning/plugin-key.d.ts

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const codeBidiWarningPluginKey: PluginKey<any>;

package/dist/types-ts4.5/plugins/code-bidi-warning/pm-plugins/main.d.ts

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EditorProps, PMPluginFactoryParams } from '../../../types';
+export declare const createPlugin: ({ dispatch, getIntl }: PMPluginFactoryParams, { appearance }: {
+    appearance: EditorProps['appearance'];
+}) => SafePlugin<import("./types").CodeBidiWarningPluginState>;

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

@@ -0,0 +1,8 @@
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+export declare const createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch<any>, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>, getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
+export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, }: {
+    doc: PmNode;
+    codeBidiWarningLabel: string;
+    tooltipEnabled: boolean;
+}): DecorationSet;

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

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

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

@@ -0,0 +1,6 @@
+import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+export type CodeBidiWarningPluginState = {
+    decorationSet: DecorationSet;
+    codeBidiWarningLabel: string;
+    tooltipEnabled: boolean;
+};

package/dist/types-ts4.5/plugins/code-block/actions.d.ts

@@ -0,0 +1,18 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { Command } from '../../types';
+import type { INPUT_METHOD, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+export declare const removeCodeBlock: Command;
+export declare const changeLanguage: (language: string) => Command;
+export declare const copyContentToClipboard: Command;
+export declare const resetCopiedState: Command;
+export declare const ignoreFollowingMutations: Command;
+export declare const resetShouldIgnoreFollowingMutations: Command;
+/**
+ * This function creates a new transaction that inserts a code block,
+ * if there is text selected it will wrap the current selection if not it will
+ * append the codeblock to the end of the document.
+ */
+export declare function createInsertCodeBlockTransaction({ state, }: {
+    state: EditorState;
+}): import("prosemirror-state").Transaction;
+export declare function insertCodeBlockWithAnalytics(inputMethod: INPUT_METHOD, analyticsAPI?: EditorAnalyticsAPI): Command;

package/dist/types-ts4.5/plugins/code-block/ide-ux/bracket-handling.d.ts

@@ -0,0 +1,12 @@
+export declare const BRACKET_MAP: {
+    '{': string;
+    '[': string;
+    '(': string;
+};
+export type BracketMapKey = keyof typeof BRACKET_MAP;
+export declare const shouldAutoCloseBracket: (before: string, after: string) => boolean;
+export declare const getAutoClosingBracketInfo: (before: string, after: string) => {
+    left: "{" | "[" | "(" | undefined;
+    right: string | undefined;
+    hasTrailingMatchingBracket: boolean;
+};

package/dist/types-ts4.5/plugins/code-block/ide-ux/commands.d.ts

@@ -0,0 +1,6 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { CommandDispatch } from '../../../types';
+export declare function indent(state: EditorState, dispatch?: CommandDispatch): boolean;
+export declare function outdent(state: EditorState, dispatch?: CommandDispatch): boolean;
+export declare function insertIndent(state: EditorState, dispatch: CommandDispatch): boolean;
+export declare function insertNewlineWithIndent(state: EditorState, dispatch?: CommandDispatch): boolean;

package/dist/types-ts4.5/plugins/code-block/ide-ux/line-handling.d.ts

@@ -0,0 +1,25 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const isSelectionEntirelyInsideCodeBlock: (state: EditorState) => boolean;
+export declare const isCursorInsideCodeBlock: (state: EditorState) => boolean;
+export declare const getStartOfCurrentLine: (state: EditorState) => {
+    text: string;
+    pos: number;
+};
+export declare const getEndOfCurrentLine: (state: EditorState) => {
+    text: string;
+    pos: number;
+};
+export declare function getLinesFromSelection(state: EditorState): {
+    text: string;
+    start: number;
+    end: number;
+};
+export declare const forEachLine: (text: string, callback: (line: string, offset: number) => void) => void;
+export declare const getLineInfo: (line: string) => {
+    indentToken: {
+        token: string;
+        size: number;
+        regex: RegExp;
+    };
+    indentText: string;
+};

package/dist/types-ts4.5/plugins/code-block/ide-ux/paired-character-handling.d.ts

@@ -0,0 +1,2 @@
+export declare const isCursorBeforeClosingCharacter: (after: string) => boolean;
+export declare const isClosingCharacter: (text: string) => boolean;

package/dist/types-ts4.5/plugins/code-block/ide-ux/quote-handling.d.ts

@@ -0,0 +1,12 @@
+export declare const QUOTE_MAP: {
+    "'": string;
+    '"': string;
+    '`': string;
+};
+export type QuoteMapKey = keyof typeof QUOTE_MAP;
+export declare const shouldAutoCloseQuote: (before: string, after: string) => boolean;
+export declare const getAutoClosingQuoteInfo: (before: string, after: string) => {
+    left: "`" | "'" | "\"" | undefined;
+    right: string | undefined;
+    hasTrailingMatchingQuote: boolean;
+};

package/dist/types-ts4.5/plugins/code-block/index.d.ts

@@ -0,0 +1,19 @@
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { NextEditorPlugin, OptionalPlugin, Command } from '@atlaskit/editor-common/types';
+import type { CodeBlockOptions } from './types';
+import type { decorationsPlugin } from '@atlaskit/editor-plugin-decorations';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { compositionPlugin } from '@atlaskit/editor-plugin-composition';
+declare const codeBlockPlugin: NextEditorPlugin<'codeBlock', {
+    pluginConfiguration: CodeBlockOptions;
+    dependencies: [
+        typeof decorationsPlugin,
+        typeof compositionPlugin,
+        OptionalPlugin<typeof analyticsPlugin>
+    ];
+    actions: {
+        insertCodeBlock: (inputMethod: INPUT_METHOD) => Command;
+    };
+}>;
+export default codeBlockPlugin;
+export type CodeBlockPlugin = typeof codeBlockPlugin;