@atlaskit/editor-common 102.5.0 → 102.5.2

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,23 @@
1
1
  # @atlaskit/editor-common
2
2
 
3
+ ## 102.5.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#123036](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/123036)
8
+ [`08a3386cf1088`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/08a3386cf1088) -
9
+ Editor virtualization experiment adjustment, fixes
10
+ - Updated dependencies
11
+
12
+ ## 102.5.1
13
+
14
+ ### Patch Changes
15
+
16
+ - [#124114](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/124114)
17
+ [`a0b9383dc1bf3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a0b9383dc1bf3) -
18
+ CEPS-362: add reason to getResolvedEditorState call chain, to allow collab provider/NCS to
19
+ differentiate between draft sync and publish use cases
20
+
3
21
  ## 102.5.0
4
22
 
5
23
  ### Minor Changes
@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
17
17
  function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
18
18
  var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
19
19
  var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
20
- var packageVersion = "102.5.0";
20
+ var packageVersion = "102.5.2";
21
21
  var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
22
22
  // Remove URL as it has UGC
23
23
  // Ignored via go/ees007
@@ -9,6 +9,7 @@ exports.memoProcessQuickInsertItems = void 0;
9
9
  var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
10
10
  var _fuse = _interopRequireDefault(require("fuse.js"));
11
11
  var _memoizeOne = _interopRequireDefault(require("memoize-one"));
12
+ var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
12
13
  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; }
13
14
  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) { (0, _defineProperty2.default)(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; }
14
15
  var processQuickInsertItems = function processQuickInsertItems(items, intl) {
@@ -56,6 +57,23 @@ var options = {
56
57
  weight: 0.01
57
58
  }]
58
59
  };
60
+ var optionsWithPriorityRemoved = {
61
+ threshold: 0.3,
62
+ includeScore: true,
63
+ keys: [{
64
+ name: 'title',
65
+ weight: 0.57
66
+ }, {
67
+ name: 'keywords',
68
+ weight: 0.08
69
+ }, {
70
+ name: 'description',
71
+ weight: 0.04
72
+ }, {
73
+ name: 'keyshortcut',
74
+ weight: 0.01
75
+ }]
76
+ };
59
77
 
60
78
  /**
61
79
  * This function is used to find and sort QuickInsertItems based on a given query string.
@@ -72,7 +90,7 @@ function find(query, items, prioritySortingFn) {
72
90
  return (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY);
73
91
  });
74
92
  }
75
- var fuseOptions = _objectSpread({}, options);
93
+ var fuseOptions = _objectSpread({}, (0, _platformFeatureFlags.fg)('platform_editor_remove_quick_insert_priority_key') ? optionsWithPriorityRemoved : options);
76
94
  if (prioritySortingFn) {
77
95
  var sortFn = prioritySortingFn(items);
78
96
  // prioritySortingFn will trigger the experiment exposure, but sortFn
@@ -23,6 +23,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
23
23
  * @jsxRuntime classic
24
24
  * @jsx jsx
25
25
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
26
+ var isSSR = Boolean(process.env.REACT_SSR);
26
27
  var inlineNodeViewClassname = exports.inlineNodeViewClassname = 'inlineNodeView';
27
28
 
28
29
  // number of initial nodes to allow React to render before switching to fallback
@@ -30,23 +31,27 @@ var initialReactRenderedNodeCount = 0;
30
31
  var canRenderFallback = function canRenderFallback(node) {
31
32
  return node.type.isInline && node.type.isAtom && node.type.isLeaf;
32
33
  };
34
+
35
+ // list of inline nodes with toDOM fallback implementations that can be virtualized. As
36
+ // additional nodes are converted they should be added here
37
+ var virtualizedNodeWhitelist = ['status', 'mention', 'emoji', 'date', 'inlineCard'];
33
38
  var virtualisationConfiguration = function virtualisationConfiguration() {
34
39
  var enableVirtualization = false;
35
40
  var reactRenderedDocumentPositionThreshold = 0;
36
41
  if ((0, _experiments.editorExperiment)('platform_editor_inline_node_virtualization', 'off')) {
37
42
  enableVirtualization = false;
38
- } else if ((0, _experiments.editorExperiment)('platform_editor_inline_node_virtualization', 'fallbackall')) {
39
- enableVirtualization = true;
40
- reactRenderedDocumentPositionThreshold = 0;
41
- } else if ((0, _experiments.editorExperiment)('platform_editor_inline_node_virtualization', 'fallbackoffscreen')) {
42
- enableVirtualization = true;
43
+ } else if ((0, _experiments.editorExperiment)('platform_editor_inline_node_virtualization', 'fallback-small')) {
44
+ enableVirtualization = true && !isSSR;
43
45
  reactRenderedDocumentPositionThreshold = 100;
46
+ } else if ((0, _experiments.editorExperiment)('platform_editor_inline_node_virtualization', 'fallback-large')) {
47
+ enableVirtualization = true && !isSSR;
48
+ reactRenderedDocumentPositionThreshold = 400;
44
49
  }
45
50
  return {
46
51
  enableVirtualization: enableVirtualization,
47
52
  reactRenderedDocumentPositionThreshold: reactRenderedDocumentPositionThreshold,
48
- virtualizeCurrentNode: function virtualizeCurrentNode() {
49
- return enableVirtualization && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold);
53
+ virtualizeCurrentNode: function virtualizeCurrentNode(nodeType) {
54
+ return enableVirtualization && virtualizedNodeWhitelist.includes(nodeType) && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold);
50
55
  }
51
56
  };
52
57
  };
@@ -59,7 +64,7 @@ function createNodeView(_ref) {
59
64
  var _virtualisationConfig = virtualisationConfiguration(),
60
65
  enableVirtualization = _virtualisationConfig.enableVirtualization,
61
66
  virtualizeCurrentNode = _virtualisationConfig.virtualizeCurrentNode;
62
- var virtualizeNode = virtualizeCurrentNode();
67
+ var virtualizeNode = virtualizeCurrentNode(nodeViewParams.node.type.name);
63
68
  // We set a variable for the current node which is
64
69
  // used for comparisions when doing updates, before being
65
70
  // overwritten to the updated node.
@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
23
23
  * @jsx jsx
24
24
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
25
25
  var packageName = "@atlaskit/editor-common";
26
- var packageVersion = "102.5.0";
26
+ var packageVersion = "102.5.2";
27
27
  var halfFocusRing = 1;
28
28
  var dropOffset = '0, 8';
29
29
  // Ignored via go/ees005
@@ -1,7 +1,7 @@
1
1
  import { isFedRamp } from './environment';
2
2
  const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
3
3
  const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
4
- const packageVersion = "102.5.0";
4
+ const packageVersion = "102.5.2";
5
5
  const sanitiseSentryEvents = (data, _hint) => {
6
6
  // Remove URL as it has UGC
7
7
  // Ignored via go/ees007
@@ -1,5 +1,6 @@
1
1
  import Fuse from 'fuse.js';
2
2
  import memoizeOne from 'memoize-one';
3
+ import { fg } from '@atlaskit/platform-feature-flags';
3
4
  const processQuickInsertItems = (items, intl) => {
4
5
  return items.reduce((acc, item) => {
5
6
  if (typeof item === 'function' &&
@@ -41,6 +42,23 @@ const options = {
41
42
  weight: 0.01
42
43
  }]
43
44
  };
45
+ const optionsWithPriorityRemoved = {
46
+ threshold: 0.3,
47
+ includeScore: true,
48
+ keys: [{
49
+ name: 'title',
50
+ weight: 0.57
51
+ }, {
52
+ name: 'keywords',
53
+ weight: 0.08
54
+ }, {
55
+ name: 'description',
56
+ weight: 0.04
57
+ }, {
58
+ name: 'keyshortcut',
59
+ weight: 0.01
60
+ }]
61
+ };
44
62
 
45
63
  /**
46
64
  * This function is used to find and sort QuickInsertItems based on a given query string.
@@ -56,7 +74,7 @@ export function find(query, items, prioritySortingFn) {
56
74
  return items.slice(0).sort((a, b) => (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY));
57
75
  }
58
76
  const fuseOptions = {
59
- ...options
77
+ ...(fg('platform_editor_remove_quick_insert_priority_key') ? optionsWithPriorityRemoved : options)
60
78
  };
61
79
  if (prioritySortingFn) {
62
80
  const sortFn = prioritySortingFn(items);
@@ -15,6 +15,7 @@ import { analyticsEventKey, browser, getPerformanceOptions, startMeasureReactNod
15
15
  import { ZERO_WIDTH_SPACE } from '../whitespace';
16
16
  import { generateUniqueNodeKey } from './generateUniqueNodeKey';
17
17
  import { getOrCreateOnVisibleObserver } from './onVisibleObserverFactory';
18
+ const isSSR = Boolean(process.env.REACT_SSR);
18
19
  export const inlineNodeViewClassname = 'inlineNodeView';
19
20
 
20
21
  // number of initial nodes to allow React to render before switching to fallback
@@ -22,22 +23,26 @@ let initialReactRenderedNodeCount = 0;
22
23
  const canRenderFallback = node => {
23
24
  return node.type.isInline && node.type.isAtom && node.type.isLeaf;
24
25
  };
26
+
27
+ // list of inline nodes with toDOM fallback implementations that can be virtualized. As
28
+ // additional nodes are converted they should be added here
29
+ const virtualizedNodeWhitelist = ['status', 'mention', 'emoji', 'date', 'inlineCard'];
25
30
  const virtualisationConfiguration = () => {
26
31
  let enableVirtualization = false;
27
32
  let reactRenderedDocumentPositionThreshold = 0;
28
33
  if (editorExperiment('platform_editor_inline_node_virtualization', 'off')) {
29
34
  enableVirtualization = false;
30
- } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallbackall')) {
31
- enableVirtualization = true;
32
- reactRenderedDocumentPositionThreshold = 0;
33
- } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallbackoffscreen')) {
34
- enableVirtualization = true;
35
+ } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallback-small')) {
36
+ enableVirtualization = true && !isSSR;
35
37
  reactRenderedDocumentPositionThreshold = 100;
38
+ } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallback-large')) {
39
+ enableVirtualization = true && !isSSR;
40
+ reactRenderedDocumentPositionThreshold = 400;
36
41
  }
37
42
  return {
38
43
  enableVirtualization,
39
44
  reactRenderedDocumentPositionThreshold,
40
- virtualizeCurrentNode: () => enableVirtualization && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold)
45
+ virtualizeCurrentNode: nodeType => enableVirtualization && virtualizedNodeWhitelist.includes(nodeType) && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold)
41
46
  };
42
47
  };
43
48
  function createNodeView({
@@ -51,7 +56,7 @@ function createNodeView({
51
56
  enableVirtualization,
52
57
  virtualizeCurrentNode
53
58
  } = virtualisationConfiguration();
54
- const virtualizeNode = virtualizeCurrentNode();
59
+ const virtualizeNode = virtualizeCurrentNode(nodeViewParams.node.type.name);
55
60
  // We set a variable for the current node which is
56
61
  // used for comparisions when doing updates, before being
57
62
  // overwritten to the updated node.
@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
13
13
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
14
14
  import Layer from '../Layer';
15
15
  const packageName = "@atlaskit/editor-common";
16
- const packageVersion = "102.5.0";
16
+ const packageVersion = "102.5.2";
17
17
  const halfFocusRing = 1;
18
18
  const dropOffset = '0, 8';
19
19
  // Ignored via go/ees005
@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
7
7
  import { isFedRamp } from './environment';
8
8
  var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
9
9
  var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
10
- var packageVersion = "102.5.0";
10
+ var packageVersion = "102.5.2";
11
11
  var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
12
12
  // Remove URL as it has UGC
13
13
  // Ignored via go/ees007
@@ -3,6 +3,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
3
3
  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; }
4
4
  import Fuse from 'fuse.js';
5
5
  import memoizeOne from 'memoize-one';
6
+ import { fg } from '@atlaskit/platform-feature-flags';
6
7
  var processQuickInsertItems = function processQuickInsertItems(items, intl) {
7
8
  return items.reduce(function (acc, item) {
8
9
  if (typeof item === 'function' &&
@@ -48,6 +49,23 @@ var options = {
48
49
  weight: 0.01
49
50
  }]
50
51
  };
52
+ var optionsWithPriorityRemoved = {
53
+ threshold: 0.3,
54
+ includeScore: true,
55
+ keys: [{
56
+ name: 'title',
57
+ weight: 0.57
58
+ }, {
59
+ name: 'keywords',
60
+ weight: 0.08
61
+ }, {
62
+ name: 'description',
63
+ weight: 0.04
64
+ }, {
65
+ name: 'keyshortcut',
66
+ weight: 0.01
67
+ }]
68
+ };
51
69
 
52
70
  /**
53
71
  * This function is used to find and sort QuickInsertItems based on a given query string.
@@ -64,7 +82,7 @@ export function find(query, items, prioritySortingFn) {
64
82
  return (a.priority || Number.POSITIVE_INFINITY) - (b.priority || Number.POSITIVE_INFINITY);
65
83
  });
66
84
  }
67
- var fuseOptions = _objectSpread({}, options);
85
+ var fuseOptions = _objectSpread({}, fg('platform_editor_remove_quick_insert_priority_key') ? optionsWithPriorityRemoved : options);
68
86
  if (prioritySortingFn) {
69
87
  var sortFn = prioritySortingFn(items);
70
88
  // prioritySortingFn will trigger the experiment exposure, but sortFn
@@ -18,6 +18,7 @@ import { analyticsEventKey, browser, getPerformanceOptions, startMeasureReactNod
18
18
  import { ZERO_WIDTH_SPACE } from '../whitespace';
19
19
  import { generateUniqueNodeKey } from './generateUniqueNodeKey';
20
20
  import { getOrCreateOnVisibleObserver } from './onVisibleObserverFactory';
21
+ var isSSR = Boolean(process.env.REACT_SSR);
21
22
  export var inlineNodeViewClassname = 'inlineNodeView';
22
23
 
23
24
  // number of initial nodes to allow React to render before switching to fallback
@@ -25,23 +26,27 @@ var initialReactRenderedNodeCount = 0;
25
26
  var canRenderFallback = function canRenderFallback(node) {
26
27
  return node.type.isInline && node.type.isAtom && node.type.isLeaf;
27
28
  };
29
+
30
+ // list of inline nodes with toDOM fallback implementations that can be virtualized. As
31
+ // additional nodes are converted they should be added here
32
+ var virtualizedNodeWhitelist = ['status', 'mention', 'emoji', 'date', 'inlineCard'];
28
33
  var virtualisationConfiguration = function virtualisationConfiguration() {
29
34
  var enableVirtualization = false;
30
35
  var reactRenderedDocumentPositionThreshold = 0;
31
36
  if (editorExperiment('platform_editor_inline_node_virtualization', 'off')) {
32
37
  enableVirtualization = false;
33
- } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallbackall')) {
34
- enableVirtualization = true;
35
- reactRenderedDocumentPositionThreshold = 0;
36
- } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallbackoffscreen')) {
37
- enableVirtualization = true;
38
+ } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallback-small')) {
39
+ enableVirtualization = true && !isSSR;
38
40
  reactRenderedDocumentPositionThreshold = 100;
41
+ } else if (editorExperiment('platform_editor_inline_node_virtualization', 'fallback-large')) {
42
+ enableVirtualization = true && !isSSR;
43
+ reactRenderedDocumentPositionThreshold = 400;
39
44
  }
40
45
  return {
41
46
  enableVirtualization: enableVirtualization,
42
47
  reactRenderedDocumentPositionThreshold: reactRenderedDocumentPositionThreshold,
43
- virtualizeCurrentNode: function virtualizeCurrentNode() {
44
- return enableVirtualization && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold);
48
+ virtualizeCurrentNode: function virtualizeCurrentNode(nodeType) {
49
+ return enableVirtualization && virtualizedNodeWhitelist.includes(nodeType) && !(initialReactRenderedNodeCount < reactRenderedDocumentPositionThreshold);
45
50
  }
46
51
  };
47
52
  };
@@ -54,7 +59,7 @@ function createNodeView(_ref) {
54
59
  var _virtualisationConfig = virtualisationConfiguration(),
55
60
  enableVirtualization = _virtualisationConfig.enableVirtualization,
56
61
  virtualizeCurrentNode = _virtualisationConfig.virtualizeCurrentNode;
57
- var virtualizeNode = virtualizeCurrentNode();
62
+ var virtualizeNode = virtualizeCurrentNode(nodeViewParams.node.type.name);
58
63
  // We set a variable for the current node which is
59
64
  // used for comparisions when doing updates, before being
60
65
  // overwritten to the updated node.
@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
20
20
  import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
21
21
  import Layer from '../Layer';
22
22
  var packageName = "@atlaskit/editor-common";
23
- var packageVersion = "102.5.0";
23
+ var packageVersion = "102.5.2";
24
24
  var halfFocusRing = 1;
25
25
  var dropOffset = '0, 8';
26
26
  // Ignored via go/ees005
@@ -6,6 +6,7 @@ import type { EditorState, ReadonlyTransaction, Transaction } from '@atlaskit/ed
6
6
  import type { Step } from '@atlaskit/editor-prosemirror/transform';
7
7
  import { token } from '@atlaskit/tokens';
8
8
  import type { Providers } from '../provider-factory';
9
+ import type { GetResolvedEditorStateReason } from '../types';
9
10
  export type NewCollabSyncUpErrorAttributes = {
10
11
  lengthOfUnconfirmedSteps?: number;
11
12
  tries: number;
@@ -455,7 +456,7 @@ export interface CollabEditProvider<Events extends CollabEvents = CollabEvents>
455
456
  sendMessage<K extends keyof Events>(data: {
456
457
  type: K;
457
458
  } & Events[K]): void;
458
- getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
459
+ getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
459
460
  getIsNamespaceLocked(): boolean;
460
461
  }
461
462
  export type CollabEditOptions = {
@@ -18,7 +18,7 @@ export { shadowSharedStyle } from './shared/shadow';
18
18
  export { dateSharedStyle, DateSharedCssClassName } from './shared/date';
19
19
  export { tasksAndDecisionsStyles, TaskDecisionSharedCssClassName } from './shared/task-decision';
20
20
  export { StatusSharedCssClassName } from './shared/status';
21
- export { getSmartCardSharedStyles, smartCardSharedStyles, SmartCardSharedCssClassName } from './shared/smart-card';
21
+ export { getSmartCardSharedStyles, smartCardSharedStyles, SmartCardSharedCssClassName, } from './shared/smart-card';
22
22
  export { DropdownMenuSharedCssClassName } from './shared/dropdown-menu';
23
23
  export { CodeBlockSharedCssClassName, codeBlockSharedStyles, codeBlockInListSafariFix, } from './shared/code-block';
24
24
  export { LAYOUT_SECTION_MARGIN, LAYOUT_COLUMN_PADDING } from './shared/layout';
@@ -5,6 +5,7 @@ import type { ResolvedEditorState } from '../collab';
5
5
  import type { EventDispatcher } from '../event-dispatcher';
6
6
  export type ContextUpdateHandler = (editorView: EditorView, eventDispatcher: EventDispatcher) => void;
7
7
  export type ReplaceRawValue = Node | object | string;
8
+ export type GetResolvedEditorStateReason = 'publish' | 'draft-sync' | 'get-content';
8
9
  export interface EditorActionsOptions<T = any> {
9
10
  focus(): boolean;
10
11
  blur(): boolean;
@@ -17,5 +18,5 @@ export interface EditorActionsOptions<T = any> {
17
18
  replaceSelection(rawValue: ReplaceRawValue | Array<ReplaceRawValue>): boolean;
18
19
  appendText(text: string): boolean;
19
20
  isDocumentEmpty(): boolean;
20
- getResolvedEditorState(): Promise<ResolvedEditorState | undefined>;
21
+ getResolvedEditorState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState | undefined>;
21
22
  }
@@ -6,7 +6,7 @@ export declare enum SortOrder {
6
6
  export { AnnotationUpdateEmitter, AnnotationUpdateEvent } from './annotation/emitter';
7
7
  export type { AnnotationState, AnnotationUpdateEventPayloads, OnAnnotationClickPayload, } from './annotation/emitter';
8
8
  export type { AnnotationProviders, InlineCommentSelectionComponentProps, InlineCommentHoverComponentProps, InlineCommentViewComponentProps, InlineCommentAnnotationProvider, AnnotationByMatches, AnnotationActionResult, } from './annotation';
9
- export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue } from './editor-actions';
9
+ export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue, GetResolvedEditorStateReason, } from './editor-actions';
10
10
  export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, } from './type-ahead';
11
11
  export type { CommandDispatch, Command, HigherOrderCommand, Predicate } from './command';
12
12
  export type { FeatureFlags, FeatureFlagKey, GetEditorFeatureFlags } from './feature-flags';
@@ -6,6 +6,7 @@ import type { EditorState, ReadonlyTransaction, Transaction } from '@atlaskit/ed
6
6
  import type { Step } from '@atlaskit/editor-prosemirror/transform';
7
7
  import { token } from '@atlaskit/tokens';
8
8
  import type { Providers } from '../provider-factory';
9
+ import type { GetResolvedEditorStateReason } from '../types';
9
10
  export type NewCollabSyncUpErrorAttributes = {
10
11
  lengthOfUnconfirmedSteps?: number;
11
12
  tries: number;
@@ -455,7 +456,7 @@ export interface CollabEditProvider<Events extends CollabEvents = CollabEvents>
455
456
  sendMessage<K extends keyof Events>(data: {
456
457
  type: K;
457
458
  } & Events[K]): void;
458
- getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
459
+ getFinalAcknowledgedState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState>;
459
460
  getIsNamespaceLocked(): boolean;
460
461
  }
461
462
  export type CollabEditOptions = {
@@ -18,7 +18,7 @@ export { shadowSharedStyle } from './shared/shadow';
18
18
  export { dateSharedStyle, DateSharedCssClassName } from './shared/date';
19
19
  export { tasksAndDecisionsStyles, TaskDecisionSharedCssClassName } from './shared/task-decision';
20
20
  export { StatusSharedCssClassName } from './shared/status';
21
- export { getSmartCardSharedStyles, smartCardSharedStyles, SmartCardSharedCssClassName } from './shared/smart-card';
21
+ export { getSmartCardSharedStyles, smartCardSharedStyles, SmartCardSharedCssClassName, } from './shared/smart-card';
22
22
  export { DropdownMenuSharedCssClassName } from './shared/dropdown-menu';
23
23
  export { CodeBlockSharedCssClassName, codeBlockSharedStyles, codeBlockInListSafariFix, } from './shared/code-block';
24
24
  export { LAYOUT_SECTION_MARGIN, LAYOUT_COLUMN_PADDING } from './shared/layout';
@@ -5,6 +5,7 @@ import type { ResolvedEditorState } from '../collab';
5
5
  import type { EventDispatcher } from '../event-dispatcher';
6
6
  export type ContextUpdateHandler = (editorView: EditorView, eventDispatcher: EventDispatcher) => void;
7
7
  export type ReplaceRawValue = Node | object | string;
8
+ export type GetResolvedEditorStateReason = 'publish' | 'draft-sync' | 'get-content';
8
9
  export interface EditorActionsOptions<T = any> {
9
10
  focus(): boolean;
10
11
  blur(): boolean;
@@ -17,5 +18,5 @@ export interface EditorActionsOptions<T = any> {
17
18
  replaceSelection(rawValue: ReplaceRawValue | Array<ReplaceRawValue>): boolean;
18
19
  appendText(text: string): boolean;
19
20
  isDocumentEmpty(): boolean;
20
- getResolvedEditorState(): Promise<ResolvedEditorState | undefined>;
21
+ getResolvedEditorState(reason: GetResolvedEditorStateReason): Promise<ResolvedEditorState | undefined>;
21
22
  }
@@ -6,7 +6,7 @@ export declare enum SortOrder {
6
6
  export { AnnotationUpdateEmitter, AnnotationUpdateEvent } from './annotation/emitter';
7
7
  export type { AnnotationState, AnnotationUpdateEventPayloads, OnAnnotationClickPayload, } from './annotation/emitter';
8
8
  export type { AnnotationProviders, InlineCommentSelectionComponentProps, InlineCommentHoverComponentProps, InlineCommentViewComponentProps, InlineCommentAnnotationProvider, AnnotationByMatches, AnnotationActionResult, } from './annotation';
9
- export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue } from './editor-actions';
9
+ export type { ContextUpdateHandler, EditorActionsOptions, ReplaceRawValue, GetResolvedEditorStateReason, } from './editor-actions';
10
10
  export type { TypeAheadStats, TypeAheadItemRenderProps, TypeAheadInsert, TypeAheadSelectItem, TypeAheadItem, TypeAheadForceSelect, TypeAheadHandler, } from './type-ahead';
11
11
  export type { CommandDispatch, Command, HigherOrderCommand, Predicate } from './command';
12
12
  export type { FeatureFlags, FeatureFlagKey, GetEditorFeatureFlags } from './feature-flags';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-common",
3
- "version": "102.5.0",
3
+ "version": "102.5.2",
4
4
  "description": "A package that contains common classes and components for editor and renderer",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -153,15 +153,15 @@
153
153
  "@atlaskit/platform-feature-flags": "^1.1.0",
154
154
  "@atlaskit/popper": "^7.0.0",
155
155
  "@atlaskit/primitives": "^14.1.0",
156
- "@atlaskit/profilecard": "^23.2.0",
156
+ "@atlaskit/profilecard": "^23.3.0",
157
157
  "@atlaskit/section-message": "^8.1.0",
158
158
  "@atlaskit/smart-card": "^35.2.0",
159
159
  "@atlaskit/smart-user-picker": "^8.0.0",
160
160
  "@atlaskit/spinner": "^18.0.0",
161
- "@atlaskit/task-decision": "^19.0.0",
161
+ "@atlaskit/task-decision": "^19.1.0",
162
162
  "@atlaskit/textfield": "^8.0.0",
163
163
  "@atlaskit/tmp-editor-statsig": "^3.6.0",
164
- "@atlaskit/tokens": "^4.4.0",
164
+ "@atlaskit/tokens": "^4.5.0",
165
165
  "@atlaskit/tooltip": "^20.0.0",
166
166
  "@atlaskit/width-detector": "^5.0.0",
167
167
  "@babel/runtime": "^7.0.0",
@@ -333,6 +333,9 @@
333
333
  },
334
334
  "forge-ui-macro-autoconvert": {
335
335
  "type": "boolean"
336
+ },
337
+ "platform_editor_remove_quick_insert_priority_key": {
338
+ "type": "boolean"
336
339
  }
337
340
  }
338
341
  }