@atlaskit/editor-plugin-user-preferences 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @atlaskit/editor-plugin-user-preferences
+
+## 0.1.0
+
+### Minor Changes
+
+- [#150264](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/150264)
+  [`f714a99eb7641`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f714a99eb7641) -
+  ED-27284 add user-preferences plugin
+
+### Patch Changes
+
+- Updated dependencies

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2019 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

package/README.md

@@ -0,0 +1 @@
+# Editor plugin user preferences

package/afm-cc/tsconfig.json

@@ -0,0 +1,30 @@
+{
+    "extends": "../../../../tsconfig.entry-points.confluence.json",
+    "compilerOptions": {
+        "target": "es5",
+        "composite": true,
+        "outDir": "../dist",
+        "rootDir": "../"
+    },
+    "include": [
+        "../src/**/*.ts",
+        "../src/**/*.tsx"
+    ],
+    "exclude": [
+        "../src/**/__tests__/*",
+        "../src/**/*.test.*",
+        "../src/**/test.*",
+        "../src/**/examples.*"
+    ],
+    "references": [
+        {
+            "path": "../../editor-common/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../editor-plugin-analytics/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
+        }
+    ]
+}

package/build/tsconfig.json

@@ -0,0 +1,17 @@
+{
+	"extends": "../tsconfig",
+	"compilerOptions": {
+		"target": "es5",
+		"paths": {}
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	]
+}

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "userPreferencesPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _userPreferencesPlugin.userPreferencesPlugin;
+  }
+});
+var _userPreferencesPlugin = require("./userPreferencesPlugin");

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

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateToolbarDockingPosition = 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 key = _ref.key,
+    value = _ref.value,
+    userPreferencesProvider = _ref.userPreferencesProvider,
+    editorAnalyticsApi = _ref.editorAnalyticsApi;
+  return function (_ref2) {
+    var tr = _ref2.tr;
+    try {
+      userPreferencesProvider.updatePreference(key, value);
+    } catch (error) {
+      (0, _monitoring.logException)(error, {
+        location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+      });
+    }
+    tr.setMeta(_main.userPreferencesPluginKey, {
+      preferences: (0, _defineProperty2.default)({}, key, value)
+    });
+    if (key === 'toolbarDockingPosition') {
+      editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent({
+        action: _analytics.ACTION.UPDATED,
+        actionSubject: _analytics.ACTION_SUBJECT.USER_PREFERENCES,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+        attributes: {
+          toolbarDocking: value
+        },
+        eventType: _analytics.EVENT_TYPE.TRACK
+      })(tr);
+    }
+    return tr;
+  };
+};

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

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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");
+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;
+  return new _safePlugin.SafePlugin({
+    key: userPreferencesPluginKey,
+    state: {
+      init: function init() {
+        return {
+          preferences: userPreferencesProvider.getPreferences()
+        };
+      },
+      apply: function apply(tr, currentPluginState) {
+        var meta = tr.getMeta(userPreferencesPluginKey);
+        if (meta !== null && meta !== void 0 && meta.preferences) {
+          return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+            preferences: _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences)
+          });
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/cjs/userPreferencesPlugin.js

@@ -0,0 +1,118 @@
+"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 userPreferencesPlugin = exports.userPreferencesPlugin = function userPreferencesPlugin(_ref) {
+  var config = _ref.config,
+    api = _ref.api;
+  var userPreferencesProvider = config.userPreferencesProvider;
+  return {
+    name: 'userPreferences',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'userPreferencesPlugin',
+        plugin: function plugin() {
+          return (0, _main.createPlugin)(config, api);
+        }
+      }];
+    },
+    actions: {
+      updateUserPreference: function updateUserPreference(key, value) {
+        var _api$analytics;
+        return (0, _commands.updateToolbarDockingPosition)({
+          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) {
+      if (!editorState) {
+        return null;
+      }
+      return _main.userPreferencesPluginKey.getState(editorState);
+    },
+    usePluginHook: function usePluginHook(_ref2) {
+      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
+          });
+        }
+      }, []);
+    }
+  };
+};

package/dist/cjs/userPreferencesPluginType.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/es2019/index.js

@@ -0,0 +1,3 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+export { userPreferencesPlugin } from './userPreferencesPlugin';

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

@@ -0,0 +1,36 @@
+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 = ({
+  key,
+  value,
+  userPreferencesProvider,
+  editorAnalyticsApi
+}) => ({
+  tr
+}) => {
+  try {
+    userPreferencesProvider.updatePreference(key, value);
+  } catch (error) {
+    logException(error, {
+      location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+    });
+  }
+  tr.setMeta(userPreferencesPluginKey, {
+    preferences: {
+      [key]: value
+    }
+  });
+  if (key === 'toolbarDockingPosition') {
+    editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent({
+      action: ACTION.UPDATED,
+      actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
+      actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+      attributes: {
+        toolbarDocking: value
+      },
+      eventType: EVENT_TYPE.TRACK
+    })(tr);
+  }
+  return tr;
+};

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

@@ -0,0 +1,31 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
+export const createPlugin = (pluginOptions, _api) => {
+  const {
+    userPreferencesProvider
+  } = pluginOptions;
+  return new SafePlugin({
+    key: userPreferencesPluginKey,
+    state: {
+      init() {
+        return {
+          preferences: userPreferencesProvider.getPreferences()
+        };
+      },
+      apply: (tr, currentPluginState) => {
+        const meta = tr.getMeta(userPreferencesPluginKey);
+        if (meta !== null && meta !== void 0 && meta.preferences) {
+          return {
+            ...currentPluginState,
+            preferences: {
+              ...currentPluginState.preferences,
+              ...meta.preferences
+            }
+          };
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/es2019/userPreferencesPlugin.js

@@ -0,0 +1,94 @@
+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 { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
+export const userPreferencesPlugin = ({
+  config,
+  api
+}) => {
+  const {
+    userPreferencesProvider
+  } = config;
+  return {
+    name: 'userPreferences',
+    pmPlugins() {
+      return [{
+        name: 'userPreferencesPlugin',
+        plugin: () => {
+          return createPlugin(config, api);
+        }
+      }];
+    },
+    actions: {
+      updateUserPreference: (key, value) => {
+        var _api$analytics;
+        return updateToolbarDockingPosition({
+          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) {
+      if (!editorState) {
+        return null;
+      }
+      return userPreferencesPluginKey.getState(editorState);
+    },
+    usePluginHook({
+      editorView
+    }) {
+      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
+          });
+        }
+      }, []);
+    }
+  };
+};

package/dist/es2019/userPreferencesPluginType.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+export { userPreferencesPlugin } from './userPreferencesPlugin';

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

@@ -0,0 +1,35 @@
+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) {
+  var key = _ref.key,
+    value = _ref.value,
+    userPreferencesProvider = _ref.userPreferencesProvider,
+    editorAnalyticsApi = _ref.editorAnalyticsApi;
+  return function (_ref2) {
+    var tr = _ref2.tr;
+    try {
+      userPreferencesProvider.updatePreference(key, value);
+    } catch (error) {
+      logException(error, {
+        location: 'editor-plugin-user-preferences/userPreferencesPlugin'
+      });
+    }
+    tr.setMeta(userPreferencesPluginKey, {
+      preferences: _defineProperty({}, key, value)
+    });
+    if (key === 'toolbarDockingPosition') {
+      editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent({
+        action: ACTION.UPDATED,
+        actionSubject: ACTION_SUBJECT.USER_PREFERENCES,
+        actionSubjectId: ACTION_SUBJECT_ID.SELECTION_TOOLBAR_PREFERENCES,
+        attributes: {
+          toolbarDocking: value
+        },
+        eventType: EVENT_TYPE.TRACK
+      })(tr);
+    }
+    return tr;
+  };
+};

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

@@ -0,0 +1,28 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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) { _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';
+export var userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
+export var createPlugin = function createPlugin(pluginOptions, _api) {
+  var userPreferencesProvider = pluginOptions.userPreferencesProvider;
+  return new SafePlugin({
+    key: userPreferencesPluginKey,
+    state: {
+      init: function init() {
+        return {
+          preferences: userPreferencesProvider.getPreferences()
+        };
+      },
+      apply: function apply(tr, currentPluginState) {
+        var meta = tr.getMeta(userPreferencesPluginKey);
+        if (meta !== null && meta !== void 0 && meta.preferences) {
+          return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+            preferences: _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences)
+          });
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/esm/userPreferencesPlugin.js

@@ -0,0 +1,111 @@
+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 { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
+export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
+  var config = _ref.config,
+    api = _ref.api;
+  var userPreferencesProvider = config.userPreferencesProvider;
+  return {
+    name: 'userPreferences',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'userPreferencesPlugin',
+        plugin: function plugin() {
+          return createPlugin(config, api);
+        }
+      }];
+    },
+    actions: {
+      updateUserPreference: function updateUserPreference(key, value) {
+        var _api$analytics;
+        return updateToolbarDockingPosition({
+          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) {
+      if (!editorState) {
+        return null;
+      }
+      return userPreferencesPluginKey.getState(editorState);
+    },
+    usePluginHook: function usePluginHook(_ref2) {
+      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
+          });
+        }
+      }, []);
+    }
+  };
+};

package/dist/esm/userPreferencesPluginType.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

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

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

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

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

@@ -0,0 +1,11 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { Config, 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 {};

package/dist/types/userPreferencesPlugin.d.ts

@@ -0,0 +1,2 @@
+import type { UserPreferencesPlugin } from './userPreferencesPluginType';
+export declare const userPreferencesPlugin: UserPreferencesPlugin;

package/dist/types/userPreferencesPluginType.d.ts

@@ -0,0 +1,20 @@
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences, UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+export type Config = {
+    userPreferencesProvider: UserPreferencesProvider;
+};
+export type PrefKey = keyof UserPreferences;
+export type ResolvedPrefKey = keyof ResolvedUserPreferences;
+export type UserPreferencesSharedState = {
+    preferences: ResolvedUserPreferences;
+};
+export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
+    pluginConfiguration: Config;
+    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

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

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

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

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

@@ -0,0 +1,11 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { Config, 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 {};

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

@@ -0,0 +1,2 @@
+import type { UserPreferencesPlugin } from './userPreferencesPluginType';
+export declare const userPreferencesPlugin: UserPreferencesPlugin;

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

@@ -0,0 +1,22 @@
+import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import { ResolvedUserPreferences, UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+export type Config = {
+    userPreferencesProvider: UserPreferencesProvider;
+};
+export type PrefKey = keyof UserPreferences;
+export type ResolvedPrefKey = keyof ResolvedUserPreferences;
+export type UserPreferencesSharedState = {
+    preferences: ResolvedUserPreferences;
+};
+export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
+    pluginConfiguration: Config;
+    actions: {
+        updateUserPreference: (key: PrefKey, value: ResolvedUserPreferences[PrefKey]) => EditorCommand;
+        setDefaultPreferences: (preferences: ResolvedUserPreferences) => void;
+    };
+    sharedState: UserPreferencesSharedState;
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>
+    ];
+}>;

package/docs/0-intro.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin User Preferences', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}
+
+  This package includes the user preferences plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:
+
+${code`
+type UserPreferencesPlugin = NextEditorPlugin<'userPreferences'>
+`}
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+`;

package/package.json

@@ -0,0 +1,89 @@
+{
+	"name": "@atlaskit/editor-plugin-user-preferences",
+	"version": "0.1.0",
+	"description": "UserPreferences plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Lego",
+		"releaseModel": "continuous",
+		"singleton": true,
+		"runReact18": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/editor-common": "^105.2.0",
+		"@atlaskit/editor-plugin-analytics": "^2.3.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@babel/runtime": "^7.0.0",
+		"bind-event-listener": "^3.0.0"
+	},
+	"peerDependencies": {
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"editor-plugin"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": "no-deprecated-imports",
+			"styling": [
+				"emotion",
+				"emotion"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	},
+	"platform-feature-flags": {
+		"platform_editor_use_preferences_plugin": {
+			"type": "boolean"
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../../../tsconfig.json",
+	"include": [
+		"src/**/*.ts",
+		"src/**/*.tsx"
+	],
+	"compilerOptions": {}
+}