@atlaskit/editor-plugin-user-preferences 8.0.12 → 8.1.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-user-preferences
 
+## 8.1.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 8.1.0
+
+### Minor Changes
+
+- [`20c2faf5c3ca8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/20c2faf5c3ca8) -
+  CONFCLOUD-84107 add override for user preference
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.0.12
 
 ### Patch Changes

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

@@ -4,18 +4,45 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateUserPreference = void 0;
+exports.updateUserPreference = exports.overrideUserPreference = exports.clearOverrideUserPreference = 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 updateUserPreference = exports.updateUserPreference = function updateUserPreference(_ref) {
+var overrideUserPreference = exports.overrideUserPreference = function overrideUserPreference(_ref) {
   var key = _ref.key,
-    value = _ref.value,
-    userPreferencesProvider = _ref.userPreferencesProvider,
-    editorAnalyticsApi = _ref.editorAnalyticsApi;
+    value = _ref.value;
   return function (_ref2) {
     var tr = _ref2.tr;
+    tr.setMeta(_main.userPreferencesPluginKey, {
+      override: {
+        key: key,
+        value: value
+      }
+    });
+    return tr;
+  };
+};
+var clearOverrideUserPreference = exports.clearOverrideUserPreference = function clearOverrideUserPreference(_ref3) {
+  var key = _ref3.key;
+  return function (_ref4) {
+    var tr = _ref4.tr;
+    tr.setMeta(_main.userPreferencesPluginKey, {
+      override: {
+        key: key,
+        value: null
+      }
+    });
+    return tr;
+  };
+};
+var updateUserPreference = exports.updateUserPreference = function updateUserPreference(_ref5) {
+  var key = _ref5.key,
+    value = _ref5.value,
+    userPreferencesProvider = _ref5.userPreferencesProvider,
+    editorAnalyticsApi = _ref5.editorAnalyticsApi;
+  return function (_ref6) {
+    var tr = _ref6.tr;
     try {
       userPreferencesProvider === null || userPreferencesProvider === void 0 || userPreferencesProvider.updatePreference(key, value);
     } catch (error) {

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

@@ -1,16 +1,38 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.userPreferencesPluginKey = exports.createPlugin = void 0;
+exports.userPreferencesPluginKey = exports.createPlugin = exports.applyOverride = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 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; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof3(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != (0, _typeof2.default)(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != (0, _typeof2.default)(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Given the current overrides and an override action `{ key, value }`, returns
+ * the new overrides object:
+ * - If `value` is `null` or `undefined`, the key is removed from overrides.
+ * - Otherwise, the key is set to `value` in overrides.
+ */
+var applyOverride = exports.applyOverride = function applyOverride(currentOverrides, override) {
+  var key = override.key,
+    value = override.value;
+  if (value === null || value === undefined) {
+    var _ = currentOverrides[key],
+      rest = (0, _objectWithoutProperties2.default)(currentOverrides, [key].map(_toPropertyKey));
+    return rest;
+  }
+  return _objectSpread(_objectSpread({}, currentOverrides), {}, (0, _defineProperty2.default)({}, key, value));
+};
 var userPreferencesPluginKey = exports.userPreferencesPluginKey = new _state.PluginKey('userPreferencesPlugin');
 var createPlugin = exports.createPlugin = function createPlugin(pluginOptions, _api) {
   var userPreferencesProvider = pluginOptions.userPreferencesProvider,
@@ -23,16 +45,31 @@ var createPlugin = exports.createPlugin = function createPlugin(pluginOptions, _
       toolbarDockingPosition: 'top'
     };
   };
+  var isUserPreferenceOverrideEnabled = (0, _expValEquals.expValEquals)('platform_editor_user_preference_override', 'isEnabled', true);
   return new _safePlugin.SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init: function init() {
         return {
-          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences(),
+          overrides: {}
         };
       },
       apply: function apply(tr, currentPluginState) {
         var meta = tr.getMeta(userPreferencesPluginKey);
+        if (isUserPreferenceOverrideEnabled) {
+          if (!meta || !meta.preferences && !meta.override) {
+            return currentPluginState;
+          }
+          var nextState = _objectSpread({}, currentPluginState);
+          if (meta.preferences) {
+            nextState.preferences = _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences);
+          }
+          if (meta.override) {
+            nextState.overrides = applyOverride(currentPluginState.overrides, meta.override);
+          }
+          return nextState;
+        }
         if (meta !== null && meta !== void 0 && meta.preferences) {
           return _objectSpread(_objectSpread({}, currentPluginState), {}, {
             preferences: _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences)

package/dist/cjs/userPreferencesPlugin.js

@@ -1,15 +1,20 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.userPreferencesPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _userPreferences = require("@atlaskit/editor-common/user-preferences");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 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");
+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 userPreferencesPlugin = exports.userPreferencesPlugin = function userPreferencesPlugin(_ref) {
   var config = _ref.config,
     api = _ref.api;
@@ -41,10 +46,36 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
         return userPreferencesProvider.getPreferences();
       }
     },
+    commands: {
+      overrideUserPreference: function overrideUserPreference(key, value) {
+        return (0, _commands.overrideUserPreference)({
+          key: key,
+          value: value
+        });
+      },
+      clearOverrideUserPreference: function clearOverrideUserPreference(key) {
+        return (0, _commands.clearOverrideUserPreference)({
+          key: key
+        });
+      }
+    },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {
         return null;
       }
+      if ((0, _expValEquals.expValEquals)('platform_editor_user_preference_override', 'isEnabled', true)) {
+        var state = _main.userPreferencesPluginKey.getState(editorState);
+
+        // state can return undefined if the plugin hasn't been registered
+        if (!state) {
+          return null;
+        } else if (!state.overrides || Object.keys(state.overrides).length === 0) {
+          return state;
+        }
+        return _objectSpread(_objectSpread({}, state), {}, {
+          preferences: _objectSpread(_objectSpread({}, state.preferences), state.overrides)
+        });
+      }
       return _main.userPreferencesPluginKey.getState(editorState);
     },
     usePluginHook: function usePluginHook(_ref2) {

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

@@ -1,6 +1,33 @@
 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 overrideUserPreference = ({
+  key,
+  value
+}) => ({
+  tr
+}) => {
+  tr.setMeta(userPreferencesPluginKey, {
+    override: {
+      key,
+      value
+    }
+  });
+  return tr;
+};
+export const clearOverrideUserPreference = ({
+  key
+}) => ({
+  tr
+}) => {
+  tr.setMeta(userPreferencesPluginKey, {
+    override: {
+      key,
+      value: null
+    }
+  });
+  return tr;
+};
 export const updateUserPreference = ({
   key,
   value,

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

@@ -1,6 +1,30 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+/**
+ * Given the current overrides and an override action `{ key, value }`, returns
+ * the new overrides object:
+ * - If `value` is `null` or `undefined`, the key is removed from overrides.
+ * - Otherwise, the key is set to `value` in overrides.
+ */
+export const applyOverride = (currentOverrides, override) => {
+  const {
+    key,
+    value
+  } = override;
+  if (value === null || value === undefined) {
+    const {
+      [key]: _,
+      ...rest
+    } = currentOverrides;
+    return rest;
+  }
+  return {
+    ...currentOverrides,
+    [key]: value
+  };
+};
 export const userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
 export const createPlugin = (pluginOptions, _api) => {
   const {
@@ -15,16 +39,36 @@ export const createPlugin = (pluginOptions, _api) => {
       toolbarDockingPosition: 'top'
     };
   };
+  const isUserPreferenceOverrideEnabled = expValEquals('platform_editor_user_preference_override', 'isEnabled', true);
   return new SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init() {
         return {
-          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences(),
+          overrides: {}
         };
       },
       apply: (tr, currentPluginState) => {
         const meta = tr.getMeta(userPreferencesPluginKey);
+        if (isUserPreferenceOverrideEnabled) {
+          if (!meta || !meta.preferences && !meta.override) {
+            return currentPluginState;
+          }
+          const nextState = {
+            ...currentPluginState
+          };
+          if (meta.preferences) {
+            nextState.preferences = {
+              ...currentPluginState.preferences,
+              ...meta.preferences
+            };
+          }
+          if (meta.override) {
+            nextState.overrides = applyOverride(currentPluginState.overrides, meta.override);
+          }
+          return nextState;
+        }
         if (meta !== null && meta !== void 0 && meta.preferences) {
           return {
             ...currentPluginState,

package/dist/es2019/userPreferencesPlugin.js

@@ -1,5 +1,6 @@
 import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { updateUserPreference } from './pm-plugins/commands';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { clearOverrideUserPreference, overrideUserPreference, updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
 import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
 import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
@@ -36,10 +37,40 @@ export const userPreferencesPlugin = ({
         return userPreferencesProvider.getPreferences();
       }
     },
+    commands: {
+      overrideUserPreference: (key, value) => {
+        return overrideUserPreference({
+          key,
+          value
+        });
+      },
+      clearOverrideUserPreference: key => {
+        return clearOverrideUserPreference({
+          key
+        });
+      }
+    },
     getSharedState(editorState) {
       if (!editorState) {
         return null;
       }
+      if (expValEquals('platform_editor_user_preference_override', 'isEnabled', true)) {
+        const state = userPreferencesPluginKey.getState(editorState);
+
+        // state can return undefined if the plugin hasn't been registered
+        if (!state) {
+          return null;
+        } else if (!state.overrides || Object.keys(state.overrides).length === 0) {
+          return state;
+        }
+        return {
+          ...state,
+          preferences: {
+            ...state.preferences,
+            ...state.overrides
+          }
+        };
+      }
       return userPreferencesPluginKey.getState(editorState);
     },
     usePluginHook({

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

@@ -2,13 +2,40 @@ 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 updateUserPreference = function updateUserPreference(_ref) {
+export var overrideUserPreference = function overrideUserPreference(_ref) {
   var key = _ref.key,
-    value = _ref.value,
-    userPreferencesProvider = _ref.userPreferencesProvider,
-    editorAnalyticsApi = _ref.editorAnalyticsApi;
+    value = _ref.value;
   return function (_ref2) {
     var tr = _ref2.tr;
+    tr.setMeta(userPreferencesPluginKey, {
+      override: {
+        key: key,
+        value: value
+      }
+    });
+    return tr;
+  };
+};
+export var clearOverrideUserPreference = function clearOverrideUserPreference(_ref3) {
+  var key = _ref3.key;
+  return function (_ref4) {
+    var tr = _ref4.tr;
+    tr.setMeta(userPreferencesPluginKey, {
+      override: {
+        key: key,
+        value: null
+      }
+    });
+    return tr;
+  };
+};
+export var updateUserPreference = function updateUserPreference(_ref5) {
+  var key = _ref5.key,
+    value = _ref5.value,
+    userPreferencesProvider = _ref5.userPreferencesProvider,
+    editorAnalyticsApi = _ref5.editorAnalyticsApi;
+  return function (_ref6) {
+    var tr = _ref6.tr;
     try {
       userPreferencesProvider === null || userPreferencesProvider === void 0 || userPreferencesProvider.updatePreference(key, value);
     } catch (error) {

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

@@ -1,9 +1,30 @@
+import _typeof from "@babel/runtime/helpers/typeof";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 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; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+/**
+ * Given the current overrides and an override action `{ key, value }`, returns
+ * the new overrides object:
+ * - If `value` is `null` or `undefined`, the key is removed from overrides.
+ * - Otherwise, the key is set to `value` in overrides.
+ */
+export var applyOverride = function applyOverride(currentOverrides, override) {
+  var key = override.key,
+    value = override.value;
+  if (value === null || value === undefined) {
+    var _ = currentOverrides[key],
+      rest = _objectWithoutProperties(currentOverrides, [key].map(_toPropertyKey));
+    return rest;
+  }
+  return _objectSpread(_objectSpread({}, currentOverrides), {}, _defineProperty({}, key, value));
+};
 export var userPreferencesPluginKey = new PluginKey('userPreferencesPlugin');
 export var createPlugin = function createPlugin(pluginOptions, _api) {
   var userPreferencesProvider = pluginOptions.userPreferencesProvider,
@@ -16,16 +37,31 @@ export var createPlugin = function createPlugin(pluginOptions, _api) {
       toolbarDockingPosition: 'top'
     };
   };
+  var isUserPreferenceOverrideEnabled = expValEquals('platform_editor_user_preference_override', 'isEnabled', true);
   return new SafePlugin({
     key: userPreferencesPluginKey,
     state: {
       init: function init() {
         return {
-          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences()
+          preferences: (userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || getInitialUserPreferences(),
+          overrides: {}
         };
       },
       apply: function apply(tr, currentPluginState) {
         var meta = tr.getMeta(userPreferencesPluginKey);
+        if (isUserPreferenceOverrideEnabled) {
+          if (!meta || !meta.preferences && !meta.override) {
+            return currentPluginState;
+          }
+          var nextState = _objectSpread({}, currentPluginState);
+          if (meta.preferences) {
+            nextState.preferences = _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences);
+          }
+          if (meta.override) {
+            nextState.overrides = applyOverride(currentPluginState.overrides, meta.override);
+          }
+          return nextState;
+        }
         if (meta !== null && meta !== void 0 && meta.preferences) {
           return _objectSpread(_objectSpread({}, currentPluginState), {}, {
             preferences: _objectSpread(_objectSpread({}, currentPluginState.preferences), meta.preferences)

package/dist/esm/userPreferencesPlugin.js

@@ -1,5 +1,9 @@
+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 { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { clearOverrideUserPreference as _clearOverrideUserPreference, overrideUserPreference as _overrideUserPreference, updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
 import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
 import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
@@ -35,10 +39,36 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
         return userPreferencesProvider.getPreferences();
       }
     },
+    commands: {
+      overrideUserPreference: function overrideUserPreference(key, value) {
+        return _overrideUserPreference({
+          key: key,
+          value: value
+        });
+      },
+      clearOverrideUserPreference: function clearOverrideUserPreference(key) {
+        return _clearOverrideUserPreference({
+          key: key
+        });
+      }
+    },
     getSharedState: function getSharedState(editorState) {
       if (!editorState) {
         return null;
       }
+      if (expValEquals('platform_editor_user_preference_override', 'isEnabled', true)) {
+        var state = userPreferencesPluginKey.getState(editorState);
+
+        // state can return undefined if the plugin hasn't been registered
+        if (!state) {
+          return null;
+        } else if (!state.overrides || Object.keys(state.overrides).length === 0) {
+          return state;
+        }
+        return _objectSpread(_objectSpread({}, state), {}, {
+          preferences: _objectSpread(_objectSpread({}, state.preferences), state.overrides)
+        });
+      }
       return userPreferencesPluginKey.getState(editorState);
     },
     usePluginHook: function usePluginHook(_ref2) {

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

@@ -1,6 +1,13 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { ResolvedUserPreferences, UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const overrideUserPreference: ({ key, value, }: {
+    key: keyof ResolvedUserPreferences;
+    value: ResolvedUserPreferences[typeof key];
+}) => EditorCommand;
+export declare const clearOverrideUserPreference: ({ key }: {
+    key: keyof ResolvedUserPreferences;
+}) => EditorCommand;
 export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
     editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
     key: keyof UserPreferences;

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

@@ -3,8 +3,19 @@ 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 { UserPreferencesPluginOptions, UserPreferencesPlugin } from '../userPreferencesPluginType';
+/**
+ * Given the current overrides and an override action `{ key, value }`, returns
+ * the new overrides object:
+ * - If `value` is `null` or `undefined`, the key is removed from overrides.
+ * - Otherwise, the key is set to `value` in overrides.
+ */
+export declare const applyOverride: (currentOverrides: Partial<ResolvedUserPreferences>, override: {
+    key: keyof ResolvedUserPreferences;
+    value: ResolvedUserPreferences[keyof ResolvedUserPreferences] | null | undefined;
+}) => Partial<ResolvedUserPreferences>;
 export declare const userPreferencesPluginKey: PluginKey;
 type UserPreferencesPluginState = {
+    overrides: Partial<ResolvedUserPreferences>;
     preferences: ResolvedUserPreferences;
 };
 export declare const createPlugin: (pluginOptions: UserPreferencesPluginOptions, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;

package/dist/types/userPreferencesPluginType.d.ts

@@ -16,6 +16,7 @@ export type UserPreferencesPluginOptions = {
 export type PrefKey = keyof UserPreferences;
 export type ResolvedPrefKey = keyof ResolvedUserPreferences;
 export type UserPreferencesSharedState = {
+    overrides: Partial<ResolvedUserPreferences>;
     preferences: ResolvedUserPreferences;
 };
 export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
@@ -23,6 +24,10 @@ export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
         getUserPreferences: () => ResolvedUserPreferences | undefined;
         updateUserPreference: (key: PrefKey, value: ResolvedUserPreferences[PrefKey]) => EditorCommand;
     };
+    commands: {
+        clearOverrideUserPreference: (key: ResolvedPrefKey) => EditorCommand;
+        overrideUserPreference: (key: ResolvedPrefKey, value: ResolvedUserPreferences[ResolvedPrefKey]) => EditorCommand;
+    };
     dependencies: [OptionalPlugin<AnalyticsPlugin>];
     pluginConfiguration: UserPreferencesPluginOptions;
     sharedState: UserPreferencesSharedState;

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

@@ -1,6 +1,13 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { ResolvedUserPreferences, UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+export declare const overrideUserPreference: ({ key, value, }: {
+    key: keyof ResolvedUserPreferences;
+    value: ResolvedUserPreferences[typeof key];
+}) => EditorCommand;
+export declare const clearOverrideUserPreference: ({ key }: {
+    key: keyof ResolvedUserPreferences;
+}) => EditorCommand;
 export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
     editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
     key: keyof UserPreferences;

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

@@ -3,8 +3,19 @@ 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 { UserPreferencesPluginOptions, UserPreferencesPlugin } from '../userPreferencesPluginType';
+/**
+ * Given the current overrides and an override action `{ key, value }`, returns
+ * the new overrides object:
+ * - If `value` is `null` or `undefined`, the key is removed from overrides.
+ * - Otherwise, the key is set to `value` in overrides.
+ */
+export declare const applyOverride: (currentOverrides: Partial<ResolvedUserPreferences>, override: {
+    key: keyof ResolvedUserPreferences;
+    value: ResolvedUserPreferences[keyof ResolvedUserPreferences] | null | undefined;
+}) => Partial<ResolvedUserPreferences>;
 export declare const userPreferencesPluginKey: PluginKey;
 type UserPreferencesPluginState = {
+    overrides: Partial<ResolvedUserPreferences>;
     preferences: ResolvedUserPreferences;
 };
 export declare const createPlugin: (pluginOptions: UserPreferencesPluginOptions, _api: ExtractInjectionAPI<UserPreferencesPlugin> | undefined) => SafePlugin<UserPreferencesPluginState>;

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

@@ -16,6 +16,7 @@ export type UserPreferencesPluginOptions = {
 export type PrefKey = keyof UserPreferences;
 export type ResolvedPrefKey = keyof ResolvedUserPreferences;
 export type UserPreferencesSharedState = {
+    overrides: Partial<ResolvedUserPreferences>;
     preferences: ResolvedUserPreferences;
 };
 export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
@@ -23,6 +24,10 @@ export type UserPreferencesPlugin = NextEditorPlugin<'userPreferences', {
         getUserPreferences: () => ResolvedUserPreferences | undefined;
         updateUserPreference: (key: PrefKey, value: ResolvedUserPreferences[PrefKey]) => EditorCommand;
     };
+    commands: {
+        clearOverrideUserPreference: (key: ResolvedPrefKey) => EditorCommand;
+        overrideUserPreference: (key: ResolvedPrefKey, value: ResolvedUserPreferences[ResolvedPrefKey]) => EditorCommand;
+    };
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>
     ];

package/editor-plugin-user-preferences.docs.tsx

@@ -5,7 +5,6 @@
 
 import path from 'path';
 
-
 import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
 
 import packageJson from './package.json';
@@ -30,7 +29,11 @@ const documentation: ComponentStructuredContentSource[] = [
 		keywords: ['editor', 'editor-plugin-user-preferences', 'atlaskit'],
 		categories: ['editor'],
 		examples: [
-			{ name: 'Basic', description: 'User preferences plugin usage.', source: path.resolve(packagePath, './examples/1-basic.tsx') },
+			{
+				name: 'Basic',
+				description: 'User preferences plugin usage.',
+				source: path.resolve(packagePath, './examples/1-basic.tsx'),
+			},
 		],
 	},
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-user-preferences",
-	"version": "8.0.12",
+	"version": "8.1.1",
 	"description": "UserPreferences plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,12 +30,12 @@
 	"dependencies": {
 		"@atlaskit/editor-plugin-analytics": "^10.0.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
-		"@atlaskit/tmp-editor-statsig": "^74.0.0",
+		"@atlaskit/tmp-editor-statsig": "^75.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.15.0",
+		"@atlaskit/editor-common": "^114.19.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {