@atlaskit/editor-synced-block-provider 3.4.0 → 3.4.1

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,13 @@
1
1
  # @atlaskit/editor-synced-block-provider
2
2
 
3
+ ## 3.4.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`656adaeec9d0b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/656adaeec9d0b) -
8
+ [ux] EDITOR-1665 add experience tracking for create sync block
9
+ - Updated dependencies
10
+
3
11
  ## 3.4.0
4
12
 
5
13
  ### Minor Changes
@@ -11,6 +11,7 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
11
11
  var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
12
12
  var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
13
13
  var _monitoring = require("@atlaskit/editor-common/monitoring");
14
+ var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
14
15
  var _types = require("../common/types");
15
16
  var _errorHandling = require("../utils/errorHandling");
16
17
  var _utils = require("../utils/utils");
@@ -39,6 +40,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
39
40
  value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
40
41
  this.fireAnalyticsEvent = fireAnalyticsEvent;
41
42
  }
43
+ }, {
44
+ key: "setCreateExperience",
45
+ value: function setCreateExperience(createExperience) {
46
+ this.createExperience = createExperience;
47
+ }
42
48
  }, {
43
49
  key: "isSourceBlock",
44
50
  value: function isSourceBlock(node) {
@@ -271,28 +277,49 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
271
277
  if (resourceId) {
272
278
  _this4.commitPendingCreation(true);
273
279
  } else {
274
- var _this4$fireAnalyticsE;
275
280
  _this4.commitPendingCreation(false);
276
- (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block'));
281
+ if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
282
+ var _this4$createExperien;
283
+ (_this4$createExperien = _this4.createExperience) === null || _this4$createExperien === void 0 || _this4$createExperien.failure({
284
+ reason: result.error || 'Failed to create bodied sync block'
285
+ });
286
+ } else {
287
+ var _this4$fireAnalyticsE;
288
+ (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block'));
289
+ }
277
290
  }
278
291
  }).catch(function (error) {
279
- var _this4$fireAnalyticsE2;
280
292
  _this4.commitPendingCreation(false);
281
293
  (0, _monitoring.logException)(error, {
282
294
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
283
295
  });
284
- (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, (0, _errorHandling.createErrorPayload)(error.message));
296
+ if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
297
+ var _this4$createExperien2;
298
+ (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
299
+ reason: error.message
300
+ });
301
+ } else {
302
+ var _this4$fireAnalyticsE2;
303
+ (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, (0, _errorHandling.createErrorPayload)(error.message));
304
+ }
285
305
  });
286
306
  this.registerPendingCreation(resourceId);
287
307
  } catch (error) {
288
- var _this$fireAnalyticsEv3;
289
308
  if (this.hasPendingCreation()) {
290
309
  this.commitPendingCreation(false);
291
310
  }
292
311
  (0, _monitoring.logException)(error, {
293
312
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
294
313
  });
295
- (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, (0, _errorHandling.createErrorPayload)(error.message));
314
+ if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
315
+ var _this$createExperienc;
316
+ (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 || _this$createExperienc.failure({
317
+ reason: error.message
318
+ });
319
+ } else {
320
+ var _this$fireAnalyticsEv3;
321
+ (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, (0, _errorHandling.createErrorPayload)(error.message));
322
+ }
296
323
  }
297
324
  }
298
325
  }, {
@@ -1,5 +1,6 @@
1
1
  import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
2
  import { logException } from '@atlaskit/editor-common/monitoring';
3
+ import { fg } from '@atlaskit/platform-feature-flags';
3
4
  import { SyncBlockError } from '../common/types';
4
5
  import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
5
6
  import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
@@ -22,6 +23,9 @@ export class SourceSyncBlockStoreManager {
22
23
  setFireAnalyticsEvent(fireAnalyticsEvent) {
23
24
  this.fireAnalyticsEvent = fireAnalyticsEvent;
24
25
  }
26
+ setCreateExperience(createExperience) {
27
+ this.createExperience = createExperience;
28
+ }
25
29
  isSourceBlock(node) {
26
30
  return node.type.name === 'bodiedSyncBlock';
27
31
  }
@@ -201,28 +205,49 @@ export class SourceSyncBlockStoreManager {
201
205
  if (resourceId) {
202
206
  this.commitPendingCreation(true);
203
207
  } else {
204
- var _this$fireAnalyticsEv4;
205
208
  this.commitPendingCreation(false);
206
- (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block'));
209
+ if (fg('platform_synced_block_dogfooding')) {
210
+ var _this$createExperienc;
211
+ (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 ? void 0 : _this$createExperienc.failure({
212
+ reason: result.error || 'Failed to create bodied sync block'
213
+ });
214
+ } else {
215
+ var _this$fireAnalyticsEv4;
216
+ (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block'));
217
+ }
207
218
  }
208
219
  }).catch(error => {
209
- var _this$fireAnalyticsEv5;
210
220
  this.commitPendingCreation(false);
211
221
  logException(error, {
212
222
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
213
223
  });
214
- (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createErrorPayload(error.message));
224
+ if (fg('platform_synced_block_dogfooding')) {
225
+ var _this$createExperienc2;
226
+ (_this$createExperienc2 = this.createExperience) === null || _this$createExperienc2 === void 0 ? void 0 : _this$createExperienc2.failure({
227
+ reason: error.message
228
+ });
229
+ } else {
230
+ var _this$fireAnalyticsEv5;
231
+ (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createErrorPayload(error.message));
232
+ }
215
233
  });
216
234
  this.registerPendingCreation(resourceId);
217
235
  } catch (error) {
218
- var _this$fireAnalyticsEv6;
219
236
  if (this.hasPendingCreation()) {
220
237
  this.commitPendingCreation(false);
221
238
  }
222
239
  logException(error, {
223
240
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
224
241
  });
225
- (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createErrorPayload(error.message));
242
+ if (fg('platform_synced_block_dogfooding')) {
243
+ var _this$createExperienc3;
244
+ (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
245
+ reason: error.message
246
+ });
247
+ } else {
248
+ var _this$fireAnalyticsEv6;
249
+ (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createErrorPayload(error.message));
250
+ }
226
251
  }
227
252
  }
228
253
  async delete(syncBlockIds, onDelete, onDeleteCompleted) {
@@ -6,6 +6,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
6
6
  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; }
7
7
  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; }
8
8
  import { logException } from '@atlaskit/editor-common/monitoring';
9
+ import { fg } from '@atlaskit/platform-feature-flags';
9
10
  import { SyncBlockError } from '../common/types';
10
11
  import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
11
12
  import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
@@ -32,6 +33,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
32
33
  value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
33
34
  this.fireAnalyticsEvent = fireAnalyticsEvent;
34
35
  }
36
+ }, {
37
+ key: "setCreateExperience",
38
+ value: function setCreateExperience(createExperience) {
39
+ this.createExperience = createExperience;
40
+ }
35
41
  }, {
36
42
  key: "isSourceBlock",
37
43
  value: function isSourceBlock(node) {
@@ -264,28 +270,49 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
264
270
  if (resourceId) {
265
271
  _this4.commitPendingCreation(true);
266
272
  } else {
267
- var _this4$fireAnalyticsE;
268
273
  _this4.commitPendingCreation(false);
269
- (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block'));
274
+ if (fg('platform_synced_block_dogfooding')) {
275
+ var _this4$createExperien;
276
+ (_this4$createExperien = _this4.createExperience) === null || _this4$createExperien === void 0 || _this4$createExperien.failure({
277
+ reason: result.error || 'Failed to create bodied sync block'
278
+ });
279
+ } else {
280
+ var _this4$fireAnalyticsE;
281
+ (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block'));
282
+ }
270
283
  }
271
284
  }).catch(function (error) {
272
- var _this4$fireAnalyticsE2;
273
285
  _this4.commitPendingCreation(false);
274
286
  logException(error, {
275
287
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
276
288
  });
277
- (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message));
289
+ if (fg('platform_synced_block_dogfooding')) {
290
+ var _this4$createExperien2;
291
+ (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
292
+ reason: error.message
293
+ });
294
+ } else {
295
+ var _this4$fireAnalyticsE2;
296
+ (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message));
297
+ }
278
298
  });
279
299
  this.registerPendingCreation(resourceId);
280
300
  } catch (error) {
281
- var _this$fireAnalyticsEv3;
282
301
  if (this.hasPendingCreation()) {
283
302
  this.commitPendingCreation(false);
284
303
  }
285
304
  logException(error, {
286
305
  location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
287
306
  });
288
- (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createErrorPayload(error.message));
307
+ if (fg('platform_synced_block_dogfooding')) {
308
+ var _this$createExperienc;
309
+ (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 || _this$createExperienc.failure({
310
+ reason: error.message
311
+ });
312
+ } else {
313
+ var _this$fireAnalyticsEv3;
314
+ (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createErrorPayload(error.message));
315
+ }
289
316
  }
290
317
  }
291
318
  }, {
@@ -1,4 +1,5 @@
1
1
  import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
2
+ import type { Experience } from '@atlaskit/editor-common/experiences';
2
3
  import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
3
4
  import { type ResourceId, type SyncBlockAttrs } from '../common/types';
4
5
  import type { SyncBlockDataProvider } from '../providers/types';
@@ -15,8 +16,10 @@ export declare class SourceSyncBlockStoreManager {
15
16
  private deletionRetryInfo?;
16
17
  private pendingResourceId?;
17
18
  private creationCallback?;
19
+ createExperience: Experience | undefined;
18
20
  constructor(dataProvider?: SyncBlockDataProvider);
19
21
  setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
22
+ setCreateExperience(createExperience: Experience): void;
20
23
  isSourceBlock(node: PMNode): boolean;
21
24
  /**
22
25
  * Add/update a sync block node to/from the local cache
@@ -1,4 +1,5 @@
1
1
  import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
2
+ import type { Experience } from '@atlaskit/editor-common/experiences';
2
3
  import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
3
4
  import { type ResourceId, type SyncBlockAttrs } from '../common/types';
4
5
  import type { SyncBlockDataProvider } from '../providers/types';
@@ -15,8 +16,10 @@ export declare class SourceSyncBlockStoreManager {
15
16
  private deletionRetryInfo?;
16
17
  private pendingResourceId?;
17
18
  private creationCallback?;
19
+ createExperience: Experience | undefined;
18
20
  constructor(dataProvider?: SyncBlockDataProvider);
19
21
  setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
22
+ setCreateExperience(createExperience: Experience): void;
20
23
  isSourceBlock(node: PMNode): boolean;
21
24
  /**
22
25
  * Add/update a sync block node to/from the local cache
package/package.json CHANGED
@@ -77,7 +77,7 @@
77
77
  }
78
78
  },
79
79
  "name": "@atlaskit/editor-synced-block-provider",
80
- "version": "3.4.0",
80
+ "version": "3.4.1",
81
81
  "description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
82
82
  "author": "Atlassian Pty Ltd",
83
83
  "license": "Apache-2.0",