@atlaskit/mention 27.17.1 → 27.18.0

package/dist/cjs/api/HttpError.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HttpError = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var HttpError = exports.HttpError = /*#__PURE__*/(0, _createClass2.default)(function HttpError(statusCode, statusMessage) {
+  (0, _classCallCheck2.default)(this, HttpError);
+  this.statusCode = statusCode;
+  this.message = statusMessage;
+  this.name = 'HttpError';
+  this.stack = new Error().stack;
+});

package/dist/cjs/api/MentionNameResolver.js

@@ -1,207 +1,19 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DefaultMentionNameResolver = void 0;
-exports.mergeNameResolverQueues = mergeNameResolverQueues;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _types = require("../types");
-var _analytics = require("../util/analytics");
-/** A queue for user ids */
-var DefaultMentionNameResolver = exports.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 () {};
-    (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;
-      var _this$splitQueueAtLim = _this.splitQueueAtLimit(),
-        queue = _this$splitQueueAtLim.queue,
-        extraQueue = _this$splitQueueAtLim.extraQueue;
-      _this.nameQueue = extraQueue;
-      _this.processingQueue = mergeNameResolverQueues(_this.processingQueue, queue);
-      _this.client.lookupMentionNames(Array.from(queue.keys())).then(function (response) {
-        response.forEach(function (mentionDetail) {
-          var id = mentionDetail.id;
-          queue.delete(id);
-          _this.resolveQueueItem(mentionDetail);
-        });
-        queue.forEach(function (_callback, id) {
-          // No response from client for these ids treat as unknown
-          _this.resolveQueueItem({
-            id: id,
-            status: _types.MentionNameStatus.UNKNOWN
-          });
-        });
-      }).catch(function () {
-        // Service completely failed, reject all items in the queue
-        queue.forEach(function (_callback, id) {
-          _this.resolveQueueItem({
-            id: id,
-            status: _types.MentionNameStatus.SERVICE_ERROR
-          });
-        });
-      });
-
-      // 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;
+Object.defineProperty(exports, "DefaultMentionNameResolver", {
+  enumerable: true,
+  get: function get() {
+    return _DefaultMentionNameResolver.DefaultMentionNameResolver;
   }
-  return (0, _createClass2.default)(DefaultMentionNameResolver, [{
-    key: "lookupName",
-    value: function lookupName(id) {
-      var _this2 = this;
-      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) {
-        var processingItems = _this2.processingQueue.get(id);
-        if (processingItems) {
-          _this2.processingQueue.set(id, [].concat((0, _toConsumableArray2.default)(processingItems), [resolve]));
-        }
-        var queuedItems = _this2.nameQueue.get(id) || [];
-        _this2.nameQueue.set(id, [].concat((0, _toConsumableArray2.default)(queuedItems), [resolve]));
-        if (queuedItems.length === 0 && !processingItems) {
-          _this2.nameStartTime.set(id, Date.now());
-        }
-        _this2.scheduleProcessQueue();
-        if (_this2.isQueueAtLimit()) {
-          _this2.processQueue();
-        }
-      });
-    }
-  }, {
-    key: "cacheName",
-    value: function cacheName(id, name) {
-      this.nameCache.set(id, {
-        id: id,
-        name: name,
-        status: _types.MentionNameStatus.OK
-      });
-    }
-  }, {
-    key: "scheduleProcessQueue",
-    value: function scheduleProcessQueue() {
-      if (!this.debounce) {
-        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() {
-      return this.nameQueue.size >= this.client.getLookupLimit();
-    }
-  }, {
-    key: "splitQueueAtLimit",
-    value: function splitQueueAtLimit() {
-      var values = Array.from(this.nameQueue.entries());
-      var splitPoint = this.client.getLookupLimit();
-      return {
-        queue: new Map(values.slice(0, splitPoint)),
-        extraQueue: new Map(values.slice(splitPoint))
-      };
-    }
-  }, {
-    key: "resolveQueueItem",
-    value: function resolveQueueItem(mentionDetail) {
-      var id = mentionDetail.id;
-      var resolvers = this.processingQueue.get(id);
-      if (resolvers) {
-        this.processingQueue.delete(id);
-        this.nameCache.set(id, mentionDetail);
-        resolvers.forEach(function (resolve) {
-          try {
-            resolve(mentionDetail);
-          } catch (_unused) {
-            // ignore - exception in consumer
-          }
-        });
-        this.fireAnalytics(false, mentionDetail);
-      }
-    }
-  }, {
-    key: "fireAnalytics",
-    value: function fireAnalytics(fromCache, mentionDetail) {
-      var id = mentionDetail.id;
-      var action = mentionDetail.status === _types.MentionNameStatus.OK ? 'completed' : 'failed';
-      var start = this.nameStartTime.get(id);
-      var duration = start ? Date.now() - start : 0;
-      this.nameStartTime.delete(id);
-      this.fireHydrationEvent(action, id, fromCache, duration);
-    }
-  }]);
-}();
-/**
- * Merge the two queues making sure to merge callback arrays for items in queueB already in queueA.
- * 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));
-
-  // now add the items from the second queue that are not already in the
-  //  merged queue being built
-  (0, _toConsumableArray2.default)(queueB).forEach(function (item) {
-    var _item = (0, _slicedToArray2.default)(item, 2),
-      key = _item[0],
-      queueBCallbacks = _item[1];
-    var itemAlreadyInMergedQueue = queueBeingMerged.has(key);
-    if (!itemAlreadyInMergedQueue) {
-      queueBeingMerged.set(key, queueBCallbacks);
-    } else {
-      var _queueBeingMerged$get;
-      // item already in merged queue, merge the callback arrays
-      var queueACallbacks = (_queueBeingMerged$get = queueBeingMerged.get(key)) !== null && _queueBeingMerged$get !== void 0 ? _queueBeingMerged$get : [];
-      var mergedCallbacks = new Set([].concat((0, _toConsumableArray2.default)(queueBCallbacks), (0, _toConsumableArray2.default)(queueACallbacks)));
-      var deduplicatedCallbacks = Array.from(mergedCallbacks.values()); // prevents calling them twice
-      queueBeingMerged.set(key, deduplicatedCallbacks);
-    }
-  });
-  return queueBeingMerged;
-}
+});
+Object.defineProperty(exports, "mergeNameResolverQueues", {
+  enumerable: true,
+  get: function get() {
+    return _mergeNameResolverQueues.mergeNameResolverQueues;
+  }
+});
+var _DefaultMentionNameResolver = require("./DefaultMentionNameResolver");
+var _mergeNameResolverQueues = require("./mergeNameResolverQueues");

package/dist/cjs/api/MentionResource.js

@@ -4,29 +4,55 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isResolvingMentionProvider = exports.default = exports.MentionResource = exports.HttpError = exports.AbstractResource = exports.AbstractMentionResource = void 0;
+Object.defineProperty(exports, "AbstractMentionResource", {
+  enumerable: true,
+  get: function get() {
+    return _AbstractMentionResource.AbstractMentionResource;
+  }
+});
+Object.defineProperty(exports, "AbstractResource", {
+  enumerable: true,
+  get: function get() {
+    return _AbstractResource.AbstractResource;
+  }
+});
+Object.defineProperty(exports, "HttpError", {
+  enumerable: true,
+  get: function get() {
+    return _HttpError.HttpError;
+  }
+});
+exports.default = exports.MentionResource = void 0;
+Object.defineProperty(exports, "isResolvingMentionProvider", {
+  enumerable: true,
+  get: function get() {
+    return _isResolvingMentionProvider.isResolvingMentionProvider;
+  }
+});
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _debounce = _interopRequireDefault(require("lodash/debounce"));
 var _utilServiceSupport = require("@atlaskit/util-service-support");
+var _isAppMention = require("../is-app-mention");
+var _isTeamMention = require("../is-team-mention");
 var _types = require("../types");
-var _logger = _interopRequireDefault(require("../util/logger"));
 var _analytics = require("../util/analytics");
-var _debounce = _interopRequireDefault(require("lodash/debounce"));
+var _logger = _interopRequireDefault(require("../util/logger"));
+var _AbstractMentionResource = require("./AbstractMentionResource");
+var _HttpError = require("./HttpError");
+var _isResolvingMentionProvider = require("./isResolvingMentionProvider");
+var _AbstractResource = require("./AbstractResource");
 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; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
-function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
 var MAX_QUERY_ITEMS = 100;
-var MAX_NOTIFIED_ITEMS = 20;
-
-// Re-exporting types to prevent breaking change
-// Re-exporting types to prevent breaking change
 
 /**
  * Configuration for the TeamMentionResource, which extends {@link MentionResourceConfig}
@@ -46,139 +72,6 @@ var emptySecurityProvider = function emptySecurityProvider() {
     headers: {}
   };
 };
-var AbstractResource = exports.AbstractResource = /*#__PURE__*/function () {
-  function AbstractResource() {
-    (0, _classCallCheck2.default)(this, AbstractResource);
-    this.changeListeners = new Map();
-    this.allResultsListeners = new Map();
-    this.errListeners = new Map();
-    this.infoListeners = new Map();
-    this.analyticsListeners = new Map();
-  }
-  return (0, _createClass2.default)(AbstractResource, [{
-    key: "subscribe",
-    value: function subscribe(key, callback, errCallback, infoCallback, allResultsCallback, analyticsListeners) {
-      if (callback) {
-        this.changeListeners.set(key, callback);
-      }
-      if (errCallback) {
-        this.errListeners.set(key, errCallback);
-      }
-      if (infoCallback) {
-        this.infoListeners.set(key, infoCallback);
-      }
-      if (allResultsCallback) {
-        this.allResultsListeners.set(key, allResultsCallback);
-      }
-      if (analyticsListeners) {
-        this.analyticsListeners.set(key, analyticsListeners);
-      }
-    }
-  }, {
-    key: "unsubscribe",
-    value: function unsubscribe(key) {
-      this.changeListeners.delete(key);
-      this.errListeners.delete(key);
-      this.infoListeners.delete(key);
-      this.allResultsListeners.delete(key);
-      this.analyticsListeners.delete(key);
-    }
-  }]);
-}();
-var AbstractMentionResource = exports.AbstractMentionResource = /*#__PURE__*/function (_AbstractResource) {
-  function AbstractMentionResource() {
-    (0, _classCallCheck2.default)(this, AbstractMentionResource);
-    return _callSuper(this, AbstractMentionResource, arguments);
-  }
-  (0, _inherits2.default)(AbstractMentionResource, _AbstractResource);
-  return (0, _createClass2.default)(AbstractMentionResource, [{
-    key: "shouldHighlightMention",
-    value: function shouldHighlightMention(_mention) {
-      return false;
-    }
-
-    // eslint-disable-next-line class-methods-use-this
-  }, {
-    key: "filter",
-    value: function filter(query) {
-      throw new Error("not yet implemented.\nParams: query=".concat(query));
-    }
-
-    // eslint-disable-next-line class-methods-use-this, no-unused-vars
-  }, {
-    key: "recordMentionSelection",
-    value: function recordMentionSelection(_mention) {
-      // Do nothing
-    }
-  }, {
-    key: "isFiltering",
-    value: function isFiltering(_query) {
-      return false;
-    }
-  }, {
-    key: "_notifyListeners",
-    value: function _notifyListeners(mentionsResult, stats) {
-      (0, _logger.default)('ak-mention-resource._notifyListeners', mentionsResult && mentionsResult.mentions && mentionsResult.mentions.length, this.changeListeners);
-      this.changeListeners.forEach(function (listener, key) {
-        try {
-          listener(mentionsResult.mentions.slice(0, MAX_NOTIFIED_ITEMS), mentionsResult.query, stats);
-        } catch (e) {
-          // ignore error from listener
-          (0, _logger.default)("error from listener '".concat(key, "', ignoring"), e);
-        }
-      });
-    }
-  }, {
-    key: "_notifyAllResultsListeners",
-    value: function _notifyAllResultsListeners(mentionsResult) {
-      (0, _logger.default)('ak-mention-resource._notifyAllResultsListeners', mentionsResult && mentionsResult.mentions && mentionsResult.mentions.length, this.changeListeners);
-      this.allResultsListeners.forEach(function (listener, key) {
-        try {
-          listener(mentionsResult.mentions.slice(0, MAX_NOTIFIED_ITEMS), mentionsResult.query);
-        } catch (e) {
-          // ignore error from listener
-          (0, _logger.default)("error from listener '".concat(key, "', ignoring"), e);
-        }
-      });
-    }
-  }, {
-    key: "_notifyErrorListeners",
-    value: function _notifyErrorListeners(error, query) {
-      this.errListeners.forEach(function (listener, key) {
-        try {
-          listener(error, query);
-        } catch (e) {
-          // ignore error from listener
-          (0, _logger.default)("error from listener '".concat(key, "', ignoring"), e);
-        }
-      });
-    }
-  }, {
-    key: "_notifyInfoListeners",
-    value: function _notifyInfoListeners(info) {
-      this.infoListeners.forEach(function (listener, key) {
-        try {
-          listener(info);
-        } catch (e) {
-          // ignore error fromr listener
-          (0, _logger.default)("error from listener '".concat(key, "', ignoring"), e);
-        }
-      });
-    }
-  }, {
-    key: "_notifyAnalyticsListeners",
-    value: function _notifyAnalyticsListeners(event, actionSubject, action, attributes) {
-      this.analyticsListeners.forEach(function (listener, key) {
-        try {
-          listener(event, actionSubject, action, attributes);
-        } catch (e) {
-          // ignore error from listener
-          (0, _logger.default)("error from listener '".concat(key, "', ignoring"), e);
-        }
-      });
-    }
-  }]);
-}(AbstractResource);
 /**
  * Provides a Javascript API
  */
@@ -474,9 +367,9 @@ var MentionResource = exports.MentionResource = /*#__PURE__*/function (_Abstract
           return mention;
         }
         var lozenge;
-        if ((0, _types.isAppMention)(mention)) {
+        if ((0, _isAppMention.isAppMention)(mention)) {
           lozenge = mention.userType;
-        } else if ((0, _types.isTeamMention)(mention)) {
+        } else if ((0, _isTeamMention.isTeamMention)(mention)) {
           lozenge = mention.userType;
         }
         return _objectSpread(_objectSpread({}, mention), {}, {
@@ -490,15 +383,17 @@ var MentionResource = exports.MentionResource = /*#__PURE__*/function (_Abstract
       });
     }
   }]);
-}(AbstractMentionResource);
-var HttpError = exports.HttpError = /*#__PURE__*/(0, _createClass2.default)(function HttpError(statusCode, statusMessage) {
-  (0, _classCallCheck2.default)(this, HttpError);
-  this.statusCode = statusCode;
-  this.message = statusMessage;
-  this.name = 'HttpError';
-  this.stack = new Error().stack;
-});
-var isResolvingMentionProvider = exports.isResolvingMentionProvider = function isResolvingMentionProvider(p) {
-  return !!(p && p.supportsMentionNameResolving && p.supportsMentionNameResolving());
-};
-var _default = exports.default = MentionResource;
+}(_AbstractMentionResource.AbstractMentionResource);
+var _default = exports.default = MentionResource;
+/**
+ * @deprecated Use `import { HttpError } from '@atlaskit/mention/mention-resource'` instead.
+ */
+/**
+ * @deprecated Use `import { isResolvingMentionProvider } from '@atlaskit/mention/mention-resource'` instead.
+ */
+/**
+ * @deprecated Use `import { AbstractResource } from '@atlaskit/mention/mention-resource'` instead.
+ */
+/**
+ * @deprecated Use `import { AbstractMentionResource } from '@atlaskit/mention/mention-resource'` instead.
+ */