@atlaskit/editor-plugin-mentions 0.1.13 → 0.1.14

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-mentions
 
+## 0.1.14
+
+### Patch Changes
+
+- [#64538](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/64538) [`264115ce5ec4`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/264115ce5ec4) - DTR-2096: Add taskListId and taskItemId to mention typeAhead clicked and pressed analytic events, when inserted within actions or tasks
+- Updated dependencies
+
 ## 0.1.13
 
 ### Patch Changes

package/dist/cjs/analytics.js

@@ -109,7 +109,7 @@ var buildTypeAheadInviteItemClickedPayload = exports.buildTypeAheadInviteItemCli
     userRole: userRole
   });
 };
-var buildTypeAheadInsertedPayload = exports.buildTypeAheadInsertedPayload = function buildTypeAheadInsertedPayload(duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider) {
+var buildTypeAheadInsertedPayload = exports.buildTypeAheadInsertedPayload = function buildTypeAheadInsertedPayload(duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider, taskListId, taskItemId) {
   var _extractAttributesFro3 = extractAttributesFromQuery(query),
     queryLength = _extractAttributesFro3.queryLength,
     spaceInQuery = _extractAttributesFro3.spaceInQuery;
@@ -127,7 +127,9 @@ var buildTypeAheadInsertedPayload = exports.buildTypeAheadInsertedPayload = func
     upKeyCount: upKeyCount,
     downKeyCount: downKeyCount,
     memberCount: (0, _utils.isTeamType)(mention.userType) && mention.context ? mention.context.memberCount : null,
-    includesYou: (0, _utils.isTeamType)(mention.userType) && mention.context ? mention.context.includesYou : null
+    includesYou: (0, _utils.isTeamType)(mention.userType) && mention.context ? mention.context.includesYou : null,
+    taskListId: taskListId,
+    taskItemId: taskItemId
   });
   if (contextIdentifierProvider) {
     analyticsPayload.containerId = contextIdentifierProvider.containerId || undefined;

package/dist/cjs/type-ahead/index.js

@@ -14,12 +14,13 @@ var _react = _interopRequireDefault(require("react"));
 var _uuid = _interopRequireDefault(require("uuid"));
 var _typeAhead = require("@atlaskit/editor-common/type-ahead");
 var _model = require("@atlaskit/editor-prosemirror/model");
+var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _item = require("@atlaskit/mention/item");
 var _resource = require("@atlaskit/mention/resource");
 var _analytics = require("../analytics");
-var _utils = require("../pm-plugins/utils");
+var _utils2 = require("../pm-plugins/utils");
 var _InviteItem = _interopRequireWildcard(require("../ui/InviteItem"));
-var _utils2 = require("../utils");
+var _utils3 = require("../utils");
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
@@ -58,7 +59,7 @@ var withInviteItem = function withInviteItem(_ref3) {
       mentionProvider: mentionProvider,
       onInviteItemMount: onInviteItemMount
     });
-    var keepInviteItem = (0, _utils2.shouldKeepInviteItem)(currentQuery, firstQueryWithoutResults);
+    var keepInviteItem = (0, _utils3.shouldKeepInviteItem)(currentQuery, firstQueryWithoutResults);
     if (mentionItems.length === 0) {
       return keepInviteItem ? [inviteItem] : [];
     }
@@ -116,7 +117,7 @@ var buildAndSendElementsTypeAheadAnalytics = function buildAndSendElementsTypeAh
     var duration = 0;
     var userOrTeamIds = null;
     var teams = null;
-    if (!(0, _utils2.isTeamStats)(stats)) {
+    if (!(0, _utils3.isTeamStats)(stats)) {
       // is from primary mention endpoint which could be just user mentions or user/team mentions
       duration = stats && stats.duration;
       teams = null;
@@ -128,7 +129,7 @@ var buildAndSendElementsTypeAheadAnalytics = function buildAndSendElementsTypeAh
       duration = stats && stats.teamMentionDuration;
       userOrTeamIds = null;
       teams = mentions.map(function (mention) {
-        return (0, _utils2.isTeamType)(mention.userType) ? {
+        return (0, _utils3.isTeamType)(mention.userType) ? {
           teamId: mention.id,
           includesYou: mention.context.includesYou,
           memberCount: mention.context.memberCount
@@ -212,7 +213,7 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
     getItems: function getItems(_ref7) {
       var query = _ref7.query,
         editorState = _ref7.editorState;
-      var pluginState = (0, _utils.getMentionPluginState)(editorState);
+      var pluginState = (0, _utils2.getMentionPluginState)(editorState);
       if (!(pluginState !== null && pluginState !== void 0 && pluginState.mentionProvider)) {
         return Promise.resolve([]);
       }
@@ -276,7 +277,7 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
         query = _ref8.query,
         sourceListItem = _ref8.sourceListItem;
       var schema = state.schema;
-      var pluginState = (0, _utils.getMentionPluginState)(state);
+      var pluginState = (0, _utils2.getMentionPluginState)(state);
       var mentionProvider = pluginState.mentionProvider;
       var _item$mention = item.mention,
         id = _item$mention.id,
@@ -289,13 +290,13 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
       var mentionContext = _objectSpread(_objectSpread({}, pluginState.contextIdentifierProvider), {}, {
         sessionId: sessionId
       });
-      if (mentionProvider && !(0, _utils2.isInviteItem)(item.mention)) {
+      if (mentionProvider && !(0, _utils3.isInviteItem)(item.mention)) {
         mentionProvider.recordMentionSelection(item.mention, mentionContext);
       }
 
       // use same timer as StatsModifier
       var pickerElapsedTime = stats.startedAt ? performance.now() - stats.startedAt : 0;
-      if (mentionProvider && mentionProvider.shouldEnableInvite && (0, _utils2.isInviteItem)(item.mention)) {
+      if (mentionProvider && mentionProvider.shouldEnableInvite && (0, _utils3.isInviteItem)(item.mention)) {
         // Don't fire event and the callback with selection by space press
         if (mode !== 'space') {
           fireEvent((0, _analytics.buildTypeAheadInviteItemClickedPayload)(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, query, pluginState.contextIdentifierProvider, mentionProvider.userRole));
@@ -305,11 +306,20 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
         }
         return state.tr;
       }
+      var taskListId, taskItemId;
+      var taskList = (0, _utils.findParentNodeOfType)(state.schema.nodes.taskList)(state.selection);
+      if (taskList) {
+        taskListId = taskList.node.attrs.localId;
+        var taskItem = (0, _utils.findParentNodeOfType)(state.schema.nodes.taskItem)(state.selection);
+        if (taskItem) {
+          taskItemId = taskItem.node.attrs.localId;
+        }
+      }
       fireEvent((0, _analytics.buildTypeAheadInsertedPayload)(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, item.mention, sourceListItem.map(function (x) {
         return x.mention;
-      }), query, pluginState.contextIdentifierProvider));
+      }), query, pluginState.contextIdentifierProvider, taskListId, taskItemId));
       sessionId = (0, _uuid.default)();
-      if (mentionProvider && (0, _utils2.isTeamType)(userType)) {
+      if (mentionProvider && (0, _utils3.isTeamType)(userType)) {
         return insert(buildNodesForTeamMention(schema, item.mention, mentionProvider, sanitizePrivateContent));
       }
 
@@ -338,7 +348,7 @@ var createTypeAheadConfig = exports.createTypeAheadConfig = function createTypeA
       if (!wasItemInserted) {
         fireEvent((0, _analytics.buildTypeAheadCancelPayload)(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, query || ''));
       }
-      var pluginState = (0, _utils.getMentionPluginState)(editorState);
+      var pluginState = (0, _utils2.getMentionPluginState)(editorState);
       if (pluginState !== null && pluginState !== void 0 && pluginState.mentionProvider) {
         var mentionProvider = pluginState.mentionProvider;
         var _iterator = _createForOfIteratorHelper(subscriptionKeys),

package/dist/es2019/analytics.js

@@ -97,7 +97,7 @@ export const buildTypeAheadInviteItemClickedPayload = (duration, upKeyCount, dow
     userRole
   });
 };
-export const buildTypeAheadInsertedPayload = (duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider) => {
+export const buildTypeAheadInsertedPayload = (duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider, taskListId, taskItemId) => {
   const {
     queryLength,
     spaceInQuery
@@ -116,7 +116,9 @@ export const buildTypeAheadInsertedPayload = (duration, upKeyCount, downKeyCount
     upKeyCount,
     downKeyCount,
     memberCount: isTeamType(mention.userType) && mention.context ? mention.context.memberCount : null,
-    includesYou: isTeamType(mention.userType) && mention.context ? mention.context.includesYou : null
+    includesYou: isTeamType(mention.userType) && mention.context ? mention.context.includesYou : null,
+    taskListId,
+    taskItemId
   });
   if (contextIdentifierProvider) {
     analyticsPayload.containerId = contextIdentifierProvider.containerId || undefined;

package/dist/es2019/type-ahead/index.js

@@ -2,6 +2,7 @@ import React from 'react';
 import uuid from 'uuid';
 import { TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { MENTION_ITEM_HEIGHT, MentionItem } from '@atlaskit/mention/item';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { buildTypeAheadCancelPayload, buildTypeAheadInsertedPayload, buildTypeAheadInviteExposurePayload, buildTypeAheadInviteItemClickedPayload, buildTypeAheadInviteItemViewedPayload, buildTypeAheadRenderedPayload } from '../analytics';
@@ -291,7 +292,16 @@ export const createTypeAheadConfig = ({
         }
         return state.tr;
       }
-      fireEvent(buildTypeAheadInsertedPayload(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, item.mention, sourceListItem.map(x => x.mention), query, pluginState.contextIdentifierProvider));
+      let taskListId, taskItemId;
+      const taskList = findParentNodeOfType(state.schema.nodes.taskList)(state.selection);
+      if (taskList) {
+        taskListId = taskList.node.attrs.localId;
+        const taskItem = findParentNodeOfType(state.schema.nodes.taskItem)(state.selection);
+        if (taskItem) {
+          taskItemId = taskItem.node.attrs.localId;
+        }
+      }
+      fireEvent(buildTypeAheadInsertedPayload(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, item.mention, sourceListItem.map(x => x.mention), query, pluginState.contextIdentifierProvider, taskListId, taskItemId));
       sessionId = uuid();
       if (mentionProvider && isTeamType(userType)) {
         return insert(buildNodesForTeamMention(schema, item.mention, mentionProvider, sanitizePrivateContent));

package/dist/esm/analytics.js

@@ -102,7 +102,7 @@ export var buildTypeAheadInviteItemClickedPayload = function buildTypeAheadInvit
     userRole: userRole
   });
 };
-export var buildTypeAheadInsertedPayload = function buildTypeAheadInsertedPayload(duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider) {
+export var buildTypeAheadInsertedPayload = function buildTypeAheadInsertedPayload(duration, upKeyCount, downKeyCount, sessionId, insertType, mention, mentionList, query, contextIdentifierProvider, taskListId, taskItemId) {
   var _extractAttributesFro3 = extractAttributesFromQuery(query),
     queryLength = _extractAttributesFro3.queryLength,
     spaceInQuery = _extractAttributesFro3.spaceInQuery;
@@ -120,7 +120,9 @@ export var buildTypeAheadInsertedPayload = function buildTypeAheadInsertedPayloa
     upKeyCount: upKeyCount,
     downKeyCount: downKeyCount,
     memberCount: isTeamType(mention.userType) && mention.context ? mention.context.memberCount : null,
-    includesYou: isTeamType(mention.userType) && mention.context ? mention.context.includesYou : null
+    includesYou: isTeamType(mention.userType) && mention.context ? mention.context.includesYou : null,
+    taskListId: taskListId,
+    taskItemId: taskItemId
   });
   if (contextIdentifierProvider) {
     analyticsPayload.containerId = contextIdentifierProvider.containerId || undefined;

package/dist/esm/type-ahead/index.js

@@ -9,6 +9,7 @@ import React from 'react';
 import uuid from 'uuid';
 import { TypeAheadAvailableNodes } from '@atlaskit/editor-common/type-ahead';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { MENTION_ITEM_HEIGHT, MentionItem } from '@atlaskit/mention/item';
 import { isResolvingMentionProvider } from '@atlaskit/mention/resource';
 import { buildTypeAheadCancelPayload, buildTypeAheadInsertedPayload, buildTypeAheadInviteExposurePayload, buildTypeAheadInviteItemClickedPayload, buildTypeAheadInviteItemViewedPayload, buildTypeAheadRenderedPayload } from '../analytics';
@@ -293,9 +294,18 @@ export var createTypeAheadConfig = function createTypeAheadConfig(_ref6) {
         }
         return state.tr;
       }
+      var taskListId, taskItemId;
+      var taskList = findParentNodeOfType(state.schema.nodes.taskList)(state.selection);
+      if (taskList) {
+        taskListId = taskList.node.attrs.localId;
+        var taskItem = findParentNodeOfType(state.schema.nodes.taskItem)(state.selection);
+        if (taskItem) {
+          taskItemId = taskItem.node.attrs.localId;
+        }
+      }
       fireEvent(buildTypeAheadInsertedPayload(pickerElapsedTime, stats.keyCount.arrowUp, stats.keyCount.arrowDown, sessionId, mode, item.mention, sourceListItem.map(function (x) {
         return x.mention;
-      }), query, pluginState.contextIdentifierProvider));
+      }), query, pluginState.contextIdentifierProvider, taskListId, taskItemId));
       sessionId = uuid();
       if (mentionProvider && isTeamType(userType)) {
         return insert(buildNodesForTeamMention(schema, item.mention, mentionProvider, sanitizePrivateContent));

package/dist/types/analytics.d.ts

@@ -9,5 +9,5 @@ export declare const buildTypeAheadCancelPayload: (duration: number, upKeyCount:
 export declare const buildTypeAheadInviteItemViewedPayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
 export declare const buildTypeAheadInviteExposurePayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, inviteExperimentCohort?: InviteExperimentCohort, userRole?: UserRole) => GasPayload;
 export declare const buildTypeAheadInviteItemClickedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, query?: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
-export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider) => GasPayload;
+export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider, taskListId?: string, taskItemId?: string) => GasPayload;
 export declare const buildTypeAheadRenderedPayload: (duration: number, userIds: Array<string> | null, query: string, teams: TeamInfoAttrAnalytics[] | null) => GasPayload;

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

@@ -9,5 +9,5 @@ export declare const buildTypeAheadCancelPayload: (duration: number, upKeyCount:
 export declare const buildTypeAheadInviteItemViewedPayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
 export declare const buildTypeAheadInviteExposurePayload: (sessionId: string, contextIdentifierProvider?: ContextIdentifierProvider, inviteExperimentCohort?: InviteExperimentCohort, userRole?: UserRole) => GasPayload;
 export declare const buildTypeAheadInviteItemClickedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, query?: string, contextIdentifierProvider?: ContextIdentifierProvider, userRole?: UserRole) => GasPayload;
-export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider) => GasPayload;
+export declare const buildTypeAheadInsertedPayload: (duration: number, upKeyCount: number, downKeyCount: number, sessionId: string, insertType: SelectItemMode, mention: MentionDescription, mentionList?: MentionDescription[], query?: string, contextIdentifierProvider?: ContextIdentifierProvider, taskListId?: string, taskItemId?: string) => GasPayload;
 export declare const buildTypeAheadRenderedPayload: (duration: number, userIds: Array<string> | null, query: string, teams: TeamInfoAttrAnalytics[] | null) => GasPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-mentions",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Mentions plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -10,7 +10,8 @@
   "atlassian": {
     "team": "Editor: AI",
     "inPublicMirror": false,
-    "releaseModel": "continuous"
+    "releaseModel": "continuous",
+    "runReact18": false
   },
   "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
   "main": "dist/cjs/index.js",
@@ -33,14 +34,14 @@
   "dependencies": {
     "@atlaskit/adf-schema": "^35.2.0",
     "@atlaskit/analytics-gas-types": "^5.1.0",
-    "@atlaskit/editor-common": "^76.27.0",
+    "@atlaskit/editor-common": "^76.32.0",
     "@atlaskit/editor-plugin-analytics": "^0.4.0",
     "@atlaskit/editor-plugin-type-ahead": "^0.8.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/icon": "^22.0.0",
     "@atlaskit/mention": "^22.1.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.30.0",
+    "@atlaskit/tokens": "^1.33.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "uuid": "^3.1.0"