@atlaskit/editor-synced-block-provider 2.16.2 → 2.16.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.16.3
+
+### Patch Changes
+
+- [`ef9a29c147d99`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ef9a29c147d99) -
+  EDITOR-4021 Ensure store manager reference remains stable when fireAnalytics callback changes.
+- Updated dependencies
+
 ## 2.16.2
 
 ### Patch Changes

package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js

@@ -28,7 +28,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 // Handles fetching source URL and title for sync blocks.
 // Can be used in both editor and renderer contexts.
 var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function ReferenceSyncBlockStoreManager(dataProvider) {
     (0, _classCallCheck2.default)(this, ReferenceSyncBlockStoreManager);
     // Keeps track of addition and deletion of reference synced blocks on the document
     // This starts as true to always flush the cache when document is saved for the first time
@@ -42,9 +42,13 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     this.syncBlockFetchDataRequests = new Map();
     this.syncBlockSourceInfoRequests = new Map();
     this.providerFactories = new Map();
-    this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   return (0, _createClass2.default)(ReferenceSyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.fireAnalyticsEvent = fireAnalyticsEvent;
+    }
+  }, {
     key: "generateResourceIdForReference",
     value: function generateResourceIdForReference(sourceId) {
       if (!this.dataProvider) {

package/dist/cjs/store-manager/sourceSyncBlockStoreManager.js

@@ -23,7 +23,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function SourceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function SourceSyncBlockStoreManager(dataProvider) {
     var _this = this;
     (0, _classCallCheck2.default)(this, SourceSyncBlockStoreManager);
     (0, _defineProperty2.default)(this, "setPendingDeletion", function (Ids, value) {
@@ -34,9 +34,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     });
     this.dataProvider = dataProvider;
     this.syncBlockCache = new Map();
-    this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   return (0, _createClass2.default)(SourceSyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.fireAnalyticsEvent = fireAnalyticsEvent;
+    }
+  }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       return node.type.name === 'bodiedSyncBlock';

package/dist/cjs/store-manager/syncBlockStoreManager.js

@@ -16,14 +16,20 @@ var _sourceSyncBlockStoreManager = require("./sourceSyncBlockStoreManager");
 // SourceSyncBlockStoreManager is responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Can be used in both editor and renderer contexts.
 var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function SyncBlockStoreManager(dataProvider) {
     (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
     // In future, if reference manager needs to reach to source manager and read it's current in memorey cache
     // we can pass the source manager as a parameter to the reference manager constructor
-    this.sourceSyncBlockStoreManager = new _sourceSyncBlockStoreManager.SourceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
-    this.referenceSyncBlockStoreManager = new _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+    this.sourceSyncBlockStoreManager = new _sourceSyncBlockStoreManager.SourceSyncBlockStoreManager(dataProvider);
+    this.referenceSyncBlockStoreManager = new _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager(dataProvider);
   }
   return (0, _createClass2.default)(SyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.referenceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+      this.sourceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+    }
+  }, {
     key: "referenceManager",
     get: function get() {
       return this.referenceSyncBlockStoreManager;
@@ -42,8 +48,10 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
   }]);
 }();
 var useMemoizedSyncBlockStoreManager = exports.useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
-  return (0, _react.useMemo)(function () {
-    var syncBlockStoreManager = new SyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+  var syncBlockStoreManager = (0, _react.useMemo)(function () {
+    var syncBlockStoreManager = new SyncBlockStoreManager(dataProvider);
     return syncBlockStoreManager;
-  }, [dataProvider, fireAnalyticsEvent]);
+  }, [dataProvider]);
+  syncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+  return syncBlockStoreManager;
 };

package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js

@@ -12,7 +12,7 @@ import { createSyncBlockNode } from '../utils/utils';
 // Handles fetching source URL and title for sync blocks.
 // Can be used in both editor and renderer contexts.
 export class ReferenceSyncBlockStoreManager {
-  constructor(dataProvider, fireAnalyticsEvent) {
+  constructor(dataProvider) {
     // Keeps track of addition and deletion of reference synced blocks on the document
     // This starts as true to always flush the cache when document is saved for the first time
     // to cater the case when a editor seesion is closed without document being updated right after reference block is deleted
@@ -25,6 +25,8 @@ export class ReferenceSyncBlockStoreManager {
     this.syncBlockFetchDataRequests = new Map();
     this.syncBlockSourceInfoRequests = new Map();
     this.providerFactories = new Map();
+  }
+  setFireAnalyticsEvent(fireAnalyticsEvent) {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   generateResourceIdForReference(sourceId) {

package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js

@@ -11,7 +11,7 @@ import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 export class SourceSyncBlockStoreManager {
-  constructor(dataProvider, fireAnalyticsEvent) {
+  constructor(dataProvider) {
     _defineProperty(this, "setPendingDeletion", (Ids, value) => {
       const syncBlock = this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
@@ -20,6 +20,8 @@ export class SourceSyncBlockStoreManager {
     });
     this.dataProvider = dataProvider;
     this.syncBlockCache = new Map();
+  }
+  setFireAnalyticsEvent(fireAnalyticsEvent) {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   isSourceBlock(node) {

package/dist/es2019/store-manager/syncBlockStoreManager.js

@@ -8,11 +8,15 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 // SourceSyncBlockStoreManager is responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Can be used in both editor and renderer contexts.
 export class SyncBlockStoreManager {
-  constructor(dataProvider, fireAnalyticsEvent) {
+  constructor(dataProvider) {
     // In future, if reference manager needs to reach to source manager and read it's current in memorey cache
     // we can pass the source manager as a parameter to the reference manager constructor
-    this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
-    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+    this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider);
+    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider);
+  }
+  setFireAnalyticsEvent(fireAnalyticsEvent) {
+    this.referenceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+    this.sourceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
   }
   get referenceManager() {
     return this.referenceSyncBlockStoreManager;
@@ -26,8 +30,10 @@ export class SyncBlockStoreManager {
   }
 }
 export const useMemoizedSyncBlockStoreManager = (dataProvider, fireAnalyticsEvent) => {
-  return useMemo(() => {
-    const syncBlockStoreManager = new SyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+  const syncBlockStoreManager = useMemo(() => {
+    const syncBlockStoreManager = new SyncBlockStoreManager(dataProvider);
     return syncBlockStoreManager;
-  }, [dataProvider, fireAnalyticsEvent]);
+  }, [dataProvider]);
+  syncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+  return syncBlockStoreManager;
 };

package/dist/esm/store-manager/referenceSyncBlockStoreManager.js

@@ -22,7 +22,7 @@ import { createSyncBlockNode } from '../utils/utils';
 // Handles fetching source URL and title for sync blocks.
 // Can be used in both editor and renderer contexts.
 export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function ReferenceSyncBlockStoreManager(dataProvider) {
     _classCallCheck(this, ReferenceSyncBlockStoreManager);
     // Keeps track of addition and deletion of reference synced blocks on the document
     // This starts as true to always flush the cache when document is saved for the first time
@@ -36,9 +36,13 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     this.syncBlockFetchDataRequests = new Map();
     this.syncBlockSourceInfoRequests = new Map();
     this.providerFactories = new Map();
-    this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   return _createClass(ReferenceSyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.fireAnalyticsEvent = fireAnalyticsEvent;
+    }
+  }, {
     key: "generateResourceIdForReference",
     value: function generateResourceIdForReference(sourceId) {
       if (!this.dataProvider) {

package/dist/esm/store-manager/sourceSyncBlockStoreManager.js

@@ -17,7 +17,7 @@ import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
-  function SourceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function SourceSyncBlockStoreManager(dataProvider) {
     var _this = this;
     _classCallCheck(this, SourceSyncBlockStoreManager);
     _defineProperty(this, "setPendingDeletion", function (Ids, value) {
@@ -28,9 +28,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     });
     this.dataProvider = dataProvider;
     this.syncBlockCache = new Map();
-    this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   return _createClass(SourceSyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.fireAnalyticsEvent = fireAnalyticsEvent;
+    }
+  }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       return node.type.name === 'bodiedSyncBlock';

package/dist/esm/store-manager/syncBlockStoreManager.js

@@ -10,14 +10,20 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 // SourceSyncBlockStoreManager is responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Can be used in both editor and renderer contexts.
 export var SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
+  function SyncBlockStoreManager(dataProvider) {
     _classCallCheck(this, SyncBlockStoreManager);
     // In future, if reference manager needs to reach to source manager and read it's current in memorey cache
     // we can pass the source manager as a parameter to the reference manager constructor
-    this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
-    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+    this.sourceSyncBlockStoreManager = new SourceSyncBlockStoreManager(dataProvider);
+    this.referenceSyncBlockStoreManager = new ReferenceSyncBlockStoreManager(dataProvider);
   }
   return _createClass(SyncBlockStoreManager, [{
+    key: "setFireAnalyticsEvent",
+    value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
+      this.referenceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+      this.sourceSyncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+    }
+  }, {
     key: "referenceManager",
     get: function get() {
       return this.referenceSyncBlockStoreManager;
@@ -36,8 +42,10 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
   }]);
 }();
 export var useMemoizedSyncBlockStoreManager = function useMemoizedSyncBlockStoreManager(dataProvider, fireAnalyticsEvent) {
-  return useMemo(function () {
-    var syncBlockStoreManager = new SyncBlockStoreManager(dataProvider, fireAnalyticsEvent);
+  var syncBlockStoreManager = useMemo(function () {
+    var syncBlockStoreManager = new SyncBlockStoreManager(dataProvider);
     return syncBlockStoreManager;
-  }, [dataProvider, fireAnalyticsEvent]);
+  }, [dataProvider]);
+  syncBlockStoreManager.setFireAnalyticsEvent(fireAnalyticsEvent);
+  return syncBlockStoreManager;
 };

package/dist/types/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -14,7 +14,8 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockFetchDataRequests;
     private syncBlockSourceInfoRequests;
     private isRefreshingSubscriptions;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;

package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -15,7 +15,8 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

package/dist/types/store-manager/syncBlockStoreManager.d.ts

@@ -5,7 +5,8 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     get referenceManager(): ReferenceSyncBlockStoreManager;
     get sourceManager(): SourceSyncBlockStoreManager;
     destroy(): void;

package/dist/types-ts4.5/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -14,7 +14,8 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockFetchDataRequests;
     private syncBlockSourceInfoRequests;
     private isRefreshingSubscriptions;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;

package/dist/types-ts4.5/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -15,7 +15,8 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

package/dist/types-ts4.5/store-manager/syncBlockStoreManager.d.ts

@@ -5,7 +5,8 @@ import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
-    constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
+    constructor(dataProvider?: SyncBlockDataProvider);
+    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     get referenceManager(): ReferenceSyncBlockStoreManager;
     get sourceManager(): SourceSyncBlockStoreManager;
     destroy(): void;

package/package.json

@@ -76,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.16.2",
+	"version": "2.16.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",