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

package/dist/esm/pm-plugins/experience-tracking/provider-only-experiences.js

@@ -1,122 +0,0 @@
-import { ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import { Experience, 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';
-var pluginKey = new PluginKey('providerOnlySyncBlockExperiences');
-export var getProviderOnlyExperiencesPlugin = function getProviderOnlyExperiencesPlugin(_ref) {
-  var refs = _ref.refs,
-    dispatchAnalyticsEvent = _ref.dispatchAnalyticsEvent,
-    syncBlockStore = _ref.syncBlockStore;
-  var saveSourceExperience = getSaveSourceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  syncBlockStore.sourceManager.setSaveExperience(saveSourceExperience);
-  var saveReferenceExperience = getSaveReferenceExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  var fetchExperience = getFetchExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  var fetchSourceInfoExperience = getFetchSourceInfoExperience({
-    refs: refs,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
-  });
-  syncBlockStore.referenceManager.setExperiences(fetchExperience, fetchSourceInfoExperience, saveReferenceExperience);
-  return new SafePlugin({
-    key: pluginKey,
-    view: function view() {
-      return {
-        destroy: function destroy() {
-          saveSourceExperience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          saveReferenceExperience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          fetchExperience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-          fetchSourceInfoExperience.abort({
-            reason: EXPERIENCE_ABORT_REASON.EDITOR_DESTROYED
-          });
-        }
-      };
-    }
-  });
-};
-
-/**
- * This experience tracks when a source sync block is saved to the BE.
- *
- * Start: When the flush source sync block function is called.
- * Success: When the sync block save is successful within 1500ms of start.
- * Failure: When 1500ms passes without the sync block being successfully saved
- */
-var getSaveSourceExperience = function getSaveSourceExperience(_ref2) {
-  var dispatchAnalyticsEvent = _ref2.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};
-
-/**
- * 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 without the sync block being successfully saved
- */
-var getSaveReferenceExperience = function getSaveReferenceExperience(_ref3) {
-  var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 1500
-    })]
-  });
-};
-
-/**
- * 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 = function getFetchExperience(_ref4) {
-  var dispatchAnalyticsEvent = _ref4.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
- */
-var getFetchSourceInfoExperience = function getFetchSourceInfoExperience(_ref5) {
-  var dispatchAnalyticsEvent = _ref5.dispatchAnalyticsEvent;
-  return new Experience(ACTION_SUBJECT.SYNCED_BLOCK, {
-    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO,
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
-    checks: [new ExperienceCheckTimeout({
-      durationMs: 2500
-    })]
-  });
-};

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

@@ -1,79 +0,0 @@
-import { pmHistoryPluginKey } from '@atlaskit/editor-common/utils';
-import { findChildren } from '@atlaskit/editor-prosemirror/utils';
-var targetEl;
-export var getTarget = function getTarget(containerElement) {
-  if (!targetEl) {
-    var element = containerElement === null || containerElement === void 0 ? void 0 : containerElement.querySelector('.ProseMirror');
-    if (!element || !(element instanceof HTMLElement)) {
-      return null;
-    }
-    targetEl = element;
-  }
-  return targetEl;
-};
-export var wasSyncBlockDeletedOrAddedByHistory = function wasSyncBlockDeletedOrAddedByHistory(tr, oldState, newState) {
-  var historyMeta = tr.getMeta(pmHistoryPluginKey);
-  if (!Boolean(historyMeta)) {
-    return {};
-  }
-  var syncBlock = newState.schema.nodes.syncBlock;
-  var oldSyncBlockNodes = findChildren(oldState.doc, function (node) {
-    return node.type === syncBlock;
-  });
-  var newSyncBlockNodes = findChildren(newState.doc, function (node) {
-    return node.type === syncBlock;
-  });
-  var oldSyncBlockIds = new Set(oldSyncBlockNodes.map(function (nodeWithPos) {
-    return nodeWithPos.node.attrs.localId;
-  }).filter(function (localId) {
-    return Boolean(localId);
-  }));
-  var newSyncBlockIds = new Set(newSyncBlockNodes.map(function (nodeWithPos) {
-    return nodeWithPos.node.attrs.localId;
-  }).filter(function (localId) {
-    return Boolean(localId);
-  }));
-  var hasDeletedSyncBlock = Array.from(oldSyncBlockIds).some(function (localId) {
-    return !newSyncBlockIds.has(localId);
-  });
-  var hasAddedSyncBlock = Array.from(newSyncBlockIds).some(function (localId) {
-    return !oldSyncBlockIds.has(localId);
-  });
-  return {
-    hasDeletedSyncBlock: hasDeletedSyncBlock,
-    hasAddedSyncBlock: hasAddedSyncBlock,
-    isUndo: historyMeta.redo === false
-  };
-};
-var getResourceIds = function getResourceIds(nodes, resourceIds, query) {
-  nodes.forEach(function (node) {
-    if (!(node instanceof HTMLElement)) {
-      return;
-    }
-    var syncBlockElements = node.querySelectorAll(query);
-    syncBlockElements.forEach(function (element) {
-      var resourceId = element.getAttribute('resourceid');
-      if (resourceId) {
-        resourceIds.push(resourceId);
-      }
-    });
-  });
-};
-export var getAddedResourceIds = function getAddedResourceIds(mutations, query) {
-  var resourceIds = [];
-  mutations.forEach(function (mutation) {
-    if (mutation.type === 'childList') {
-      getResourceIds(mutation.addedNodes, resourceIds, query);
-    }
-  });
-  return resourceIds;
-};
-export var getRemovedResourceIds = function getRemovedResourceIds(mutations, query) {
-  var resourceIds = [];
-  mutations.forEach(function (mutation) {
-    if (mutation.type === 'childList') {
-      getResourceIds(mutation.removedNodes, resourceIds, query);
-    }
-  });
-  return resourceIds;
-};

package/dist/types/pm-plugins/experience-tracking/create-reference-experience.d.ts

@@ -1,10 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions } from '../../types';
-/**
- * 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 declare const getCreateReferenceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, }: ExperienceOptions) => SafePlugin<any>;

package/dist/types/pm-plugins/experience-tracking/create-source-experience.d.ts

@@ -1,10 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getCreateSourceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;

package/dist/types/pm-plugins/experience-tracking/delete-reference-experience.d.ts

@@ -1,13 +0,0 @@
-import { Experience } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions, type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getDeleteReferenceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;
-export declare const getDeleteReferenceExperience: ({ refs, dispatchAnalyticsEvent }: ExperienceOptions) => Experience;

package/dist/types/pm-plugins/experience-tracking/delete-source-experience.d.ts

@@ -1,12 +0,0 @@
-import { Experience } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions, type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getDeleteSourceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;
-export declare const getDeleteSourceExperience: ({ refs, dispatchAnalyticsEvent }: ExperienceOptions) => Experience;

package/dist/types/pm-plugins/experience-tracking/get-experience-tracking-plugins.d.ts

@@ -1,5 +0,0 @@
-import type { ProviderExperienceOptions } from "../../types";
-export declare const getExperienceTrackingPlugins: ({ refs, dispatchAnalyticsEvent, syncBlockStore }: ProviderExperienceOptions) => {
-    name: string;
-    plugin: () => import("@atlaskit/editor-common/safe-plugin").SafePlugin<any>;
-}[];

package/dist/types/pm-plugins/experience-tracking/provider-only-experiences.d.ts

@@ -1,3 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ProviderExperienceOptions } from '../../types';
-export declare const getProviderOnlyExperiencesPlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore }: ProviderExperienceOptions) => SafePlugin<any>;

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

@@ -1,9 +0,0 @@
-import type { EditorState, Transaction } from "@atlaskit/editor-prosemirror/state";
-export declare const getTarget: (containerElement: HTMLElement | undefined) => HTMLElement | null;
-export declare const wasSyncBlockDeletedOrAddedByHistory: (tr: Transaction, oldState: EditorState, newState: EditorState) => {
-    hasAddedSyncBlock?: boolean;
-    hasDeletedSyncBlock?: boolean;
-    isUndo?: boolean;
-};
-export declare const getAddedResourceIds: (mutations: MutationRecord[], query: string) => string[];
-export declare const getRemovedResourceIds: (mutations: MutationRecord[], query: string) => string[];

package/dist/types-ts4.5/pm-plugins/experience-tracking/create-reference-experience.d.ts

@@ -1,10 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions } from '../../types';
-/**
- * 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 declare const getCreateReferenceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, }: ExperienceOptions) => SafePlugin<any>;

package/dist/types-ts4.5/pm-plugins/experience-tracking/create-source-experience.d.ts

@@ -1,10 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getCreateSourceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;

package/dist/types-ts4.5/pm-plugins/experience-tracking/delete-reference-experience.d.ts

@@ -1,13 +0,0 @@
-import { Experience } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions, type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getDeleteReferenceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;
-export declare const getDeleteReferenceExperience: ({ refs, dispatchAnalyticsEvent }: ExperienceOptions) => Experience;

package/dist/types-ts4.5/pm-plugins/experience-tracking/delete-source-experience.d.ts

@@ -1,12 +0,0 @@
-import { Experience } from '@atlaskit/editor-common/experiences';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExperienceOptions, type ProviderExperienceOptions } from '../../types';
-/**
- * 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 declare const getDeleteSourceExperiencePlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore, }: ProviderExperienceOptions) => SafePlugin<any>;
-export declare const getDeleteSourceExperience: ({ refs, dispatchAnalyticsEvent }: ExperienceOptions) => Experience;

package/dist/types-ts4.5/pm-plugins/experience-tracking/get-experience-tracking-plugins.d.ts

@@ -1,5 +0,0 @@
-import type { ProviderExperienceOptions } from "../../types";
-export declare const getExperienceTrackingPlugins: ({ refs, dispatchAnalyticsEvent, syncBlockStore }: ProviderExperienceOptions) => {
-    name: string;
-    plugin: () => import("@atlaskit/editor-common/safe-plugin").SafePlugin<any>;
-}[];

package/dist/types-ts4.5/pm-plugins/experience-tracking/provider-only-experiences.d.ts

@@ -1,3 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ProviderExperienceOptions } from '../../types';
-export declare const getProviderOnlyExperiencesPlugin: ({ refs, dispatchAnalyticsEvent, syncBlockStore }: ProviderExperienceOptions) => SafePlugin<any>;

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

@@ -1,9 +0,0 @@
-import type { EditorState, Transaction } from "@atlaskit/editor-prosemirror/state";
-export declare const getTarget: (containerElement: HTMLElement | undefined) => HTMLElement | null;
-export declare const wasSyncBlockDeletedOrAddedByHistory: (tr: Transaction, oldState: EditorState, newState: EditorState) => {
-    hasAddedSyncBlock?: boolean;
-    hasDeletedSyncBlock?: boolean;
-    isUndo?: boolean;
-};
-export declare const getAddedResourceIds: (mutations: MutationRecord[], query: string) => string[];
-export declare const getRemovedResourceIds: (mutations: MutationRecord[], query: string) => string[];