@atlaskit/editor-plugin-indentation 3.1.6 → 3.2.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/editor-plugin-indentation
 
+## 3.2.1
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
+## 3.2.0
+
+### Minor Changes
+
+- [`d2a535bed291e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2a535bed291e) -
+  [EDITOR-1153] Let the `editor-plugin-indentation` handle `paragraphs` when they are selected in a
+  range with `blockTaskItem`, but don't indent the `paragraphs` inside `blockTaskItem`s
+
+### Patch Changes
+
+- [`d2a535bed291e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2a535bed291e) -
+  [EDITOR-1153] Make sure that Tab works for range selections for `blockTaskItem`
+- Updated dependencies
+
 ## 3.1.6
 
 ### Patch Changes

package/dist/cjs/pm-plugins/keymap.js

@@ -17,17 +17,24 @@ function keymapPlugin(editorAnalyticsAPI) {
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   (0, _keymaps.findShortcutByKeymap)(_keymaps.indent), function (state, dispatch) {
-    var blockTaskItem = state.schema.nodes.blockTaskItem;
+    var _state$schema$nodes = state.schema.nodes,
+      blockTaskItem = _state$schema$nodes.blockTaskItem,
+      paragraph = _state$schema$nodes.paragraph,
+      doc = _state$schema$nodes.doc;
     if (blockTaskItem) {
       var hasBlockTaskItem = false;
+      var hasParagraphAtDocLevel = false;
       // Check if the selection contains a blockTaskItem
-      state.doc.nodesBetween(state.selection.from, state.selection.to, function (node) {
+      state.doc.nodesBetween(state.selection.from, state.selection.to, function (node, _pos, parent) {
         if (node.type === blockTaskItem) {
           hasBlockTaskItem = true;
           return false; // stop iterating
         }
+        if (node.type === paragraph && (parent === null || parent === void 0 ? void 0 : parent.type) === doc) {
+          hasParagraphAtDocLevel = true;
+        }
       });
-      if (hasBlockTaskItem) {
+      if (hasBlockTaskItem && !hasParagraphAtDocLevel) {
         return false; // let `editor-plugin-tasks-and-decisions` handle indentation
       }
     }

package/dist/es2019/pm-plugins/keymap.js

@@ -11,18 +11,24 @@ export function keymapPlugin(editorAnalyticsAPI) {
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   findShortcutByKeymap(indent), (state, dispatch) => {
     const {
-      blockTaskItem
+      blockTaskItem,
+      paragraph,
+      doc
     } = state.schema.nodes;
     if (blockTaskItem) {
       let hasBlockTaskItem = false;
+      let hasParagraphAtDocLevel = false;
       // Check if the selection contains a blockTaskItem
-      state.doc.nodesBetween(state.selection.from, state.selection.to, node => {
+      state.doc.nodesBetween(state.selection.from, state.selection.to, (node, _pos, parent) => {
         if (node.type === blockTaskItem) {
           hasBlockTaskItem = true;
           return false; // stop iterating
         }
+        if (node.type === paragraph && (parent === null || parent === void 0 ? void 0 : parent.type) === doc) {
+          hasParagraphAtDocLevel = true;
+        }
       });
-      if (hasBlockTaskItem) {
+      if (hasBlockTaskItem && !hasParagraphAtDocLevel) {
         return false; // let `editor-plugin-tasks-and-decisions` handle indentation
       }
     }

package/dist/esm/pm-plugins/keymap.js

@@ -10,17 +10,24 @@ export function keymapPlugin(editorAnalyticsAPI) {
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   findShortcutByKeymap(indent), function (state, dispatch) {
-    var blockTaskItem = state.schema.nodes.blockTaskItem;
+    var _state$schema$nodes = state.schema.nodes,
+      blockTaskItem = _state$schema$nodes.blockTaskItem,
+      paragraph = _state$schema$nodes.paragraph,
+      doc = _state$schema$nodes.doc;
     if (blockTaskItem) {
       var hasBlockTaskItem = false;
+      var hasParagraphAtDocLevel = false;
       // Check if the selection contains a blockTaskItem
-      state.doc.nodesBetween(state.selection.from, state.selection.to, function (node) {
+      state.doc.nodesBetween(state.selection.from, state.selection.to, function (node, _pos, parent) {
         if (node.type === blockTaskItem) {
           hasBlockTaskItem = true;
           return false; // stop iterating
         }
+        if (node.type === paragraph && (parent === null || parent === void 0 ? void 0 : parent.type) === doc) {
+          hasParagraphAtDocLevel = true;
+        }
       });
-      if (hasBlockTaskItem) {
+      if (hasBlockTaskItem && !hasParagraphAtDocLevel) {
         return false; // let `editor-plugin-tasks-and-decisions` handle indentation
       }
     }

package/dist/types/editor-commands/utils.d.ts

@@ -29,9 +29,9 @@ export declare function getPrevIndentLevel(prevAttrs: PrevAttributes): number;
  * @returns
  */
 export declare function createAnalyticsDispatch({ getAttrsChanges, inputMethod, editorAnalyticsAPI, state, dispatch, }: {
+    dispatch?: (tr: Transaction) => void;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     getAttrsChanges: () => GetAttrsChange<IndentationMarkAttributes, IndentationChangesOptions>[];
     inputMethod: IndentationInputMethod;
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     state: EditorState;
-    dispatch?: (tr: Transaction) => void;
 }): (tr: Transaction) => void;

package/dist/types/indentationPluginType.d.ts

@@ -3,8 +3,8 @@ import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { IndentationInputMethod } from './editor-commands/utils';
 type IndentationPluginSharedState = {
-    isIndentationAllowed: boolean;
     indentDisabled: boolean;
+    isIndentationAllowed: boolean;
     outdentDisabled: boolean;
 };
 export type IndentationPluginDependencies = [OptionalPlugin<AnalyticsPlugin>];
@@ -13,18 +13,18 @@ export type IndentationPluginActions = {
     outdentParagraphOrHeading: (inputMethod: IndentationInputMethod) => Command;
 };
 export type IndentationPlugin = NextEditorPlugin<'indentation', {
-    dependencies: IndentationPluginDependencies;
     actions: IndentationPluginActions;
+    dependencies: IndentationPluginDependencies;
     sharedState: IndentationPluginSharedState | undefined;
 }>;
 export interface GetAttrsChange<T, V> {
-    node: Node;
-    prevAttrs?: T;
     newAttrs: T | false | undefined;
+    node: Node;
     options: V;
+    prevAttrs?: T;
 }
 export type GetAttrsWithChangesRecorder<T, V> = {
-    getAttrs(prevAttrs?: T | undefined, node?: Node): T | false | undefined;
     getAndResetAttrsChanges(): GetAttrsChange<T, V>[];
+    getAttrs(prevAttrs?: T | undefined, node?: Node): T | false | undefined;
 };
 export {};

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

@@ -29,9 +29,9 @@ export declare function getPrevIndentLevel(prevAttrs: PrevAttributes): number;
  * @returns
  */
 export declare function createAnalyticsDispatch({ getAttrsChanges, inputMethod, editorAnalyticsAPI, state, dispatch, }: {
+    dispatch?: (tr: Transaction) => void;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     getAttrsChanges: () => GetAttrsChange<IndentationMarkAttributes, IndentationChangesOptions>[];
     inputMethod: IndentationInputMethod;
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     state: EditorState;
-    dispatch?: (tr: Transaction) => void;
 }): (tr: Transaction) => void;

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

@@ -3,8 +3,8 @@ import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { IndentationInputMethod } from './editor-commands/utils';
 type IndentationPluginSharedState = {
-    isIndentationAllowed: boolean;
     indentDisabled: boolean;
+    isIndentationAllowed: boolean;
     outdentDisabled: boolean;
 };
 export type IndentationPluginDependencies = [
@@ -15,18 +15,18 @@ export type IndentationPluginActions = {
     outdentParagraphOrHeading: (inputMethod: IndentationInputMethod) => Command;
 };
 export type IndentationPlugin = NextEditorPlugin<'indentation', {
-    dependencies: IndentationPluginDependencies;
     actions: IndentationPluginActions;
+    dependencies: IndentationPluginDependencies;
     sharedState: IndentationPluginSharedState | undefined;
 }>;
 export interface GetAttrsChange<T, V> {
-    node: Node;
-    prevAttrs?: T;
     newAttrs: T | false | undefined;
+    node: Node;
     options: V;
+    prevAttrs?: T;
 }
 export type GetAttrsWithChangesRecorder<T, V> = {
-    getAttrs(prevAttrs?: T | undefined, node?: Node): T | false | undefined;
     getAndResetAttrsChanges(): GetAttrsChange<T, V>[];
+    getAttrs(prevAttrs?: T | undefined, node?: Node): T | false | undefined;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-indentation",
-	"version": "3.1.6",
+	"version": "3.2.1",
 	"description": "Indentation plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,7 +36,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.27.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
@@ -44,7 +44,6 @@
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"wait-for-expect": "^1.2.0"
 	},