@atlaskit/editor-plugin-metrics 3.1.1 → 3.2.1

package/dist/esm/pm-plugins/utils/check-tr-action-type.js

@@ -0,0 +1,152 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { InsertTypeAheadStep, LinkMetaStep } from '@atlaskit/adf-schema/steps';
+import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+export var ActionType = /*#__PURE__*/function (ActionType) {
+  ActionType["TEXT_INPUT"] = "textInput";
+  ActionType["EMPTY_LINE_ADDED_OR_DELETED"] = "emptyLineAddedOrDeleted";
+  ActionType["INSERTED_FROM_TYPE_AHEAD"] = "insertedFromTypeAhead";
+  ActionType["INSERTING_NEW_LIST_TYPE_NODE"] = "insertingNewListTypeNode";
+  ActionType["UPDATING_NEW_LIST_TYPE_ITEM"] = "updatingNewListItem";
+  ActionType["ADDING_LINK"] = "addingLink";
+  ActionType["UPDATING_STATUS"] = "updatingStatus";
+  return ActionType;
+}({});
+var isTextInput = function isTextInput(step) {
+  var _ref = step,
+    content = _ref.slice.content,
+    from = _ref.from,
+    to = _ref.to;
+  var node = content.firstChild;
+  var isAddingCharacter = from === to && content.childCount === 1 && !!node && !!node.text && node.text.length === 1;
+  var isDeletingCharacter = to - from === 1 && content.childCount === 0;
+  return isAddingCharacter || isDeletingCharacter;
+};
+var isEmptyLineAddedOrDeleted = function isEmptyLineAddedOrDeleted(step) {
+  var _ref2 = step,
+    content = _ref2.slice.content,
+    from = _ref2.from,
+    to = _ref2.to;
+  var isEmptyLineDeleted = to - from === 2 && content.size === 0;
+  if (isEmptyLineDeleted) {
+    return true;
+  }
+  var isEmptyLineAdded = false;
+  content.forEach(function (node) {
+    isEmptyLineAdded = node.type.name === 'paragraph' && node.content.size === 0;
+  });
+  return isEmptyLineAdded;
+};
+var isUpdatingListTypeNode = function isUpdatingListTypeNode(step) {
+  var slice = step.slice;
+  var childCount = slice.content.childCount;
+  if (childCount < 1) {
+    return false;
+  }
+  var isListTypeNode = false;
+  slice.content.forEach(function (node) {
+    isListTypeNode = ['decisionList', 'decisionItem', 'bulletList', 'listItem', 'orderedList', 'taskList', 'taskItem'].includes(node.type.name);
+  });
+  if (!isListTypeNode) {
+    return false;
+  }
+  return childCount === 1 ? ActionType.INSERTING_NEW_LIST_TYPE_NODE : ActionType.UPDATING_NEW_LIST_TYPE_ITEM;
+};
+var isUpdatingStatus = function isUpdatingStatus(step) {
+  var slice = step.slice;
+  var firstChild = slice.content.firstChild;
+  if (!firstChild) {
+    return undefined;
+  }
+  return firstChild.type.name === 'status' && firstChild.attrs.localId;
+};
+var isAddingLink = function isAddingLink(tr) {
+  var hasLinkStep = tr.steps.some(function (step) {
+    return step instanceof LinkMetaStep;
+  });
+  var hasReplaceStep = tr.steps.some(function (step) {
+    return step instanceof ReplaceStep;
+  });
+  return hasLinkStep && !hasReplaceStep;
+};
+var isTypeAheadRelatedTr = function isTypeAheadRelatedTr(tr) {
+  var _tr$getMeta;
+  if (((_tr$getMeta = tr.getMeta('typeAheadPlugin$')) === null || _tr$getMeta === void 0 ? void 0 : _tr$getMeta.action) === 'INSERT_RAW_QUERY') {
+    return 'INSERT_RAW_QUERY';
+  }
+  if (!tr.getMeta('appendedTransaction')) {
+    return false;
+  }
+  var insertTypeAheadStep = tr.steps.find(function (step) {
+    return step instanceof InsertTypeAheadStep;
+  });
+  var replaceStep = tr.steps.find(function (step) {
+    return step instanceof ReplaceStep;
+  });
+  if (!insertTypeAheadStep || !replaceStep) {
+    return false;
+  }
+  return insertTypeAheadStep instanceof InsertTypeAheadStep && insertTypeAheadStep.stage;
+};
+export var shouldSkipTr = function shouldSkipTr(tr) {
+  var resolvingLink = isAddingLink(tr);
+  if (resolvingLink) {
+    return true;
+  }
+  var typeAheadRelatedTr = isTypeAheadRelatedTr(tr);
+  if (typeAheadRelatedTr) {
+    return typeAheadRelatedTr !== 'INSERTING_ITEM';
+  } else {
+    return tr.getMeta('appendedTransaction');
+  }
+};
+export var checkTrActionType = function checkTrActionType(tr) {
+  if (tr.getMeta('input_rule_plugin_transaction')) {
+    return {
+      type: ActionType.INSERTING_NEW_LIST_TYPE_NODE
+    };
+  }
+  var stepsLength = tr.steps.length;
+  if (stepsLength <= 0) {
+    return undefined;
+  }
+  if (isAddingLink(tr)) {
+    return {
+      type: ActionType.ADDING_LINK
+    };
+  }
+  var _tr$steps = _slicedToArray(tr.steps, 1),
+    firstStep = _tr$steps[0];
+  var isReplaceStep = firstStep instanceof ReplaceStep;
+  var isReplaceAroundStep = firstStep instanceof ReplaceAroundStep;
+  if (!isReplaceStep && !isReplaceAroundStep) {
+    return undefined;
+  }
+  if (isReplaceStep) {
+    if (isTextInput(firstStep)) {
+      return {
+        type: ActionType.TEXT_INPUT
+      };
+    }
+    if (isEmptyLineAddedOrDeleted(firstStep)) {
+      return {
+        type: ActionType.EMPTY_LINE_ADDED_OR_DELETED
+      };
+    }
+    var statusId = isUpdatingStatus(firstStep);
+    if (statusId) {
+      return {
+        type: ActionType.UPDATING_STATUS,
+        extraData: {
+          statusId: statusId
+        }
+      };
+    }
+  }
+  var updatingListTypeNode = isUpdatingListTypeNode(firstStep);
+  if (updatingListTypeNode) {
+    return {
+      type: updatingListTypeNode
+    };
+  }
+  return undefined;
+};

package/dist/types/metricsPluginType.d.ts

@@ -1,10 +1,20 @@
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls';
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { MetricsState } from './pm-plugins/main';
+type handleIntentToStartEditProps = {
+    newSelection?: Selection;
+    shouldStartTimer?: boolean;
+    shouldPersistActiveSession?: boolean;
+};
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
-    dependencies: [AnalyticsPlugin];
+    dependencies: [AnalyticsPlugin, OptionalPlugin<BlockControlsPlugin>];
     sharedState: MetricsState;
     commands: {
+        startActiveSessionTimer: () => EditorCommand;
         stopActiveSession: () => EditorCommand;
+        handleIntentToStartEdit: ({ newSelection, shouldStartTimer, shouldPersistActiveSession, }: handleIntentToStartEditProps) => EditorCommand;
     };
 }>;
+export {};

package/dist/types/pm-plugins/main.d.ts

@@ -3,6 +3,7 @@ import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
+import { type TrActionType } from './utils/check-tr-action-type';
 export declare const metricsKey: PluginKey<any>;
 export type MetricsState = {
     intentToStartEditTime?: number;
@@ -12,7 +13,9 @@ export type MetricsState = {
     lastSelection?: Selection;
     actionTypeCount: ActionByType;
     timeOfLastTextInput?: number;
+    shouldPersistActiveSession?: boolean;
     initialContent?: Fragment;
+    previousTrType?: TrActionType;
 };
 export type ActionByType = {
     textInputCount: number;

package/dist/types/pm-plugins/utils/check-tr-action-type.d.ts

@@ -0,0 +1,18 @@
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+export declare enum ActionType {
+    TEXT_INPUT = "textInput",
+    EMPTY_LINE_ADDED_OR_DELETED = "emptyLineAddedOrDeleted",
+    INSERTED_FROM_TYPE_AHEAD = "insertedFromTypeAhead",
+    INSERTING_NEW_LIST_TYPE_NODE = "insertingNewListTypeNode",
+    UPDATING_NEW_LIST_TYPE_ITEM = "updatingNewListItem",
+    ADDING_LINK = "addingLink",
+    UPDATING_STATUS = "updatingStatus"
+}
+export declare const shouldSkipTr: (tr: ReadonlyTransaction) => boolean;
+export type TrActionType = {
+    type: ActionType;
+    extraData?: {
+        statusId?: string;
+    };
+} | undefined;
+export declare const checkTrActionType: (tr: ReadonlyTransaction) => TrActionType;

package/dist/types/pm-plugins/utils/get-node-changes.d.ts

@@ -1,5 +1,5 @@
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
-import { MetricsState } from '../main';
+import type { MetricsState } from '../main';
 export declare const getNodeChanges: ({ currentContent, pluginState, }: {
     currentContent: Fragment;
     pluginState?: MetricsState | undefined;

package/dist/types/pm-plugins/utils/is-non-text-undo.d.ts

@@ -1,2 +1,2 @@
-import { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
 export declare const isNonTextUndo: (tr: ReadonlyTransaction) => boolean;

package/dist/types-ts4.5/metricsPluginType.d.ts

@@ -1,12 +1,23 @@
-import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls';
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { MetricsState } from './pm-plugins/main';
+type handleIntentToStartEditProps = {
+    newSelection?: Selection;
+    shouldStartTimer?: boolean;
+    shouldPersistActiveSession?: boolean;
+};
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
     dependencies: [
-        AnalyticsPlugin
+        AnalyticsPlugin,
+        OptionalPlugin<BlockControlsPlugin>
     ];
     sharedState: MetricsState;
     commands: {
+        startActiveSessionTimer: () => EditorCommand;
         stopActiveSession: () => EditorCommand;
+        handleIntentToStartEdit: ({ newSelection, shouldStartTimer, shouldPersistActiveSession, }: handleIntentToStartEditProps) => EditorCommand;
     };
 }>;
+export {};

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -3,6 +3,7 @@ import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
+import { type TrActionType } from './utils/check-tr-action-type';
 export declare const metricsKey: PluginKey<any>;
 export type MetricsState = {
     intentToStartEditTime?: number;
@@ -12,7 +13,9 @@ export type MetricsState = {
     lastSelection?: Selection;
     actionTypeCount: ActionByType;
     timeOfLastTextInput?: number;
+    shouldPersistActiveSession?: boolean;
     initialContent?: Fragment;
+    previousTrType?: TrActionType;
 };
 export type ActionByType = {
     textInputCount: number;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-action-type.d.ts

@@ -0,0 +1,18 @@
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+export declare enum ActionType {
+    TEXT_INPUT = "textInput",
+    EMPTY_LINE_ADDED_OR_DELETED = "emptyLineAddedOrDeleted",
+    INSERTED_FROM_TYPE_AHEAD = "insertedFromTypeAhead",
+    INSERTING_NEW_LIST_TYPE_NODE = "insertingNewListTypeNode",
+    UPDATING_NEW_LIST_TYPE_ITEM = "updatingNewListItem",
+    ADDING_LINK = "addingLink",
+    UPDATING_STATUS = "updatingStatus"
+}
+export declare const shouldSkipTr: (tr: ReadonlyTransaction) => boolean;
+export type TrActionType = {
+    type: ActionType;
+    extraData?: {
+        statusId?: string;
+    };
+} | undefined;
+export declare const checkTrActionType: (tr: ReadonlyTransaction) => TrActionType;

package/dist/types-ts4.5/pm-plugins/utils/get-node-changes.d.ts

@@ -1,5 +1,5 @@
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
-import { MetricsState } from '../main';
+import type { MetricsState } from '../main';
 export declare const getNodeChanges: ({ currentContent, pluginState, }: {
     currentContent: Fragment;
     pluginState?: MetricsState | undefined;

package/dist/types-ts4.5/pm-plugins/utils/is-non-text-undo.d.ts

@@ -1,2 +1,2 @@
-import { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
 export declare const isNonTextUndo: (tr: ReadonlyTransaction) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-metrics",
-	"version": "3.1.1",
+	"version": "3.2.1",
 	"description": "Metrics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,10 +25,11 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.2.1",
-		"@atlaskit/editor-common": "^99.14.0",
+		"@atlaskit/editor-common": "^99.19.0",
 		"@atlaskit/editor-plugin-analytics": "^1.12.0",
+		"@atlaskit/editor-plugin-block-controls": "^2.27.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/platform-feature-flags": "^1.0.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},