@atlaskit/editor-plugin-block-menu 5.2.2 → 5.2.4

package/dist/types-ts4.5/editor-commands/transform-node-utils/steps/listToListStep.d.ts

@@ -0,0 +1,65 @@
+import type { TransformStep } from '../types';
+/**
+ * Transform step that converts between bulletList, orderedList, and taskList types.
+ * This step maintains the order and indentation of the list by recursively
+ * converting all nested lists while preserving the structure. It also handles
+ * conversion between listItem and taskItem types.
+ *
+ * When converting to taskList/taskItem, unsupported content (images, codeBlocks) is filtered out.
+ *
+ * @example
+ * Input (bulletList with nested bulletList):
+ * - bulletList
+ *   - listItem "1"
+ *     - bulletList
+ *       - listItem "1.1"
+ *         - bulletList
+ *           - listItem "1.1.1"
+ *       - listItem "1.2"
+ *   - listItem "2"
+ *
+ * Output (orderedList with nested orderedList):
+ * 1. orderedList
+ *    1. listItem "1"
+ *       1. orderedList
+ *          1. listItem "1.1"
+ *             1. orderedList
+ *                1. listItem "1.1.1"
+ *          2. listItem "1.2"
+ *    2. listItem "2"
+ *
+ * @example
+ * Input (bulletList with nested taskList):
+ * - bulletList
+ *   - listItem "Regular item"
+ *     - taskList
+ *       - taskItem "Task 1" (checked)
+ *       - taskItem "Task 2" (unchecked)
+ *
+ * Output (orderedList with nested orderedList, taskItems converted to listItems):
+ * 1. orderedList
+ *    1. listItem "Regular item"
+ *       1. orderedList
+ *          1. listItem "Task 1"
+ *          2. listItem "Task 2"
+ *
+ * @example
+ * Input (bulletList to taskList, with paragraph extraction):
+ * - bulletList
+ *   - listItem
+ *     - paragraph "Text content"
+ *   - listItem
+ *     - paragraph "Text"
+ *     - codeBlock "code"
+ *     - mediaSingle (image)
+ *
+ * Output (taskList with text extracted from paragraphs, unsupported content filtered):
+ * - taskList
+ *   - taskItem "Text content" (text extracted from paragraph)
+ *   - taskItem "Text" (text extracted, codeBlock and image filtered out)
+ *
+ * @param nodes - The nodes to transform
+ * @param context - The transformation context containing schema and target node type
+ * @returns The transformed nodes
+ */
+export declare const listToListStep: TransformStep;

package/dist/types-ts4.5/editor-commands/transform-node-utils/{unwrapListStep.d.ts → steps/unwrapListStep.d.ts}

@@ -1,4 +1,4 @@
-import type { TransformStep } from './types';
+import type { TransformStep } from '../types';
 /**
  * Given an array of nodes, processes each list removing all parent list nodes and
  * just returning their child contents.

package/dist/types-ts4.5/editor-commands/transform-node-utils/{wrapMixedContentStep.d.ts → steps/wrapMixedContentStep.d.ts}

@@ -1,4 +1,4 @@
-import type { TransformStep } from './types';
+import type { TransformStep } from '../types';
 /**
  * A wrap step that handles mixed content according to the Compatibility Matrix:
  * - Wraps consecutive compatible nodes into the target container

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "5.2.2",
+	"version": "5.2.4",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/dist/cjs/editor-commands/transform-node-utils/steps/convertBulletListToTextStep.js

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.convertBulletListToTextStep = void 0;
-var _createListToTextStep = require("./createListToTextStep");
-/**
- * Given an array of nodes, processes each bullet list by converting its items
- * to paragraphs with "- " prefix.
- *
- * Handles nested bullet lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - bulletList()(
- *     listItem()(p()('Item 1')),
- *     bulletList()(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('- Item 1')
- * - p()('   - Sub item 1')
- */
-var convertBulletListToTextStep = exports.convertBulletListToTextStep = (0, _createListToTextStep.createListToTextStep)({
-  listTypeName: 'bulletList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: function getPrefix() {
-    return '- ';
-  },
-  unwrapParagraphContent: true
-});

package/dist/cjs/editor-commands/transform-node-utils/steps/convertOrderedListToTextStep.js

@@ -1,62 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.convertOrderedListToTextStep = void 0;
-var _createListToTextStep = require("./createListToTextStep");
-/**
- * Converts a number to a letter (1=a, 2=b, etc.)
- * For numbers > 26, continues with aa, ab, etc.
- */
-var numberToLetter = function numberToLetter(num) {
-  var result = '';
-  var n = num;
-  while (n > 0) {
-    n--;
-    result = String.fromCharCode(97 + n % 26) + result;
-    n = Math.floor(n / 26);
-  }
-  return result;
-};
-
-/**
- * Gets the appropriate prefix for an ordered list item based on depth and index.
- * - Level 0: "1. ", "2. ", "3. ", etc.
- * - Level 1+: "a. ", "b. ", "c. ", etc.
- */
-var getOrderedListPrefix = function getOrderedListPrefix(depth, index) {
-  if (depth === 0) {
-    return "".concat(index, ". ");
-  }
-  return "".concat(numberToLetter(index), ". ");
-};
-
-/**
- * Given an array of nodes, processes each ordered list by converting its items
- * to paragraphs with numbered prefixes (1., 2., 3.) at the top level and
- * lettered prefixes (a., b., c.) for nested levels.
- *
- * Handles nested ordered lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - orderedList({ order: 1 })(
- *     listItem()(p()('Item 1')),
- *     orderedList({ order: 1 })(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('1. Item 1')
- * - p()('   a. Sub item 1')
- */
-var convertOrderedListToTextStep = exports.convertOrderedListToTextStep = (0, _createListToTextStep.createListToTextStep)({
-  listTypeName: 'orderedList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: function getPrefix(depth, index) {
-    return getOrderedListPrefix(depth, index);
-  },
-  unwrapParagraphContent: true
-});

package/dist/cjs/editor-commands/transform-node-utils/steps/convertTaskListToTextStep.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.convertTaskListToTextStep = void 0;
-var _createListToTextStep = require("./createListToTextStep");
-/**
- * Given an array of nodes, processes each task list by converting its items
- * to paragraphs with a checkbox prefix. Uses "[] " for unchecked (TODO) tasks
- * and "[x] " for checked (DONE) tasks.
- *
- * Handles nested task lists recursively with 4-space indentation per level.
- *
- * This is used when converting a task list to a container that doesn't support
- * task items (like blockquote).
- *
- * @example
- * Input:
- * - taskList()(
- *     taskItem({ state: 'TODO' })('Task list item'),
- *     taskList()(taskItem({ state: 'DONE' })('Nested done task'))
- *   )
- *
- * Output:
- * - p()('[] Task list item')
- * - p()('    [x] Nested done task')
- */
-var convertTaskListToTextStep = exports.convertTaskListToTextStep = (0, _createListToTextStep.createListToTextStep)({
-  listTypeName: 'taskList',
-  itemTypeName: 'taskItem',
-  indent: '    ',
-  // 4 spaces per nesting level
-  getPrefix: function getPrefix(_, __, itemNode) {
-    var _itemNode$attrs;
-    return ((_itemNode$attrs = itemNode.attrs) === null || _itemNode$attrs === void 0 ? void 0 : _itemNode$attrs.state) === 'DONE' ? '[x] ' : '[] ';
-  },
-  unwrapParagraphContent: false
-});

package/dist/cjs/editor-commands/transform-node-utils/steps/createListToTextStep.js

@@ -1,90 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createListToTextStep = void 0;
-var _model = require("@atlaskit/editor-prosemirror/model");
-/**
- * Configuration for creating a list-to-text transformation step.
- */
-
-/**
- * Recursively extracts list items from a list (including nested lists)
- * and converts them to paragraphs with configurable prefixes and indentation.
- */
-var extractListItemsAsParagraphs = function extractListItemsAsParagraphs(node, schema, config) {
-  var paragraphs = [];
-  var paragraphType = schema.nodes.paragraph;
-  var listType = schema.nodes[config.listTypeName];
-  var itemType = schema.nodes[config.itemTypeName];
-  var _extract = function extract(currentNode) {
-    var depth = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    var itemIndex = 0;
-    currentNode.forEach(function (child) {
-      if (child.type === itemType) {
-        itemIndex++;
-        var indent = config.indent.repeat(depth);
-        var prefix = config.getPrefix(depth, itemIndex, child);
-        var listPrefix = schema.text("".concat(indent).concat(prefix));
-
-        // Collect inline content and nested lists separately
-        var inlineContent = [];
-        var nestedLists = [];
-        child.forEach(function (grandChild) {
-          if (grandChild.type === listType) {
-            nestedLists.push(grandChild);
-          } else if (config.unwrapParagraphContent && grandChild.type === paragraphType) {
-            // Extract content from paragraph nodes
-            grandChild.forEach(function (content) {
-              inlineContent.push(content);
-            });
-          } else {
-            inlineContent.push(grandChild);
-          }
-        });
-
-        // Create paragraph with prefix + inline content
-        if (inlineContent.length > 0) {
-          var newContent = _model.Fragment.from(listPrefix).append(_model.Fragment.fromArray(inlineContent));
-          var newParagraph = paragraphType.create({}, newContent);
-          paragraphs.push(newParagraph);
-        }
-
-        // Recursively process nested lists with increased depth
-        nestedLists.forEach(function (nestedList) {
-          _extract(nestedList, depth + 1);
-        });
-      } else if (child.type === listType) {
-        // Handle list that appears directly as a sibling
-        _extract(child, depth + 1);
-      }
-    });
-  };
-  _extract(node, 0);
-  return paragraphs;
-};
-
-/**
- * Creates a TransformStep that converts a list to paragraphs with text prefixes.
- *
- * Given an array of nodes, processes each list by converting its items
- * to paragraphs with configurable prefixes.
- *
- * Handles nested lists recursively with configurable indentation per level.
- *
- * @param config - Configuration for the list-to-text transformation
- * @returns A TransformStep function
- */
-var createListToTextStep = exports.createListToTextStep = function createListToTextStep(config) {
-  return function (nodes, context) {
-    var schema = context.schema;
-    var listType = schema.nodes[config.listTypeName];
-    return nodes.flatMap(function (node) {
-      if (node.type === listType) {
-        return extractListItemsAsParagraphs(node, schema, config);
-      }
-      return node;
-    });
-  };
-};

package/dist/es2019/editor-commands/transform-node-utils/steps/convertBulletListToTextStep.js

@@ -1,27 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Given an array of nodes, processes each bullet list by converting its items
- * to paragraphs with "- " prefix.
- *
- * Handles nested bullet lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - bulletList()(
- *     listItem()(p()('Item 1')),
- *     bulletList()(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('- Item 1')
- * - p()('   - Sub item 1')
- */
-export const convertBulletListToTextStep = createListToTextStep({
-  listTypeName: 'bulletList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: () => '- ',
-  unwrapParagraphContent: true
-});

package/dist/es2019/editor-commands/transform-node-utils/steps/convertOrderedListToTextStep.js

@@ -1,55 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Converts a number to a letter (1=a, 2=b, etc.)
- * For numbers > 26, continues with aa, ab, etc.
- */
-const numberToLetter = num => {
-  let result = '';
-  let n = num;
-  while (n > 0) {
-    n--;
-    result = String.fromCharCode(97 + n % 26) + result;
-    n = Math.floor(n / 26);
-  }
-  return result;
-};
-
-/**
- * Gets the appropriate prefix for an ordered list item based on depth and index.
- * - Level 0: "1. ", "2. ", "3. ", etc.
- * - Level 1+: "a. ", "b. ", "c. ", etc.
- */
-const getOrderedListPrefix = (depth, index) => {
-  if (depth === 0) {
-    return `${index}. `;
-  }
-  return `${numberToLetter(index)}. `;
-};
-
-/**
- * Given an array of nodes, processes each ordered list by converting its items
- * to paragraphs with numbered prefixes (1., 2., 3.) at the top level and
- * lettered prefixes (a., b., c.) for nested levels.
- *
- * Handles nested ordered lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - orderedList({ order: 1 })(
- *     listItem()(p()('Item 1')),
- *     orderedList({ order: 1 })(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('1. Item 1')
- * - p()('   a. Sub item 1')
- */
-export const convertOrderedListToTextStep = createListToTextStep({
-  listTypeName: 'orderedList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: (depth, index) => getOrderedListPrefix(depth, index),
-  unwrapParagraphContent: true
-});

package/dist/es2019/editor-commands/transform-node-utils/steps/convertTaskListToTextStep.js

@@ -1,34 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Given an array of nodes, processes each task list by converting its items
- * to paragraphs with a checkbox prefix. Uses "[] " for unchecked (TODO) tasks
- * and "[x] " for checked (DONE) tasks.
- *
- * Handles nested task lists recursively with 4-space indentation per level.
- *
- * This is used when converting a task list to a container that doesn't support
- * task items (like blockquote).
- *
- * @example
- * Input:
- * - taskList()(
- *     taskItem({ state: 'TODO' })('Task list item'),
- *     taskList()(taskItem({ state: 'DONE' })('Nested done task'))
- *   )
- *
- * Output:
- * - p()('[] Task list item')
- * - p()('    [x] Nested done task')
- */
-export const convertTaskListToTextStep = createListToTextStep({
-  listTypeName: 'taskList',
-  itemTypeName: 'taskItem',
-  indent: '    ',
-  // 4 spaces per nesting level
-  getPrefix: (_, __, itemNode) => {
-    var _itemNode$attrs;
-    return ((_itemNode$attrs = itemNode.attrs) === null || _itemNode$attrs === void 0 ? void 0 : _itemNode$attrs.state) === 'DONE' ? '[x] ' : '[] ';
-  },
-  unwrapParagraphContent: false
-});

package/dist/es2019/editor-commands/transform-node-utils/steps/createListToTextStep.js

@@ -1,86 +0,0 @@
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
-
-/**
- * Configuration for creating a list-to-text transformation step.
- */
-
-/**
- * Recursively extracts list items from a list (including nested lists)
- * and converts them to paragraphs with configurable prefixes and indentation.
- */
-const extractListItemsAsParagraphs = (node, schema, config) => {
-  const paragraphs = [];
-  const paragraphType = schema.nodes.paragraph;
-  const listType = schema.nodes[config.listTypeName];
-  const itemType = schema.nodes[config.itemTypeName];
-  const extract = (currentNode, depth = 0) => {
-    let itemIndex = 0;
-    currentNode.forEach(child => {
-      if (child.type === itemType) {
-        itemIndex++;
-        const indent = config.indent.repeat(depth);
-        const prefix = config.getPrefix(depth, itemIndex, child);
-        const listPrefix = schema.text(`${indent}${prefix}`);
-
-        // Collect inline content and nested lists separately
-        const inlineContent = [];
-        const nestedLists = [];
-        child.forEach(grandChild => {
-          if (grandChild.type === listType) {
-            nestedLists.push(grandChild);
-          } else if (config.unwrapParagraphContent && grandChild.type === paragraphType) {
-            // Extract content from paragraph nodes
-            grandChild.forEach(content => {
-              inlineContent.push(content);
-            });
-          } else {
-            inlineContent.push(grandChild);
-          }
-        });
-
-        // Create paragraph with prefix + inline content
-        if (inlineContent.length > 0) {
-          const newContent = Fragment.from(listPrefix).append(Fragment.fromArray(inlineContent));
-          const newParagraph = paragraphType.create({}, newContent);
-          paragraphs.push(newParagraph);
-        }
-
-        // Recursively process nested lists with increased depth
-        nestedLists.forEach(nestedList => {
-          extract(nestedList, depth + 1);
-        });
-      } else if (child.type === listType) {
-        // Handle list that appears directly as a sibling
-        extract(child, depth + 1);
-      }
-    });
-  };
-  extract(node, 0);
-  return paragraphs;
-};
-
-/**
- * Creates a TransformStep that converts a list to paragraphs with text prefixes.
- *
- * Given an array of nodes, processes each list by converting its items
- * to paragraphs with configurable prefixes.
- *
- * Handles nested lists recursively with configurable indentation per level.
- *
- * @param config - Configuration for the list-to-text transformation
- * @returns A TransformStep function
- */
-export const createListToTextStep = config => {
-  return (nodes, context) => {
-    const {
-      schema
-    } = context;
-    const listType = schema.nodes[config.listTypeName];
-    return nodes.flatMap(node => {
-      if (node.type === listType) {
-        return extractListItemsAsParagraphs(node, schema, config);
-      }
-      return node;
-    });
-  };
-};

package/dist/esm/editor-commands/transform-node-utils/steps/convertBulletListToTextStep.js

@@ -1,29 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Given an array of nodes, processes each bullet list by converting its items
- * to paragraphs with "- " prefix.
- *
- * Handles nested bullet lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - bulletList()(
- *     listItem()(p()('Item 1')),
- *     bulletList()(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('- Item 1')
- * - p()('   - Sub item 1')
- */
-export var convertBulletListToTextStep = createListToTextStep({
-  listTypeName: 'bulletList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: function getPrefix() {
-    return '- ';
-  },
-  unwrapParagraphContent: true
-});

package/dist/esm/editor-commands/transform-node-utils/steps/convertOrderedListToTextStep.js

@@ -1,57 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Converts a number to a letter (1=a, 2=b, etc.)
- * For numbers > 26, continues with aa, ab, etc.
- */
-var numberToLetter = function numberToLetter(num) {
-  var result = '';
-  var n = num;
-  while (n > 0) {
-    n--;
-    result = String.fromCharCode(97 + n % 26) + result;
-    n = Math.floor(n / 26);
-  }
-  return result;
-};
-
-/**
- * Gets the appropriate prefix for an ordered list item based on depth and index.
- * - Level 0: "1. ", "2. ", "3. ", etc.
- * - Level 1+: "a. ", "b. ", "c. ", etc.
- */
-var getOrderedListPrefix = function getOrderedListPrefix(depth, index) {
-  if (depth === 0) {
-    return "".concat(index, ". ");
-  }
-  return "".concat(numberToLetter(index), ". ");
-};
-
-/**
- * Given an array of nodes, processes each ordered list by converting its items
- * to paragraphs with numbered prefixes (1., 2., 3.) at the top level and
- * lettered prefixes (a., b., c.) for nested levels.
- *
- * Handles nested ordered lists recursively with 3-space indentation per level.
- *
- * @example
- * Input:
- * - orderedList({ order: 1 })(
- *     listItem()(p()('Item 1')),
- *     orderedList({ order: 1 })(listItem()(p()('Sub item 1')))
- *   )
- *
- * Output:
- * - p()('1. Item 1')
- * - p()('   a. Sub item 1')
- */
-export var convertOrderedListToTextStep = createListToTextStep({
-  listTypeName: 'orderedList',
-  itemTypeName: 'listItem',
-  indent: '   ',
-  // 3 spaces per nesting level
-  getPrefix: function getPrefix(depth, index) {
-    return getOrderedListPrefix(depth, index);
-  },
-  unwrapParagraphContent: true
-});

package/dist/esm/editor-commands/transform-node-utils/steps/convertTaskListToTextStep.js

@@ -1,34 +0,0 @@
-import { createListToTextStep } from './createListToTextStep';
-
-/**
- * Given an array of nodes, processes each task list by converting its items
- * to paragraphs with a checkbox prefix. Uses "[] " for unchecked (TODO) tasks
- * and "[x] " for checked (DONE) tasks.
- *
- * Handles nested task lists recursively with 4-space indentation per level.
- *
- * This is used when converting a task list to a container that doesn't support
- * task items (like blockquote).
- *
- * @example
- * Input:
- * - taskList()(
- *     taskItem({ state: 'TODO' })('Task list item'),
- *     taskList()(taskItem({ state: 'DONE' })('Nested done task'))
- *   )
- *
- * Output:
- * - p()('[] Task list item')
- * - p()('    [x] Nested done task')
- */
-export var convertTaskListToTextStep = createListToTextStep({
-  listTypeName: 'taskList',
-  itemTypeName: 'taskItem',
-  indent: '    ',
-  // 4 spaces per nesting level
-  getPrefix: function getPrefix(_, __, itemNode) {
-    var _itemNode$attrs;
-    return ((_itemNode$attrs = itemNode.attrs) === null || _itemNode$attrs === void 0 ? void 0 : _itemNode$attrs.state) === 'DONE' ? '[x] ' : '[] ';
-  },
-  unwrapParagraphContent: false
-});