@atlaskit/editor-synced-block-renderer 14.0.0 → 14.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # @atlaskit/editor-synced-block-renderer
2
2
 
3
+ ## 14.2.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`70beff9491f9d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/70beff9491f9d) -
8
+ Forward `mentionNodeDataProvider` into the synced block renderer so mention avatars resolve inside
9
+ a synced block replica location, matching the behaviour already gated by
10
+ `platform_editor_mention_node_avatar` elsewhere. The forwarding itself is gated behind a new
11
+ `platform_editor_mention_avatar_synced_block` experiment so this integration can be rolled out
12
+ independently.
13
+
14
+ ## 14.1.0
15
+
16
+ ### Minor Changes
17
+
18
+ - [`90712d67e0e35`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/90712d67e0e35) -
19
+ Add APIs and renderer support for unpublished same-page synced block references behind
20
+ editor-synced-block-same-page-sync.
21
+
22
+ ### Patch Changes
23
+
24
+ - Updated dependencies
25
+
3
26
  ## 14.0.0
4
27
 
5
28
  ### Patch Changes
@@ -52,6 +52,9 @@
52
52
  {
53
53
  "path": "../../../design-system/image/afm-cc/tsconfig.json"
54
54
  },
55
+ {
56
+ "path": "../../../platform/feature-experiments/afm-cc/tsconfig.json"
57
+ },
55
58
  {
56
59
  "path": "../../../design-system/primitives/afm-cc/tsconfig.json"
57
60
  },
@@ -52,6 +52,9 @@
52
52
  {
53
53
  "path": "../../../design-system/image/afm-products/tsconfig.json"
54
54
  },
55
+ {
56
+ "path": "../../../platform/feature-experiments/afm-products/tsconfig.json"
57
+ },
55
58
  {
56
59
  "path": "../../../design-system/primitives/afm-products/tsconfig.json"
57
60
  },
@@ -12,6 +12,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
12
12
  var _react = _interopRequireWildcard(require("react"));
13
13
  var _reactIntl = require("react-intl");
14
14
  var _messages = require("@atlaskit/editor-common/messages");
15
+ var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
15
16
  var _renderer = require("@atlaskit/renderer");
16
17
  var _rendererActionsContext = require("@atlaskit/renderer/actions/renderer-actions-context");
17
18
  var _rendererContext = require("@atlaskit/renderer/renderer-context");
@@ -90,6 +91,7 @@ var AKRendererWrapper = exports.AKRendererWrapper = /*#__PURE__*/(0, _react.memo
90
91
  emojiResourceConfig = _ref4.emojiResourceConfig,
91
92
  eventHandlers = _ref4.eventHandlers,
92
93
  media = _ref4.media,
94
+ mentionNodeDataProvider = _ref4.mentionNodeDataProvider,
93
95
  smartLinks = _ref4.smartLinks,
94
96
  stickyHeaders = _ref4.stickyHeaders,
95
97
  contentMode = _ref4.contentMode;
@@ -136,7 +138,13 @@ var AKRendererWrapper = exports.AKRendererWrapper = /*#__PURE__*/(0, _react.memo
136
138
  disableTableOverflowShadow: true,
137
139
  emojiResourceConfig: emojiResourceConfig,
138
140
  eventHandlers: eventHandlers,
139
- media: media,
141
+ media: media
142
+ // Synced block replica locations render through this wrapper rather than the
143
+ // main editor/renderer surfaces, so forwarding the provider here is gated
144
+ // independently of `platform_editor_mention_node_avatar` (which still controls
145
+ // whether the avatar itself renders once a provider is present).
146
+ ,
147
+ mentionNodeDataProvider: (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_mention_avatar_synced_block') ? mentionNodeDataProvider : undefined,
140
148
  smartLinks: smartLinks,
141
149
  stickyHeaders: stickyHeaders,
142
150
  contentMode: contentMode
@@ -8,6 +8,7 @@ exports.renderSyncedBlockContent = renderSyncedBlockContent;
8
8
  var _react = _interopRequireDefault(require("react"));
9
9
  var _coreUtils = require("@atlaskit/editor-common/core-utils");
10
10
  var _editorSyncedBlockProvider = require("@atlaskit/editor-synced-block-provider");
11
+ var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
11
12
  var _AKRendererWrapper = require("./AKRendererWrapper");
12
13
  var _SyncedBlockErrorComponent = require("./SyncedBlockErrorComponent");
13
14
  var _SyncedBlockLoadingState = require("./SyncedBlockLoadingState");
@@ -19,7 +20,6 @@ var _SyncedBlockLoadingState = require("./SyncedBlockLoadingState");
19
20
  * Returns null if the caller should handle rendering itself (e.g. wrapping in a container div).
20
21
  */
21
22
  function renderSyncedBlockContent(_ref) {
22
- var _syncBlockInstance$da2;
23
23
  var syncBlockInstance = _ref.syncBlockInstance,
24
24
  isLoading = _ref.isLoading,
25
25
  rendererOptions = _ref.rendererOptions,
@@ -73,8 +73,9 @@ function renderSyncedBlockContent(_ref) {
73
73
  isSuccess: false
74
74
  };
75
75
  }
76
- if ((syncBlockInstance === null || syncBlockInstance === void 0 || (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.status) === 'unpublished') {
77
- var _syncBlockInstance$da3;
76
+ var isLocalSameDocumentSource = Boolean(syncBlockInstance.localSameDocumentSource) && (0, _isExperimentEnabled.isExperimentEnabled)('editor-synced-block-same-page-sync');
77
+ if (syncBlockInstance.data.status === 'unpublished' && !isLocalSameDocumentSource) {
78
+ var _syncBlockInstance$da2;
78
79
  return {
79
80
  element: /*#__PURE__*/_react.default.createElement(_SyncedBlockErrorComponent.SyncedBlockErrorComponent
80
81
  /* eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed) */, {
@@ -82,7 +83,7 @@ function renderSyncedBlockContent(_ref) {
82
83
  type: _editorSyncedBlockProvider.SyncBlockError.Unpublished
83
84
  },
84
85
  resourceId: resourceId,
85
- sourceURL: (_syncBlockInstance$da3 = syncBlockInstance.data) === null || _syncBlockInstance$da3 === void 0 ? void 0 : _syncBlockInstance$da3.sourceURL,
86
+ sourceURL: (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.sourceURL,
86
87
  fireAnalyticsEvent: fireAnalyticsEvent,
87
88
  getAccountId: getAccountId
88
89
  }),
@@ -2,6 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
2
2
  import React, { memo, useMemo } from 'react';
3
3
  import { useIntl } from 'react-intl';
4
4
  import { syncBlockMessages as messages } from '@atlaskit/editor-common/messages';
5
+ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
5
6
  import { ReactRenderer, ValidationContextProvider, defaultNodeComponents } from '@atlaskit/renderer';
6
7
  import { RendererActionsContext } from '@atlaskit/renderer/actions/renderer-actions-context';
7
8
  import { RendererContextProvider } from '@atlaskit/renderer/renderer-context';
@@ -81,6 +82,7 @@ export const AKRendererWrapper = /*#__PURE__*/memo(({
81
82
  emojiResourceConfig,
82
83
  eventHandlers,
83
84
  media,
85
+ mentionNodeDataProvider,
84
86
  smartLinks,
85
87
  stickyHeaders,
86
88
  contentMode
@@ -128,7 +130,13 @@ export const AKRendererWrapper = /*#__PURE__*/memo(({
128
130
  disableTableOverflowShadow: true,
129
131
  emojiResourceConfig: emojiResourceConfig,
130
132
  eventHandlers: eventHandlers,
131
- media: media,
133
+ media: media
134
+ // Synced block replica locations render through this wrapper rather than the
135
+ // main editor/renderer surfaces, so forwarding the provider here is gated
136
+ // independently of `platform_editor_mention_node_avatar` (which still controls
137
+ // whether the avatar itself renders once a provider is present).
138
+ ,
139
+ mentionNodeDataProvider: isExperimentEnabled('platform_editor_mention_avatar_synced_block') ? mentionNodeDataProvider : undefined,
132
140
  smartLinks: smartLinks,
133
141
  stickyHeaders: stickyHeaders,
134
142
  contentMode: contentMode
@@ -1,6 +1,7 @@
1
1
  import React from 'react';
2
2
  import { isSSR } from '@atlaskit/editor-common/core-utils';
3
3
  import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
4
+ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
4
5
  import { AKRendererWrapper } from './AKRendererWrapper';
5
6
  import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
6
7
  import { SyncedBlockLoadingState } from './SyncedBlockLoadingState';
@@ -23,7 +24,6 @@ export function renderSyncedBlockContent({
23
24
  error,
24
25
  getAccountId
25
26
  }) {
26
- var _syncBlockInstance$da2;
27
27
  const isSSRMode = isSSR();
28
28
  if (isOffline && !isSSRMode) {
29
29
  return {
@@ -67,8 +67,9 @@ export function renderSyncedBlockContent({
67
67
  isSuccess: false
68
68
  };
69
69
  }
70
- if ((syncBlockInstance === null || syncBlockInstance === void 0 ? void 0 : (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.status) === 'unpublished') {
71
- var _syncBlockInstance$da3;
70
+ const isLocalSameDocumentSource = Boolean(syncBlockInstance.localSameDocumentSource) && isExperimentEnabled('editor-synced-block-same-page-sync');
71
+ if (syncBlockInstance.data.status === 'unpublished' && !isLocalSameDocumentSource) {
72
+ var _syncBlockInstance$da2;
72
73
  return {
73
74
  element: /*#__PURE__*/React.createElement(SyncedBlockErrorComponent
74
75
  /* eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed) */, {
@@ -76,7 +77,7 @@ export function renderSyncedBlockContent({
76
77
  type: SyncBlockError.Unpublished
77
78
  },
78
79
  resourceId: resourceId,
79
- sourceURL: (_syncBlockInstance$da3 = syncBlockInstance.data) === null || _syncBlockInstance$da3 === void 0 ? void 0 : _syncBlockInstance$da3.sourceURL,
80
+ sourceURL: (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.sourceURL,
80
81
  fireAnalyticsEvent: fireAnalyticsEvent,
81
82
  getAccountId: getAccountId
82
83
  }),
@@ -7,6 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
7
7
  import React, { memo, useMemo } from 'react';
8
8
  import { useIntl } from 'react-intl';
9
9
  import { syncBlockMessages as messages } from '@atlaskit/editor-common/messages';
10
+ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
10
11
  import { ReactRenderer, ValidationContextProvider, defaultNodeComponents } from '@atlaskit/renderer';
11
12
  import { RendererActionsContext } from '@atlaskit/renderer/actions/renderer-actions-context';
12
13
  import { RendererContextProvider } from '@atlaskit/renderer/renderer-context';
@@ -81,6 +82,7 @@ export var AKRendererWrapper = /*#__PURE__*/memo(function (_ref3) {
81
82
  emojiResourceConfig = _ref4.emojiResourceConfig,
82
83
  eventHandlers = _ref4.eventHandlers,
83
84
  media = _ref4.media,
85
+ mentionNodeDataProvider = _ref4.mentionNodeDataProvider,
84
86
  smartLinks = _ref4.smartLinks,
85
87
  stickyHeaders = _ref4.stickyHeaders,
86
88
  contentMode = _ref4.contentMode;
@@ -127,7 +129,13 @@ export var AKRendererWrapper = /*#__PURE__*/memo(function (_ref3) {
127
129
  disableTableOverflowShadow: true,
128
130
  emojiResourceConfig: emojiResourceConfig,
129
131
  eventHandlers: eventHandlers,
130
- media: media,
132
+ media: media
133
+ // Synced block replica locations render through this wrapper rather than the
134
+ // main editor/renderer surfaces, so forwarding the provider here is gated
135
+ // independently of `platform_editor_mention_node_avatar` (which still controls
136
+ // whether the avatar itself renders once a provider is present).
137
+ ,
138
+ mentionNodeDataProvider: isExperimentEnabled('platform_editor_mention_avatar_synced_block') ? mentionNodeDataProvider : undefined,
131
139
  smartLinks: smartLinks,
132
140
  stickyHeaders: stickyHeaders,
133
141
  contentMode: contentMode
@@ -1,6 +1,7 @@
1
1
  import React from 'react';
2
2
  import { isSSR } from '@atlaskit/editor-common/core-utils';
3
3
  import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
4
+ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
4
5
  import { AKRendererWrapper } from './AKRendererWrapper';
5
6
  import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
6
7
  import { SyncedBlockLoadingState } from './SyncedBlockLoadingState';
@@ -12,7 +13,6 @@ import { SyncedBlockLoadingState } from './SyncedBlockLoadingState';
12
13
  * Returns null if the caller should handle rendering itself (e.g. wrapping in a container div).
13
14
  */
14
15
  export function renderSyncedBlockContent(_ref) {
15
- var _syncBlockInstance$da2;
16
16
  var syncBlockInstance = _ref.syncBlockInstance,
17
17
  isLoading = _ref.isLoading,
18
18
  rendererOptions = _ref.rendererOptions,
@@ -66,8 +66,9 @@ export function renderSyncedBlockContent(_ref) {
66
66
  isSuccess: false
67
67
  };
68
68
  }
69
- if ((syncBlockInstance === null || syncBlockInstance === void 0 || (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.status) === 'unpublished') {
70
- var _syncBlockInstance$da3;
69
+ var isLocalSameDocumentSource = Boolean(syncBlockInstance.localSameDocumentSource) && isExperimentEnabled('editor-synced-block-same-page-sync');
70
+ if (syncBlockInstance.data.status === 'unpublished' && !isLocalSameDocumentSource) {
71
+ var _syncBlockInstance$da2;
71
72
  return {
72
73
  element: /*#__PURE__*/React.createElement(SyncedBlockErrorComponent
73
74
  /* eslint-disable-next-line @atlassian/perf-linting/no-unstable-inline-props -- Ignored via go/ees017 (to be fixed) */, {
@@ -75,7 +76,7 @@ export function renderSyncedBlockContent(_ref) {
75
76
  type: SyncBlockError.Unpublished
76
77
  },
77
78
  resourceId: resourceId,
78
- sourceURL: (_syncBlockInstance$da3 = syncBlockInstance.data) === null || _syncBlockInstance$da3 === void 0 ? void 0 : _syncBlockInstance$da3.sourceURL,
79
+ sourceURL: (_syncBlockInstance$da2 = syncBlockInstance.data) === null || _syncBlockInstance$da2 === void 0 ? void 0 : _syncBlockInstance$da2.sourceURL,
79
80
  fireAnalyticsEvent: fireAnalyticsEvent,
80
81
  getAccountId: getAccountId
81
82
  }),
@@ -1,2 +1,2 @@
1
1
  import type { RendererProps } from '@atlaskit/renderer';
2
- export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'eventHandlers' | 'media' | 'smartLinks' | 'stickyHeaders' | 'contentMode'>;
2
+ export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'eventHandlers' | 'media' | 'mentionNodeDataProvider' | 'smartLinks' | 'stickyHeaders' | 'contentMode'>;
@@ -1,5 +1,5 @@
1
1
  import React from 'react';
2
- import type { DocNode } from '@atlaskit/adf-schema';
2
+ import type { DocNode } from '@atlaskit/adf-schema/doc';
3
3
  import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
4
4
  import type { SyncedBlockRendererOptions } from '../types';
5
5
  export declare const AKRendererWrapper: React.MemoExoticComponent<({ doc, dataProviders, options, }: {
@@ -1,5 +1,5 @@
1
1
  import React from 'react';
2
- import type { DocNode } from '@atlaskit/adf-schema';
2
+ import type { DocNode } from '@atlaskit/adf-schema/doc';
3
3
  import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
4
4
  import type { SyncBlockNode, SyncedBlockProvider, SyncBlockPrefetchData } from '@atlaskit/editor-synced-block-provider';
5
5
  import type { SyncedBlockRendererOptions } from './types';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-synced-block-renderer",
3
- "version": "14.0.0",
3
+ "version": "14.2.0",
4
4
  "description": "SyncedBlockRenderer for @atlaskit/editor-plugin-synced-block",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -30,29 +30,30 @@
30
30
  "sideEffects": false,
31
31
  "atlaskit:src": "src/index.ts",
32
32
  "dependencies": {
33
- "@atlaskit/adf-schema": "^57.1.0",
34
- "@atlaskit/button": "^25.2.0",
35
- "@atlaskit/css": "^1.0.0",
36
- "@atlaskit/editor-json-transformer": "^9.6.0",
33
+ "@atlaskit/adf-schema": "^57.3.0",
34
+ "@atlaskit/button": "^25.3.0",
35
+ "@atlaskit/css": "^1.1.0",
36
+ "@atlaskit/editor-json-transformer": "^9.8.0",
37
37
  "@atlaskit/editor-plugin-synced-block": "^14.0.0",
38
- "@atlaskit/editor-synced-block-provider": "^12.0.0",
39
- "@atlaskit/heading": "^7.1.0",
40
- "@atlaskit/icon": "^37.5.0",
41
- "@atlaskit/icon-lab": "^7.7.0",
42
- "@atlaskit/image": "^5.1.0",
43
- "@atlaskit/primitives": "^22.4.0",
38
+ "@atlaskit/editor-synced-block-provider": "^12.2.0",
39
+ "@atlaskit/heading": "^7.2.0",
40
+ "@atlaskit/icon": "^37.6.0",
41
+ "@atlaskit/icon-lab": "^7.8.0",
42
+ "@atlaskit/image": "^5.2.0",
43
+ "@atlaskit/platform-feature-experiments": "^0.3.0",
44
+ "@atlaskit/primitives": "^22.5.0",
44
45
  "@atlaskit/react-compiler-gating": "^0.2.0",
45
- "@atlaskit/renderer": "^137.0.0",
46
- "@atlaskit/spinner": "^20.3.0",
47
- "@atlaskit/tokens": "^16.8.0",
48
- "@atlaskit/tooltip": "^24.2.0",
46
+ "@atlaskit/renderer": "^137.4.0",
47
+ "@atlaskit/spinner": "^20.4.0",
48
+ "@atlaskit/tokens": "^16.11.0",
49
+ "@atlaskit/tooltip": "^24.3.0",
49
50
  "@babel/runtime": "^7.0.0",
50
51
  "@compiled/react": "^1.0.2",
51
52
  "react-relay": "^20.1.1",
52
53
  "relay-runtime": "^20.1.1"
53
54
  },
54
55
  "peerDependencies": {
55
- "@atlaskit/editor-common": "^120.0.0",
56
+ "@atlaskit/editor-common": "^120.16.0",
56
57
  "react": "^18.2.0 || ^19.2.0",
57
58
  "react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
58
59
  },
@@ -61,38 +62,5 @@
61
62
  "react-intl": "^7.0.0",
62
63
  "typescript": "npm:@typescript/typescript6@^6.0.2"
63
64
  },
64
- "techstack": {
65
- "@atlassian/frontend": {
66
- "import-structure": [
67
- "atlassian-conventions"
68
- ],
69
- "circular-dependencies": [
70
- "file-and-folder-level"
71
- ]
72
- },
73
- "@repo/internal": {
74
- "dom-events": "use-bind-event-listener",
75
- "analytics": [
76
- "analytics-next"
77
- ],
78
- "design-tokens": [
79
- "color"
80
- ],
81
- "theming": [
82
- "react-context"
83
- ],
84
- "ui-components": [
85
- "lite-mode"
86
- ],
87
- "deprecation": "no-deprecated-imports",
88
- "styling": [
89
- "emotion",
90
- "emotion"
91
- ],
92
- "imports": [
93
- "import-no-extraneous-disable-for-examples-and-docs"
94
- ]
95
- }
96
- },
97
65
  "platform-feature-flags": {}
98
66
  }