@atlaskit/editor-plugin-user-preferences 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-user-preferences
 
+## 0.2.0
+
+### Minor Changes
+
+- [#158546](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/158546)
+  [`b7fe4e6f226f3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b7fe4e6f226f3) -
+  ED-27284 use user preferences plugin in editor preset.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.1.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -3,7 +3,7 @@
     "compilerOptions": {
         "target": "es5",
         "composite": true,
-        "outDir": "../dist",
+        "outDir": "../../../../../confluence/tsDist/@atlaskit__editor-plugin-user-preferences",
         "rootDir": "../"
     },
     "include": [
@@ -25,6 +25,9 @@
         },
         {
             "path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../tmp-editor-statsig/afm-cc/tsconfig.json"
         }
     ]
 }

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

@@ -4,12 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateToolbarDockingPosition = void 0;
+exports.updateUserPreference = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _monitoring = require("@atlaskit/editor-common/monitoring");
 var _main = require("./main");
-var updateToolbarDockingPosition = exports.updateToolbarDockingPosition = function updateToolbarDockingPosition(_ref) {
+var updateUserPreference = exports.updateUserPreference = function updateUserPreference(_ref) {
   var key = _ref.key,
     value = _ref.value,
     userPreferencesProvider = _ref.userPreferencesProvider,
@@ -17,12 +17,15 @@ var updateToolbarDockingPosition = exports.updateToolbarDockingPosition = functi
   return function (_ref2) {
     var tr = _ref2.tr;
     try {
-      userPreferencesProvider.updatePreference(key, value);
+      userPreferencesProvider === null || userPreferencesProvider === void 0 || userPreferencesProvider.updatePreference(key, value);
     } catch (error) {
       (0, _monitoring.logException)(error, {
         location: 'editor-plugin-user-preferences/userPreferencesPlugin'
       });
     }
+
+    // If the userPreferencesProvider is not available,
+    // the plugin's state will be updated to operate in 'in memory' mode.
     tr.setMeta(_main.userPreferencesPluginKey, {
       preferences: (0, _defineProperty2.default)({}, key, value)
     });

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

@@ -8,17 +8,27 @@ exports.userPreferencesPluginKey = exports.createPlugin = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 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 userPreferencesPluginKey = exports.userPreferencesPluginKey = new _state.PluginKey('userPreferencesPlugin');
 var createPlugin = exports.createPlugin = function createPlugin(pluginOptions, _api) {
-  var userPreferencesProvider = pluginOptions.userPreferencesProvider;
+  var userPreferencesProvider = pluginOptions.userPreferencesProvider,
+    initialUserPreferences = pluginOptions.initialUserPreferences;
+  var getInitialUserPreferences = function getInitialUserPreferences() {
+    if (initialUserPreferences && (0, _experiments.editorExperiment)('platform_editor_controls', 'variant1')) {
+      return initialUserPreferences;
+    }
+    return {
+      toolbarDockingPosition: 'top'
+    };
+  };
   return new _safePlugin.SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init: function init() {
         return {
-          preferences: userPreferencesProvider.getPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
         };
       },
       apply: function apply(tr, currentPluginState) {

package/dist/cjs/ui/useDocumentVisibilityWatcher.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useDocumentVisibilityWatcher = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _react = require("react");
+var _bindEventListener = require("bind-event-listener");
+var _monitoring = require("@atlaskit/editor-common/monitoring");
+var useDocumentVisibilityWatcher = exports.useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
+  (0, _react.useEffect)(function () {
+    if (userPreferencesProvider) {
+      var refreshPreferences = /*#__PURE__*/function () {
+        var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+          return _regenerator.default.wrap(function _callee$(_context) {
+            while (1) switch (_context.prev = _context.next) {
+              case 0:
+                if (!(document.visibilityState === 'visible')) {
+                  _context.next = 9;
+                  break;
+                }
+                _context.prev = 1;
+                _context.next = 4;
+                return userPreferencesProvider.loadPreferences();
+              case 4:
+                _context.next = 9;
+                break;
+              case 6:
+                _context.prev = 6;
+                _context.t0 = _context["catch"](1);
+                (0, _monitoring.logException)(_context.t0, {
+                  location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+                });
+              case 9:
+              case "end":
+                return _context.stop();
+            }
+          }, _callee, null, [[1, 6]]);
+        }));
+        return function refreshPreferences() {
+          return _ref.apply(this, arguments);
+        };
+      }();
+      return (0, _bindEventListener.bind)(document, {
+        type: 'visibilitychange',
+        listener: refreshPreferences
+      });
+    }
+  }, [userPreferencesProvider]);
+};

package/dist/cjs/ui/useUserPreferencesInitListener.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUserPreferencesInitListener = void 0;
+var _react = require("react");
+var _analytics = require("@atlaskit/editor-common/analytics");
+var useUserPreferencesInitListener = exports.useUserPreferencesInitListener = function useUserPreferencesInitListener(isInitialized, resolvedUserPreferences, api) {
+  var isInitializedRef = (0, _react.useRef)(false);
+  (0, _react.useEffect)(function () {
+    if (isInitialized && resolvedUserPreferences && !isInitializedRef.current) {
+      var _api$analytics;
+      isInitializedRef.current = true;
+      api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+        action: _analytics.ACTION.INITIALISED,
+        actionSubject: _analytics.ACTION_SUBJECT.USER_PREFERENCES,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+        attributes: {
+          toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
+        },
+        eventType: _analytics.EVENT_TYPE.OPERATIONAL
+      });
+    }
+  }, [api, isInitialized, resolvedUserPreferences]);
+};

package/dist/cjs/ui/useUserPreferencesUpdateListener.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUserPreferencesUpdateListener = void 0;
+var _react = require("react");
+var _main = require("../pm-plugins/main");
+var useUserPreferencesUpdateListener = exports.useUserPreferencesUpdateListener = function useUserPreferencesUpdateListener(editorView, resolvedUserPreferences) {
+  (0, _react.useEffect)(function () {
+    if (resolvedUserPreferences) {
+      editorView.dispatch(editorView.state.tr.setMeta(_main.userPreferencesPluginKey, {
+        preferences: resolvedUserPreferences
+      }));
+    }
+  }, [resolvedUserPreferences, editorView]);
+};

package/dist/cjs/userPreferencesPlugin.js

@@ -1,20 +1,15 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.userPreferencesPlugin = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _react = require("react");
-var _bindEventListener = require("bind-event-listener");
-var _analytics = require("@atlaskit/editor-common/analytics");
-var _monitoring = require("@atlaskit/editor-common/monitoring");
 var _userPreferences = require("@atlaskit/editor-common/user-preferences");
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _commands = require("./pm-plugins/commands");
 var _main = require("./pm-plugins/main");
+var _useDocumentVisibilityWatcher = require("./ui/useDocumentVisibilityWatcher");
+var _useUserPreferencesInitListener = require("./ui/useUserPreferencesInitListener");
+var _useUserPreferencesUpdateListener = require("./ui/useUserPreferencesUpdateListener");
 var userPreferencesPlugin = exports.userPreferencesPlugin = function userPreferencesPlugin(_ref) {
   var config = _ref.config,
     api = _ref.api;
@@ -32,15 +27,12 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
     actions: {
       updateUserPreference: function updateUserPreference(key, value) {
         var _api$analytics;
-        return (0, _commands.updateToolbarDockingPosition)({
+        return (0, _commands.updateUserPreference)({
           key: key,
           value: value,
           userPreferencesProvider: userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
-      },
-      setDefaultPreferences: function setDefaultPreferences(preferences) {
-        userPreferencesProvider.setDefaultPreferences(preferences);
       }
     },
     getSharedState: function getSharedState(editorState) {
@@ -53,66 +45,9 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
       var editorView = _ref2.editorView;
       var _useResolvedUserPrefe = (0, _userPreferences.useResolvedUserPreferences)(userPreferencesProvider),
         resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
-      var isInitialized = (0, _react.useRef)(false);
-      (0, _react.useEffect)(function () {
-        if ((0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')) {
-          if (userPreferencesProvider.isInitialized && !isInitialized.current) {
-            var _api$analytics2;
-            isInitialized.current = true;
-            api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || _api$analytics2.actions.fireAnalyticsEvent({
-              action: _analytics.ACTION.INITIALISED,
-              actionSubject: _analytics.ACTION_SUBJECT.USER_PREFERENCES,
-              actionSubjectId: _analytics.ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
-              attributes: {
-                toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
-              },
-              eventType: _analytics.EVENT_TYPE.OPERATIONAL
-            });
-          }
-          editorView.dispatch(editorView.state.tr.setMeta(_main.userPreferencesPluginKey, {
-            preferences: resolvedUserPreferences
-          }));
-        }
-      }, [resolvedUserPreferences, editorView]);
-      (0, _react.useEffect)(function () {
-        if ((0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin')) {
-          var refreshPrefrerence = /*#__PURE__*/function () {
-            var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-              return _regenerator.default.wrap(function _callee$(_context) {
-                while (1) switch (_context.prev = _context.next) {
-                  case 0:
-                    if (!(document.visibilityState === 'visible')) {
-                      _context.next = 9;
-                      break;
-                    }
-                    _context.prev = 1;
-                    _context.next = 4;
-                    return userPreferencesProvider.loadPreferences();
-                  case 4:
-                    _context.next = 9;
-                    break;
-                  case 6:
-                    _context.prev = 6;
-                    _context.t0 = _context["catch"](1);
-                    (0, _monitoring.logException)(_context.t0, {
-                      location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-                    });
-                  case 9:
-                  case "end":
-                    return _context.stop();
-                }
-              }, _callee, null, [[1, 6]]);
-            }));
-            return function refreshPrefrerence() {
-              return _ref3.apply(this, arguments);
-            };
-          }();
-          return (0, _bindEventListener.bind)(document, {
-            type: 'visibilitychange',
-            listener: refreshPrefrerence
-          });
-        }
-      }, []);
+      (0, _useUserPreferencesUpdateListener.useUserPreferencesUpdateListener)(editorView, resolvedUserPreferences);
+      (0, _useDocumentVisibilityWatcher.useDocumentVisibilityWatcher)(userPreferencesProvider);
+      (0, _useUserPreferencesInitListener.useUserPreferencesInitListener)(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };
 };

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

@@ -1,7 +1,7 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { userPreferencesPluginKey } from './main';
-export const updateToolbarDockingPosition = ({
+export const updateUserPreference = ({
   key,
   value,
   userPreferencesProvider,
@@ -10,12 +10,15 @@ export const updateToolbarDockingPosition = ({
   tr
 }) => {
   try {
-    userPreferencesProvider.updatePreference(key, value);
+    userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.updatePreference(key, value);
   } catch (error) {
     logException(error, {
       location: 'editor-plugin-user-preferences/userPreferencesPlugin'
     });
   }
+
+  // If the userPreferencesProvider is not available,
+  // the plugin's state will be updated to operate in 'in memory' mode.
   tr.setMeta(userPreferencesPluginKey, {
     preferences: {
       [key]: value

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

@@ -1,16 +1,26 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 export const userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
 export const createPlugin = (pluginOptions, _api) => {
   const {
-    userPreferencesProvider
+    userPreferencesProvider,
+    initialUserPreferences
   } = pluginOptions;
+  const getInitialUserPreferences = () => {
+    if (initialUserPreferences && editorExperiment('platform_editor_controls', 'variant1')) {
+      return initialUserPreferences;
+    }
+    return {
+      toolbarDockingPosition: 'top'
+    };
+  };
   return new SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init() {
         return {
-          preferences: userPreferencesProvider.getPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
         };
       },
       apply: (tr, currentPluginState) => {

package/dist/es2019/ui/useDocumentVisibilityWatcher.js

@@ -0,0 +1,24 @@
+import { useEffect } from 'react';
+import { bind } from 'bind-event-listener';
+import { logException } from '@atlaskit/editor-common/monitoring';
+export const useDocumentVisibilityWatcher = userPreferencesProvider => {
+  useEffect(() => {
+    if (userPreferencesProvider) {
+      const refreshPreferences = async () => {
+        if (document.visibilityState === 'visible') {
+          try {
+            await userPreferencesProvider.loadPreferences();
+          } catch (error) {
+            logException(error, {
+              location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+            });
+          }
+        }
+      };
+      return bind(document, {
+        type: 'visibilitychange',
+        listener: refreshPreferences
+      });
+    }
+  }, [userPreferencesProvider]);
+};

package/dist/es2019/ui/useUserPreferencesInitListener.js

@@ -0,0 +1,20 @@
+import { useEffect, useRef } from 'react';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+export const useUserPreferencesInitListener = (isInitialized, resolvedUserPreferences, api) => {
+  const isInitializedRef = useRef(false);
+  useEffect(() => {
+    if (isInitialized && resolvedUserPreferences && !isInitializedRef.current) {
+      var _api$analytics;
+      isInitializedRef.current = true;
+      api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
+        action: ACTION.INITIALISED,
+        actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
+        actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+        attributes: {
+          toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
+        },
+        eventType: EVENT_TYPE.OPERATIONAL
+      });
+    }
+  }, [api, isInitialized, resolvedUserPreferences]);
+};

package/dist/es2019/ui/useUserPreferencesUpdateListener.js

@@ -0,0 +1,11 @@
+import { useEffect } from 'react';
+import { userPreferencesPluginKey } from '../pm-plugins/main';
+export const useUserPreferencesUpdateListener = (editorView, resolvedUserPreferences) => {
+  useEffect(() => {
+    if (resolvedUserPreferences) {
+      editorView.dispatch(editorView.state.tr.setMeta(userPreferencesPluginKey, {
+        preferences: resolvedUserPreferences
+      }));
+    }
+  }, [resolvedUserPreferences, editorView]);
+};

package/dist/es2019/userPreferencesPlugin.js

@@ -1,18 +1,14 @@
-import { useEffect, useRef } from 'react';
-import { bind } from 'bind-event-listener';
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
-import { logException } from '@atlaskit/editor-common/monitoring';
 import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { updateToolbarDockingPosition } from './pm-plugins/commands';
+import { updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
+import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
+import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
+import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
 export const userPreferencesPlugin = ({
   config,
   api
 }) => {
-  const {
-    userPreferencesProvider
-  } = config;
+  const userPreferencesProvider = config.userPreferencesProvider;
   return {
     name: 'userPreferences',
     pmPlugins() {
@@ -26,15 +22,12 @@ export const userPreferencesPlugin = ({
     actions: {
       updateUserPreference: (key, value) => {
         var _api$analytics;
-        return updateToolbarDockingPosition({
+        return updateUserPreference({
           key,
           value,
           userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
-      },
-      setDefaultPreferences: preferences => {
-        userPreferencesProvider.setDefaultPreferences(preferences);
       }
     },
     getSharedState(editorState) {
@@ -49,46 +42,9 @@ export const userPreferencesPlugin = ({
       const {
         resolvedUserPreferences
       } = useResolvedUserPreferences(userPreferencesProvider);
-      const isInitialized = useRef(false);
-      useEffect(() => {
-        if (fg('platform_editor_use_preferences_plugin')) {
-          if (userPreferencesProvider.isInitialized && !isInitialized.current) {
-            var _api$analytics2;
-            isInitialized.current = true;
-            api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions.fireAnalyticsEvent({
-              action: ACTION.INITIALISED,
-              actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
-              actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
-              attributes: {
-                toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
-              },
-              eventType: EVENT_TYPE.OPERATIONAL
-            });
-          }
-          editorView.dispatch(editorView.state.tr.setMeta(userPreferencesPluginKey, {
-            preferences: resolvedUserPreferences
-          }));
-        }
-      }, [resolvedUserPreferences, editorView]);
-      useEffect(() => {
-        if (fg('platform_editor_use_preferences_plugin')) {
-          const refreshPrefrerence = async () => {
-            if (document.visibilityState === 'visible') {
-              try {
-                await userPreferencesProvider.loadPreferences();
-              } catch (error) {
-                logException(error, {
-                  location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-                });
-              }
-            }
-          };
-          return bind(document, {
-            type: 'visibilitychange',
-            listener: refreshPrefrerence
-          });
-        }
-      }, []);
+      useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
+      useDocumentVisibilityWatcher(userPreferencesProvider);
+      useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };
 };

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

@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { userPreferencesPluginKey } from './main';
-export var updateToolbarDockingPosition = function updateToolbarDockingPosition(_ref) {
+export var updateUserPreference = function updateUserPreference(_ref) {
   var key = _ref.key,
     value = _ref.value,
     userPreferencesProvider = _ref.userPreferencesProvider,
@@ -10,12 +10,15 @@ export var updateToolbarDockingPosition = function updateToolbarDockingPosition(
   return function (_ref2) {
     var tr = _ref2.tr;
     try {
-      userPreferencesProvider.updatePreference(key, value);
+      userPreferencesProvider === null || userPreferencesProvider === void 0 || userPreferencesProvider.updatePreference(key, value);
     } catch (error) {
       logException(error, {
         location: 'editor-plugin-user-preferences/userPreferencesPlugin'
       });
     }
+
+    // If the userPreferencesProvider is not available,
+    // the plugin's state will be updated to operate in 'in memory' mode.
     tr.setMeta(userPreferencesPluginKey, {
       preferences: _defineProperty({}, key, value)
     });

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

@@ -3,15 +3,25 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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) { _defineProperty(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; }
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 export var userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
 export var createPlugin = function createPlugin(pluginOptions, _api) {
-  var userPreferencesProvider = pluginOptions.userPreferencesProvider;
+  var userPreferencesProvider = pluginOptions.userPreferencesProvider,
+    initialUserPreferences = pluginOptions.initialUserPreferences;
+  var getInitialUserPreferences = function getInitialUserPreferences() {
+    if (initialUserPreferences && editorExperiment('platform_editor_controls', 'variant1')) {
+      return initialUserPreferences;
+    }
+    return {
+      toolbarDockingPosition: 'top'
+    };
+  };
   return new SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init: function init() {
         return {
-          preferences: userPreferencesProvider.getPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
         };
       },
       apply: function apply(tr, currentPluginState) {

package/dist/esm/ui/useDocumentVisibilityWatcher.js

@@ -0,0 +1,46 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { useEffect } from 'react';
+import { bind } from 'bind-event-listener';
+import { logException } from '@atlaskit/editor-common/monitoring';
+export var useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
+  useEffect(function () {
+    if (userPreferencesProvider) {
+      var refreshPreferences = /*#__PURE__*/function () {
+        var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+          return _regeneratorRuntime.wrap(function _callee$(_context) {
+            while (1) switch (_context.prev = _context.next) {
+              case 0:
+                if (!(document.visibilityState === 'visible')) {
+                  _context.next = 9;
+                  break;
+                }
+                _context.prev = 1;
+                _context.next = 4;
+                return userPreferencesProvider.loadPreferences();
+              case 4:
+                _context.next = 9;
+                break;
+              case 6:
+                _context.prev = 6;
+                _context.t0 = _context["catch"](1);
+                logException(_context.t0, {
+                  location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+                });
+              case 9:
+              case "end":
+                return _context.stop();
+            }
+          }, _callee, null, [[1, 6]]);
+        }));
+        return function refreshPreferences() {
+          return _ref.apply(this, arguments);
+        };
+      }();
+      return bind(document, {
+        type: 'visibilitychange',
+        listener: refreshPreferences
+      });
+    }
+  }, [userPreferencesProvider]);
+};

package/dist/esm/ui/useUserPreferencesInitListener.js

@@ -0,0 +1,20 @@
+import { useEffect, useRef } from 'react';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+export var useUserPreferencesInitListener = function useUserPreferencesInitListener(isInitialized, resolvedUserPreferences, api) {
+  var isInitializedRef = useRef(false);
+  useEffect(function () {
+    if (isInitialized && resolvedUserPreferences && !isInitializedRef.current) {
+      var _api$analytics;
+      isInitializedRef.current = true;
+      api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+        action: ACTION.INITIALISED,
+        actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
+        actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+        attributes: {
+          toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
+        },
+        eventType: EVENT_TYPE.OPERATIONAL
+      });
+    }
+  }, [api, isInitialized, resolvedUserPreferences]);
+};

package/dist/esm/ui/useUserPreferencesUpdateListener.js

@@ -0,0 +1,11 @@
+import { useEffect } from 'react';
+import { userPreferencesPluginKey } from '../pm-plugins/main';
+export var useUserPreferencesUpdateListener = function useUserPreferencesUpdateListener(editorView, resolvedUserPreferences) {
+  useEffect(function () {
+    if (resolvedUserPreferences) {
+      editorView.dispatch(editorView.state.tr.setMeta(userPreferencesPluginKey, {
+        preferences: resolvedUserPreferences
+      }));
+    }
+  }, [resolvedUserPreferences, editorView]);
+};

package/dist/esm/userPreferencesPlugin.js

@@ -1,13 +1,9 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { useEffect, useRef } from 'react';
-import { bind } from 'bind-event-listener';
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
-import { logException } from '@atlaskit/editor-common/monitoring';
 import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { updateToolbarDockingPosition } from './pm-plugins/commands';
+import { updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
+import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
+import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
+import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
 export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
   var config = _ref.config,
     api = _ref.api;
@@ -25,15 +21,12 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
     actions: {
       updateUserPreference: function updateUserPreference(key, value) {
         var _api$analytics;
-        return updateToolbarDockingPosition({
+        return _updateUserPreference({
           key: key,
           value: value,
           userPreferencesProvider: userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
-      },
-      setDefaultPreferences: function setDefaultPreferences(preferences) {
-        userPreferencesProvider.setDefaultPreferences(preferences);
       }
     },
     getSharedState: function getSharedState(editorState) {
@@ -46,66 +39,9 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
       var editorView = _ref2.editorView;
       var _useResolvedUserPrefe = useResolvedUserPreferences(userPreferencesProvider),
         resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
-      var isInitialized = useRef(false);
-      useEffect(function () {
-        if (fg('platform_editor_use_preferences_plugin')) {
-          if (userPreferencesProvider.isInitialized && !isInitialized.current) {
-            var _api$analytics2;
-            isInitialized.current = true;
-            api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || _api$analytics2.actions.fireAnalyticsEvent({
-              action: ACTION.INITIALISED,
-              actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
-              actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
-              attributes: {
-                toolbarDocking: resolvedUserPreferences.toolbarDockingPosition
-              },
-              eventType: EVENT_TYPE.OPERATIONAL
-            });
-          }
-          editorView.dispatch(editorView.state.tr.setMeta(userPreferencesPluginKey, {
-            preferences: resolvedUserPreferences
-          }));
-        }
-      }, [resolvedUserPreferences, editorView]);
-      useEffect(function () {
-        if (fg('platform_editor_use_preferences_plugin')) {
-          var refreshPrefrerence = /*#__PURE__*/function () {
-            var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-              return _regeneratorRuntime.wrap(function _callee$(_context) {
-                while (1) switch (_context.prev = _context.next) {
-                  case 0:
-                    if (!(document.visibilityState === 'visible')) {
-                      _context.next = 9;
-                      break;
-                    }
-                    _context.prev = 1;
-                    _context.next = 4;
-                    return userPreferencesProvider.loadPreferences();
-                  case 4:
-                    _context.next = 9;
-                    break;
-                  case 6:
-                    _context.prev = 6;
-                    _context.t0 = _context["catch"](1);
-                    logException(_context.t0, {
-                      location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-                    });
-                  case 9:
-                  case "end":
-                    return _context.stop();
-                }
-              }, _callee, null, [[1, 6]]);
-            }));
-            return function refreshPrefrerence() {
-              return _ref3.apply(this, arguments);
-            };
-          }();
-          return bind(document, {
-            type: 'visibilitychange',
-            listener: refreshPrefrerence
-          });
-        }
-      }, []);
+      useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
+      useDocumentVisibilityWatcher(userPreferencesProvider);
+      useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };
 };

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
 export { userPreferencesPlugin } from './userPreferencesPlugin';
-export type { UserPreferencesPlugin } from './userPreferencesPluginType';
+export type { UserPreferencesPlugin, UserPreferencesPluginOptions, } from './userPreferencesPluginType';

package/dist/types/pm-plugins/commands.d.ts

@@ -1,10 +1,9 @@
 import { type EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
-import type { PrefKey } from '../userPreferencesPluginType';
-export declare const updateToolbarDockingPosition: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
-    key: PrefKey;
-    value: ResolvedUserPreferences[PrefKey];
-    userPreferencesProvider: UserPreferencesProvider;
+import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
+    key: keyof UserPreferences;
+    value: "top" | "none";
+    userPreferencesProvider?: UserPreferencesProvider | undefined;
     editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
 }) => EditorCommand;

package/dist/types/pm-plugins/main.d.ts

@@ -2,10 +2,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { Config, UserPreferencesPlugin } from '../userPreferencesPluginType';
+import type { UserPreferencesPluginOptions, UserPreferencesPlugin } from '../userPreferencesPluginType';
 export declare const userPreferencesPluginKey: PluginKey<any>;
 type UserPreferencesPluginState = {
     preferences: ResolvedUserPreferences;
 };
-export declare const createPlugin: (pluginOptions: Config, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;
+export declare const createPlugin: (pluginOptions: UserPreferencesPluginOptions, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;
 export {};

package/dist/types/ui/useDocumentVisibilityWatcher.d.ts

@@ -0,0 +1,2 @@
+import { UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;

package/dist/types/ui/useUserPreferencesInitListener.d.ts

@@ -0,0 +1,4 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { UserPreferencesPlugin } from '../userPreferencesPluginType';
+export declare const useUserPreferencesInitListener: (isInitialized: boolean, resolvedUserPreferences: ResolvedUserPreferences | null, api?: ExtractInjectionAPI<UserPreferencesPlugin>) => void;

package/dist/types/ui/useUserPreferencesUpdateListener.d.ts

@@ -0,0 +1,3 @@
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare const useUserPreferencesUpdateListener: (editorView: EditorView, resolvedUserPreferences: ResolvedUserPreferences | null) => void;

package/dist/types/userPreferencesPluginType.d.ts

@@ -1,8 +1,17 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import { type ResolvedUserPreferences, type UserPreferencesProvider, type UserPreferences } from '@atlaskit/editor-common/user-preferences';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-export type Config = {
-    userPreferencesProvider: UserPreferencesProvider;
+export type UserPreferencesPluginOptions = {
+    /**
+     * The user preferences provider to be used to get and set user preferences.
+     * When not provided, user preferences will not be persisted.
+     */
+    userPreferencesProvider?: UserPreferencesProvider;
+    /**
+     * The initial user preferences to be used when the userPreferencesProvider is not available.
+     * Otherwise, will default to the userPreferencesProvider's initial preferences.
+     */
+    initialUserPreferences?: ResolvedUserPreferences;
 };
 export type PrefKey = keyof UserPreferences;
 export type ResolvedPrefKey = keyof ResolvedUserPreferences;
@@ -10,10 +19,9 @@ export type UserPreferencesSharedState = {
     preferences: ResolvedUserPreferences;
 };
 export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
-    pluginConfiguration: Config;
+    pluginConfiguration: UserPreferencesPluginOptions;
     actions: {
         updateUserPreference: (key: PrefKey, value: ResolvedUserPreferences[PrefKey]) => EditorCommand;
-        setDefaultPreferences: (preferences: ResolvedUserPreferences) => void;
     };
     sharedState: UserPreferencesSharedState;
     dependencies: [OptionalPlugin<AnalyticsPlugin>];

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

@@ -1,2 +1,2 @@
 export { userPreferencesPlugin } from './userPreferencesPlugin';
-export type { UserPreferencesPlugin } from './userPreferencesPluginType';
+export type { UserPreferencesPlugin, UserPreferencesPluginOptions, } from './userPreferencesPluginType';

package/dist/types-ts4.5/pm-plugins/commands.d.ts

@@ -1,10 +1,9 @@
 import { type EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
-import type { PrefKey } from '../userPreferencesPluginType';
-export declare const updateToolbarDockingPosition: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
-    key: PrefKey;
-    value: ResolvedUserPreferences[PrefKey];
-    userPreferencesProvider: UserPreferencesProvider;
+import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
+    key: keyof UserPreferences;
+    value: "top" | "none";
+    userPreferencesProvider?: UserPreferencesProvider | undefined;
     editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
 }) => EditorCommand;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -2,10 +2,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { Config, UserPreferencesPlugin } from '../userPreferencesPluginType';
+import type { UserPreferencesPluginOptions, UserPreferencesPlugin } from '../userPreferencesPluginType';
 export declare const userPreferencesPluginKey: PluginKey<any>;
 type UserPreferencesPluginState = {
     preferences: ResolvedUserPreferences;
 };
-export declare const createPlugin: (pluginOptions: Config, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;
+export declare const createPlugin: (pluginOptions: UserPreferencesPluginOptions, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;
 export {};

package/dist/types-ts4.5/ui/useDocumentVisibilityWatcher.d.ts

@@ -0,0 +1,2 @@
+import { UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;

package/dist/types-ts4.5/ui/useUserPreferencesInitListener.d.ts

@@ -0,0 +1,4 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { UserPreferencesPlugin } from '../userPreferencesPluginType';
+export declare const useUserPreferencesInitListener: (isInitialized: boolean, resolvedUserPreferences: ResolvedUserPreferences | null, api?: ExtractInjectionAPI<UserPreferencesPlugin>) => void;

package/dist/types-ts4.5/ui/useUserPreferencesUpdateListener.d.ts

@@ -0,0 +1,3 @@
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare const useUserPreferencesUpdateListener: (editorView: EditorView, resolvedUserPreferences: ResolvedUserPreferences | null) => void;

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

@@ -1,8 +1,17 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import { type ResolvedUserPreferences, type UserPreferencesProvider, type UserPreferences } from '@atlaskit/editor-common/user-preferences';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-export type Config = {
-    userPreferencesProvider: UserPreferencesProvider;
+export type UserPreferencesPluginOptions = {
+    /**
+     * The user preferences provider to be used to get and set user preferences.
+     * When not provided, user preferences will not be persisted.
+     */
+    userPreferencesProvider?: UserPreferencesProvider;
+    /**
+     * The initial user preferences to be used when the userPreferencesProvider is not available.
+     * Otherwise, will default to the userPreferencesProvider's initial preferences.
+     */
+    initialUserPreferences?: ResolvedUserPreferences;
 };
 export type PrefKey = keyof UserPreferences;
 export type ResolvedPrefKey = keyof ResolvedUserPreferences;
@@ -10,10 +19,9 @@ export type UserPreferencesSharedState = {
     preferences: ResolvedUserPreferences;
 };
 export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
-    pluginConfiguration: Config;
+    pluginConfiguration: UserPreferencesPluginOptions;
     actions: {
         updateUserPreference: (key: PrefKey, value: ResolvedUserPreferences[PrefKey]) => EditorCommand;
-        setDefaultPreferences: (preferences: ResolvedUserPreferences) => void;
     };
     sharedState: UserPreferencesSharedState;
     dependencies: [

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-user-preferences",
-	"version": "0.1.2",
+	"version": "0.2.0",
 	"description": "UserPreferences plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,10 +32,11 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^106.0.0",
+		"@atlaskit/editor-common": "^106.7.0",
 		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/tmp-editor-statsig": "^7.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},