@atlaskit/renderer 151.0.0 → 151.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/renderer
 
+## 151.0.1
+
+### Patch Changes
+
+- [`0dacb94545d03`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0dacb94545d03) -
+  Behind cc_maui_annotations_on_extensions: fire the cc_maui_comments_on_charts_exp exposure only
+  where the chart Comment button can show. Adds an optional viewModeEditorToolbarItems UiConfig
+  hook, used by MAUI charts to show Comment in the view-mode toolbar (live pages), and a
+  getAddCommentPermission annotation plugin action, used to disable the chart Comment button without
+  comment permission. The full-page renderer checks extension comment creation on first hover or
+  focus instead of while rendering.
+
 ## 151.0.0
 
 ### Minor Changes

package/dist/cjs/react/nodes/extension.js

@@ -9,6 +9,7 @@ exports.renderExtension = exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = _interopRequireWildcard(require("react"));
 var _react2 = require("@emotion/react");
 var _enums = require("@atlaskit/editor-common/analytics/types/enums");
@@ -212,35 +213,72 @@ var ExtensionWithAnnotations = function ExtensionWithAnnotations(props) {
     return Boolean(props.extensionNode && (isBlockNodeSupported === null || isBlockNodeSupported === void 0 ? void 0 : isBlockNodeSupported(props.extensionNode)) === true);
   }, [props.extensionNode, isBlockNodeSupported]);
   var canCreateCommentOnBlockNode = providers === null || providers === void 0 || (_providers$inlineComm2 = providers.inlineComment) === null || _providers$inlineComm2 === void 0 ? void 0 : _providers$inlineComm2.canCreateCommentOnBlockNode;
-  var isCommentTarget = (0, _react.useMemo)(function () {
-    return Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateCommentOnBlockNode(props.extensionNode)));
-  }, [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   var isFullPageRenderer = props.rendererAppearance === 'full-page' || props.rendererAppearance === 'full-width';
+  // The creation policy may fire an experiment exposure. In the full-page renderer it is only
+  // checked once the user hovers or focuses the extension, where the comment target appears.
+  // Other renderers have no hover entry point, so they keep checking during render. Saved
+  // threads stay viewable through `supportsComments`.
+  // Only an allowed result is stored. A rejection is not cached because it can be temporary (for
+  // example before Statsig initializes), so the check runs again on the next hover or focus.
+  var _useState = (0, _react.useState)(),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    allowedCommentNode = _useState2[0],
+    setAllowedCommentNode = _useState2[1];
+  var canCreateDuringRender = (0, _react.useMemo)(function () {
+    return !isFullPageRenderer && Boolean(supportsComments && props.extensionNode && (canCreateCommentOnBlockNode === null || canCreateCommentOnBlockNode === void 0 ? void 0 : canCreateCommentOnBlockNode(props.extensionNode)));
+  }, [isFullPageRenderer, supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
+  var isCommentTarget = Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateDuringRender || allowedCommentNode === props.extensionNode));
+  var isCommentTargetRef = (0, _react.useRef)(isCommentTarget);
+  isCommentTargetRef.current = isCommentTarget;
+  var resolveCommentTarget = (0, _react.useCallback)(function (target) {
+    if (isCommentTargetRef.current) {
+      return true;
+    }
+    var node = props.extensionNode;
+    if (!supportsComments || !node || !canCreateCommentOnBlockNode || !canCreateCommentOnBlockNode(node)) {
+      return false;
+    }
+    // The hover target is matched against this attribute before React re-renders, so set it
+    // now; the batched render below writes the same value.
+    target.dataset.inlineCommentsTarget = 'true';
+    isCommentTargetRef.current = true;
+    setAllowedCommentNode(node);
+    return true;
+  }, [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   var onMouseEnter = (0, _react.useCallback)(function (event) {
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     if (event.buttons === 0) {
       setHoverTarget === null || setHoverTarget === void 0 || setHoverTarget(event.currentTarget);
       setIsWithinRange(true);
     }
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
   var onMouseLeave = (0, _react.useCallback)(function () {
-    return initiateTimeout();
+    if (isCommentTargetRef.current) {
+      initiateTimeout();
+    }
   }, [initiateTimeout]);
   var onFocus = (0, _react.useCallback)(function (event) {
     if (event.currentTarget.contains(event.relatedTarget)) {
       return;
     }
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     setHoverTarget === null || setHoverTarget === void 0 || setHoverTarget(event.currentTarget);
     setIsWithinRange(true);
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
   var onBlur = (0, _react.useCallback)(function (event) {
-    if (!event.currentTarget.contains(event.relatedTarget)) {
+    if (isCommentTargetRef.current && !event.currentTarget.contains(event.relatedTarget)) {
       initiateTimeout();
     }
   }, [initiateTimeout]);
-  var commentTargetOptions = isCommentTarget && isFullPageRenderer ? {
-    isCommentTarget: true,
+  // Listen whenever comments are supported, so the first hover or focus can check creation.
+  var commentTargetOptions = supportsComments && isFullPageRenderer ? {
+    isCommentTarget: isCommentTarget,
     onBlur: onBlur,
     onFocus: onFocus,
     onMouseEnter: onMouseEnter,

package/dist/cjs/ui/Renderer/index.js

@@ -79,7 +79,7 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "150.0.7";
+var packageVersion = "151.0.1";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/es2019/react/nodes/extension.js

@@ -4,7 +4,7 @@ import _extends from "@babel/runtime/helpers/extends";
  * @jsx jsx
  */
 
-import React, { useCallback, useContext, useEffect, useMemo, useRef } from 'react';
+import React, { useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { jsx, css } from '@emotion/react';
@@ -190,31 +190,67 @@ const ExtensionWithAnnotations = props => {
   const isBlockNodeSupported = providers === null || providers === void 0 ? void 0 : (_providers$inlineComm = providers.inlineComment) === null || _providers$inlineComm === void 0 ? void 0 : _providers$inlineComm.isBlockNodeSupported;
   const supportsComments = useMemo(() => Boolean(props.extensionNode && (isBlockNodeSupported === null || isBlockNodeSupported === void 0 ? void 0 : isBlockNodeSupported(props.extensionNode)) === true), [props.extensionNode, isBlockNodeSupported]);
   const canCreateCommentOnBlockNode = providers === null || providers === void 0 ? void 0 : (_providers$inlineComm2 = providers.inlineComment) === null || _providers$inlineComm2 === void 0 ? void 0 : _providers$inlineComm2.canCreateCommentOnBlockNode;
-  const isCommentTarget = useMemo(() => Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateCommentOnBlockNode(props.extensionNode))), [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   const isFullPageRenderer = props.rendererAppearance === 'full-page' || props.rendererAppearance === 'full-width';
+  // The creation policy may fire an experiment exposure. In the full-page renderer it is only
+  // checked once the user hovers or focuses the extension, where the comment target appears.
+  // Other renderers have no hover entry point, so they keep checking during render. Saved
+  // threads stay viewable through `supportsComments`.
+  // Only an allowed result is stored. A rejection is not cached because it can be temporary (for
+  // example before Statsig initializes), so the check runs again on the next hover or focus.
+  const [allowedCommentNode, setAllowedCommentNode] = useState();
+  const canCreateDuringRender = useMemo(() => !isFullPageRenderer && Boolean(supportsComments && props.extensionNode && (canCreateCommentOnBlockNode === null || canCreateCommentOnBlockNode === void 0 ? void 0 : canCreateCommentOnBlockNode(props.extensionNode))), [isFullPageRenderer, supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
+  const isCommentTarget = Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateDuringRender || allowedCommentNode === props.extensionNode));
+  const isCommentTargetRef = useRef(isCommentTarget);
+  isCommentTargetRef.current = isCommentTarget;
+  const resolveCommentTarget = useCallback(target => {
+    if (isCommentTargetRef.current) {
+      return true;
+    }
+    const node = props.extensionNode;
+    if (!supportsComments || !node || !canCreateCommentOnBlockNode || !canCreateCommentOnBlockNode(node)) {
+      return false;
+    }
+    // The hover target is matched against this attribute before React re-renders, so set it
+    // now; the batched render below writes the same value.
+    target.dataset.inlineCommentsTarget = 'true';
+    isCommentTargetRef.current = true;
+    setAllowedCommentNode(node);
+    return true;
+  }, [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   const onMouseEnter = useCallback(event => {
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     if (event.buttons === 0) {
       setHoverTarget === null || setHoverTarget === void 0 ? void 0 : setHoverTarget(event.currentTarget);
       setIsWithinRange(true);
     }
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
-  const onMouseLeave = useCallback(() => initiateTimeout(), [initiateTimeout]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
+  const onMouseLeave = useCallback(() => {
+    if (isCommentTargetRef.current) {
+      initiateTimeout();
+    }
+  }, [initiateTimeout]);
   const onFocus = useCallback(event => {
     if (event.currentTarget.contains(event.relatedTarget)) {
       return;
     }
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     setHoverTarget === null || setHoverTarget === void 0 ? void 0 : setHoverTarget(event.currentTarget);
     setIsWithinRange(true);
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
   const onBlur = useCallback(event => {
-    if (!event.currentTarget.contains(event.relatedTarget)) {
+    if (isCommentTargetRef.current && !event.currentTarget.contains(event.relatedTarget)) {
       initiateTimeout();
     }
   }, [initiateTimeout]);
-  const commentTargetOptions = isCommentTarget && isFullPageRenderer ? {
-    isCommentTarget: true,
+  // Listen whenever comments are supported, so the first hover or focus can check creation.
+  const commentTargetOptions = supportsComments && isFullPageRenderer ? {
+    isCommentTarget,
     onBlur,
     onFocus,
     onMouseEnter,

package/dist/es2019/ui/Renderer/index.js

@@ -64,7 +64,7 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const TABLE_INFO_TIMEOUT = 10000;
 const RENDER_EVENT_SAMPLE_RATE = 0.1;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "150.0.7";
+const packageVersion = "151.0.1";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/esm/react/nodes/extension.js

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var _excluded = ["commentProps", "commentTargetOptions"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -9,7 +10,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  * @jsx jsx
  */
 
-import React, { useCallback, useContext, useEffect, useMemo, useRef } from 'react';
+import React, { useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { jsx, css } from '@emotion/react';
@@ -205,35 +206,72 @@ var ExtensionWithAnnotations = function ExtensionWithAnnotations(props) {
     return Boolean(props.extensionNode && (isBlockNodeSupported === null || isBlockNodeSupported === void 0 ? void 0 : isBlockNodeSupported(props.extensionNode)) === true);
   }, [props.extensionNode, isBlockNodeSupported]);
   var canCreateCommentOnBlockNode = providers === null || providers === void 0 || (_providers$inlineComm2 = providers.inlineComment) === null || _providers$inlineComm2 === void 0 ? void 0 : _providers$inlineComm2.canCreateCommentOnBlockNode;
-  var isCommentTarget = useMemo(function () {
-    return Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateCommentOnBlockNode(props.extensionNode)));
-  }, [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   var isFullPageRenderer = props.rendererAppearance === 'full-page' || props.rendererAppearance === 'full-width';
+  // The creation policy may fire an experiment exposure. In the full-page renderer it is only
+  // checked once the user hovers or focuses the extension, where the comment target appears.
+  // Other renderers have no hover entry point, so they keep checking during render. Saved
+  // threads stay viewable through `supportsComments`.
+  // Only an allowed result is stored. A rejection is not cached because it can be temporary (for
+  // example before Statsig initializes), so the check runs again on the next hover or focus.
+  var _useState = useState(),
+    _useState2 = _slicedToArray(_useState, 2),
+    allowedCommentNode = _useState2[0],
+    setAllowedCommentNode = _useState2[1];
+  var canCreateDuringRender = useMemo(function () {
+    return !isFullPageRenderer && Boolean(supportsComments && props.extensionNode && (canCreateCommentOnBlockNode === null || canCreateCommentOnBlockNode === void 0 ? void 0 : canCreateCommentOnBlockNode(props.extensionNode)));
+  }, [isFullPageRenderer, supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
+  var isCommentTarget = Boolean(supportsComments && props.extensionNode && (!canCreateCommentOnBlockNode || canCreateDuringRender || allowedCommentNode === props.extensionNode));
+  var isCommentTargetRef = useRef(isCommentTarget);
+  isCommentTargetRef.current = isCommentTarget;
+  var resolveCommentTarget = useCallback(function (target) {
+    if (isCommentTargetRef.current) {
+      return true;
+    }
+    var node = props.extensionNode;
+    if (!supportsComments || !node || !canCreateCommentOnBlockNode || !canCreateCommentOnBlockNode(node)) {
+      return false;
+    }
+    // The hover target is matched against this attribute before React re-renders, so set it
+    // now; the batched render below writes the same value.
+    target.dataset.inlineCommentsTarget = 'true';
+    isCommentTargetRef.current = true;
+    setAllowedCommentNode(node);
+    return true;
+  }, [supportsComments, props.extensionNode, canCreateCommentOnBlockNode]);
   var onMouseEnter = useCallback(function (event) {
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     if (event.buttons === 0) {
       setHoverTarget === null || setHoverTarget === void 0 || setHoverTarget(event.currentTarget);
       setIsWithinRange(true);
     }
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
   var onMouseLeave = useCallback(function () {
-    return initiateTimeout();
+    if (isCommentTargetRef.current) {
+      initiateTimeout();
+    }
   }, [initiateTimeout]);
   var onFocus = useCallback(function (event) {
     if (event.currentTarget.contains(event.relatedTarget)) {
       return;
     }
+    if (!resolveCommentTarget(event.currentTarget)) {
+      return;
+    }
     cancelTimeout();
     setHoverTarget === null || setHoverTarget === void 0 || setHoverTarget(event.currentTarget);
     setIsWithinRange(true);
-  }, [cancelTimeout, setHoverTarget, setIsWithinRange]);
+  }, [cancelTimeout, resolveCommentTarget, setHoverTarget, setIsWithinRange]);
   var onBlur = useCallback(function (event) {
-    if (!event.currentTarget.contains(event.relatedTarget)) {
+    if (isCommentTargetRef.current && !event.currentTarget.contains(event.relatedTarget)) {
       initiateTimeout();
     }
   }, [initiateTimeout]);
-  var commentTargetOptions = isCommentTarget && isFullPageRenderer ? {
-    isCommentTarget: true,
+  // Listen whenever comments are supported, so the first hover or focus can check creation.
+  var commentTargetOptions = supportsComments && isFullPageRenderer ? {
+    isCommentTarget: isCommentTarget,
     onBlur: onBlur,
     onFocus: onFocus,
     onMouseEnter: onMouseEnter,

package/dist/esm/ui/Renderer/index.js

@@ -69,7 +69,7 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "150.0.7";
+var packageVersion = "151.0.1";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "151.0.0",
+	"version": "151.0.1",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"