@atlaskit/editor-plugin-synced-block 5.2.1 → 5.3.0

package/dist/esm/pm-plugins/experience-tracking/create-reference-experience.js

@@ -1,107 +0,0 @@
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { EXPERIENCE_ABORT_REASON } from '../../types';
-import { getAddedResourceIds, wasSyncBlockDeletedOrAddedByHistory, getTarget } from '../utils/experience-tracking-utils';
-var isPastedFromFabricEditor = function isPastedFromFabricEditor(html) {
-  return !!html && html.indexOf('data-pm-slice="') >= 0;
-};
-var pluginKey = new PluginKey('createReferenceSyncBlockExperience');
-var START_METHOD = {
-  PASTE: 'paste',
-  UNDO: 'undo',
-  REDO: 'redo'
-};
-
-/**
- * This experience tracks when a reference sync block is inserted.
- *
- * Start: When user pastes a sync block from editor and createSyncedBlock is called
- * Success: When the sync block is added to the DOM within 500ms of start
- * Failure: When 500ms passes without the reference sync block being added to the DOM
- */
-export var getCreateReferenceExperiencePlugin = function getCreateReferenceExperiencePlugin(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent;
-  var experience = getCreateReferenceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  return new SafePlugin({
-    key: pluginKey,
-    view: function view() {
-      return {
-        destroy: function destroy() {
-          experience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-        }
-      };
-    },
-    props: {
-      handlePaste: function handlePaste(_view, rawEvent, slice) {
-        var _event$clipboardData;
-        var event = rawEvent;
-        var html = (_event$clipboardData = event.clipboardData) === null || _event$clipboardData === void 0 ? void 0 : _event$clipboardData.getData('text/html');
-
-        // do not start on paste from renderer, because this flattens the content and does not create a reference block
-        if (isPastedFromFabricEditor(html)) {
-          slice.content.forEach(function (node) {
-            if (node.type.name === 'syncBlock' || node.type.name === 'bodiedSyncBlock') {
-              experience.start({
-                method: START_METHOD.PASTE
-              });
-            }
-          });
-        }
-      }
-    },
-    appendTransaction: function appendTransaction(transactions, oldState, newState) {
-      transactions.forEach(function (tr) {
-        var _wasSyncBlockDeletedO = wasSyncBlockDeletedOrAddedByHistory(tr, oldState, newState),
-          hasAddedSyncBlock = _wasSyncBlockDeletedO.hasAddedSyncBlock,
-          isUndo = _wasSyncBlockDeletedO.isUndo;
-        if (hasAddedSyncBlock) {
-          experience.start({
-            method: isUndo ? START_METHOD.UNDO : START_METHOD.REDO
-          });
-        }
-      });
-      return null;
-    }
-  });
-};
-var getCreateReferenceExperience = function getCreateReferenceExperience(_ref2) {
-  var refs = _ref2.refs,
-    dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_CREATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 500
-    }), new ExperienceCheckDomMutation({
-      onDomMutation: function onDomMutation(_ref3) {
-        var mutations = _ref3.mutations;
-        var insertedResourceIds = getAddedResourceIds(mutations, '[data-prosemirror-node-name="syncBlock"]');
-        if (insertedResourceIds.length > 0) {
-          return {
-            status: 'success',
-            metadata: {
-              insertedResourceIds: insertedResourceIds
-            }
-          };
-        }
-        return undefined;
-      },
-      observeConfig: function observeConfig() {
-        return {
-          target: getTarget(refs.containerElement),
-          options: {
-            childList: true
-          }
-        };
-      }
-    })]
-  });
-};

package/dist/esm/pm-plugins/experience-tracking/create-source-experience.js

@@ -1,163 +0,0 @@
-import { bind } from 'bind-event-listener';
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout, getPopupContainerFromEditorView, popupWithNestedElement } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { EXPERIENCE_ABORT_REASON } from '../../types';
-import { getAddedResourceIds, getTarget } from '../utils/experience-tracking-utils';
-var pluginKey = new PluginKey('createSourceSyncBlockExperience');
-var START_METHOD = {
-  BLOCK_MENU: 'block-menu',
-  PINNED_TOOLBAR: 'pinned-toolbar',
-  QUICK_INSERT: 'quick-insert'
-};
-var SYNCED_BLOCK_CREATE_BUTTON_IDS = ['create-synced-block-toolbar-btn', 'create-synced-block-block-menu-btn', 'create-synced-block-quick-insert-btn'];
-var syncedBlockCreateButtonIds = new Set(SYNCED_BLOCK_CREATE_BUTTON_IDS);
-
-/**
- * This experience tracks when a source sync block is inserted.
- *
- * Start: When user inserts a sync block via block menu, quick insert or pinned toolbar
- * Success: When the sync block is added to the DOM within 3000ms of start
- * Failure: When 3000ms passes without the source sync block being added to the DOM
- */
-export var getCreateSourceExperiencePlugin = function getCreateSourceExperiencePlugin(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    syncBlockStore = _ref.syncBlockStore;
-  var popupsTargetEl;
-  var editorViewEl;
-  var getPopupsTarget = function getPopupsTarget() {
-    if (!popupsTargetEl) {
-      popupsTargetEl = refs.popupsMountPoint || refs.wrapperElement || getPopupContainerFromEditorView(editorViewEl);
-    }
-    return popupsTargetEl;
-  };
-  var experience = getCreateSourceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  syncBlockStore.sourceManager.setCreateExperience(experience);
-  var unbindClickListener = bind(document, {
-    type: 'click',
-    listener: function listener(event) {
-      var target = event.target;
-      if (!target) {
-        return;
-      }
-      var button = target.closest('button[data-testid]');
-      if (!button || !(button instanceof HTMLButtonElement)) {
-        return;
-      }
-      var testId = button.dataset.testid;
-      if (!isSyncedBlockCreateButtonId(testId)) {
-        return;
-      }
-      handleButtonClick(testId, experience);
-    }
-  });
-  var unbindKeydownListener = bind(document, {
-    type: 'keydown',
-    listener: function listener(event) {
-      if (isEnterKey(event.key)) {
-        var typeaheadPopup = popupWithNestedElement(getPopupsTarget(), '.fabric-editor-typeahead');
-        if (!typeaheadPopup || !(typeaheadPopup instanceof HTMLElement)) {
-          return;
-        }
-        var firstItem = typeaheadPopup.querySelector('[role="option"]');
-        if (!firstItem || !(firstItem instanceof HTMLElement)) {
-          return;
-        }
-        var testId = firstItem.dataset.testid;
-        if (testId === 'create-synced-block-quick-insert-btn') {
-          experience.start({
-            method: START_METHOD.QUICK_INSERT
-          });
-        }
-      }
-    },
-    options: {
-      capture: true
-    }
-  });
-  return new SafePlugin({
-    key: pluginKey,
-    view: function view(editorView) {
-      editorViewEl = editorView.dom;
-      return {
-        destroy: function destroy() {
-          experience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          unbindClickListener();
-          unbindKeydownListener();
-        }
-      };
-    }
-  });
-};
-var getCreateSourceExperience = function getCreateSourceExperience(_ref2) {
-  var refs = _ref2.refs,
-    dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 3000
-    }), new ExperienceCheckDomMutation({
-      onDomMutation: function onDomMutation(_ref3) {
-        var mutations = _ref3.mutations;
-        var createdResourceIds = getAddedResourceIds(mutations, '[data-prosemirror-node-name="bodiedSyncBlock"]');
-        if (createdResourceIds.length > 0) {
-          return {
-            status: 'success',
-            metadata: {
-              createdResourceIds: createdResourceIds
-            }
-          };
-        }
-        return undefined;
-      },
-      observeConfig: function observeConfig() {
-        return {
-          target: getTarget(refs.containerElement),
-          options: {
-            childList: true
-          }
-        };
-      }
-    })]
-  });
-};
-var isSyncedBlockCreateButtonId = function isSyncedBlockCreateButtonId(value) {
-  return !!value && syncedBlockCreateButtonIds.has(value);
-};
-var handleButtonClick = function handleButtonClick(testId, experience) {
-  switch (testId) {
-    case 'create-synced-block-toolbar-btn':
-      experience.start({
-        method: START_METHOD.PINNED_TOOLBAR
-      });
-      break;
-    case 'create-synced-block-block-menu-btn':
-      experience.start({
-        method: START_METHOD.BLOCK_MENU
-      });
-      break;
-    case 'create-synced-block-quick-insert-btn':
-      experience.start({
-        method: START_METHOD.QUICK_INSERT
-      });
-      break;
-    default:
-      {
-        // Exhaustiveness check: if a new SyncedBlockToolbarButtonId is added
-        // but not handled above, TypeScript will error here.
-        var _exhaustiveCheck = testId;
-        return _exhaustiveCheck;
-      }
-  }
-};
-var isEnterKey = function isEnterKey(key) {
-  return key === 'Enter';
-};

package/dist/esm/pm-plugins/experience-tracking/delete-reference-experience.js

@@ -1,169 +0,0 @@
-import { bind } from 'bind-event-listener';
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { EXPERIENCE_ABORT_REASON } from '../../types';
-import { getRemovedResourceIds, getTarget, wasSyncBlockDeletedOrAddedByHistory } from '../utils/experience-tracking-utils';
-var pluginKey = new PluginKey('deleteReferenceSyncBlockExperience');
-var START_METHOD = {
-  ELEMENT_TOOLBAR: 'element-toolbar',
-  DELETE: 'delete',
-  TYPED_OVER: 'typed-over',
-  CUT: 'cut',
-  UNDO: 'undo',
-  REDO: 'redo'
-};
-
-/**
- * This experience tracks when a reference sync block is deleted.
- *
- * Start: When user deletes ref sync block from toolbar, presses delete when cursor is in front of ref sync block,
- * presses any key with a ref sync block selected, cuts with a ref sync block selected, triggers undo/redo that deletes a ref sync block
- * Success: When the sync block is removed from the DOM within 2000ms of start
- * Failure: When 2000ms passes without the reference sync block being removed from the DOM
- */
-export var getDeleteReferenceExperiencePlugin = function getDeleteReferenceExperiencePlugin(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    syncBlockStore = _ref.syncBlockStore;
-  var experience = getDeleteReferenceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  syncBlockStore.sourceManager.setDeleteExperience(experience);
-  var unbindClickListener = bind(document, {
-    type: 'click',
-    listener: function listener(event) {
-      var target = event.target;
-      if (!target) {
-        return;
-      }
-      var button = target.closest('button[data-testid]');
-      if (!button || !(button instanceof HTMLButtonElement)) {
-        return;
-      }
-      var testId = button.dataset.testid;
-      if (isReferenceSyncedBlockDeleteButtonId(testId)) {
-        experience.start({
-          method: START_METHOD.ELEMENT_TOOLBAR
-        });
-      }
-    }
-  });
-  return new SafePlugin({
-    key: pluginKey,
-    props: {
-      handleDOMEvents: {
-        cut: function cut(view) {
-          var state = view.state;
-          if (hasSyncBlockInSelection(state.selection)) {
-            experience.start({
-              method: START_METHOD.CUT
-            });
-          }
-          return false;
-        },
-        keydown: function keydown(view, event) {
-          var state = view.state;
-          var hasSelection = hasSyncBlockInSelection(state.selection);
-          var hasAdjacent = hasSyncBlockBeforeCursor(state.selection);
-          if (hasSelection) {
-            experience.start({
-              method: START_METHOD.TYPED_OVER
-            });
-          }
-          if (isDeleteKey(event.key) && hasAdjacent) {
-            experience.start({
-              method: START_METHOD.DELETE
-            });
-          }
-          return false;
-        }
-      }
-    },
-    appendTransaction: function appendTransaction(transactions, oldState, newState) {
-      transactions.forEach(function (tr) {
-        var _wasSyncBlockDeletedO = wasSyncBlockDeletedOrAddedByHistory(tr, oldState, newState),
-          hasDeletedSyncBlock = _wasSyncBlockDeletedO.hasDeletedSyncBlock,
-          isUndo = _wasSyncBlockDeletedO.isUndo;
-        if (hasDeletedSyncBlock) {
-          experience.start({
-            method: isUndo ? START_METHOD.UNDO : START_METHOD.REDO
-          });
-        }
-      });
-      return null;
-    },
-    view: function view() {
-      return {
-        destroy: function destroy() {
-          experience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          unbindClickListener();
-        }
-      };
-    }
-  });
-};
-export var getDeleteReferenceExperience = function getDeleteReferenceExperience(_ref2) {
-  var refs = _ref2.refs,
-    dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_DELETE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 2000
-    }), new ExperienceCheckDomMutation({
-      onDomMutation: function onDomMutation(_ref3) {
-        var mutations = _ref3.mutations;
-        var deletedResourceIds = getRemovedResourceIds(mutations, '[data-prosemirror-node-name="syncBlock"]');
-        if (deletedResourceIds.length > 0) {
-          return {
-            status: 'success',
-            metadata: {
-              deletedResourceIds: deletedResourceIds
-            }
-          };
-        }
-        return undefined;
-      },
-      observeConfig: function observeConfig() {
-        return {
-          target: getTarget(refs.containerElement),
-          options: {
-            childList: true
-          }
-        };
-      }
-    })]
-  });
-};
-var isReferenceSyncedBlockDeleteButtonId = function isReferenceSyncedBlockDeleteButtonId(testId) {
-  return testId === 'reference-synced-block-delete-button';
-};
-var isDeleteKey = function isDeleteKey(key) {
-  return key === 'Delete' || key === 'Backspace';
-};
-var hasSyncBlockInSelection = function hasSyncBlockInSelection(selection) {
-  var syncBlock = selection.$from.doc.type.schema.nodes.syncBlock;
-  var found = false;
-  selection.$from.doc.nodesBetween(selection.from, selection.to, function (node) {
-    if (node.type === syncBlock) {
-      found = true;
-      return false;
-    }
-    // sync block nodes can only be found at the top level
-    return false;
-  });
-  return found;
-};
-var hasSyncBlockBeforeCursor = function hasSyncBlockBeforeCursor(selection) {
-  if (!selection.empty) {
-    return false;
-  }
-  var syncBlock = selection.$from.doc.type.schema.nodes.syncBlock;
-  var nodeBefore = selection.$from.nodeBefore;
-  return (nodeBefore === null || nodeBefore === void 0 ? void 0 : nodeBefore.type) === syncBlock;
-};

package/dist/esm/pm-plugins/experience-tracking/delete-source-experience.js

@@ -1,97 +0,0 @@
-import { bind } from 'bind-event-listener';
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, ExperienceCheckDomMutation, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { EXPERIENCE_ABORT_REASON } from '../../types';
-import { getRemovedResourceIds, getTarget } from '../utils/experience-tracking-utils';
-var pluginKey = new PluginKey('deleteSourceSyncBlockExperience');
-var START_METHOD = {
-  DELETE_CONFIRM_BUTTON: 'delete-confirm-button'
-};
-
-/**
- * This experience tracks when a source sync block is deleted.
- *
- * Start: When user clicks the delete button in the delete modal
- * Success: When the sync block is removed from the DOM within 2000ms of start
- * Failure: When 2000ms passes without the source sync block being removed from the DOM
- */
-export var getDeleteSourceExperiencePlugin = function getDeleteSourceExperiencePlugin(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    syncBlockStore = _ref.syncBlockStore;
-  var experience = getDeleteSourceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  syncBlockStore.sourceManager.setDeleteExperience(experience);
-  var unbindClickListener = bind(document, {
-    type: 'click',
-    listener: function listener(event) {
-      var target = event.target;
-      if (!target) {
-        return;
-      }
-      var button = target.closest('button[data-testid]');
-      if (!button || !(button instanceof HTMLButtonElement)) {
-        return;
-      }
-      var testId = button.dataset.testid;
-      if (isSyncedBlockDeleteButtonId(testId)) {
-        experience.start({
-          method: START_METHOD.DELETE_CONFIRM_BUTTON
-        });
-      }
-    }
-  });
-  return new SafePlugin({
-    key: pluginKey,
-    view: function view() {
-      return {
-        destroy: function destroy() {
-          experience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          unbindClickListener();
-        }
-      };
-    }
-  });
-};
-export var getDeleteSourceExperience = function getDeleteSourceExperience(_ref2) {
-  var refs = _ref2.refs,
-    dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 2000
-    }), new ExperienceCheckDomMutation({
-      onDomMutation: function onDomMutation(_ref3) {
-        var mutations = _ref3.mutations;
-        var deletedResourceIds = getRemovedResourceIds(mutations, '[data-prosemirror-node-name="bodiedSyncBlock"]');
-        if (deletedResourceIds.length > 0) {
-          return {
-            status: 'success',
-            metadata: {
-              deletedResourceIds: deletedResourceIds
-            }
-          };
-        }
-        return undefined;
-      },
-      observeConfig: function observeConfig() {
-        return {
-          target: getTarget(refs.containerElement),
-          options: {
-            childList: true
-          }
-        };
-      }
-    })]
-  });
-};
-var isSyncedBlockDeleteButtonId = function isSyncedBlockDeleteButtonId(testId) {
-  return testId === 'synced-block-delete-confirmation-modal-delete-button';
-};

package/dist/esm/pm-plugins/experience-tracking/get-experience-tracking-plugins.js

@@ -1,55 +0,0 @@
-import { getCreateReferenceExperiencePlugin } from "./create-reference-experience";
-import { getCreateSourceExperiencePlugin } from "./create-source-experience";
-import { getDeleteReferenceExperiencePlugin } from "./delete-reference-experience";
-import { getDeleteSourceExperiencePlugin } from "./delete-source-experience";
-import { getProviderOnlyExperiencesPlugin } from "./provider-only-experiences";
-export var getExperienceTrackingPlugins = function getExperienceTrackingPlugins(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    syncBlockStore = _ref.syncBlockStore;
-  return [{
-    name: 'createReferenceSyncedBlockExperiencePlugin',
-    plugin: function plugin() {
-      return getCreateReferenceExperiencePlugin({
-        refs: refs,
-        dispatchAnalyticsEvent: dispatchAnalyticsEvent
-      });
-    }
-  }, {
-    name: 'createSourceSyncedBlockExperiencePlugin',
-    plugin: function plugin() {
-      return getCreateSourceExperiencePlugin({
-        refs: refs,
-        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-        syncBlockStore: syncBlockStore
-      });
-    }
-  }, {
-    name: 'deleteSourceExperiencePlugin',
-    plugin: function plugin() {
-      return getDeleteSourceExperiencePlugin({
-        refs: refs,
-        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-        syncBlockStore: syncBlockStore
-      });
-    }
-  }, {
-    name: 'deleteReferenceExperiencePlugin',
-    plugin: function plugin() {
-      return getDeleteReferenceExperiencePlugin({
-        refs: refs,
-        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-        syncBlockStore: syncBlockStore
-      });
-    }
-  }, {
-    name: 'providerOnlySyncedBlockExperiencesPlugin',
-    plugin: function plugin() {
-      return getProviderOnlyExperiencesPlugin({
-        refs: refs,
-        dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-        syncBlockStore: syncBlockStore
-      });
-    }
-  }];
-};