@atlaskit/mention 19.8.1 → 19.9.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/mention
 
+## 19.9.3
+
+### Patch Changes
+
+- [`d1ed723c1e0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d1ed723c1e0) - Fix bug where includeTeams in smartMentionResource was not being passed in correctly
+
+## 19.9.2
+
+### Patch Changes
+
+- [`570ccaa00bd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/570ccaa00bd) - Add the ability for users in Default Mention Name Resolver to be nullable
+
+## 19.9.1
+
+### Patch Changes
+
+- [`a92e3bdb515`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a92e3bdb515) - Relaxed product enum typing to take in any string
+
+## 19.9.0
+
+### Minor Changes
+
+- [`e65ada9dbbb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e65ada9dbbb) - Debounce MentionResource when debounceTime is passed in
+
 ## 19.8.1
 
 ### Patch Changes

package/dist/cjs/api/MentionResource.js

@@ -31,6 +31,8 @@ var _logger = _interopRequireDefault(require("../util/logger"));
 
 var _analytics = require("../util/analytics");
 
+var _debounce = _interopRequireDefault(require("lodash/debounce"));
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
@@ -221,6 +223,11 @@ var MentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
     _this.inviteExperimentCohort = config.inviteExperimentCohort;
     _this.onInviteItemClick = config.onInviteItemClick;
     _this.userRole = config.userRole || 'basic';
+
+    if (_this.config.debounceTime) {
+      _this.filter = (0, _debounce.default)(_this.filter, _this.config.debounceTime);
+    }
+
     return _this;
   }
 

package/dist/cjs/api/SmartMentionResource.js

@@ -165,17 +165,22 @@ var SmartMentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
                 maxNumberOfResults = conf.maxNumberOfResults || 100;
                 request = {
                   baseUrl: conf.baseUrl,
-                  context: _objectSpread(_objectSpread({}, conf), {}, {
+                  context: {
+                    productKey: conf.productKey,
                     contextType: CONTEXT_TYPE,
                     principalId: conf.principalId || 'context',
                     containerId: contextIdentifier && contextIdentifier.containerId,
+                    siteId: conf.siteId,
                     objectId: contextIdentifier && contextIdentifier.objectId || 'undefined',
                     childObjectId: contextIdentifier && contextIdentifier.childObjectId || 'undefined',
                     mentionsSessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined',
                     sessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined'
-                  }),
+                  },
+                  includeGroups: conf.includeGroups,
+                  includeTeams: conf.includeTeams,
                   includeUsers: typeof conf.includeUsers === 'undefined' ? true : conf.includeUsers,
                   maxNumberOfResults: maxNumberOfResults,
+                  searchQueryFilter: conf.searchQueryFilter,
                   query: query
                 };
                 _context2.prev = 4;

package/dist/cjs/default-mention-name-resolver/default-mention-name-resolver.js

@@ -64,7 +64,8 @@ var DefaultMentionNameResolver = /*#__PURE__*/function () {
     key: "lookupName",
     value: function () {
       var _lookupName = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
-        var url, data, userInfo;
+        var _data$users, url, data, userInfo;
+
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
@@ -89,7 +90,7 @@ var DefaultMentionNameResolver = /*#__PURE__*/function () {
 
               case 6:
                 data = _context2.sent;
-                userInfo = data.users.find(function (user) {
+                userInfo = (_data$users = data.users) === null || _data$users === void 0 ? void 0 : _data$users.find(function (user) {
                   return user.accountId === id;
                 });
                 return _context2.abrupt("return", userInfo ? {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/mention",
-	"version": "19.8.1",
+	"version": "19.9.3",
 	"sideEffects": false
 }

package/dist/es2019/api/MentionResource.js

@@ -6,6 +6,7 @@ const MAX_NOTIFIED_ITEMS = 20;
 // Re-exporting types to prevent breaking change
 // Re-exporting types to prevent breaking change
 import { SLI_EVENT_TYPE, Actions, SliNames } from '../util/analytics';
+import debounce from 'lodash/debounce';
 
 const emptySecurityProvider = () => {
   return {
@@ -148,6 +149,10 @@ export class MentionResource extends AbstractMentionResource {
     this.inviteExperimentCohort = config.inviteExperimentCohort;
     this.onInviteItemClick = config.onInviteItemClick;
     this.userRole = config.userRole || 'basic';
+
+    if (this.config.debounceTime) {
+      this.filter = debounce(this.filter, this.config.debounceTime);
+    }
   }
 
   shouldHighlightMention(mention) {

package/dist/es2019/api/SmartMentionResource.js

@@ -74,17 +74,22 @@ class SmartMentionResource extends AbstractMentionResource {
     const maxNumberOfResults = conf.maxNumberOfResults || 100;
     const request = {
       baseUrl: conf.baseUrl,
-      context: { ...conf,
+      context: {
+        productKey: conf.productKey,
         contextType: CONTEXT_TYPE,
         principalId: conf.principalId || 'context',
         containerId: contextIdentifier && contextIdentifier.containerId,
+        siteId: conf.siteId,
         objectId: contextIdentifier && contextIdentifier.objectId || 'undefined',
         childObjectId: contextIdentifier && contextIdentifier.childObjectId || 'undefined',
         mentionsSessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined',
         sessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined'
       },
+      includeGroups: conf.includeGroups,
+      includeTeams: conf.includeTeams,
       includeUsers: typeof conf.includeUsers === 'undefined' ? true : conf.includeUsers,
       maxNumberOfResults: maxNumberOfResults,
+      searchQueryFilter: conf.searchQueryFilter,
       query
     };
 

package/dist/es2019/default-mention-name-resolver/default-mention-name-resolver.js

@@ -27,6 +27,8 @@ export class DefaultMentionNameResolver {
 
   async lookupName(id) {
     try {
+      var _data$users;
+
       if (this.cache.has(id)) {
         return {
           id,
@@ -37,7 +39,7 @@ export class DefaultMentionNameResolver {
 
       const url = getConfig().getGraphQLUrl(this.baseUrl);
       const data = await makeRequest(url, [id]);
-      const userInfo = data.users.find(user => user.accountId === id);
+      const userInfo = (_data$users = data.users) === null || _data$users === void 0 ? void 0 : _data$users.find(user => user.accountId === id);
       return userInfo ? {
         id,
         name: userInfo.name,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/mention",
-	"version": "19.8.1",
+	"version": "19.9.3",
 	"sideEffects": false
 }

package/dist/esm/api/MentionResource.js

@@ -23,6 +23,7 @@ var MAX_NOTIFIED_ITEMS = 20;
 // Re-exporting types to prevent breaking change
 // Re-exporting types to prevent breaking change
 import { SLI_EVENT_TYPE, Actions, SliNames } from '../util/analytics';
+import debounce from 'lodash/debounce';
 
 var emptySecurityProvider = function emptySecurityProvider() {
   return {
@@ -204,6 +205,11 @@ export var MentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
     _this.inviteExperimentCohort = config.inviteExperimentCohort;
     _this.onInviteItemClick = config.onInviteItemClick;
     _this.userRole = config.userRole || 'basic';
+
+    if (_this.config.debounceTime) {
+      _this.filter = debounce(_this.filter, _this.config.debounceTime);
+    }
+
     return _this;
   }
 

package/dist/esm/api/SmartMentionResource.js

@@ -143,17 +143,22 @@ var SmartMentionResource = /*#__PURE__*/function (_AbstractMentionResou) {
                 maxNumberOfResults = conf.maxNumberOfResults || 100;
                 request = {
                   baseUrl: conf.baseUrl,
-                  context: _objectSpread(_objectSpread({}, conf), {}, {
+                  context: {
+                    productKey: conf.productKey,
                     contextType: CONTEXT_TYPE,
                     principalId: conf.principalId || 'context',
                     containerId: contextIdentifier && contextIdentifier.containerId,
+                    siteId: conf.siteId,
                     objectId: contextIdentifier && contextIdentifier.objectId || 'undefined',
                     childObjectId: contextIdentifier && contextIdentifier.childObjectId || 'undefined',
                     mentionsSessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined',
                     sessionId: contextIdentifier && contextIdentifier.sessionId || 'undefined'
-                  }),
+                  },
+                  includeGroups: conf.includeGroups,
+                  includeTeams: conf.includeTeams,
                   includeUsers: typeof conf.includeUsers === 'undefined' ? true : conf.includeUsers,
                   maxNumberOfResults: maxNumberOfResults,
+                  searchQueryFilter: conf.searchQueryFilter,
                   query: query
                 };
                 _context2.prev = 4;

package/dist/esm/default-mention-name-resolver/default-mention-name-resolver.js

@@ -50,7 +50,8 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
     key: "lookupName",
     value: function () {
       var _lookupName = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(id) {
-        var url, data, userInfo;
+        var _data$users, url, data, userInfo;
+
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
@@ -75,7 +76,7 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
 
               case 6:
                 data = _context2.sent;
-                userInfo = data.users.find(function (user) {
+                userInfo = (_data$users = data.users) === null || _data$users === void 0 ? void 0 : _data$users.find(function (user) {
                   return user.accountId === id;
                 });
                 return _context2.abrupt("return", userInfo ? {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/mention",
-	"version": "19.8.1",
+	"version": "19.9.3",
 	"sideEffects": false
 }

package/dist/types/api/SmartMentionResource.d.ts

@@ -1,4 +1,3 @@
-import { SupportedProduct } from './SmartMentionTypes';
 import { MentionContextIdentifier, MentionsResult, MentionDescription, MentionNameDetails, MentionNameResolver } from '../types';
 import { AbstractMentionResource, ResolvingMentionProvider } from '../resource';
 export interface SmartMentionConfig {
@@ -13,12 +12,11 @@ export interface SmartMentionConfig {
      */
     principalId?: string;
     /**
-     * Use 'people' if you are waiting for a product scope.
-     * If your product is not part of the SupportedProduct enum,
-     * and you have a supported product scope, please raise a PR
-     * to add your product onto the SupportedProduct enum.
+     * Platform search is only available for certain products. Please
+     * reach out to #help-smart-experiences to check.
+     * Use productKey='people' if you are waiting for a product scope.
      */
-    productKey: SupportedProduct;
+    productKey: string;
     /**
      * Lucene-type query to proxy onto the search service.
      */

package/dist/types/api/SmartMentionTypes.d.ts

@@ -1,4 +1,3 @@
-export declare type SupportedProduct = 'jira' | 'confluence' | 'people' | 'bitbucket';
 export interface RecommendationRequest {
     baseUrl?: string;
     context: Context;
@@ -21,7 +20,7 @@ export interface Context {
     sessionId?: string;
     principalId: string;
     childObjectId?: string;
-    productKey: 'jira' | 'confluence' | 'people' | 'bitbucket';
+    productKey: string;
     siteId: string;
     productAttributes?: ProductAttributes;
 }

package/dist/types/types.d.ts

@@ -31,6 +31,7 @@ export interface MentionResourceConfig extends ServiceConfig {
     onInviteItemClick?: (flow: InviteFlow) => void;
     userRole?: UserRole;
     productName?: string;
+    debounceTime?: number;
 }
 export interface ResourceProvider<Result> {
     /**

package/docs/1-in-editor.tsx

@@ -9,10 +9,10 @@ import {
 import SectionMessage from '@atlaskit/section-message';
 
 const MentionProps = require('!!extract-react-types-loader!../src/api/extract-react-types/smart-config-props');
-import MentionWithEditorExample from '../examples/14-mention-with-editor';
-const MentionWithEditorExampleSource = require('!!raw-loader!../examples/14-mention-with-editor');
-import SmartMentionWithEditorExample from '../examples/15-smart-mention-resource';
-const SmartMentionWithEditorExampleSource = require('!!raw-loader!../examples/15-smart-mention-resource');
+import MentionWithEditorExample from '../examples/14-mention-with-editor-extending-abstract-mention-resource';
+const MentionWithEditorExampleSource = require('!!raw-loader!../examples/14-mention-with-editor-extending-abstract-mention-resource');
+import SmartMentionWithEditorExample from '../examples/16-smart-mention-resource';
+const SmartMentionWithEditorExampleSource = require('!!raw-loader!../examples/16-smart-mention-resource');
 
 export default md`
   ${(<AtlassianInternalWarning />)}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/mention",
-  "version": "19.8.1",
+  "version": "19.9.3",
   "description": "A React component used to display user profiles in a list for 'Mention' functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,6 +36,7 @@
     "@atlaskit/tooltip": "^17.5.0",
     "@atlaskit/util-service-support": "^6.0.0",
     "@babel/runtime": "^7.0.0",
+    "lodash": "^4.17.15",
     "uuid": "^3.1.0"
   },
   "peerDependencies": {
@@ -48,8 +49,8 @@
     "@atlaskit/adf-utils": "^14.2.0",
     "@atlaskit/build-utils": "*",
     "@atlaskit/docs": "^9.0.0",
-    "@atlaskit/editor-core": "^150.0.0",
-    "@atlaskit/editor-test-helpers": "^15.4.0",
+    "@atlaskit/editor-core": "^151.2.0",
+    "@atlaskit/editor-test-helpers": "^15.5.0",
     "@atlaskit/elements-test-helpers": "^0.7.0",
     "@atlaskit/section-message": "^6.0.0",
     "@atlaskit/ssr": "*",