@atlaskit/editor-core 187.34.1 → 187.35.0

package/report.api.md

@@ -28,6 +28,7 @@ import type { AllowedBlockTypes } from '@atlaskit/editor-common/types';
 import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { AnalyticsEventPayload as AnalyticsEventPayload_2 } from '@atlaskit/analytics-next/AnalyticsEvent';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import { BrowserFreezetracking } from '@atlaskit/editor-common/types';
 import type { CardOptions } from '@atlaskit/editor-common/card';
@@ -37,6 +38,7 @@ import type { CollabEditOptions } from '@atlaskit/editor-common/collab';
 import { Color } from '@atlaskit/status/element';
 import { Command as Command_2 } from '@atlaskit/editor-common/types';
 import { ComponentType } from 'react';
+import type { compositionPlugin } from '@atlaskit/editor-plugin-composition';
 import type { ConfigWithNodeInfo } from '@atlaskit/editor-plugin-floating-toolbar';
 import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
 import type { ContextUpdateHandler } from '@atlaskit/editor-common/types';
@@ -45,6 +47,7 @@ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { darkModeStatusColorPalette } from '@atlaskit/editor-common/ui-color';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
+import type { decorationsPlugin } from '@atlaskit/editor-plugin-decorations';
 import { dedupe } from '@atlaskit/editor-common/utils';
 import { DEFAULT_BORDER_COLOR } from '@atlaskit/editor-common/ui-color';
 import type { DirectEditorProps } from '@atlaskit/editor-prosemirror/view';
@@ -270,9 +273,6 @@ type BeforeAndAfterToolbarComponents = {
   after: ReactComponents;
 };
 
-// @public (undocumented)
-export const blockPluginStateKey: PluginKey<BlockTypeState>;
-
 // @public (undocumented)
 interface BlockType {
   // (undocumented)
@@ -295,6 +295,23 @@ export type BlockTypeInputMethod =
   | INPUT_METHOD.SHORTCUT
   | INPUT_METHOD.TOOLBAR;
 
+// @public (undocumented)
+export type BlockTypePlugin = NextEditorPlugin<
+  'blockType',
+  {
+    pluginConfiguration: BlockTypePluginOptions | undefined;
+    dependencies: [OptionalPlugin<typeof analyticsPlugin>];
+    sharedState: BlockTypeState | undefined;
+    actions: {
+      insertBlockQuote: (inputMethod: BlockTypeInputMethod) => Command_2;
+      setBlockType: (
+        name: string,
+        inputMethod: BlockTypeInputMethod,
+      ) => Command_2;
+    };
+  }
+>;
+
 // @public (undocumented)
 interface BlockTypePluginOptions {
   // (undocumented)
@@ -348,6 +365,25 @@ interface CodeBlockOptions extends LongPressSelectionPluginOptions {
   appearance?: EditorAppearance | undefined;
 }
 
+// @public (undocumented)
+export type CodeBlockPlugin = typeof codeBlockPlugin;
+
+// @public (undocumented)
+const codeBlockPlugin: NextEditorPlugin<
+  'codeBlock',
+  {
+    pluginConfiguration: CodeBlockOptions;
+    dependencies: [
+      typeof decorationsPlugin,
+      typeof compositionPlugin,
+      OptionalPlugin<typeof analyticsPlugin>,
+    ];
+    actions: {
+      insertCodeBlock: (inputMethod: INPUT_METHOD) => Command_2;
+    };
+  }
+>;
+
 // @public (undocumented)
 export class CollapsedEditor extends React_2.Component<Props, State> {
   // (undocumented)
@@ -1097,16 +1133,6 @@ export type InsertBlockInputMethodToolbar =
   | INPUT_METHOD.INSERT_MENU
   | INPUT_METHOD.TOOLBAR;
 
-// @public (undocumented)
-export function insertBlockType(name: string): Command_2;
-
-// @public (undocumented)
-export const insertBlockTypesWithAnalytics: (
-  name: string,
-  inputMethod: BlockTypeInputMethod,
-  editorAnalyticsApi: EditorAnalyticsAPI | undefined,
-) => Command_2;
-
 // @public (undocumented)
 export const insertDate: (
   date?: DateType,
@@ -1557,6 +1583,24 @@ export const openDatePicker: () => Command;
 
 export { PaletteColor };
 
+// @public (undocumented)
+export type PanelPlugin = typeof panelPlugin;
+
+// @public (undocumented)
+const panelPlugin: NextEditorPlugin<
+  'panel',
+  {
+    pluginConfiguration: PanelPluginOptions | undefined;
+    dependencies: [
+      typeof decorationsPlugin,
+      OptionalPlugin<typeof analyticsPlugin>,
+    ];
+    actions: {
+      insertPanel: (inputMethod: INPUT_METHOD) => Command_2;
+    };
+  }
+>;
+
 // @public (undocumented)
 interface PanelPluginConfig {
   // (undocumented)
@@ -1565,6 +1609,11 @@ interface PanelPluginConfig {
   allowCustomPanelEdit?: boolean;
 }
 
+// @public (undocumented)
+interface PanelPluginOptions
+  extends LongPressSelectionPluginOptions,
+    PanelPluginConfig {}
+
 // @public (undocumented)
 type PastePluginOptions = {
   cardOptions?: CardOptions;
@@ -1849,16 +1898,6 @@ export const selectionPluginKey: PluginKey<any>;
 // @public (undocumented)
 interface SelectionPluginOptions extends LongPressSelectionPluginOptions {}
 
-// @public (undocumented)
-export function setBlockType(name: string): Command_2;
-
-// @public (undocumented)
-export function setBlockTypeWithAnalytics(
-  name: string,
-  inputMethod: BlockTypeInputMethod,
-  editorAnalyticsApi: EditorAnalyticsAPI | undefined,
-): Command_2;
-
 // @public (undocumented)
 type SetEditorAPI = (editorApi: PublicPluginAPI<any>) => void;
 

package/tmp/api-report-tmp.d.ts

@@ -17,6 +17,7 @@ import type { AllowedBlockTypes } from '@atlaskit/editor-common/types';
 import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { AnalyticsEventPayload as AnalyticsEventPayload_2 } from '@atlaskit/analytics-next/AnalyticsEvent';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
 import { BrowserFreezetracking } from '@atlaskit/editor-common/types';
 import type { CardOptions } from '@atlaskit/editor-common/card';
@@ -26,6 +27,7 @@ import type { CollabEditOptions } from '@atlaskit/editor-common/collab';
 import { Color } from '@atlaskit/status/element';
 import { Command as Command_2 } from '@atlaskit/editor-common/types';
 import { ComponentType } from 'react';
+import type { compositionPlugin } from '@atlaskit/editor-plugin-composition';
 import type { ConfigWithNodeInfo } from '@atlaskit/editor-plugin-floating-toolbar';
 import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
 import type { ContextUpdateHandler } from '@atlaskit/editor-common/types';
@@ -34,6 +36,7 @@ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { darkModeStatusColorPalette } from '@atlaskit/editor-common/ui-color';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
+import type { decorationsPlugin } from '@atlaskit/editor-plugin-decorations';
 import { dedupe } from '@atlaskit/editor-common/utils';
 import { DEFAULT_BORDER_COLOR } from '@atlaskit/editor-common/ui-color';
 import type { DirectEditorProps } from '@atlaskit/editor-prosemirror/view';
@@ -258,9 +261,6 @@ type BeforeAndAfterToolbarComponents = {
     after: ReactComponents;
 };
 
-// @public (undocumented)
-export const blockPluginStateKey: PluginKey<BlockTypeState>;
-
 // @public (undocumented)
 interface BlockType {
     // (undocumented)
@@ -278,6 +278,17 @@ interface BlockType {
 // @public (undocumented)
 export type BlockTypeInputMethod = INPUT_METHOD.FORMATTING | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.SHORTCUT | INPUT_METHOD.TOOLBAR;
 
+// @public (undocumented)
+export type BlockTypePlugin = NextEditorPlugin<'blockType', {
+    pluginConfiguration: BlockTypePluginOptions | undefined;
+    dependencies: [OptionalPlugin<typeof analyticsPlugin>];
+    sharedState: BlockTypeState | undefined;
+    actions: {
+        insertBlockQuote: (inputMethod: BlockTypeInputMethod) => Command_2;
+        setBlockType: (name: string, inputMethod: BlockTypeInputMethod) => Command_2;
+    };
+}>;
+
 // @public (undocumented)
 interface BlockTypePluginOptions {
     // (undocumented)
@@ -331,6 +342,22 @@ interface CodeBlockOptions extends LongPressSelectionPluginOptions {
     appearance?: EditorAppearance | undefined;
 }
 
+// @public (undocumented)
+export type CodeBlockPlugin = typeof codeBlockPlugin;
+
+// @public (undocumented)
+const codeBlockPlugin: NextEditorPlugin<'codeBlock', {
+    pluginConfiguration: CodeBlockOptions;
+    dependencies: [
+    typeof decorationsPlugin,
+    typeof compositionPlugin,
+    OptionalPlugin<typeof analyticsPlugin>
+    ];
+    actions: {
+        insertCodeBlock: (inputMethod: INPUT_METHOD) => Command_2;
+    };
+}>;
+
 // @public (undocumented)
 export class CollapsedEditor extends React_2.Component<Props, State> {
     // (undocumented)
@@ -1012,12 +1039,6 @@ export { INPUT_METHOD }
 // @public (undocumented)
 export type InsertBlockInputMethodToolbar = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.TOOLBAR;
 
-// @public (undocumented)
-export function insertBlockType(name: string): Command_2;
-
-// @public (undocumented)
-export const insertBlockTypesWithAnalytics: (name: string, inputMethod: BlockTypeInputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Command_2;
-
 // @public (undocumented)
 export const insertDate: (date?: DateType, inputMethod?: InsertBlockInputMethodToolbar, commitMethod?: INPUT_METHOD.KEYBOARD | INPUT_METHOD.PICKER, enterPressed?: boolean) => Command;
 
@@ -1394,6 +1415,21 @@ export const openDatePicker: () => Command;
 
 export { PaletteColor }
 
+// @public (undocumented)
+export type PanelPlugin = typeof panelPlugin;
+
+// @public (undocumented)
+const panelPlugin: NextEditorPlugin<'panel', {
+    pluginConfiguration: PanelPluginOptions | undefined;
+    dependencies: [
+    typeof decorationsPlugin,
+    OptionalPlugin<typeof analyticsPlugin>
+    ];
+    actions: {
+        insertPanel: (inputMethod: INPUT_METHOD) => Command_2;
+    };
+}>;
+
 // @public (undocumented)
 interface PanelPluginConfig {
     // (undocumented)
@@ -1402,6 +1438,10 @@ interface PanelPluginConfig {
     allowCustomPanelEdit?: boolean;
 }
 
+// @public (undocumented)
+interface PanelPluginOptions extends LongPressSelectionPluginOptions, PanelPluginConfig {
+}
+
 // @public (undocumented)
 type PastePluginOptions = {
     cardOptions?: CardOptions;
@@ -1655,12 +1695,6 @@ export const selectionPluginKey: PluginKey<any>;
 interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
 }
 
-// @public (undocumented)
-export function setBlockType(name: string): Command_2;
-
-// @public (undocumented)
-export function setBlockTypeWithAnalytics(name: string, inputMethod: BlockTypeInputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command_2;
-
 // @public (undocumented)
 type SetEditorAPI = (editorApi: PublicPluginAPI<any>) => void;
 

package/dist/cjs/plugins/block-type/commands/insert-block.js

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.insertBlock = void 0;
-var _utils = require("@atlaskit/editor-prosemirror/utils");
-var _state = require("@atlaskit/editor-prosemirror/state");
-var insertBlock = function insertBlock(state, nodeType, nodeName, start, end, attrs) {
-  // To ensure that match is done after HardBreak.
-  var _state$schema$nodes = state.schema.nodes,
-    hardBreak = _state$schema$nodes.hardBreak,
-    codeBlock = _state$schema$nodes.codeBlock,
-    listItem = _state$schema$nodes.listItem;
-  var $pos = state.doc.resolve(start);
-  if ($pos.nodeAfter.type !== hardBreak) {
-    return null;
-  }
-
-  // To ensure no nesting is done. (unless we're inserting a codeBlock inside lists)
-  if ($pos.depth > 1 && !(nodeType === codeBlock && (0, _utils.hasParentNodeOfType)(listItem)(state.selection))) {
-    return null;
-  }
-
-  // Split at the start of autoformatting and delete formatting characters.
-  var tr = state.tr.delete(start, end).split(start);
-  var currentNode = tr.doc.nodeAt(start + 1);
-
-  // If node has more content split at the end of autoformatting.
-  var nodeHasMoreContent = false;
-  tr.doc.nodesBetween(start, start + currentNode.nodeSize, function (node, pos) {
-    if (!nodeHasMoreContent && node.type === hardBreak) {
-      nodeHasMoreContent = true;
-      tr = tr.split(pos + 1).delete(pos, pos + 1);
-    }
-  });
-  if (nodeHasMoreContent) {
-    currentNode = tr.doc.nodeAt(start + 1);
-  }
-
-  // Create new node and fill with content of current node.
-  var _state$schema$nodes2 = state.schema.nodes,
-    blockquote = _state$schema$nodes2.blockquote,
-    paragraph = _state$schema$nodes2.paragraph;
-  var content;
-  var depth;
-  if (nodeType === blockquote) {
-    depth = 3;
-    content = [paragraph.create({}, currentNode.content)];
-  } else {
-    depth = 2;
-    content = currentNode.content;
-  }
-  var newNode = nodeType.create(attrs, content);
-
-  // Add new node.
-  tr = tr.setSelection(new _state.NodeSelection(tr.doc.resolve(start + 1))).replaceSelectionWith(newNode).setSelection(new _state.TextSelection(tr.doc.resolve(start + depth)));
-  return tr;
-};
-exports.insertBlock = insertBlock;

package/dist/es2019/plugins/block-type/commands/insert-block.js

@@ -1,55 +0,0 @@
-import { hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
-import { TextSelection, NodeSelection } from '@atlaskit/editor-prosemirror/state';
-export const insertBlock = (state, nodeType, nodeName, start, end, attrs) => {
-  // To ensure that match is done after HardBreak.
-  const {
-    hardBreak,
-    codeBlock,
-    listItem
-  } = state.schema.nodes;
-  const $pos = state.doc.resolve(start);
-  if ($pos.nodeAfter.type !== hardBreak) {
-    return null;
-  }
-
-  // To ensure no nesting is done. (unless we're inserting a codeBlock inside lists)
-  if ($pos.depth > 1 && !(nodeType === codeBlock && hasParentNodeOfType(listItem)(state.selection))) {
-    return null;
-  }
-
-  // Split at the start of autoformatting and delete formatting characters.
-  let tr = state.tr.delete(start, end).split(start);
-  let currentNode = tr.doc.nodeAt(start + 1);
-
-  // If node has more content split at the end of autoformatting.
-  let nodeHasMoreContent = false;
-  tr.doc.nodesBetween(start, start + currentNode.nodeSize, (node, pos) => {
-    if (!nodeHasMoreContent && node.type === hardBreak) {
-      nodeHasMoreContent = true;
-      tr = tr.split(pos + 1).delete(pos, pos + 1);
-    }
-  });
-  if (nodeHasMoreContent) {
-    currentNode = tr.doc.nodeAt(start + 1);
-  }
-
-  // Create new node and fill with content of current node.
-  const {
-    blockquote,
-    paragraph
-  } = state.schema.nodes;
-  let content;
-  let depth;
-  if (nodeType === blockquote) {
-    depth = 3;
-    content = [paragraph.create({}, currentNode.content)];
-  } else {
-    depth = 2;
-    content = currentNode.content;
-  }
-  const newNode = nodeType.create(attrs, content);
-
-  // Add new node.
-  tr = tr.setSelection(new NodeSelection(tr.doc.resolve(start + 1))).replaceSelectionWith(newNode).setSelection(new TextSelection(tr.doc.resolve(start + depth)));
-  return tr;
-};

package/dist/esm/plugins/block-type/commands/insert-block.js

@@ -1,53 +0,0 @@
-import { hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
-import { TextSelection, NodeSelection } from '@atlaskit/editor-prosemirror/state';
-export var insertBlock = function insertBlock(state, nodeType, nodeName, start, end, attrs) {
-  // To ensure that match is done after HardBreak.
-  var _state$schema$nodes = state.schema.nodes,
-    hardBreak = _state$schema$nodes.hardBreak,
-    codeBlock = _state$schema$nodes.codeBlock,
-    listItem = _state$schema$nodes.listItem;
-  var $pos = state.doc.resolve(start);
-  if ($pos.nodeAfter.type !== hardBreak) {
-    return null;
-  }
-
-  // To ensure no nesting is done. (unless we're inserting a codeBlock inside lists)
-  if ($pos.depth > 1 && !(nodeType === codeBlock && hasParentNodeOfType(listItem)(state.selection))) {
-    return null;
-  }
-
-  // Split at the start of autoformatting and delete formatting characters.
-  var tr = state.tr.delete(start, end).split(start);
-  var currentNode = tr.doc.nodeAt(start + 1);
-
-  // If node has more content split at the end of autoformatting.
-  var nodeHasMoreContent = false;
-  tr.doc.nodesBetween(start, start + currentNode.nodeSize, function (node, pos) {
-    if (!nodeHasMoreContent && node.type === hardBreak) {
-      nodeHasMoreContent = true;
-      tr = tr.split(pos + 1).delete(pos, pos + 1);
-    }
-  });
-  if (nodeHasMoreContent) {
-    currentNode = tr.doc.nodeAt(start + 1);
-  }
-
-  // Create new node and fill with content of current node.
-  var _state$schema$nodes2 = state.schema.nodes,
-    blockquote = _state$schema$nodes2.blockquote,
-    paragraph = _state$schema$nodes2.paragraph;
-  var content;
-  var depth;
-  if (nodeType === blockquote) {
-    depth = 3;
-    content = [paragraph.create({}, currentNode.content)];
-  } else {
-    depth = 2;
-    content = currentNode.content;
-  }
-  var newNode = nodeType.create(attrs, content);
-
-  // Add new node.
-  tr = tr.setSelection(new NodeSelection(tr.doc.resolve(start + 1))).replaceSelectionWith(newNode).setSelection(new TextSelection(tr.doc.resolve(start + depth)));
-  return tr;
-};

package/dist/types/plugins/block-type/commands/insert-block.d.ts

@@ -1,5 +0,0 @@
-import type { NodeType } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-export declare const insertBlock: (state: EditorState, nodeType: NodeType, nodeName: string, start: number, end: number, attrs?: {
-    [key: string]: any;
-} | undefined) => Transaction | null;

package/dist/types-ts4.5/plugins/block-type/commands/insert-block.d.ts

@@ -1,5 +0,0 @@
-import type { NodeType } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-export declare const insertBlock: (state: EditorState, nodeType: NodeType, nodeName: string, start: number, end: number, attrs?: {
-    [key: string]: any;
-} | undefined) => Transaction | null;