@atlaskit/renderer 137.1.3 → 137.1.4

package/dist/esm/ui/utils/expand-search-text.js

@@ -0,0 +1,93 @@
+import { findChildrenByMark } from '@atlaskit/editor-prosemirror/utils';
+
+/**
+ * Minimal structural view of an ADF entity. `parameters.nestedContent` holds raw ADF JSON rather
+ * than ProseMirror nodes, so it cannot be walked with the model API.
+ */
+
+/** Separates text from adjacent blocks so phrases cannot fuse across block boundaries. */
+var BLOCK_SEPARATOR = ' ';
+var asText = function asText(value) {
+  return typeof value === 'string' ? value : '';
+};
+
+/**
+ * Extracts text from raw ADF JSON.
+ *
+ * Needed because some extensions stash a whole ADF subtree in `attrs.parameters.nestedContent`
+ * instead of in their node content — Confluence does this when it coerces nesting the schema
+ * cannot represent (an expand more than two collapsible layers deep, say). Such a node is a
+ * ProseMirror leaf, so the model walk cannot see the subtree even though it renders on the page
+ * via a nested renderer. Recurses, because nestedContent routinely holds further nested content.
+ */
+var _adfEntityText = function adfEntityText(entity) {
+  var _entity$attrs, _entity$content;
+  if (!entity) {
+    return '';
+  }
+  var parts = [];
+  if (entity.type === 'text') {
+    parts.push(asText(entity.text));
+  }
+  var nestedContent = (_entity$attrs = entity.attrs) === null || _entity$attrs === void 0 || (_entity$attrs = _entity$attrs.parameters) === null || _entity$attrs === void 0 ? void 0 : _entity$attrs.nestedContent;
+  if (nestedContent) {
+    // Prefer the real subtree over `attrs.text`, which is only a placeholder label for it.
+    parts.push(_adfEntityText(nestedContent));
+  } else {
+    var _entity$attrs2;
+    parts.push(asText((_entity$attrs2 = entity.attrs) === null || _entity$attrs2 === void 0 ? void 0 : _entity$attrs2.text));
+  }
+  (_entity$content = entity.content) === null || _entity$content === void 0 || _entity$content.forEach(function (child) {
+    return parts.push(_adfEntityText(child));
+  });
+  return parts.filter(Boolean).join(BLOCK_SEPARATOR);
+};
+
+/**
+ * `textBetween` drops every non-text leaf unless the node spec declares `leafText`, and no ADF
+ * node does. Leaves carry their visible text in attrs, so recover it here.
+ */
+var leafText = function leafText(leaf) {
+  var _leaf$attrs, _leaf$attrs2;
+  var nestedContent = (_leaf$attrs = leaf.attrs) === null || _leaf$attrs === void 0 || (_leaf$attrs = _leaf$attrs.parameters) === null || _leaf$attrs === void 0 ? void 0 : _leaf$attrs.nestedContent;
+  if (nestedContent) {
+    return _adfEntityText(nestedContent);
+  }
+  return asText((_leaf$attrs2 = leaf.attrs) === null || _leaf$attrs2 === void 0 ? void 0 : _leaf$attrs2.text);
+};
+var hasInlineComment = function hasInlineComment(node) {
+  return findChildrenByMark(node, node.type.schema.marks.annotation, true).some(function (annotation) {
+    return annotation.node.marks.some(function (mark) {
+      return mark.attrs.annotationType === 'inlineComment';
+    });
+  });
+};
+
+/** `null` is a cached "no mirror for this node", as distinct from `undefined` for a cache miss. */
+var searchTextCache = new WeakMap();
+
+/**
+ * Plain-text mirror of an expand's body, rendered in its place while collapsed so browser
+ * find-in-page can still reach the content.
+ *
+ * Cached on the node. ProseMirror nodes are immutable and `render-document` memoises
+ * `nodeFromJSON`, so the same node instance is reused across renders — including across the
+ * serializer rebuilds that invalidate the module-level `memoizeOne` caches.
+ *
+ * @returns the mirror text, or `undefined` if this expand must keep its body rendered.
+ */
+export var getExpandSearchText = function getExpandSearchText(node) {
+  var cached = searchTextCache.get(node);
+  if (cached === undefined) {
+    cached = hasInlineComment(node) ?
+    // Withhold the mirror, which makes Expand keep rendering `children`. Comment
+    // navigation walks the DOM to find the annotated node and scrolls it into view, so
+    // the annotation has to exist as a real element — a flat text mirror carries no
+    // annotation marks and cannot stand in for it. Without this, stepping through
+    // comments with the arrow keys silently fails to reach any comment inside a
+    // collapsed expand. Costs the lazy-load win for these expands, deliberately.
+    null : node.textBetween(0, node.content.size, BLOCK_SEPARATOR, leafText);
+    searchTextCache.set(node, cached);
+  }
+  return cached !== null && cached !== void 0 ? cached : undefined;
+};

package/dist/types/ui/Expand.d.ts

@@ -1,17 +1,23 @@
 import React from 'react';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { WithIntlProps, WrappedComponentProps } from 'react-intl';
 import type { AnalyticsEventPayload } from '../analytics/events';
 import type { RendererAppearance, RendererContentMode } from './Renderer/types';
 export interface ExpandProps {
     children: React.ReactNode;
     fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
-    loadBodyContent?: boolean;
     localId?: string;
     nestedHeaderIds?: Array<string>;
+    /**
+     * This expand's ProseMirror node. Supplying it opts the expand into lazy body loading: until the
+     * expand is first opened, a plain-text mirror of the body is rendered in place of `children`.
+     * Once opened, `children` stay mounted for the rest of the page's life, including after the
+     * expand is collapsed again (PGXT-9021). Omit it to keep `children` in the DOM at all times.
+     */
+    node?: PMNode;
     nodeType: 'expand' | 'nestedExpand';
     rendererAppearance?: RendererAppearance;
     rendererContentMode?: RendererContentMode;
-    searchText?: string;
     title: string;
 }
 declare const _default_1: React.FC<WithIntlProps<ExpandProps & WrappedComponentProps>> & {

package/dist/types/ui/utils/expand-search-text.d.ts

@@ -0,0 +1,12 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Plain-text mirror of an expand's body, rendered in its place while collapsed so browser
+ * find-in-page can still reach the content.
+ *
+ * Cached on the node. ProseMirror nodes are immutable and `render-document` memoises
+ * `nodeFromJSON`, so the same node instance is reused across renders — including across the
+ * serializer rebuilds that invalidate the module-level `memoizeOne` caches.
+ *
+ * @returns the mirror text, or `undefined` if this expand must keep its body rendered.
+ */
+export declare const getExpandSearchText: (node: PMNode) => string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "137.1.3",
+	"version": "137.1.4",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -40,7 +40,7 @@
 		"@atlaskit/button": "^25.2.0",
 		"@atlaskit/code": "^19.1.0",
 		"@atlaskit/css": "^1.0.0",
-		"@atlaskit/editor-card-provider": "^7.1.0",
+		"@atlaskit/editor-card-provider": "^7.2.0",
 		"@atlaskit/editor-json-transformer": "^9.6.0",
 		"@atlaskit/editor-palette": "^3.4.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
@@ -85,7 +85,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.2.0",
+		"@atlaskit/editor-common": "^120.3.0",
 		"@atlaskit/link-provider": "^5.4.0",
 		"@atlaskit/media-core": "^38.0.0",
 		"react": "^18.2.0",
@@ -252,9 +252,6 @@
 			"type": "boolean",
 			"referenceOnly": true
 		},
-		"platform_editor_video_caption_commit": {
-			"type": "boolean"
-		},
 		"platform-dst-lozenge-tag-badge-visual-uplifts": {
 			"type": "boolean"
 		},