@atlaskit/editor-plugin-block-controls 20.0.3 → 20.1.1

package/dist/types/pm-plugins/utils/sparse-surfaces-state.d.ts

@@ -0,0 +1,27 @@
+import type { BlockControlsSurfaceInvalidation } from '@atlaskit/editor-common/block-controls/surface-candidate-invalidation';
+import type { EditorState, ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { ActiveNode } from '../../blockControlsPluginType';
+import type { SparseSurfaceCandidateState } from './sparse-surface-candidates';
+export type SparseSurfacesState = {
+    activeNodesByPosition: ReadonlyMap<number, ActiveNode>;
+    anchors: ReadonlyMap<number, string>;
+    candidates: SparseSurfaceCandidateState;
+    decorations: DecorationSet;
+    documentChanged: boolean;
+    invalidation?: BlockControlsSurfaceInvalidation;
+};
+export type SparseSurfacesReconciliation = Pick<SparseSurfacesState, 'activeNodesByPosition' | 'anchors' | 'candidates' | 'decorations'>;
+export type SparseSurfacesMeta = {
+    reconciliation: SparseSurfacesReconciliation;
+    type: 'commitReconciliation';
+};
+export declare const createInitialSparseSurfacesState: (candidates: SparseSurfaceCandidateState) => SparseSurfacesState;
+export type ApplySparseSurfacesTransactionInput = {
+    invalidation: BlockControlsSurfaceInvalidation | undefined;
+    meta: SparseSurfacesMeta | undefined;
+    newState: EditorState;
+    previous: SparseSurfacesState;
+    tr: ReadonlyTransaction;
+};
+export declare const applySparseSurfacesTransaction: (input: ApplySparseSurfacesTransactionInput) => SparseSurfacesState;

package/dist/types/pm-plugins/utils/sparse-surfaces-view.d.ts

@@ -0,0 +1,15 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { BlockControlsPlugin } from '../../blockControlsPluginType';
+import type { SparseSurfacesState } from './sparse-surfaces-state';
+type SparseSurfacesPluginView = {
+    destroy: () => void;
+    update: (view: EditorView, previousState: EditorState) => void;
+};
+export declare const createSparseSurfacesView: ({ api, pluginKey, view, }: {
+    api: ExtractInjectionAPI<BlockControlsPlugin> | undefined;
+    pluginKey: PluginKey<SparseSurfacesState>;
+    view: EditorView;
+}) => SparseSurfacesPluginView;
+export {};

package/dist/types/pm-plugins/utils/surface-viewport.d.ts

@@ -0,0 +1,10 @@
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export type SurfaceViewportPositions = readonly number[];
+/**
+ * Tracks block DOM nodes that intersect the browser viewport. The browser owns clipping and
+ * visibility decisions; this helper only translates observer targets back to PM positions.
+ */
+export declare const observeSurfaceViewport: (view: EditorView, onChange: (positions: SurfaceViewportPositions) => void) => {
+    destroy: () => void;
+    update: () => void;
+};

package/dist/types/ui/utils/get-surface-placement.d.ts

@@ -58,11 +58,12 @@ export type SurfaceWrapperPlacement = {
  */
 export declare const toMeasuredSurfaceWrapperPlacement: (placement: SurfacePlacement) => SurfaceWrapperPlacement;
 export type AnchoredSurfacePlacementOptions = {
-    /** The target node's CSS anchor name, i.e. its `data-node-anchor` value. */
+    /** The target node's CSS anchor name, from a sparse marker or native `data-node-anchor`. */
     anchorName: string;
+    layout?: string;
     nodeType: string;
     nodeTypeWithLevel: string;
     parentNodeType?: string;
     side: SurfaceSide;
 };
-export declare const getAnchoredSurfacePlacement: ({ anchorName, nodeType, nodeTypeWithLevel, parentNodeType, side, }: AnchoredSurfacePlacementOptions) => SurfaceWrapperPlacement;
+export declare const getAnchoredSurfacePlacement: ({ anchorName, layout, nodeType, nodeTypeWithLevel, parentNodeType, side, }: AnchoredSurfacePlacementOptions) => SurfaceWrapperPlacement;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-controls",
-	"version": "20.0.3",
+	"version": "20.1.1",
 	"description": "Block controls plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -26,7 +26,7 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/browser-apis": "^1.2.0",
-		"@atlaskit/button": "^25.3.0",
+		"@atlaskit/button": "^25.4.0",
 		"@atlaskit/css": "^1.1.0",
 		"@atlaskit/docs": "^12.2.0",
 		"@atlaskit/editor-plugin-accessibility-utils": "^19.0.0",
@@ -43,13 +43,13 @@
 		"@atlaskit/editor-plugin-show-diff": "^17.1.0",
 		"@atlaskit/editor-plugin-toolbar": "^16.0.0",
 		"@atlaskit/editor-plugin-type-ahead": "^20.0.0",
-		"@atlaskit/editor-plugin-ui-control-registry": "^13.0.0",
+		"@atlaskit/editor-plugin-ui-control-registry": "^13.1.0",
 		"@atlaskit/editor-plugin-user-intent": "^17.0.0",
 		"@atlaskit/editor-plugin-width": "^20.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@atlaskit/editor-shared-styles": "^4.3.0",
 		"@atlaskit/editor-tables": "^3.2.0",
-		"@atlaskit/editor-ui-control-model": "^2.9.0",
+		"@atlaskit/editor-ui-control-model": "^2.10.0",
 		"@atlaskit/icon": "^37.7.0",
 		"@atlaskit/icon-lab": "^7.9.0",
 		"@atlaskit/link": "^5.1.0",
@@ -61,7 +61,7 @@
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/section-message": "^10.2.0",
 		"@atlaskit/theme": "^28.2.0",
-		"@atlaskit/tmp-editor-statsig": "^201.0.0",
+		"@atlaskit/tmp-editor-statsig": "^202.0.0",
 		"@atlaskit/tokens": "^18.2.0",
 		"@atlaskit/tooltip": "^24.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -73,7 +73,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^123.2.0",
+		"@atlaskit/editor-common": "^123.5.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"

package/dist/cjs/pm-plugins/utils/surface-node-positions.js

@@ -1,100 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.updateSurfaceNodePositions = exports.getSurfaceNodePositions = void 0;
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-var _blockControlUiContext = require("@atlaskit/editor-common/block-controls/block-control-ui-context");
-var _createSurfaceContext = require("@atlaskit/editor-ui-control-model/create-surface-context");
-var _surfaceRenderer = require("@atlaskit/editor-ui-control-model/surface-renderer");
-var _blockControlsSurfaceContext = require("../../ui/block-controls-surface-context");
-var _hasSurfaceControls = require("../../ui/utils/has-surface-controls");
-var createSurfaceContextAtPosition = function createSurfaceContextAtPosition(state, position, activeNode) {
-  var blockControlsContext = (0, _blockControlsSurfaceContext.createBlockControlsSurfaceContextForPosition)(state, position, activeNode);
-  return blockControlsContext ? (0, _createSurfaceContext.createSurfaceContext)(_blockControlUiContext.BLOCK_CONTROL_UI_CONTEXT, blockControlsContext) : undefined;
-};
-
-/**
- * A position qualifies as soon as ANY of the given surfaces would render something for it.
- * The surface context depends only on state/position/activeNode, not on which surface is being
- * checked, so it's built once here rather than once per surface inside the `.some()`.
- */
-var willAnySurfaceRenderAt = function willAnySurfaceRenderAt(surfaces, state, position, activeNode) {
-  var surfaceContext = createSurfaceContextAtPosition(state, position, activeNode);
-  return surfaces.some(function (_ref) {
-    var childrenMap = _ref.childrenMap,
-      root = _ref.root;
-    return (0, _surfaceRenderer.willComponentRender)(root, childrenMap, surfaceContext);
-  });
-};
-var getSurfaceNodePositions = exports.getSurfaceNodePositions = function getSurfaceNodePositions(state, resolvedSurfaces, activeNode) {
-  var from = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
-  var to = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : state.doc.content.size;
-  var surfaces = resolvedSurfaces.flatMap(function (_ref2) {
-    var childrenMap = _ref2.childrenMap,
-      components = _ref2.components,
-      root = _ref2.root;
-    return root && (0, _hasSurfaceControls.hasSurfaceControls)(components) ? [{
-      childrenMap: childrenMap,
-      root: root
-    }] : [];
-  });
-  if (surfaces.length === 0) {
-    return [];
-  }
-  var positions = [];
-  var start = Math.max(0, from);
-  var end = Math.min(state.doc.content.size, Math.max(start, to));
-  state.doc.nodesBetween(start, end, function (node, position) {
-    if (node.isBlock && willAnySurfaceRenderAt(surfaces, state, position, activeNode)) {
-      positions.push(position);
-    }
-  });
-  return positions;
-};
-var hasActiveNodeChanged = function hasActiveNodeChanged(previousActiveNode, activeNode) {
-  return (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.pos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.pos) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.nodeType) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.nodeType) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.rootPos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.rootPos);
-};
-var updateSurfaceNodePositions = exports.updateSurfaceNodePositions = function updateSurfaceNodePositions(_ref3) {
-  var activeNode = _ref3.activeNode,
-    currentPositions = _ref3.currentPositions,
-    from = _ref3.from,
-    newState = _ref3.newState,
-    previousActiveNode = _ref3.previousActiveNode,
-    resolvedSurfaces = _ref3.resolvedSurfaces,
-    to = _ref3.to,
-    tr = _ref3.tr;
-  var activeNodeChanged = hasActiveNodeChanged(previousActiveNode, activeNode);
-  if (!tr.docChanged && !activeNodeChanged) {
-    return currentPositions;
-  }
-  var nextActiveNode = activeNode !== null && activeNode !== void 0 ? activeNode : undefined;
-  if (activeNodeChanged) {
-    return getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode);
-  }
-  var surfaces = resolvedSurfaces.flatMap(function (_ref4) {
-    var childrenMap = _ref4.childrenMap,
-      components = _ref4.components,
-      root = _ref4.root;
-    return root && (0, _hasSurfaceControls.hasSurfaceControls)(components) ? [{
-      childrenMap: childrenMap,
-      root: root
-    }] : [];
-  });
-  var mappedPositions = currentPositions.map(function (position) {
-    return tr.mapping.mapResult(position, -1);
-  }).filter(function (result) {
-    return !result.deleted;
-  }).map(function (result) {
-    return result.pos;
-  }).filter(function (position) {
-    var node = newState.doc.nodeAt(position);
-    return Boolean((node === null || node === void 0 ? void 0 : node.isBlock) && willAnySurfaceRenderAt(surfaces, newState, position, nextActiveNode));
-  });
-  var changedPositions = getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode, from - 1, to + 1);
-  return Array.from(new Set([].concat((0, _toConsumableArray2.default)(mappedPositions), (0, _toConsumableArray2.default)(changedPositions)))).sort(function (first, second) {
-    return first - second;
-  });
-};

package/dist/es2019/pm-plugins/utils/surface-node-positions.js

@@ -1,78 +0,0 @@
-import { BLOCK_CONTROL_UI_CONTEXT } from '@atlaskit/editor-common/block-controls/block-control-ui-context';
-import { createSurfaceContext } from '@atlaskit/editor-ui-control-model/create-surface-context';
-import { willComponentRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
-import { createBlockControlsSurfaceContextForPosition } from '../../ui/block-controls-surface-context';
-import { hasSurfaceControls } from '../../ui/utils/has-surface-controls';
-const createSurfaceContextAtPosition = (state, position, activeNode) => {
-  const blockControlsContext = createBlockControlsSurfaceContextForPosition(state, position, activeNode);
-  return blockControlsContext ? createSurfaceContext(BLOCK_CONTROL_UI_CONTEXT, blockControlsContext) : undefined;
-};
-
-/**
- * A position qualifies as soon as ANY of the given surfaces would render something for it.
- * The surface context depends only on state/position/activeNode, not on which surface is being
- * checked, so it's built once here rather than once per surface inside the `.some()`.
- */
-const willAnySurfaceRenderAt = (surfaces, state, position, activeNode) => {
-  const surfaceContext = createSurfaceContextAtPosition(state, position, activeNode);
-  return surfaces.some(({
-    childrenMap,
-    root
-  }) => willComponentRender(root, childrenMap, surfaceContext));
-};
-export const getSurfaceNodePositions = (state, resolvedSurfaces, activeNode, from = 0, to = state.doc.content.size) => {
-  const surfaces = resolvedSurfaces.flatMap(({
-    childrenMap,
-    components,
-    root
-  }) => root && hasSurfaceControls(components) ? [{
-    childrenMap,
-    root
-  }] : []);
-  if (surfaces.length === 0) {
-    return [];
-  }
-  const positions = [];
-  const start = Math.max(0, from);
-  const end = Math.min(state.doc.content.size, Math.max(start, to));
-  state.doc.nodesBetween(start, end, (node, position) => {
-    if (node.isBlock && willAnySurfaceRenderAt(surfaces, state, position, activeNode)) {
-      positions.push(position);
-    }
-  });
-  return positions;
-};
-const hasActiveNodeChanged = (previousActiveNode, activeNode) => (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.pos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.pos) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.nodeType) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.nodeType) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.rootPos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.rootPos);
-export const updateSurfaceNodePositions = ({
-  activeNode,
-  currentPositions,
-  from,
-  newState,
-  previousActiveNode,
-  resolvedSurfaces,
-  to,
-  tr
-}) => {
-  const activeNodeChanged = hasActiveNodeChanged(previousActiveNode, activeNode);
-  if (!tr.docChanged && !activeNodeChanged) {
-    return currentPositions;
-  }
-  const nextActiveNode = activeNode !== null && activeNode !== void 0 ? activeNode : undefined;
-  if (activeNodeChanged) {
-    return getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode);
-  }
-  const surfaces = resolvedSurfaces.flatMap(({
-    childrenMap,
-    components,
-    root
-  }) => root && hasSurfaceControls(components) ? [{
-    childrenMap,
-    root
-  }] : []);
-  const mappedPositions = currentPositions.map(position => tr.mapping.mapResult(position, -1)).filter(result => !result.deleted).map(result => result.pos).filter(position => {
-    const node = newState.doc.nodeAt(position);
-    return Boolean((node === null || node === void 0 ? void 0 : node.isBlock) && willAnySurfaceRenderAt(surfaces, newState, position, nextActiveNode));
-  });
-  const changedPositions = getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode, from - 1, to + 1);
-  return Array.from(new Set([...mappedPositions, ...changedPositions])).sort((first, second) => first - second);
-};

package/dist/esm/pm-plugins/utils/surface-node-positions.js

@@ -1,93 +0,0 @@
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-import { BLOCK_CONTROL_UI_CONTEXT } from '@atlaskit/editor-common/block-controls/block-control-ui-context';
-import { createSurfaceContext } from '@atlaskit/editor-ui-control-model/create-surface-context';
-import { willComponentRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
-import { createBlockControlsSurfaceContextForPosition } from '../../ui/block-controls-surface-context';
-import { hasSurfaceControls } from '../../ui/utils/has-surface-controls';
-var createSurfaceContextAtPosition = function createSurfaceContextAtPosition(state, position, activeNode) {
-  var blockControlsContext = createBlockControlsSurfaceContextForPosition(state, position, activeNode);
-  return blockControlsContext ? createSurfaceContext(BLOCK_CONTROL_UI_CONTEXT, blockControlsContext) : undefined;
-};
-
-/**
- * A position qualifies as soon as ANY of the given surfaces would render something for it.
- * The surface context depends only on state/position/activeNode, not on which surface is being
- * checked, so it's built once here rather than once per surface inside the `.some()`.
- */
-var willAnySurfaceRenderAt = function willAnySurfaceRenderAt(surfaces, state, position, activeNode) {
-  var surfaceContext = createSurfaceContextAtPosition(state, position, activeNode);
-  return surfaces.some(function (_ref) {
-    var childrenMap = _ref.childrenMap,
-      root = _ref.root;
-    return willComponentRender(root, childrenMap, surfaceContext);
-  });
-};
-export var getSurfaceNodePositions = function getSurfaceNodePositions(state, resolvedSurfaces, activeNode) {
-  var from = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
-  var to = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : state.doc.content.size;
-  var surfaces = resolvedSurfaces.flatMap(function (_ref2) {
-    var childrenMap = _ref2.childrenMap,
-      components = _ref2.components,
-      root = _ref2.root;
-    return root && hasSurfaceControls(components) ? [{
-      childrenMap: childrenMap,
-      root: root
-    }] : [];
-  });
-  if (surfaces.length === 0) {
-    return [];
-  }
-  var positions = [];
-  var start = Math.max(0, from);
-  var end = Math.min(state.doc.content.size, Math.max(start, to));
-  state.doc.nodesBetween(start, end, function (node, position) {
-    if (node.isBlock && willAnySurfaceRenderAt(surfaces, state, position, activeNode)) {
-      positions.push(position);
-    }
-  });
-  return positions;
-};
-var hasActiveNodeChanged = function hasActiveNodeChanged(previousActiveNode, activeNode) {
-  return (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.pos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.pos) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.nodeType) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.nodeType) || (previousActiveNode === null || previousActiveNode === void 0 ? void 0 : previousActiveNode.rootPos) !== (activeNode === null || activeNode === void 0 ? void 0 : activeNode.rootPos);
-};
-export var updateSurfaceNodePositions = function updateSurfaceNodePositions(_ref3) {
-  var activeNode = _ref3.activeNode,
-    currentPositions = _ref3.currentPositions,
-    from = _ref3.from,
-    newState = _ref3.newState,
-    previousActiveNode = _ref3.previousActiveNode,
-    resolvedSurfaces = _ref3.resolvedSurfaces,
-    to = _ref3.to,
-    tr = _ref3.tr;
-  var activeNodeChanged = hasActiveNodeChanged(previousActiveNode, activeNode);
-  if (!tr.docChanged && !activeNodeChanged) {
-    return currentPositions;
-  }
-  var nextActiveNode = activeNode !== null && activeNode !== void 0 ? activeNode : undefined;
-  if (activeNodeChanged) {
-    return getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode);
-  }
-  var surfaces = resolvedSurfaces.flatMap(function (_ref4) {
-    var childrenMap = _ref4.childrenMap,
-      components = _ref4.components,
-      root = _ref4.root;
-    return root && hasSurfaceControls(components) ? [{
-      childrenMap: childrenMap,
-      root: root
-    }] : [];
-  });
-  var mappedPositions = currentPositions.map(function (position) {
-    return tr.mapping.mapResult(position, -1);
-  }).filter(function (result) {
-    return !result.deleted;
-  }).map(function (result) {
-    return result.pos;
-  }).filter(function (position) {
-    var node = newState.doc.nodeAt(position);
-    return Boolean((node === null || node === void 0 ? void 0 : node.isBlock) && willAnySurfaceRenderAt(surfaces, newState, position, nextActiveNode));
-  });
-  var changedPositions = getSurfaceNodePositions(newState, resolvedSurfaces, nextActiveNode, from - 1, to + 1);
-  return Array.from(new Set([].concat(_toConsumableArray(mappedPositions), _toConsumableArray(changedPositions)))).sort(function (first, second) {
-    return first - second;
-  });
-};

package/dist/types/pm-plugins/utils/surface-node-positions.d.ts

@@ -1,14 +0,0 @@
-import type { EditorState, ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import type { ResolvedSurface } from '@atlaskit/editor-ui-control-model/surface-renderer/types';
-import type { ActiveNode } from '../../blockControlsPluginType';
-export declare const getSurfaceNodePositions: (state: EditorState, resolvedSurfaces: readonly ResolvedSurface[], activeNode?: ActiveNode, from?: number, to?: number) => number[];
-export declare const updateSurfaceNodePositions: ({ activeNode, currentPositions, from, newState, previousActiveNode, resolvedSurfaces, to, tr, }: {
-    activeNode: ActiveNode | null | undefined;
-    currentPositions: number[];
-    from: number;
-    newState: EditorState;
-    previousActiveNode: ActiveNode | null | undefined;
-    resolvedSurfaces: readonly ResolvedSurface[];
-    to: number;
-    tr: ReadonlyTransaction;
-}) => number[];