@atlaskit/editor-synced-block-renderer 5.3.0 → 5.3.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-synced-block-renderer
 
+## 5.3.2
+
+### Patch Changes
+
+- [`7f41011a1b0ff`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7f41011a1b0ff) -
+  EDITOR-1665 update sync block experience events to use general experience ids, keep existing error
+  events and add success events
+- Updated dependencies
+
+## 5.3.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 5.3.0
 
 ### Minor Changes

package/afm-jira/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"target": "es5",
 		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-synced-block-renderer/app",

package/afm-products/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../../tsconfig.entry-points.products.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"target": "es5",
 		"outDir": "../../../../../tsDist/@atlaskit__editor-synced-block-renderer/app",

package/dist/cjs/ui/SyncedBlockNodeComponentRenderer.js

@@ -10,8 +10,6 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _react = _interopRequireDefault(require("react"));
 var _syncBlock = require("@atlaskit/editor-common/sync-block");
 var _editorSyncedBlockProvider = require("@atlaskit/editor-synced-block-provider");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
-var _experienceTracking = require("../utils/experience-tracking");
 var _AKRendererWrapper = require("./AKRendererWrapper");
 var _SyncedBlockErrorComponent = require("./SyncedBlockErrorComponent");
 var _SyncedBlockLoadingState = require("./SyncedBlockLoadingState");
@@ -23,9 +21,6 @@ var SyncedBlockNodeComponentRenderer = exports.SyncedBlockNodeComponentRenderer
     localId = nodeProps.localId,
     fireAnalyticsEvent = nodeProps.fireAnalyticsEvent;
   syncBlockStoreManager.referenceManager.updateFireAnalyticsEvent(fireAnalyticsEvent);
-  if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
-    (0, _experienceTracking.setupExperienceTracking)(syncBlockStoreManager, fireAnalyticsEvent);
-  }
   var _useFetchSyncBlockDat = (0, _editorSyncedBlockProvider.useFetchSyncBlockData)(syncBlockStoreManager, resourceId, localId, fireAnalyticsEvent),
     syncBlockInstance = _useFetchSyncBlockDat.syncBlockInstance,
     isLoading = _useFetchSyncBlockDat.isLoading,

package/dist/es2019/ui/SyncedBlockNodeComponentRenderer.js

@@ -1,8 +1,6 @@
 import React from 'react';
 import { SyncBlockSharedCssClassName, SyncBlockRendererDataAttributeName } from '@atlaskit/editor-common/sync-block';
 import { SyncBlockError, useFetchSyncBlockData } from '@atlaskit/editor-synced-block-provider';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { setupExperienceTracking } from '../utils/experience-tracking';
 import { AKRendererWrapper } from './AKRendererWrapper';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
 import { SyncedBlockLoadingState } from './SyncedBlockLoadingState';
@@ -17,9 +15,6 @@ export const SyncedBlockNodeComponentRenderer = ({
     fireAnalyticsEvent
   } = nodeProps;
   syncBlockStoreManager.referenceManager.updateFireAnalyticsEvent(fireAnalyticsEvent);
-  if (fg('platform_synced_block_dogfooding')) {
-    setupExperienceTracking(syncBlockStoreManager, fireAnalyticsEvent);
-  }
   const {
     syncBlockInstance,
     isLoading,

package/dist/esm/ui/SyncedBlockNodeComponentRenderer.js

@@ -3,8 +3,6 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import React from 'react';
 import { SyncBlockSharedCssClassName, SyncBlockRendererDataAttributeName } from '@atlaskit/editor-common/sync-block';
 import { SyncBlockError, useFetchSyncBlockData } from '@atlaskit/editor-synced-block-provider';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { setupExperienceTracking } from '../utils/experience-tracking';
 import { AKRendererWrapper } from './AKRendererWrapper';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
 import { SyncedBlockLoadingState } from './SyncedBlockLoadingState';
@@ -16,9 +14,6 @@ export var SyncedBlockNodeComponentRenderer = function SyncedBlockNodeComponentR
     localId = nodeProps.localId,
     fireAnalyticsEvent = nodeProps.fireAnalyticsEvent;
   syncBlockStoreManager.referenceManager.updateFireAnalyticsEvent(fireAnalyticsEvent);
-  if (fg('platform_synced_block_dogfooding')) {
-    setupExperienceTracking(syncBlockStoreManager, fireAnalyticsEvent);
-  }
   var _useFetchSyncBlockDat = useFetchSyncBlockData(syncBlockStoreManager, resourceId, localId, fireAnalyticsEvent),
     syncBlockInstance = _useFetchSyncBlockDat.syncBlockInstance,
     isLoading = _useFetchSyncBlockDat.isLoading,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-synced-block-renderer",
-	"version": "5.3.0",
+	"version": "5.3.2",
 	"description": "SyncedBlockRenderer for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,17 +30,17 @@
 	"dependencies": {
 		"@atlaskit/button": "^23.9.0",
 		"@atlaskit/css": "^0.19.0",
-		"@atlaskit/editor-plugin-synced-block": "^5.1.0",
-		"@atlaskit/editor-synced-block-provider": "^3.7.0",
+		"@atlaskit/editor-plugin-synced-block": "^5.2.0",
+		"@atlaskit/editor-synced-block-provider": "^3.12.0",
 		"@atlaskit/heading": "^5.2.0",
 		"@atlaskit/icon": "^29.4.0",
 		"@atlaskit/icon-lab": "^5.14.0",
 		"@atlaskit/image": "^3.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^17.1.0",
-		"@atlaskit/renderer": "^125.4.0",
+		"@atlaskit/renderer": "^126.1.0",
 		"@atlaskit/spinner": "^19.0.0",
-		"@atlaskit/tokens": "^9.1.0",
+		"@atlaskit/tokens": "^10.1.0",
 		"@atlaskit/tooltip": "^20.14.0",
 		"@babel/runtime": "^7.0.0",
 		"react-relay": "npm:atl-react-relay@0.0.0-main-39e79f66",

package/dist/cjs/utils/experience-tracking.js

@@ -1,74 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.setupExperienceTracking = exports.getSaveReferenceExperience = exports.getFetchSourceInfoExperience = exports.getFetchExperience = exports.createExperienceDispatcher = void 0;
-var _analytics = require("@atlaskit/editor-common/analytics");
-var _experiences = require("@atlaskit/editor-common/experiences");
-var setupExperienceTracking = exports.setupExperienceTracking = function setupExperienceTracking(syncBlockStoreManager, fireAnalyticsEvent) {
-  if (!fireAnalyticsEvent) {
-    return;
-  }
-  var dispatchAnalyticsEvent = createExperienceDispatcher(fireAnalyticsEvent);
-  syncBlockStoreManager.referenceManager.setExperiences(getFetchExperience(dispatchAnalyticsEvent), getFetchSourceInfoExperience(dispatchAnalyticsEvent), getSaveReferenceExperience(dispatchAnalyticsEvent));
-};
-var createExperienceDispatcher = exports.createExperienceDispatcher = function createExperienceDispatcher(fireAnalyticsEvent) {
-  return function (payload) {
-    // Runtime type guard - only forward experience events
-    if (payload.action === 'experienceMeasured' || payload.action === 'experienceSampled') {
-      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent(payload);
-    }
-  };
-};
-
-/**
- * This experience tracks when a reference sync block data is fetched from the BE.
- *
- * Start: When the fetchNodesData function is called.
- * Success: When the fetching the data is successful within 1500ms of start.
- * Failure: When 1500ms passes without the data being successfully fetched, or the fetch fails
- */
-var getFetchExperience = exports.getFetchExperience = function getFetchExperience(dispatchAnalyticsEvent) {
-  return new _experiences.Experience(_analytics.ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: _analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new _experiences.ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
- *
- * Start: When the fetchSourceInfo function is called.
- * Success: When the fetching the data is successful within 2500ms of start.
- * Failure: When 2500ms passes without the data being successfully fetched, or the fetch fails
- */
-var getFetchSourceInfoExperience = exports.getFetchSourceInfoExperience = function getFetchSourceInfoExperience(dispatchAnalyticsEvent) {
-  return new _experiences.Experience(_analytics.ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: _analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new _experiences.ExperienceCheckTimeout({
-      durationMs: 2500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block is saved to the BE.
- *
- * Start: When the flush sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes before the sync block save is marked as successful
- */
-var getSaveReferenceExperience = exports.getSaveReferenceExperience = function getSaveReferenceExperience(dispatchAnalyticsEvent) {
-  return new _experiences.Experience(_analytics.ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: _analytics.ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new _experiences.ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};

package/dist/es2019/utils/experience-tracking.js

@@ -1,68 +0,0 @@
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
-export const setupExperienceTracking = (syncBlockStoreManager, fireAnalyticsEvent) => {
-  if (!fireAnalyticsEvent) {
-    return;
-  }
-  const dispatchAnalyticsEvent = createExperienceDispatcher(fireAnalyticsEvent);
-  syncBlockStoreManager.referenceManager.setExperiences(getFetchExperience(dispatchAnalyticsEvent), getFetchSourceInfoExperience(dispatchAnalyticsEvent), getSaveReferenceExperience(dispatchAnalyticsEvent));
-};
-export const createExperienceDispatcher = fireAnalyticsEvent => {
-  return payload => {
-    // Runtime type guard - only forward experience events
-    if (payload.action === 'experienceMeasured' || payload.action === 'experienceSampled') {
-      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(payload);
-    }
-  };
-};
-
-/**
- * This experience tracks when a reference sync block data is fetched from the BE.
- *
- * Start: When the fetchNodesData function is called.
- * Success: When the fetching the data is successful within 1500ms of start.
- * Failure: When 1500ms passes without the data being successfully fetched, or the fetch fails
- */
-export const getFetchExperience = dispatchAnalyticsEvent => {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH,
-    dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
- *
- * Start: When the fetchSourceInfo function is called.
- * Success: When the fetching the data is successful within 2500ms of start.
- * Failure: When 2500ms passes without the data being successfully fetched, or the fetch fails
- */
-export const getFetchSourceInfoExperience = dispatchAnalyticsEvent => {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO,
-    dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 2500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block is saved to the BE.
- *
- * Start: When the flush sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes before the sync block save is marked as successful
- */
-export const getSaveReferenceExperience = dispatchAnalyticsEvent => {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE,
-    dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};

package/dist/esm/utils/experience-tracking.js

@@ -1,68 +0,0 @@
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
-export var setupExperienceTracking = function setupExperienceTracking(syncBlockStoreManager, fireAnalyticsEvent) {
-  if (!fireAnalyticsEvent) {
-    return;
-  }
-  var dispatchAnalyticsEvent = createExperienceDispatcher(fireAnalyticsEvent);
-  syncBlockStoreManager.referenceManager.setExperiences(getFetchExperience(dispatchAnalyticsEvent), getFetchSourceInfoExperience(dispatchAnalyticsEvent), getSaveReferenceExperience(dispatchAnalyticsEvent));
-};
-export var createExperienceDispatcher = function createExperienceDispatcher(fireAnalyticsEvent) {
-  return function (payload) {
-    // Runtime type guard - only forward experience events
-    if (payload.action === 'experienceMeasured' || payload.action === 'experienceSampled') {
-      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent(payload);
-    }
-  };
-};
-
-/**
- * This experience tracks when a reference sync block data is fetched from the BE.
- *
- * Start: When the fetchNodesData function is called.
- * Success: When the fetching the data is successful within 1500ms of start.
- * Failure: When 1500ms passes without the data being successfully fetched, or the fetch fails
- */
-export var getFetchExperience = function getFetchExperience(dispatchAnalyticsEvent) {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
- *
- * Start: When the fetchSourceInfo function is called.
- * Success: When the fetching the data is successful within 2500ms of start.
- * Failure: When 2500ms passes without the data being successfully fetched, or the fetch fails
- */
-export var getFetchSourceInfoExperience = function getFetchSourceInfoExperience(dispatchAnalyticsEvent) {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 2500
-    })]
-  });
-};
-
-/**
- * This experience tracks when a reference sync block is saved to the BE.
- *
- * Start: When the flush sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes before the sync block save is marked as successful
- */
-export var getSaveReferenceExperience = function getSaveReferenceExperience(dispatchAnalyticsEvent) {
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};

package/dist/types/utils/experience-tracking.d.ts

@@ -1,30 +0,0 @@
-import { type DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
-import { Experience } from '@atlaskit/editor-common/experiences';
-import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-import type { AnalyticsEventPayload as RendererAnalyticsEventPayload } from '@atlaskit/renderer';
-export declare const setupExperienceTracking: (syncBlockStoreManager: SyncBlockStoreManager, fireAnalyticsEvent?: ((payload: RendererAnalyticsEventPayload) => void)) => void;
-export declare const createExperienceDispatcher: (fireAnalyticsEvent?: ((payload: RendererAnalyticsEventPayload) => void)) => DispatchAnalyticsEvent;
-/**
- * This experience tracks when a reference sync block data is fetched from the BE.
- *
- * Start: When the fetchNodesData function is called.
- * Success: When the fetching the data is successful within 1500ms of start.
- * Failure: When 1500ms passes without the data being successfully fetched, or the fetch fails
- */
-export declare const getFetchExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;
-/**
- * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
- *
- * Start: When the fetchSourceInfo function is called.
- * Success: When the fetching the data is successful within 2500ms of start.
- * Failure: When 2500ms passes without the data being successfully fetched, or the fetch fails
- */
-export declare const getFetchSourceInfoExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;
-/**
- * This experience tracks when a reference sync block is saved to the BE.
- *
- * Start: When the flush sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes before the sync block save is marked as successful
- */
-export declare const getSaveReferenceExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;

package/dist/types-ts4.5/utils/experience-tracking.d.ts

@@ -1,30 +0,0 @@
-import { type DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
-import { Experience } from '@atlaskit/editor-common/experiences';
-import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-import type { AnalyticsEventPayload as RendererAnalyticsEventPayload } from '@atlaskit/renderer';
-export declare const setupExperienceTracking: (syncBlockStoreManager: SyncBlockStoreManager, fireAnalyticsEvent?: ((payload: RendererAnalyticsEventPayload) => void)) => void;
-export declare const createExperienceDispatcher: (fireAnalyticsEvent?: ((payload: RendererAnalyticsEventPayload) => void)) => DispatchAnalyticsEvent;
-/**
- * This experience tracks when a reference sync block data is fetched from the BE.
- *
- * Start: When the fetchNodesData function is called.
- * Success: When the fetching the data is successful within 1500ms of start.
- * Failure: When 1500ms passes without the data being successfully fetched, or the fetch fails
- */
-export declare const getFetchExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;
-/**
- * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
- *
- * Start: When the fetchSourceInfo function is called.
- * Success: When the fetching the data is successful within 2500ms of start.
- * Failure: When 2500ms passes without the data being successfully fetched, or the fetch fails
- */
-export declare const getFetchSourceInfoExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;
-/**
- * This experience tracks when a reference sync block is saved to the BE.
- *
- * Start: When the flush sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes before the sync block save is marked as successful
- */
-export declare const getSaveReferenceExperience: (dispatchAnalyticsEvent: DispatchAnalyticsEvent) => Experience;