@atlaskit/editor-plugin-card 0.14.23 → 0.14.24

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-card
 
+## 0.14.24
+
+### Patch Changes
+
+- [#63549](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63549) [`c2147cd56a94`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c2147cd56a94) - Fix inconsistency of discoverability pulse
+- Updated dependencies
+
 ## 0.14.23
 
 ### Patch Changes

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

@@ -94,14 +94,16 @@ var AwarenessWrapper = exports.AwarenessWrapper = function AwarenessWrapper(_ref
     return (0, _react2.jsx)("span", {
       css: shouldShowLinkPulse && loaderWrapperStyles,
       className: "card"
-    }, shouldShowLinkPulse ? (0, _react2.jsx)(_analyticsNext.AnalyticsContext, {
+    }, (0, _react2.jsx)(_analyticsNext.AnalyticsContext, {
       data: {
         attributes: (0, _utils.getResolvedAttributesFromStore)(url, 'inline', cardContext === null || cardContext === void 0 || (_cardContext$value = cardContext.value) === null || _cardContext$value === void 0 ? void 0 : _cardContext$value.store)
       }
     }, (0, _react2.jsx)(_Pulse.DiscoveryPulse, {
       localStorageKey: _localStorage.LOCAL_STORAGE_DISCOVERY_KEY_SMART_LINK,
       localStorageKeyExpirationInMs: _localStorage.ONE_DAY_IN_MILLISECONDS,
-      discoveryMode: "start"
-    }, cardWithOverlay)) : cardWithOverlay);
-  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 || (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, cardWithOverlay]);
+      discoveryMode: "start",
+      shouldShowPulse: isResolvedViewRendered && shouldShowLinkPulse,
+      testId: "link-discovery-pulse"
+    }, cardWithOverlay)));
+  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 || (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, isResolvedViewRendered, cardWithOverlay]);
 };

package/dist/cjs/ui/LinkToolbarAppearance.js

@@ -135,7 +135,8 @@ var LinkToolbarAppearance = exports.LinkToolbarAppearance = /*#__PURE__*/functio
             attributes: _objectSpread({}, resolvedAnalyticsAttributes)
           }
         }, /*#__PURE__*/_react.default.createElement(_Pulse.DiscoveryPulse, {
-          localStorageKey: _localStorage.LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR
+          localStorageKey: _localStorage.LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR,
+          testId: "toolbar-discovery-pulse"
         }, LinkToolbarButtons));
       }
       return LinkToolbarButtons;

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

@@ -14,15 +14,17 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 var DiscoveryPulse = exports.DiscoveryPulse = function DiscoveryPulse(_ref) {
   var children = _ref.children,
     localStorageKey = _ref.localStorageKey,
-    isDiscovered = _ref.isDiscovered,
     localStorageKeyExpirationInMs = _ref.localStorageKeyExpirationInMs,
     _ref$discoveryMode = _ref.discoveryMode,
-    discoveryMode = _ref$discoveryMode === void 0 ? 'iteration' : _ref$discoveryMode;
-  var discovered = isDiscovered || (0, _localStorage.isLocalStorageKeyDiscovered)(localStorageKey);
+    discoveryMode = _ref$discoveryMode === void 0 ? 'iteration' : _ref$discoveryMode,
+    shouldShowPulse = _ref.shouldShowPulse,
+    testId = _ref.testId;
+  var discovered = (0, _localStorage.isLocalStorageKeyDiscovered)(localStorageKey);
+  var showPulse = shouldShowPulse !== null && shouldShowPulse !== void 0 ? shouldShowPulse : !discovered;
   var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
     createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
   (0, _react.useEffect)(function () {
-    if (!discovered) {
+    if (showPulse) {
       createAnalyticsEvent({
         action: 'viewed',
         actionSubject: 'pulse',
@@ -32,16 +34,16 @@ var DiscoveryPulse = exports.DiscoveryPulse = function DiscoveryPulse(_ref) {
         }
       }).fire('media');
     }
-  }, [createAnalyticsEvent, discovered, localStorageKey]);
+  }, [createAnalyticsEvent, discovered, localStorageKey, showPulse]);
   var onDiscovery = (0, _react.useCallback)(function () {
     if (!discovered) {
       (0, _localStorage.markLocalStorageKeyDiscovered)(localStorageKey, localStorageKeyExpirationInMs);
     }
   }, [discovered, localStorageKey, localStorageKeyExpirationInMs]);
-  var pulseProps = {
-    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+  return /*#__PURE__*/_react.default.createElement(_linkingCommon.Pulse, {
     onAnimationIteration: discoveryMode === 'iteration' ? onDiscovery : undefined,
-    isDiscovered: discovered
-  };
-  return /*#__PURE__*/_react.default.createElement(_linkingCommon.Pulse, pulseProps, children);
+    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+    showPulse: showPulse,
+    testId: testId
+  }, children);
 };

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

@@ -78,14 +78,16 @@ export const AwarenessWrapper = ({
     return jsx("span", {
       css: shouldShowLinkPulse && loaderWrapperStyles,
       className: "card"
-    }, shouldShowLinkPulse ? jsx(AnalyticsContext, {
+    }, jsx(AnalyticsContext, {
       data: {
         attributes: getResolvedAttributesFromStore(url, 'inline', cardContext === null || cardContext === void 0 ? void 0 : (_cardContext$value = cardContext.value) === null || _cardContext$value === void 0 ? void 0 : _cardContext$value.store)
       }
     }, jsx(DiscoveryPulse, {
       localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_SMART_LINK,
       localStorageKeyExpirationInMs: ONE_DAY_IN_MILLISECONDS,
-      discoveryMode: "start"
-    }, cardWithOverlay)) : cardWithOverlay);
-  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 ? void 0 : (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, cardWithOverlay]);
+      discoveryMode: "start",
+      shouldShowPulse: isResolvedViewRendered && shouldShowLinkPulse,
+      testId: "link-discovery-pulse"
+    }, cardWithOverlay)));
+  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 ? void 0 : (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, isResolvedViewRendered, cardWithOverlay]);
 };

package/dist/es2019/ui/LinkToolbarAppearance.js

@@ -106,7 +106,8 @@ export class LinkToolbarAppearance extends React.Component {
             }
           }
         }, /*#__PURE__*/React.createElement(DiscoveryPulse, {
-          localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR
+          localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR,
+          testId: "toolbar-discovery-pulse"
         }, LinkToolbarButtons));
       }
       return LinkToolbarButtons;

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

@@ -5,16 +5,18 @@ import { isLocalStorageKeyDiscovered, markLocalStorageKeyDiscovered } from '../.
 export const DiscoveryPulse = ({
   children,
   localStorageKey,
-  isDiscovered,
   localStorageKeyExpirationInMs,
-  discoveryMode = 'iteration'
+  discoveryMode = 'iteration',
+  shouldShowPulse,
+  testId
 }) => {
-  const discovered = isDiscovered || isLocalStorageKeyDiscovered(localStorageKey);
+  const discovered = isLocalStorageKeyDiscovered(localStorageKey);
+  const showPulse = shouldShowPulse !== null && shouldShowPulse !== void 0 ? shouldShowPulse : !discovered;
   const {
     createAnalyticsEvent
   } = useAnalyticsEvents();
   useEffect(() => {
-    if (!discovered) {
+    if (showPulse) {
       createAnalyticsEvent({
         action: 'viewed',
         actionSubject: 'pulse',
@@ -24,16 +26,16 @@ export const DiscoveryPulse = ({
         }
       }).fire('media');
     }
-  }, [createAnalyticsEvent, discovered, localStorageKey]);
+  }, [createAnalyticsEvent, discovered, localStorageKey, showPulse]);
   const onDiscovery = useCallback(() => {
     if (!discovered) {
       markLocalStorageKeyDiscovered(localStorageKey, localStorageKeyExpirationInMs);
     }
   }, [discovered, localStorageKey, localStorageKeyExpirationInMs]);
-  const pulseProps = {
-    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+  return /*#__PURE__*/React.createElement(Pulse, {
     onAnimationIteration: discoveryMode === 'iteration' ? onDiscovery : undefined,
-    isDiscovered: discovered
-  };
-  return /*#__PURE__*/React.createElement(Pulse, pulseProps, children);
+    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+    showPulse: showPulse,
+    testId: testId
+  }, children);
 };

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

@@ -86,14 +86,16 @@ export var AwarenessWrapper = function AwarenessWrapper(_ref) {
     return jsx("span", {
       css: shouldShowLinkPulse && loaderWrapperStyles,
       className: "card"
-    }, shouldShowLinkPulse ? jsx(AnalyticsContext, {
+    }, jsx(AnalyticsContext, {
       data: {
         attributes: getResolvedAttributesFromStore(url, 'inline', cardContext === null || cardContext === void 0 || (_cardContext$value = cardContext.value) === null || _cardContext$value === void 0 ? void 0 : _cardContext$value.store)
       }
     }, jsx(DiscoveryPulse, {
       localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_SMART_LINK,
       localStorageKeyExpirationInMs: ONE_DAY_IN_MILLISECONDS,
-      discoveryMode: "start"
-    }, cardWithOverlay)) : cardWithOverlay);
-  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 || (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, cardWithOverlay]);
+      discoveryMode: "start",
+      shouldShowPulse: isResolvedViewRendered && shouldShowLinkPulse,
+      testId: "link-discovery-pulse"
+    }, cardWithOverlay)));
+  }, [shouldShowLinkPulse, url, cardContext === null || cardContext === void 0 || (_cardContext$value2 = cardContext.value) === null || _cardContext$value2 === void 0 ? void 0 : _cardContext$value2.store, isResolvedViewRendered, cardWithOverlay]);
 };

package/dist/esm/ui/LinkToolbarAppearance.js

@@ -125,7 +125,8 @@ export var LinkToolbarAppearance = /*#__PURE__*/function (_React$Component) {
             attributes: _objectSpread({}, resolvedAnalyticsAttributes)
           }
         }, /*#__PURE__*/React.createElement(DiscoveryPulse, {
-          localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR
+          localStorageKey: LOCAL_STORAGE_DISCOVERY_KEY_TOOLBAR,
+          testId: "toolbar-discovery-pulse"
         }, LinkToolbarButtons));
       }
       return LinkToolbarButtons;

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

@@ -5,15 +5,17 @@ import { isLocalStorageKeyDiscovered, markLocalStorageKeyDiscovered } from '../.
 export var DiscoveryPulse = function DiscoveryPulse(_ref) {
   var children = _ref.children,
     localStorageKey = _ref.localStorageKey,
-    isDiscovered = _ref.isDiscovered,
     localStorageKeyExpirationInMs = _ref.localStorageKeyExpirationInMs,
     _ref$discoveryMode = _ref.discoveryMode,
-    discoveryMode = _ref$discoveryMode === void 0 ? 'iteration' : _ref$discoveryMode;
-  var discovered = isDiscovered || isLocalStorageKeyDiscovered(localStorageKey);
+    discoveryMode = _ref$discoveryMode === void 0 ? 'iteration' : _ref$discoveryMode,
+    shouldShowPulse = _ref.shouldShowPulse,
+    testId = _ref.testId;
+  var discovered = isLocalStorageKeyDiscovered(localStorageKey);
+  var showPulse = shouldShowPulse !== null && shouldShowPulse !== void 0 ? shouldShowPulse : !discovered;
   var _useAnalyticsEvents = useAnalyticsEvents(),
     createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
   useEffect(function () {
-    if (!discovered) {
+    if (showPulse) {
       createAnalyticsEvent({
         action: 'viewed',
         actionSubject: 'pulse',
@@ -23,16 +25,16 @@ export var DiscoveryPulse = function DiscoveryPulse(_ref) {
         }
       }).fire('media');
     }
-  }, [createAnalyticsEvent, discovered, localStorageKey]);
+  }, [createAnalyticsEvent, discovered, localStorageKey, showPulse]);
   var onDiscovery = useCallback(function () {
     if (!discovered) {
       markLocalStorageKeyDiscovered(localStorageKey, localStorageKeyExpirationInMs);
     }
   }, [discovered, localStorageKey, localStorageKeyExpirationInMs]);
-  var pulseProps = {
-    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+  return /*#__PURE__*/React.createElement(Pulse, {
     onAnimationIteration: discoveryMode === 'iteration' ? onDiscovery : undefined,
-    isDiscovered: discovered
-  };
-  return /*#__PURE__*/React.createElement(Pulse, pulseProps, children);
+    onAnimationStart: discoveryMode === 'start' ? onDiscovery : undefined,
+    showPulse: showPulse,
+    testId: testId
+  }, children);
 };

package/dist/types/ui/Pulse/index.d.ts

@@ -13,14 +13,12 @@ export interface PulseProps {
      * The time in ms after which the key in local storage will be considered expired and the Pulse will be shown again
      */
     localStorageKeyExpirationInMs?: number;
-    /**
-     * And indicator that the feature was discovered externally and the pulsation needs to stop.
-     */
-    isDiscovered?: boolean;
     /**
      * Indicates when the feature is considered discovered. If "start" is passed, local storage key will be invalidated
      * as soon as the animation starts. If "iteration" is passed (the default one), it will be invalidated after the first iteration
      */
     discoveryMode?: PulseDiscoveryMode;
+    shouldShowPulse?: boolean;
+    testId?: string;
 }
-export declare const DiscoveryPulse: ({ children, localStorageKey, isDiscovered, localStorageKeyExpirationInMs, discoveryMode, }: PulseProps) => JSX.Element;
+export declare const DiscoveryPulse: ({ children, localStorageKey, localStorageKeyExpirationInMs, discoveryMode, shouldShowPulse, testId, }: PulseProps) => JSX.Element;

package/dist/types-ts4.5/ui/Pulse/index.d.ts

@@ -13,14 +13,12 @@ export interface PulseProps {
      * The time in ms after which the key in local storage will be considered expired and the Pulse will be shown again
      */
     localStorageKeyExpirationInMs?: number;
-    /**
-     * And indicator that the feature was discovered externally and the pulsation needs to stop.
-     */
-    isDiscovered?: boolean;
     /**
      * Indicates when the feature is considered discovered. If "start" is passed, local storage key will be invalidated
      * as soon as the animation starts. If "iteration" is passed (the default one), it will be invalidated after the first iteration
      */
     discoveryMode?: PulseDiscoveryMode;
+    shouldShowPulse?: boolean;
+    testId?: string;
 }
-export declare const DiscoveryPulse: ({ children, localStorageKey, isDiscovered, localStorageKeyExpirationInMs, discoveryMode, }: PulseProps) => JSX.Element;
+export declare const DiscoveryPulse: ({ children, localStorageKey, localStorageKeyExpirationInMs, discoveryMode, shouldShowPulse, testId, }: PulseProps) => JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-card",
-  "version": "0.14.23",
+  "version": "0.14.24",
   "description": "Card plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -35,7 +35,7 @@
     "@atlaskit/adf-schema": "^35.2.0",
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/custom-steps": "^0.0.10",
-    "@atlaskit/editor-common": "^76.29.0",
+    "@atlaskit/editor-common": "^76.30.0",
     "@atlaskit/editor-plugin-analytics": "^0.4.0",
     "@atlaskit/editor-plugin-decorations": "^0.2.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
@@ -50,7 +50,7 @@
     "@atlaskit/link-analytics": "^8.3.0",
     "@atlaskit/link-client-extension": "^1.8.0",
     "@atlaskit/link-datasource": "^1.19.0",
-    "@atlaskit/linking-common": "^4.21.0",
+    "@atlaskit/linking-common": "^5.0.0",
     "@atlaskit/linking-types": "^8.5.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/primitives": "^1.15.0",