@atlaskit/editor-plugin-mentions 24.0.10 → 24.1.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-plugin-mentions
 
+## 24.1.0
+
+### Minor Changes
+
+- [`051cd10867eae`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/051cd10867eae) -
+  Expose uploadStatus and mentionProviderStatus to distinguish pending providers from unavailable
+  capabilities. Under platform_editor_ssr_toolbar_optimistic, keep mention and media toolbar buttons
+  enabled while providers are pending, avoiding class changes on successful initialization while
+  preserving existing insertion restrictions.
+
+  When a view-only synchronous SSR media provider accompanies a pending full provider, keep uploads
+  pending until the full provider resolves instead of treating the SSR config as a permission
+  denial.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 24.0.10
 
 ### Patch Changes

package/dist/cjs/pm-plugins/main.js

@@ -12,6 +12,7 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _insm = require("@atlaskit/insm");
 var _analytics2 = require("@atlaskit/mention/analytics");
 var _types = require("@atlaskit/mention/types");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _isMentionTypeAheadEnabled = require("../isMentionTypeAheadEnabled");
 var _mentionNodeView = require("../nodeviews/mentionNodeView");
@@ -44,7 +45,7 @@ var ACTIONS = exports.ACTIONS = {
   CLEAR_PENDING_PASTED_AGENT_MENTION: 'CLEAR_PENDING_PASTED_AGENT_MENTION'
 };
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "24.0.9";
+var PACKAGE_VERSION = "24.0.10";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {
@@ -86,7 +87,8 @@ function createMentionPlugin(_ref) {
     state: {
       init: function init(_, state) {
         return {
-          canInsertMention: isMentionInsertionEnabled(state)
+          canInsertMention: isMentionInsertionEnabled(state),
+          mentionProviderStatus: 'pending'
         };
       },
       apply: function apply(tr, pluginState, oldState, newState) {
@@ -108,7 +110,8 @@ function createMentionPlugin(_ref) {
         switch (action) {
           case ACTIONS.SET_PROVIDER:
             newPluginState = _objectSpread(_objectSpread({}, newPluginState), {}, {
-              mentionProvider: params.provider
+              mentionProvider: params.provider,
+              mentionProviderStatus: params.provider ? 'available' : 'unavailable'
             });
             hasPublicPluginStateChanged = true;
             break;
@@ -191,9 +194,13 @@ function createMentionPlugin(_ref) {
       }
     },
     view: function view(editorView) {
+      var destroyed = false;
+      var optimistic = (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_ssr_toolbar_optimistic');
+      var currentProviderPromise;
       var providerHandler = function providerHandler(name, providerPromise) {
         switch (name) {
           case 'mentionProvider':
+            currentProviderPromise = providerPromise;
             if (!providerPromise) {
               fireEvent({
                 action: _analytics.ACTION.ERRORED,
@@ -207,6 +214,9 @@ function createMentionPlugin(_ref) {
               return setProvider(undefined)(editorView.state, editorView.dispatch);
             }
             providerPromise.then(function (provider) {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               if (mentionProvider) {
                 mentionProvider.unsubscribe('mentionPlugin');
               }
@@ -214,6 +224,9 @@ function createMentionPlugin(_ref) {
               setProvider(provider)(editorView.state, editorView.dispatch);
               provider.subscribe('mentionPlugin', undefined, undefined, undefined, undefined, sendAnalytics);
             }).catch(function () {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               fireEvent({
                 action: _analytics.ACTION.ERRORED,
                 actionSubject: _analytics.ACTION_SUBJECT.MENTION,
@@ -234,9 +247,19 @@ function createMentionPlugin(_ref) {
         providerHandler('mentionProvider', options === null || options === void 0 ? void 0 : options.mentionProvider);
       } else {
         pmPluginFactoryParams.providerFactory.subscribe('mentionProvider', providerHandler);
+        if (optimistic) {
+          // Subscribe does not notify us when no provider exists. Wait until the view
+          // has finished mounting before publishing the unavailable state.
+          Promise.resolve().then(function () {
+            if (!destroyed && !pmPluginFactoryParams.providerFactory.hasProvider('mentionProvider')) {
+              setProvider(undefined)(editorView.state, editorView.dispatch);
+            }
+          });
+        }
       }
       return {
         destroy: function destroy() {
+          destroyed = true;
           if (pmPluginFactoryParams.providerFactory) {
             pmPluginFactoryParams.providerFactory.unsubscribe('mentionProvider', providerHandler);
           }

package/dist/es2019/pm-plugins/main.js

@@ -3,6 +3,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { insm } from '@atlaskit/insm';
 import { SLI_EVENT_TYPE, SMART_EVENT_TYPE } from '@atlaskit/mention/analytics';
 import { ComponentNames } from '@atlaskit/mention/types';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { isMentionTypeAheadEnabled } from '../isMentionTypeAheadEnabled';
 import { MentionNodeView } from '../nodeviews/mentionNodeView';
@@ -33,7 +34,7 @@ export const ACTIONS = {
   CLEAR_PENDING_PASTED_AGENT_MENTION: 'CLEAR_PENDING_PASTED_AGENT_MENTION'
 };
 const PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-const PACKAGE_VERSION = "24.0.9";
+const PACKAGE_VERSION = "24.0.10";
 const setProvider = provider => (state, dispatch) => {
   if (dispatch) {
     dispatch(state.tr.setMeta(mentionPluginKey, {
@@ -73,7 +74,8 @@ export function createMentionPlugin({
     state: {
       init(_, state) {
         return {
-          canInsertMention: isMentionInsertionEnabled(state)
+          canInsertMention: isMentionInsertionEnabled(state),
+          mentionProviderStatus: 'pending'
         };
       },
       apply(tr, pluginState, oldState, newState) {
@@ -98,7 +100,8 @@ export function createMentionPlugin({
           case ACTIONS.SET_PROVIDER:
             newPluginState = {
               ...newPluginState,
-              mentionProvider: params.provider
+              mentionProvider: params.provider,
+              mentionProviderStatus: params.provider ? 'available' : 'unavailable'
             };
             hasPublicPluginStateChanged = true;
             break;
@@ -179,9 +182,13 @@ export function createMentionPlugin({
       }
     },
     view(editorView) {
+      let destroyed = false;
+      const optimistic = isExperimentEnabled('platform_editor_ssr_toolbar_optimistic');
+      let currentProviderPromise;
       const providerHandler = (name, providerPromise) => {
         switch (name) {
           case 'mentionProvider':
+            currentProviderPromise = providerPromise;
             if (!providerPromise) {
               fireEvent({
                 action: ACTION.ERRORED,
@@ -195,6 +202,9 @@ export function createMentionPlugin({
               return setProvider(undefined)(editorView.state, editorView.dispatch);
             }
             providerPromise.then(provider => {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               if (mentionProvider) {
                 mentionProvider.unsubscribe('mentionPlugin');
               }
@@ -202,6 +212,9 @@ export function createMentionPlugin({
               setProvider(provider)(editorView.state, editorView.dispatch);
               provider.subscribe('mentionPlugin', undefined, undefined, undefined, undefined, sendAnalytics);
             }).catch(() => {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               fireEvent({
                 action: ACTION.ERRORED,
                 actionSubject: ACTION_SUBJECT.MENTION,
@@ -222,9 +235,19 @@ export function createMentionPlugin({
         providerHandler('mentionProvider', options === null || options === void 0 ? void 0 : options.mentionProvider);
       } else {
         pmPluginFactoryParams.providerFactory.subscribe('mentionProvider', providerHandler);
+        if (optimistic) {
+          // Subscribe does not notify us when no provider exists. Wait until the view
+          // has finished mounting before publishing the unavailable state.
+          Promise.resolve().then(() => {
+            if (!destroyed && !pmPluginFactoryParams.providerFactory.hasProvider('mentionProvider')) {
+              setProvider(undefined)(editorView.state, editorView.dispatch);
+            }
+          });
+        }
       }
       return {
         destroy() {
+          destroyed = true;
           if (pmPluginFactoryParams.providerFactory) {
             pmPluginFactoryParams.providerFactory.unsubscribe('mentionProvider', providerHandler);
           }

package/dist/esm/pm-plugins/main.js

@@ -6,6 +6,7 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { insm } from '@atlaskit/insm';
 import { SLI_EVENT_TYPE, SMART_EVENT_TYPE } from '@atlaskit/mention/analytics';
 import { ComponentNames } from '@atlaskit/mention/types';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { isMentionTypeAheadEnabled } from '../isMentionTypeAheadEnabled';
 import { MentionNodeView } from '../nodeviews/mentionNodeView';
@@ -36,7 +37,7 @@ export var ACTIONS = {
   CLEAR_PENDING_PASTED_AGENT_MENTION: 'CLEAR_PENDING_PASTED_AGENT_MENTION'
 };
 var PACKAGE_NAME = "@atlaskit/editor-plugin-mentions";
-var PACKAGE_VERSION = "24.0.9";
+var PACKAGE_VERSION = "24.0.10";
 var setProvider = function setProvider(provider) {
   return function (state, dispatch) {
     if (dispatch) {
@@ -78,7 +79,8 @@ export function createMentionPlugin(_ref) {
     state: {
       init: function init(_, state) {
         return {
-          canInsertMention: isMentionInsertionEnabled(state)
+          canInsertMention: isMentionInsertionEnabled(state),
+          mentionProviderStatus: 'pending'
         };
       },
       apply: function apply(tr, pluginState, oldState, newState) {
@@ -100,7 +102,8 @@ export function createMentionPlugin(_ref) {
         switch (action) {
           case ACTIONS.SET_PROVIDER:
             newPluginState = _objectSpread(_objectSpread({}, newPluginState), {}, {
-              mentionProvider: params.provider
+              mentionProvider: params.provider,
+              mentionProviderStatus: params.provider ? 'available' : 'unavailable'
             });
             hasPublicPluginStateChanged = true;
             break;
@@ -183,9 +186,13 @@ export function createMentionPlugin(_ref) {
       }
     },
     view: function view(editorView) {
+      var destroyed = false;
+      var optimistic = isExperimentEnabled('platform_editor_ssr_toolbar_optimistic');
+      var currentProviderPromise;
       var providerHandler = function providerHandler(name, providerPromise) {
         switch (name) {
           case 'mentionProvider':
+            currentProviderPromise = providerPromise;
             if (!providerPromise) {
               fireEvent({
                 action: ACTION.ERRORED,
@@ -199,6 +206,9 @@ export function createMentionPlugin(_ref) {
               return setProvider(undefined)(editorView.state, editorView.dispatch);
             }
             providerPromise.then(function (provider) {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               if (mentionProvider) {
                 mentionProvider.unsubscribe('mentionPlugin');
               }
@@ -206,6 +216,9 @@ export function createMentionPlugin(_ref) {
               setProvider(provider)(editorView.state, editorView.dispatch);
               provider.subscribe('mentionPlugin', undefined, undefined, undefined, undefined, sendAnalytics);
             }).catch(function () {
+              if (optimistic && (destroyed || currentProviderPromise !== providerPromise)) {
+                return;
+              }
               fireEvent({
                 action: ACTION.ERRORED,
                 actionSubject: ACTION_SUBJECT.MENTION,
@@ -226,9 +239,19 @@ export function createMentionPlugin(_ref) {
         providerHandler('mentionProvider', options === null || options === void 0 ? void 0 : options.mentionProvider);
       } else {
         pmPluginFactoryParams.providerFactory.subscribe('mentionProvider', providerHandler);
+        if (optimistic) {
+          // Subscribe does not notify us when no provider exists. Wait until the view
+          // has finished mounting before publishing the unavailable state.
+          Promise.resolve().then(function () {
+            if (!destroyed && !pmPluginFactoryParams.providerFactory.hasProvider('mentionProvider')) {
+              setProvider(undefined)(editorView.state, editorView.dispatch);
+            }
+          });
+        }
       }
       return {
         destroy: function destroy() {
+          destroyed = true;
           if (pmPluginFactoryParams.providerFactory) {
             pmPluginFactoryParams.providerFactory.unsubscribe('mentionProvider', providerHandler);
           }

package/dist/types/types/index.d.ts

@@ -140,6 +140,8 @@ export type MentionPluginState = {
      */
     lastInsertedAgentMentionPrompt?: string | null;
     mentionProvider?: MentionProvider;
+    /** Initial provider resolution, separate from whether the selection allows mentions. */
+    mentionProviderStatus?: 'pending' | 'available' | 'unavailable';
     mentions?: Array<MentionDescription>;
     /**
      * @internal Tracks a pasted agent mention pending name resolution (cache miss).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-mentions",
-	"version": "24.0.10",
+	"version": "24.1.0",
 	"description": "Mentions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -40,7 +40,7 @@
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/popper": "^9.4.0",
-		"@atlaskit/popup": "^8.0.0",
+		"@atlaskit/popup": "^8.1.0",
 		"@atlaskit/portal": "^7.0.0",
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/profilecard": "^27.1.0",