@atlaskit/mention 23.0.4 → 23.1.0

package/dist/cjs/api/MentionNameResolver.js

@@ -18,12 +18,15 @@ var DefaultMentionNameResolver = exports.DefaultMentionNameResolver = /*#__PURE_
   function DefaultMentionNameResolver(client) {
     var _this = this;
     var analyticsProps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var onResolvedAll = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : function () {};
     (0, _classCallCheck2.default)(this, DefaultMentionNameResolver);
     (0, _defineProperty2.default)(this, "nameCache", new Map());
     (0, _defineProperty2.default)(this, "nameQueue", new Map());
     (0, _defineProperty2.default)(this, "nameStartTime", new Map());
     (0, _defineProperty2.default)(this, "processingQueue", new Map());
     (0, _defineProperty2.default)(this, "debounce", 0);
+    (0, _defineProperty2.default)(this, "debounceOnResolve", null);
+    (0, _defineProperty2.default)(this, "isOnResolvedAllCalled", false);
     (0, _defineProperty2.default)(this, "processQueue", function () {
       clearTimeout(_this.debounce);
       _this.debounce = 0;
@@ -58,10 +61,15 @@ var DefaultMentionNameResolver = exports.DefaultMentionNameResolver = /*#__PURE_
       // Make sure anything left in the queue gets processed.
       if (_this.nameQueue.size > 0) {
         _this.scheduleProcessQueue();
+      } else {
+        _this.scheduleOnAllResolved();
       }
     });
     this.client = client;
     this.fireHydrationEvent = (0, _analytics.fireAnalyticsMentionHydrationEvent)(analyticsProps);
+    // If provided, this will be called once all pending mentions in the queue are resolved.
+    // A sample usage is scrolling to a mention on page load, after the mentions have loadad.
+    this.onResolvedAll = onResolvedAll;
   }
   (0, _createClass2.default)(DefaultMentionNameResolver, [{
     key: "lookupName",
@@ -70,6 +78,9 @@ var DefaultMentionNameResolver = exports.DefaultMentionNameResolver = /*#__PURE_
       var name = this.nameCache.get(id);
       if (name) {
         this.fireAnalytics(true, name);
+        if (this.nameQueue.size === 0) {
+          this.scheduleOnAllResolved();
+        }
         return name;
       }
       return new Promise(function (resolve) {
@@ -104,6 +115,21 @@ var DefaultMentionNameResolver = exports.DefaultMentionNameResolver = /*#__PURE_
         this.debounce = window.setTimeout(this.processQueue, DefaultMentionNameResolver.waitForBatch);
       }
     }
+  }, {
+    key: "scheduleOnAllResolved",
+    value: function scheduleOnAllResolved() {
+      var _this3 = this;
+      if (this.debounceOnResolve) {
+        clearTimeout(this.debounceOnResolve);
+      }
+      this.debounceOnResolve = window.setTimeout(function () {
+        if (_this3.isOnResolvedAllCalled) {
+          return;
+        }
+        _this3.onResolvedAll();
+        _this3.isOnResolvedAllCalled = true;
+      }, DefaultMentionNameResolver.waitForResolveAll);
+    }
   }, {
     key: "isQueueAtLimit",
     value: function isQueueAtLimit() {
@@ -155,6 +181,8 @@ var DefaultMentionNameResolver = exports.DefaultMentionNameResolver = /*#__PURE_
  * This addresses [this ticket](https://product-fabric.atlassian.net/browse/QS-3789).
  */
 (0, _defineProperty2.default)(DefaultMentionNameResolver, "waitForBatch", 100);
+// ms
+(0, _defineProperty2.default)(DefaultMentionNameResolver, "waitForResolveAll", 800);
 function mergeNameResolverQueues(queueA, queueB) {
   var queueBeingMerged = new Map((0, _toConsumableArray2.default)(queueA));
 

package/dist/cjs/util/analytics.js

@@ -12,7 +12,7 @@ var _types = require("../types");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var packageName = "@atlaskit/mention";
-var packageVersion = "23.0.4";
+var packageVersion = "23.1.0";
 var SLI_EVENT_TYPE = exports.SLI_EVENT_TYPE = 'sli';
 var SMART_EVENT_TYPE = exports.SMART_EVENT_TYPE = 'smart';
 var SliNames = exports.SliNames = /*#__PURE__*/function (SliNames) {

package/dist/es2019/api/MentionNameResolver.js

@@ -5,12 +5,14 @@ import { fireAnalyticsMentionHydrationEvent } from '../util/analytics';
 /** A queue for user ids */
 
 export class DefaultMentionNameResolver {
-  constructor(client, analyticsProps = {}) {
+  constructor(client, analyticsProps = {}, onResolvedAll = () => {}) {
     _defineProperty(this, "nameCache", new Map());
     _defineProperty(this, "nameQueue", new Map());
     _defineProperty(this, "nameStartTime", new Map());
     _defineProperty(this, "processingQueue", new Map());
     _defineProperty(this, "debounce", 0);
+    _defineProperty(this, "debounceOnResolve", null);
+    _defineProperty(this, "isOnResolvedAllCalled", false);
     _defineProperty(this, "processQueue", () => {
       clearTimeout(this.debounce);
       this.debounce = 0;
@@ -48,15 +50,23 @@ export class DefaultMentionNameResolver {
       // Make sure anything left in the queue gets processed.
       if (this.nameQueue.size > 0) {
         this.scheduleProcessQueue();
+      } else {
+        this.scheduleOnAllResolved();
       }
     });
     this.client = client;
     this.fireHydrationEvent = fireAnalyticsMentionHydrationEvent(analyticsProps);
+    // If provided, this will be called once all pending mentions in the queue are resolved.
+    // A sample usage is scrolling to a mention on page load, after the mentions have loadad.
+    this.onResolvedAll = onResolvedAll;
   }
   lookupName(id) {
     const name = this.nameCache.get(id);
     if (name) {
       this.fireAnalytics(true, name);
+      if (this.nameQueue.size === 0) {
+        this.scheduleOnAllResolved();
+      }
       return name;
     }
     return new Promise(resolve => {
@@ -87,6 +97,18 @@ export class DefaultMentionNameResolver {
       this.debounce = window.setTimeout(this.processQueue, DefaultMentionNameResolver.waitForBatch);
     }
   }
+  scheduleOnAllResolved() {
+    if (this.debounceOnResolve) {
+      clearTimeout(this.debounceOnResolve);
+    }
+    this.debounceOnResolve = window.setTimeout(() => {
+      if (this.isOnResolvedAllCalled) {
+        return;
+      }
+      this.onResolvedAll();
+      this.isOnResolvedAllCalled = true;
+    }, DefaultMentionNameResolver.waitForResolveAll);
+  }
   isQueueAtLimit() {
     return this.nameQueue.size >= this.client.getLookupLimit();
   }
@@ -133,6 +155,8 @@ export class DefaultMentionNameResolver {
  * This addresses [this ticket](https://product-fabric.atlassian.net/browse/QS-3789).
  */
 _defineProperty(DefaultMentionNameResolver, "waitForBatch", 100);
+// ms
+_defineProperty(DefaultMentionNameResolver, "waitForResolveAll", 800);
 export function mergeNameResolverQueues(queueA, queueB) {
   const queueBeingMerged = new Map([...queueA]);
 

package/dist/es2019/util/analytics.js

@@ -2,7 +2,7 @@ import { OPERATIONAL_EVENT_TYPE, UI_EVENT_TYPE } from '@atlaskit/analytics-gas-t
 import { ELEMENTS_CHANNEL } from '../_constants';
 import { isSpecialMentionText } from '../types';
 const packageName = "@atlaskit/mention";
-const packageVersion = "23.0.4";
+const packageVersion = "23.1.0";
 export const SLI_EVENT_TYPE = 'sli';
 export const SMART_EVENT_TYPE = 'smart';
 export let SliNames = /*#__PURE__*/function (SliNames) {

package/dist/esm/api/MentionNameResolver.js

@@ -12,12 +12,15 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
   function DefaultMentionNameResolver(client) {
     var _this = this;
     var analyticsProps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var onResolvedAll = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : function () {};
     _classCallCheck(this, DefaultMentionNameResolver);
     _defineProperty(this, "nameCache", new Map());
     _defineProperty(this, "nameQueue", new Map());
     _defineProperty(this, "nameStartTime", new Map());
     _defineProperty(this, "processingQueue", new Map());
     _defineProperty(this, "debounce", 0);
+    _defineProperty(this, "debounceOnResolve", null);
+    _defineProperty(this, "isOnResolvedAllCalled", false);
     _defineProperty(this, "processQueue", function () {
       clearTimeout(_this.debounce);
       _this.debounce = 0;
@@ -52,10 +55,15 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
       // Make sure anything left in the queue gets processed.
       if (_this.nameQueue.size > 0) {
         _this.scheduleProcessQueue();
+      } else {
+        _this.scheduleOnAllResolved();
       }
     });
     this.client = client;
     this.fireHydrationEvent = fireAnalyticsMentionHydrationEvent(analyticsProps);
+    // If provided, this will be called once all pending mentions in the queue are resolved.
+    // A sample usage is scrolling to a mention on page load, after the mentions have loadad.
+    this.onResolvedAll = onResolvedAll;
   }
   _createClass(DefaultMentionNameResolver, [{
     key: "lookupName",
@@ -64,6 +72,9 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
       var name = this.nameCache.get(id);
       if (name) {
         this.fireAnalytics(true, name);
+        if (this.nameQueue.size === 0) {
+          this.scheduleOnAllResolved();
+        }
         return name;
       }
       return new Promise(function (resolve) {
@@ -98,6 +109,21 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
         this.debounce = window.setTimeout(this.processQueue, DefaultMentionNameResolver.waitForBatch);
       }
     }
+  }, {
+    key: "scheduleOnAllResolved",
+    value: function scheduleOnAllResolved() {
+      var _this3 = this;
+      if (this.debounceOnResolve) {
+        clearTimeout(this.debounceOnResolve);
+      }
+      this.debounceOnResolve = window.setTimeout(function () {
+        if (_this3.isOnResolvedAllCalled) {
+          return;
+        }
+        _this3.onResolvedAll();
+        _this3.isOnResolvedAllCalled = true;
+      }, DefaultMentionNameResolver.waitForResolveAll);
+    }
   }, {
     key: "isQueueAtLimit",
     value: function isQueueAtLimit() {
@@ -150,6 +176,8 @@ export var DefaultMentionNameResolver = /*#__PURE__*/function () {
  * This addresses [this ticket](https://product-fabric.atlassian.net/browse/QS-3789).
  */
 _defineProperty(DefaultMentionNameResolver, "waitForBatch", 100);
+// ms
+_defineProperty(DefaultMentionNameResolver, "waitForResolveAll", 800);
 export function mergeNameResolverQueues(queueA, queueB) {
   var queueBeingMerged = new Map(_toConsumableArray(queueA));
 

package/dist/esm/util/analytics.js

@@ -5,7 +5,7 @@ import { OPERATIONAL_EVENT_TYPE, UI_EVENT_TYPE } from '@atlaskit/analytics-gas-t
 import { ELEMENTS_CHANNEL } from '../_constants';
 import { isSpecialMentionText } from '../types';
 var packageName = "@atlaskit/mention";
-var packageVersion = "23.0.4";
+var packageVersion = "23.1.0";
 export var SLI_EVENT_TYPE = 'sli';
 export var SMART_EVENT_TYPE = 'smart';
 export var SliNames = /*#__PURE__*/function (SliNames) {

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

@@ -9,17 +9,22 @@ export type { MentionNameResolver } from '../types';
 type Queue = Map<string, Callback[]>;
 export declare class DefaultMentionNameResolver implements MentionNameResolver {
     static waitForBatch: number;
+    private static waitForResolveAll;
     private client;
     private nameCache;
     private nameQueue;
     private nameStartTime;
     private processingQueue;
     private debounce;
+    private debounceOnResolve;
+    private onResolvedAll;
+    private isOnResolvedAllCalled;
     private fireHydrationEvent;
-    constructor(client: MentionNameClient, analyticsProps?: WithAnalyticsEventsProps);
+    constructor(client: MentionNameClient, analyticsProps?: WithAnalyticsEventsProps, onResolvedAll?: () => void);
     lookupName(id: string): Promise<MentionNameDetails> | MentionNameDetails;
     cacheName(id: string, name: string): void;
     private scheduleProcessQueue;
+    private scheduleOnAllResolved;
     private isQueueAtLimit;
     private splitQueueAtLimit;
     private resolveQueueItem;

package/dist/types-ts4.5/api/MentionNameResolver.d.ts

@@ -9,17 +9,22 @@ export type { MentionNameResolver } from '../types';
 type Queue = Map<string, Callback[]>;
 export declare class DefaultMentionNameResolver implements MentionNameResolver {
     static waitForBatch: number;
+    private static waitForResolveAll;
     private client;
     private nameCache;
     private nameQueue;
     private nameStartTime;
     private processingQueue;
     private debounce;
+    private debounceOnResolve;
+    private onResolvedAll;
+    private isOnResolvedAllCalled;
     private fireHydrationEvent;
-    constructor(client: MentionNameClient, analyticsProps?: WithAnalyticsEventsProps);
+    constructor(client: MentionNameClient, analyticsProps?: WithAnalyticsEventsProps, onResolvedAll?: () => void);
     lookupName(id: string): Promise<MentionNameDetails> | MentionNameDetails;
     cacheName(id: string, name: string): void;
     private scheduleProcessQueue;
+    private scheduleOnAllResolved;
     private isQueueAtLimit;
     private splitQueueAtLimit;
     private resolveQueueItem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/mention",
-  "version": "23.0.4",
+  "version": "23.1.0",
   "description": "A React component used to display user profiles in a list for 'Mention' functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -61,7 +61,6 @@
   "devDependencies": {
     "@atlaskit/elements-test-helpers": "^0.7.0",
     "@atlaskit/visual-regression": "*",
-    "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/query-string": "^4.3.1",
     "@types/serialize-javascript": "^5.0.0",
     "enzyme": "^3.10.0",
@@ -91,7 +90,6 @@
       ]
     }
   },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1",
   "af:exports": {
     ".": "./src/index.ts",
     "./element": "./src/element.ts",