@atlaskit/editor-plugin-annotation 1.10.2 → 1.10.3

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.
Files changed (10) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/cjs/commands/index.js +1 -1
  3. package/dist/cjs/commands/transform.js +24 -1
  4. package/dist/es2019/commands/index.js +1 -1
  5. package/dist/es2019/commands/transform.js +19 -1
  6. package/dist/esm/commands/index.js +1 -1
  7. package/dist/esm/commands/transform.js +24 -1
  8. package/dist/types/commands/transform.d.ts +1 -0
  9. package/dist/types-ts4.5/commands/transform.d.ts +1 -0
  10. package/package.json +32 -12
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @atlaskit/editor-plugin-annotation
2
2
 
3
+ ## 1.10.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [#110714](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/110714)
8
+ [`9e5e71458aec6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9e5e71458aec6) -
9
+ [ED-23281] Explictly opt out scrollIntoView when adding annotation mark as it is handled by
10
+ scrolling comment sidebar into view instead
11
+ - Updated dependencies
12
+
3
13
  ## 1.10.2
4
14
 
5
15
  ### Patch Changes
package/dist/cjs/commands/index.js CHANGED
@@ -179,7 +179,7 @@ var setInlineCommentDraftState = exports.setInlineCommentDraftState = function s
179
179
  var isCommentOnMediaOn = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
180
180
  var targetNodeId = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : undefined;
181
181
  var commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, isCommentOnMediaOn, supportedBlockNodes);
182
- return (0, _pluginFactory.createCommand)(commandAction, _transform.default.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
182
+ return (0, _pluginFactory.createCommand)(commandAction, _transform.default.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
183
183
  };
184
184
  };
185
185
  var addInlineComment = exports.addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {
package/dist/cjs/commands/transform.js CHANGED
@@ -42,7 +42,7 @@ var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
42
42
  var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {
43
43
  return function (id, supportedBlockNodes) {
44
44
  return function (transaction, state) {
45
- var _editorAPI$editorView;
45
+ var _editorAPI$editorView, _pluginState$featureF;
46
46
  var tr = addAnnotationMark(id, supportedBlockNodes)(transaction, state);
47
47
  editorAPI === null || editorAPI === void 0 || (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 || _editorAPI$editorView.actions.applyViewModeStepAt(tr);
48
48
 
@@ -50,6 +50,12 @@ var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI)
50
50
  tr = addInsertAnalytics(editorAnalyticsAPI)(tr, state);
51
51
  // add close analytics step to transaction
52
52
  tr = addOpenCloseAnalytics(editorAnalyticsAPI)(false, _analytics.INPUT_METHOD.TOOLBAR)(tr, state);
53
+ var pluginState = (0, _utils2.getPluginState)(state);
54
+ var isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 || (_pluginState$featureF = pluginState.featureFlagsPluginState) === null || _pluginState$featureF === void 0 ? void 0 : _pluginState$featureF.commentsOnMediaAutoscrollInEditor;
55
+ if (isAutoScrollBugFixEnabled) {
56
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
57
+ tr.setMeta('scrollIntoView', false);
58
+ }
53
59
  return tr;
54
60
  };
55
61
  };
@@ -64,6 +70,22 @@ var addOpenCloseAnalytics = function addOpenCloseAnalytics(editorAnalyticsAPI) {
64
70
  };
65
71
  };
66
72
  };
73
+ var handleDraftState = function handleDraftState(editorAnalyticsAPI) {
74
+ return function (drafting) {
75
+ var method = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _analytics.INPUT_METHOD.TOOLBAR;
76
+ return function (transaction, state) {
77
+ var _pluginState$featureF2;
78
+ var tr = addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, method)(transaction, state);
79
+ var pluginState = (0, _utils2.getPluginState)(state);
80
+ var isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 || (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaAutoscrollInEditor;
81
+ if (isAutoScrollBugFixEnabled) {
82
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
83
+ tr.setMeta('scrollIntoView', false);
84
+ }
85
+ return tr;
86
+ };
87
+ };
88
+ };
67
89
  var addInsertAnalytics = function addInsertAnalytics(editorAnalyticsAPI) {
68
90
  return function (transaction, state) {
69
91
  var analyticsEvent = {
@@ -109,6 +131,7 @@ var addResolveAnalytics = function addResolveAnalytics(editorAnalyticsAPI) {
109
131
  var _default = exports.default = {
110
132
  addAnnotationMark: addAnnotationMark,
111
133
  addInlineComment: addInlineComment,
134
+ handleDraftState: handleDraftState,
112
135
  addOpenCloseAnalytics: addOpenCloseAnalytics,
113
136
  addInsertAnalytics: addInsertAnalytics,
114
137
  addResolveAnalytics: addResolveAnalytics
package/dist/es2019/commands/index.js CHANGED
@@ -148,7 +148,7 @@ export const showInlineCommentForBlockNode = (supportedBlockNodes = []) => (node
148
148
  };
149
149
  export const setInlineCommentDraftState = (editorAnalyticsAPI, supportedBlockNodes = []) => (drafting, inputMethod = INPUT_METHOD.TOOLBAR, targetType = 'inline', isCommentOnMediaOn = false, targetNodeId = undefined) => {
150
150
  const commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, isCommentOnMediaOn, supportedBlockNodes);
151
- return createCommand(commandAction, transform.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
151
+ return createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
152
152
  };
153
153
  export const addInlineComment = (editorAnalyticsAPI, editorAPI) => (id, supportedBlockNodes) => {
154
154
  const commandAction = editorState => ({
package/dist/es2019/commands/transform.js CHANGED
@@ -34,7 +34,7 @@ const addAnnotationMark = (id, supportedBlockNodes) => (transaction, state) => {
34
34
  return tr;
35
35
  };
36
36
  const addInlineComment = (editorAnalyticsAPI, editorAPI) => (id, supportedBlockNodes) => (transaction, state) => {
37
- var _editorAPI$editorView;
37
+ var _editorAPI$editorView, _pluginState$featureF;
38
38
  let tr = addAnnotationMark(id, supportedBlockNodes)(transaction, state);
39
39
  editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 ? void 0 : _editorAPI$editorView.actions.applyViewModeStepAt(tr);
40
40
 
@@ -42,6 +42,12 @@ const addInlineComment = (editorAnalyticsAPI, editorAPI) => (id, supportedBlockN
42
42
  tr = addInsertAnalytics(editorAnalyticsAPI)(tr, state);
43
43
  // add close analytics step to transaction
44
44
  tr = addOpenCloseAnalytics(editorAnalyticsAPI)(false, INPUT_METHOD.TOOLBAR)(tr, state);
45
+ const pluginState = getPluginState(state);
46
+ const isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$featureF = pluginState.featureFlagsPluginState) === null || _pluginState$featureF === void 0 ? void 0 : _pluginState$featureF.commentsOnMediaAutoscrollInEditor;
47
+ if (isAutoScrollBugFixEnabled) {
48
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
49
+ tr.setMeta('scrollIntoView', false);
50
+ }
45
51
  return tr;
46
52
  };
47
53
  const addOpenCloseAnalytics = editorAnalyticsAPI => (drafting, method = INPUT_METHOD.TOOLBAR) => (transaction, state) => {
@@ -49,6 +55,17 @@ const addOpenCloseAnalytics = editorAnalyticsAPI => (drafting, method = INPUT_ME
49
55
  editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 ? void 0 : editorAnalyticsAPI.attachAnalyticsEvent(draftingPayload)(transaction);
50
56
  return transaction;
51
57
  };
58
+ const handleDraftState = editorAnalyticsAPI => (drafting, method = INPUT_METHOD.TOOLBAR) => (transaction, state) => {
59
+ var _pluginState$featureF2;
60
+ const tr = addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, method)(transaction, state);
61
+ const pluginState = getPluginState(state);
62
+ const isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaAutoscrollInEditor;
63
+ if (isAutoScrollBugFixEnabled) {
64
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
65
+ tr.setMeta('scrollIntoView', false);
66
+ }
67
+ return tr;
68
+ };
52
69
  const addInsertAnalytics = editorAnalyticsAPI => (transaction, state) => {
53
70
  const analyticsEvent = {
54
71
  action: ACTION.INSERTED,
@@ -89,6 +106,7 @@ const addResolveAnalytics = editorAnalyticsAPI => method => (transaction, state)
89
106
  export default {
90
107
  addAnnotationMark,
91
108
  addInlineComment,
109
+ handleDraftState,
92
110
  addOpenCloseAnalytics,
93
111
  addInsertAnalytics,
94
112
  addResolveAnalytics
package/dist/esm/commands/index.js CHANGED
@@ -172,7 +172,7 @@ export var setInlineCommentDraftState = function setInlineCommentDraftState(edit
172
172
  var isCommentOnMediaOn = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
173
173
  var targetNodeId = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : undefined;
174
174
  var commandAction = getDraftCommandAction(drafting, targetType, targetNodeId, isCommentOnMediaOn, supportedBlockNodes);
175
- return createCommand(commandAction, transform.addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, inputMethod));
175
+ return createCommand(commandAction, transform.handleDraftState(editorAnalyticsAPI)(drafting, inputMethod));
176
176
  };
177
177
  };
178
178
  export var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {
package/dist/esm/commands/transform.js CHANGED
@@ -36,7 +36,7 @@ var addAnnotationMark = function addAnnotationMark(id, supportedBlockNodes) {
36
36
  var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI) {
37
37
  return function (id, supportedBlockNodes) {
38
38
  return function (transaction, state) {
39
- var _editorAPI$editorView;
39
+ var _editorAPI$editorView, _pluginState$featureF;
40
40
  var tr = addAnnotationMark(id, supportedBlockNodes)(transaction, state);
41
41
  editorAPI === null || editorAPI === void 0 || (_editorAPI$editorView = editorAPI.editorViewMode) === null || _editorAPI$editorView === void 0 || _editorAPI$editorView.actions.applyViewModeStepAt(tr);
42
42
 
@@ -44,6 +44,12 @@ var addInlineComment = function addInlineComment(editorAnalyticsAPI, editorAPI)
44
44
  tr = addInsertAnalytics(editorAnalyticsAPI)(tr, state);
45
45
  // add close analytics step to transaction
46
46
  tr = addOpenCloseAnalytics(editorAnalyticsAPI)(false, INPUT_METHOD.TOOLBAR)(tr, state);
47
+ var pluginState = getPluginState(state);
48
+ var isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 || (_pluginState$featureF = pluginState.featureFlagsPluginState) === null || _pluginState$featureF === void 0 ? void 0 : _pluginState$featureF.commentsOnMediaAutoscrollInEditor;
49
+ if (isAutoScrollBugFixEnabled) {
50
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
51
+ tr.setMeta('scrollIntoView', false);
52
+ }
47
53
  return tr;
48
54
  };
49
55
  };
@@ -58,6 +64,22 @@ var addOpenCloseAnalytics = function addOpenCloseAnalytics(editorAnalyticsAPI) {
58
64
  };
59
65
  };
60
66
  };
67
+ var handleDraftState = function handleDraftState(editorAnalyticsAPI) {
68
+ return function (drafting) {
69
+ var method = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : INPUT_METHOD.TOOLBAR;
70
+ return function (transaction, state) {
71
+ var _pluginState$featureF2;
72
+ var tr = addOpenCloseAnalytics(editorAnalyticsAPI)(drafting, method)(transaction, state);
73
+ var pluginState = getPluginState(state);
74
+ var isAutoScrollBugFixEnabled = pluginState === null || pluginState === void 0 || (_pluginState$featureF2 = pluginState.featureFlagsPluginState) === null || _pluginState$featureF2 === void 0 ? void 0 : _pluginState$featureF2.commentsOnMediaAutoscrollInEditor;
75
+ if (isAutoScrollBugFixEnabled) {
76
+ // Explicitly disable scrollIntoView as scrolling is handled by CommentSidebar
77
+ tr.setMeta('scrollIntoView', false);
78
+ }
79
+ return tr;
80
+ };
81
+ };
82
+ };
61
83
  var addInsertAnalytics = function addInsertAnalytics(editorAnalyticsAPI) {
62
84
  return function (transaction, state) {
63
85
  var analyticsEvent = {
@@ -103,6 +125,7 @@ var addResolveAnalytics = function addResolveAnalytics(editorAnalyticsAPI) {
103
125
  export default {
104
126
  addAnnotationMark: addAnnotationMark,
105
127
  addInlineComment: addInlineComment,
128
+ handleDraftState: handleDraftState,
106
129
  addOpenCloseAnalytics: addOpenCloseAnalytics,
107
130
  addInsertAnalytics: addInsertAnalytics,
108
131
  addResolveAnalytics: addResolveAnalytics
package/dist/types/commands/transform.d.ts CHANGED
@@ -141,6 +141,7 @@ declare const _default: {
141
141
  pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
142
142
  sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
143
143
  }, import("@atlaskit/editor-common/types").FeatureFlags>>]> | undefined) => (id: string, supportedBlockNodes?: string[] | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
144
+ handleDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
144
145
  addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
145
146
  addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
146
147
  addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
package/dist/types-ts4.5/commands/transform.d.ts CHANGED
@@ -168,6 +168,7 @@ declare const _default: {
168
168
  sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
169
169
  }, import("@atlaskit/editor-common/types").FeatureFlags>>
170
170
  ]> | undefined) => (id: string, supportedBlockNodes?: string[] | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
171
+ handleDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
171
172
  addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
172
173
  addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
173
174
  addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-annotation",
3
- "version": "1.10.2",
3
+ "version": "1.10.3",
4
4
  "description": "Annotation plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -20,7 +20,10 @@
20
20
  "types": "dist/types/index.d.ts",
21
21
  "typesVersions": {
22
22
  ">=4.5 <4.9": {
23
- "*": ["dist/types-ts4.5/*", "dist/types-ts4.5/index.d.ts"]
23
+ "*": [
24
+ "dist/types-ts4.5/*",
25
+ "dist/types-ts4.5/index.d.ts"
26
+ ]
24
27
  }
25
28
  },
26
29
  "sideEffects": false,
@@ -30,12 +33,12 @@
30
33
  },
31
34
  "dependencies": {
32
35
  "@atlaskit/adf-schema": "^36.10.7",
33
- "@atlaskit/editor-common": "^82.6.0",
36
+ "@atlaskit/editor-common": "^82.9.0",
34
37
  "@atlaskit/editor-plugin-analytics": "^1.2.0",
35
38
  "@atlaskit/editor-plugin-editor-viewmode": "^1.2.0",
36
39
  "@atlaskit/editor-plugin-feature-flags": "^1.1.0",
37
40
  "@atlaskit/editor-prosemirror": "4.0.1",
38
- "@atlaskit/icon": "^22.3.0",
41
+ "@atlaskit/icon": "^22.4.0",
39
42
  "@atlaskit/platform-feature-flags": "^0.2.0",
40
43
  "@babel/runtime": "^7.0.0"
41
44
  },
@@ -55,18 +58,35 @@
55
58
  },
56
59
  "techstack": {
57
60
  "@atlassian/frontend": {
58
- "import-structure": ["atlassian-conventions"],
59
- "circular-dependencies": ["file-and-folder-level"]
61
+ "import-structure": [
62
+ "atlassian-conventions"
63
+ ],
64
+ "circular-dependencies": [
65
+ "file-and-folder-level"
66
+ ]
60
67
  },
61
68
  "@repo/internal": {
62
69
  "dom-events": "use-bind-event-listener",
63
- "analytics": ["analytics-next"],
64
- "design-tokens": ["color"],
65
- "theming": ["react-context"],
66
- "ui-components": ["lite-mode"],
70
+ "analytics": [
71
+ "analytics-next"
72
+ ],
73
+ "design-tokens": [
74
+ "color"
75
+ ],
76
+ "theming": [
77
+ "react-context"
78
+ ],
79
+ "ui-components": [
80
+ "lite-mode"
81
+ ],
67
82
  "deprecation": "no-deprecated-imports",
68
- "styling": ["emotion", "emotion"],
69
- "imports": ["import-no-extraneous-disable-for-examples-and-docs"]
83
+ "styling": [
84
+ "emotion",
85
+ "emotion"
86
+ ],
87
+ "imports": [
88
+ "import-no-extraneous-disable-for-examples-and-docs"
89
+ ]
70
90
  }
71
91
  },
72
92
  "platform-feature-flags": {