@atlaskit/editor-plugin-block-type 2.0.0 → 3.0.1

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

@@ -1,11 +1,13 @@
 import type { EditorAnalyticsAPI, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, HeadingLevelsAndNormalText } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, HeadingLevelsAndNormalText } from '@atlaskit/editor-common/types';
+import type { TextBlockTypes } from '../block-types';
 export type InputMethod = INPUT_METHOD.TOOLBAR | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.SHORTCUT | INPUT_METHOD.FORMATTING | INPUT_METHOD.KEYBOARD;
-export declare function setBlockType(name: string): Command;
-export declare function setBlockTypeWithAnalytics(name: string, inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
-export declare function setNormalText(): Command;
-export declare function setNormalTextWithAnalytics(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
-export declare const setHeadingWithAnalytics: (newHeadingLevel: HeadingLevelsAndNormalText, inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Command;
+export declare function setBlockType(name: TextBlockTypes): EditorCommand;
+export declare function setHeading(level: HeadingLevelsAndNormalText): EditorCommand;
+export declare function setBlockTypeWithAnalytics(name: TextBlockTypes, inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): EditorCommand;
+export declare function setNormalText(): EditorCommand;
+export declare function setNormalTextWithAnalytics(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): EditorCommand;
+export declare const setHeadingWithAnalytics: (newHeadingLevel: HeadingLevelsAndNormalText, inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => EditorCommand;
 /**
  *
  * @param name - block type name

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

@@ -2,8 +2,3 @@ export { cleanUpAtTheStartOfDocument, insertBlockQuoteWithAnalytics, setBlockTyp
 export type { InputMethod } from './block-type';
 export { deleteAndMoveCursor } from './delete-and-move-cursor';
 export { deleteBlockContent } from './delete-block-content';
-/**
- * @private
- * @deprecated use import from @atlaskit/editor-common/commands
- */
-export { setHeading } from '@atlaskit/editor-common/commands';

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

@@ -1,5 +1,6 @@
-import type { Command, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TextBlockTypes } from './block-types';
 import type { InputMethod } from './commands/block-type';
 import type { BlockTypeState } from './pm-plugins/main';
 import type { BlockTypePluginOptions } from './types';
@@ -11,7 +12,9 @@ export type BlockTypePlugin = NextEditorPlugin<'blockType', {
     sharedState: BlockTypeState | undefined;
     actions: {
         insertBlockQuote: (inputMethod: InputMethod) => Command;
-        setBlockType: (name: string, inputMethod: InputMethod) => Command;
+    };
+    commands: {
+        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod) => EditorCommand;
     };
 }>;
 declare const blockTypePlugin: BlockTypePlugin;

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

@@ -1,6 +1,7 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { BlockTypePlugin } from '../index';
 import type { BlockType } from '../types';
 export type BlockTypeState = {
     currentBlockType: BlockType;
@@ -9,7 +10,7 @@ export type BlockTypeState = {
     availableWrapperBlockTypes: BlockType[];
 };
 export declare const pluginKey: PluginKey<BlockTypeState>;
-export declare const createPlugin: (editorAnalyticsApi: EditorAnalyticsAPI | undefined, dispatch: (eventName: string | PluginKey, data: any) => void, lastNodeMustBeParagraph?: boolean) => SafePlugin<{
+export declare const createPlugin: (editorAPI: ExtractInjectionAPI<BlockTypePlugin> | undefined, dispatch: (eventName: string | PluginKey, data: any) => void, lastNodeMustBeParagraph?: boolean) => SafePlugin<{
     currentBlockType: BlockType;
     blockTypesDisabled: boolean;
     availableBlockTypes: BlockType[];

package/dist/types-ts4.5/plugin/ui/ToolbarBlockType/index.d.ts

@@ -3,6 +3,7 @@ import React from 'react';
 import type { WrappedComponentProps } from 'react-intl-next';
 import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { TextBlockTypes } from '../../block-types';
 import type { BlockTypeState } from '../../pm-plugins/main';
 import type { BlockType } from '../../types';
 export type DropdownItem = MenuItem & {
@@ -17,7 +18,7 @@ export interface Props {
     popupsBoundariesElement?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
     editorView?: EditorView;
-    setBlockType: (type: string) => void;
+    setTextLevel: (type: TextBlockTypes) => void;
 }
 export interface State {
     active: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-block-type",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "description": "BlockType plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -38,15 +38,15 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^32.0.0",
-    "@atlaskit/editor-common": "^76.2.0",
-    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-common": "^76.17.0",
+    "@atlaskit/editor-plugin-analytics": "^0.3.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.8.0",
     "@atlaskit/editor-tables": "^2.3.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/prosemirror-input-rules": "^2.4.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.25.0",
+    "@atlaskit/tokens": "^1.28.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },

package/report.api.md

@@ -18,6 +18,7 @@
 import type { AllowedBlockTypes } from '@atlaskit/editor-common/types';
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Command } from '@atlaskit/editor-common/types';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { HeadingLevelsAndNormalText } from '@atlaskit/editor-common/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
@@ -48,7 +49,12 @@ export type BlockTypePlugin = NextEditorPlugin<
     sharedState: BlockTypeState | undefined;
     actions: {
       insertBlockQuote: (inputMethod: InputMethod) => Command;
-      setBlockType: (name: string, inputMethod: InputMethod) => Command;
+    };
+    commands: {
+      setTextLevel: (
+        level: TextBlockTypes,
+        inputMethod: InputMethod,
+      ) => EditorCommand;
     };
   }
 >;
@@ -89,6 +95,16 @@ export type InputMethod =
   | INPUT_METHOD.SHORTCUT
   | INPUT_METHOD.TOOLBAR;
 
+// @public (undocumented)
+export type TextBlockTypes =
+  | 'heading1'
+  | 'heading2'
+  | 'heading3'
+  | 'heading4'
+  | 'heading5'
+  | 'heading6'
+  | 'normal';
+
 // (No @packageDocumentation comment for this package)
 ```
 

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

@@ -7,6 +7,7 @@
 import type { AllowedBlockTypes } from '@atlaskit/editor-common/types';
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Command } from '@atlaskit/editor-common/types';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { HeadingLevelsAndNormalText } from '@atlaskit/editor-common/types';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
@@ -35,7 +36,9 @@ export type BlockTypePlugin = NextEditorPlugin<'blockType', {
     sharedState: BlockTypeState | undefined;
     actions: {
         insertBlockQuote: (inputMethod: InputMethod) => Command;
-        setBlockType: (name: string, inputMethod: InputMethod) => Command;
+    };
+    commands: {
+        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod) => EditorCommand;
     };
 }>;
 
@@ -70,6 +73,9 @@ export type DropdownItem = MenuItem & {
 // @public (undocumented)
 export type InputMethod = INPUT_METHOD.FORMATTING | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.SHORTCUT | INPUT_METHOD.TOOLBAR;
 
+// @public (undocumented)
+export type TextBlockTypes = 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'normal';
+
 // (No @packageDocumentation comment for this package)
 
 ```