@atlaskit/editor-common 105.1.0 → 105.2.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-common
 
+## 105.2.0
+
+### Minor Changes
+
+- [#153475](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/153475)
+  [`b9a03a01ca8da`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b9a03a01ca8da) -
+  EDITOR-737: Add word count attribute to define button analytics.
+- [#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
+
 ## 105.1.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "105.1.0";
+var packageVersion = "105.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "105.1.0";
+var packageVersion = "105.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/cjs/user-preferences/hooks.js

@@ -0,0 +1,23 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useResolvedUserPreferences = useResolvedUserPreferences;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+function useResolvedUserPreferences(userPreferencesProvider) {
+  var _useState = (0, _react.useState)(userPreferencesProvider.getPreferences()),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    resolvedUserPreferences = _useState2[0],
+    setResolvedUserPreferences = _useState2[1];
+  (0, _react.useEffect)(function () {
+    return userPreferencesProvider.onUpdate(function () {
+      setResolvedUserPreferences(userPreferencesProvider.getPreferences());
+    });
+  }, [userPreferencesProvider]);
+  return {
+    resolvedUserPreferences: resolvedUserPreferences
+  };
+}

package/dist/cjs/user-preferences/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "TOOLBAR_DOCKING_POSITIONS", {
+  enumerable: true,
+  get: function get() {
+    return _userPreferences.TOOLBAR_DOCKING_POSITIONS;
+  }
+});
+Object.defineProperty(exports, "UserPreferencesProvider", {
+  enumerable: true,
+  get: function get() {
+    return _userPreferencesProvider.UserPreferencesProvider;
+  }
+});
+Object.defineProperty(exports, "useResolvedUserPreferences", {
+  enumerable: true,
+  get: function get() {
+    return _hooks.useResolvedUserPreferences;
+  }
+});
+var _userPreferencesProvider = require("./user-preferences-provider");
+var _userPreferences = require("./user-preferences");
+var _hooks = require("./hooks");

package/dist/cjs/user-preferences/persistence-api.js

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

package/dist/cjs/user-preferences/user-preferences-provider.js

@@ -0,0 +1,215 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UserPreferencesProvider = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@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) { (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 UserPreferencesProvider = exports.UserPreferencesProvider = /*#__PURE__*/function () {
+  /**
+   * @param persistenceAPI - The persistence API to use for loading and updating user preferences
+   * @param defaultPreferences - The default user preferences to use
+   * @param initialUserPreferences - The initial user preferences to use (optional)
+   */
+  function UserPreferencesProvider(persistenceAPI, defaultPreferences) {
+    var _this$persistenceAPI$, _this$persistenceAPI;
+    (0, _classCallCheck2.default)(this, UserPreferencesProvider);
+    (0, _defineProperty2.default)(this, "callbacks", []);
+    (0, _defineProperty2.default)(this, "userPreferences", {});
+    (0, _defineProperty2.default)(this, "initialized", false);
+    this.persistenceAPI = persistenceAPI;
+    this.defaultPreferences = defaultPreferences;
+    this.resolvedUserPreferences = defaultPreferences;
+    var initialUserPreferences = (_this$persistenceAPI$ = (_this$persistenceAPI = this.persistenceAPI).getInitialUserPreferences) === null || _this$persistenceAPI$ === void 0 ? void 0 : _this$persistenceAPI$.call(_this$persistenceAPI);
+    if (initialUserPreferences) {
+      this.setUserPreferences(initialUserPreferences);
+    } else {
+      this.loadPreferences();
+    }
+  }
+  return (0, _createClass2.default)(UserPreferencesProvider, [{
+    key: "isInitialized",
+    get: function get() {
+      return this.initialized;
+    }
+
+    /**
+     * This method fetches the latest user preferences
+     * @returns a promise that resolves with the user preferences, or rejects if error occurs
+     * @throws Error if there is an error loading user preferences
+     */
+  }, {
+    key: "loadPreferences",
+    value: (function () {
+      var _loadPreferences = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var userPreferences;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return this.persistenceAPI.loadUserPreferences();
+            case 2:
+              userPreferences = _context.sent;
+              this.setUserPreferences(userPreferences);
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function loadPreferences() {
+        return _loadPreferences.apply(this, arguments);
+      }
+      return loadPreferences;
+    }()
+    /**
+     * This method updates a user preference
+     * @param key
+     * @param value
+     * @returns a promise that resolves when the user preference is updated
+     * @throws Error if there is an error updating user preferences
+     */
+    )
+  }, {
+    key: "updatePreference",
+    value: (function () {
+      var _updatePreference = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(key, value) {
+        var userPreferences;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return this.persistenceAPI.updateUserPreference(key, value);
+            case 2:
+              userPreferences = _context2.sent;
+              this.setUserPreferences(userPreferences);
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this);
+      }));
+      function updatePreference(_x, _x2) {
+        return _updatePreference.apply(this, arguments);
+      }
+      return updatePreference;
+    }()
+    /**
+     * get a user preference, Note that this function is a not async function,
+     * meaning that consumers should prefetch the user preference and make it available initially
+     * @param key
+     */
+    )
+  }, {
+    key: "getPreference",
+    value: function getPreference(key) {
+      return this.resolvedUserPreferences[key];
+    }
+
+    /**
+     * get all user preferences
+     */
+  }, {
+    key: "getPreferences",
+    value: function getPreferences() {
+      return this.resolvedUserPreferences;
+    }
+
+    /**
+     * This method fetches the latest user preferences
+     * @returns a function to unsubscribe from the updates
+     */
+  }, {
+    key: "onUpdate",
+    value: function onUpdate(_onUpdate) {
+      var _this = this;
+      this.callbacks.push(_onUpdate);
+
+      // Return the cleanup function to unsubscribe from the updates
+      return function () {
+        _this.callbacks = _this.callbacks.filter(function (callback) {
+          return callback !== _onUpdate;
+        });
+      };
+    }
+
+    /**
+     * This method is used to set the default user preferences,
+     * setting the default user preferences will also trigger an update
+     * This is useful when the default user preferences dynamically based on the context
+     * @param preferences
+     */
+  }, {
+    key: "setDefaultPreferences",
+    value: function setDefaultPreferences(preferences) {
+      this.defaultPreferences = preferences;
+      var hasUpdated = this.resolveUserPreferences();
+      if (hasUpdated) {
+        this.notifyUserPreferencesUpdated();
+      }
+    }
+  }, {
+    key: "setUserPreferences",
+    value: function setUserPreferences(userPreferences) {
+      this.userPreferences = userPreferences;
+      var hasUpdated = this.resolveUserPreferences();
+      if (hasUpdated || !this.initialized) {
+        this.notifyUserPreferencesUpdated();
+      }
+      if (!this.initialized) {
+        this.initialized = true;
+      }
+    }
+  }, {
+    key: "notifyUserPreferencesUpdated",
+    value: function notifyUserPreferencesUpdated() {
+      var _this2 = this;
+      this.callbacks.forEach(function (callback) {
+        callback(_this2.resolvedUserPreferences);
+      });
+    }
+
+    /**
+     * This method resolves the user preferences by merging the default preferences
+     * with the user preferences and filtering out any undefined or null values
+     * to avoid overwriting default preferences with null values
+     * @returns true if the user preferences were updated, false otherwise
+     */
+  }, {
+    key: "resolveUserPreferences",
+    value: function resolveUserPreferences() {
+      var _this3 = this;
+      // Merge default preferences with user preferences
+      // and filter out any undefined or null values
+      // to avoid overwriting default preferences with null values
+      var newResolvedUserPreferences = _objectSpread(_objectSpread({}, this.defaultPreferences), Object.fromEntries(Object.entries(this.userPreferences).filter(function (_ref) {
+        var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+          v = _ref2[1];
+        return v !== undefined && v !== null;
+      })));
+
+      // if the user preferences is NOT initialized, we need to update and notify
+      // the user preferences
+      // if the user preferences is initialized, we need to check if the new user preferences
+      // is different from the old user preferences
+      var needUpdate = Object.entries(newResolvedUserPreferences).some(function (_ref3) {
+        var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+          key = _ref4[0],
+          value = _ref4[1];
+        return value !== _this3.resolvedUserPreferences[key];
+      });
+      if (needUpdate) {
+        this.resolvedUserPreferences = newResolvedUserPreferences;
+      }
+      return needUpdate;
+    }
+  }]);
+}();

package/dist/cjs/user-preferences/user-preferences.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TOOLBAR_DOCKING_POSITIONS = void 0;
+var TOOLBAR_DOCKING_POSITIONS = exports.TOOLBAR_DOCKING_POSITIONS = ['top', 'none'];

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "105.1.0";
+const packageVersion = "105.2.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "105.1.0";
+const packageVersion = "105.2.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/es2019/user-preferences/hooks.js

@@ -0,0 +1,12 @@
+import { useEffect, useState } from 'react';
+export function useResolvedUserPreferences(userPreferencesProvider) {
+  const [resolvedUserPreferences, setResolvedUserPreferences] = useState(userPreferencesProvider.getPreferences());
+  useEffect(() => {
+    return userPreferencesProvider.onUpdate(() => {
+      setResolvedUserPreferences(userPreferencesProvider.getPreferences());
+    });
+  }, [userPreferencesProvider]);
+  return {
+    resolvedUserPreferences
+  };
+}

package/dist/es2019/user-preferences/index.js

@@ -0,0 +1,5 @@
+// Disable no-re-export rule for entry point files
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { UserPreferencesProvider } from './user-preferences-provider';
+export { TOOLBAR_DOCKING_POSITIONS } from './user-preferences';
+export { useResolvedUserPreferences } from './hooks';

package/dist/es2019/user-preferences/persistence-api.js

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

package/dist/es2019/user-preferences/user-preferences-provider.js

@@ -0,0 +1,134 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+export class UserPreferencesProvider {
+  /**
+   * @param persistenceAPI - The persistence API to use for loading and updating user preferences
+   * @param defaultPreferences - The default user preferences to use
+   * @param initialUserPreferences - The initial user preferences to use (optional)
+   */
+  constructor(persistenceAPI, defaultPreferences) {
+    var _this$persistenceAPI$, _this$persistenceAPI;
+    _defineProperty(this, "callbacks", []);
+    _defineProperty(this, "userPreferences", {});
+    _defineProperty(this, "initialized", false);
+    this.persistenceAPI = persistenceAPI;
+    this.defaultPreferences = defaultPreferences;
+    this.resolvedUserPreferences = defaultPreferences;
+    const initialUserPreferences = (_this$persistenceAPI$ = (_this$persistenceAPI = this.persistenceAPI).getInitialUserPreferences) === null || _this$persistenceAPI$ === void 0 ? void 0 : _this$persistenceAPI$.call(_this$persistenceAPI);
+    if (initialUserPreferences) {
+      this.setUserPreferences(initialUserPreferences);
+    } else {
+      this.loadPreferences();
+    }
+  }
+  get isInitialized() {
+    return this.initialized;
+  }
+
+  /**
+   * This method fetches the latest user preferences
+   * @returns a promise that resolves with the user preferences, or rejects if error occurs
+   * @throws Error if there is an error loading user preferences
+   */
+  async loadPreferences() {
+    const userPreferences = await this.persistenceAPI.loadUserPreferences();
+    this.setUserPreferences(userPreferences);
+  }
+
+  /**
+   * This method updates a user preference
+   * @param key
+   * @param value
+   * @returns a promise that resolves when the user preference is updated
+   * @throws Error if there is an error updating user preferences
+   */
+  async updatePreference(key, value) {
+    const userPreferences = await this.persistenceAPI.updateUserPreference(key, value);
+    this.setUserPreferences(userPreferences);
+  }
+
+  /**
+   * get a user preference, Note that this function is a not async function,
+   * meaning that consumers should prefetch the user preference and make it available initially
+   * @param key
+   */
+  getPreference(key) {
+    return this.resolvedUserPreferences[key];
+  }
+
+  /**
+   * get all user preferences
+   */
+  getPreferences() {
+    return this.resolvedUserPreferences;
+  }
+
+  /**
+   * This method fetches the latest user preferences
+   * @returns a function to unsubscribe from the updates
+   */
+  onUpdate(onUpdate) {
+    this.callbacks.push(onUpdate);
+
+    // Return the cleanup function to unsubscribe from the updates
+    return () => {
+      this.callbacks = this.callbacks.filter(callback => callback !== onUpdate);
+    };
+  }
+
+  /**
+   * This method is used to set the default user preferences,
+   * setting the default user preferences will also trigger an update
+   * This is useful when the default user preferences dynamically based on the context
+   * @param preferences
+   */
+  setDefaultPreferences(preferences) {
+    this.defaultPreferences = preferences;
+    const hasUpdated = this.resolveUserPreferences();
+    if (hasUpdated) {
+      this.notifyUserPreferencesUpdated();
+    }
+  }
+  setUserPreferences(userPreferences) {
+    this.userPreferences = userPreferences;
+    const hasUpdated = this.resolveUserPreferences();
+    if (hasUpdated || !this.initialized) {
+      this.notifyUserPreferencesUpdated();
+    }
+    if (!this.initialized) {
+      this.initialized = true;
+    }
+  }
+  notifyUserPreferencesUpdated() {
+    this.callbacks.forEach(callback => {
+      callback(this.resolvedUserPreferences);
+    });
+  }
+
+  /**
+   * This method resolves the user preferences by merging the default preferences
+   * with the user preferences and filtering out any undefined or null values
+   * to avoid overwriting default preferences with null values
+   * @returns true if the user preferences were updated, false otherwise
+   */
+  resolveUserPreferences() {
+    // Merge default preferences with user preferences
+    // and filter out any undefined or null values
+    // to avoid overwriting default preferences with null values
+    const newResolvedUserPreferences = {
+      ...this.defaultPreferences,
+      ...Object.fromEntries(Object.entries(this.userPreferences).filter(([, v]) => v !== undefined && v !== null))
+    };
+
+    // if the user preferences is NOT initialized, we need to update and notify
+    // the user preferences
+    // if the user preferences is initialized, we need to check if the new user preferences
+    // is different from the old user preferences
+    const needUpdate = Object.entries(newResolvedUserPreferences).some(([key, value]) => {
+      return value !== this.resolvedUserPreferences[key];
+    });
+    if (needUpdate) {
+      this.resolvedUserPreferences = newResolvedUserPreferences;
+    }
+    return needUpdate;
+  }
+}

package/dist/es2019/user-preferences/user-preferences.js

@@ -0,0 +1 @@
+export const TOOLBAR_DOCKING_POSITIONS = ['top', 'none'];

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "105.1.0";
+var packageVersion = "105.2.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "105.1.0";
+var packageVersion = "105.2.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/esm/user-preferences/hooks.js

@@ -0,0 +1,16 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useState } from 'react';
+export function useResolvedUserPreferences(userPreferencesProvider) {
+  var _useState = useState(userPreferencesProvider.getPreferences()),
+    _useState2 = _slicedToArray(_useState, 2),
+    resolvedUserPreferences = _useState2[0],
+    setResolvedUserPreferences = _useState2[1];
+  useEffect(function () {
+    return userPreferencesProvider.onUpdate(function () {
+      setResolvedUserPreferences(userPreferencesProvider.getPreferences());
+    });
+  }, [userPreferencesProvider]);
+  return {
+    resolvedUserPreferences: resolvedUserPreferences
+  };
+}

package/dist/esm/user-preferences/index.js

@@ -0,0 +1,5 @@
+// Disable no-re-export rule for entry point files
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { UserPreferencesProvider } from './user-preferences-provider';
+export { TOOLBAR_DOCKING_POSITIONS } from './user-preferences';
+export { useResolvedUserPreferences } from './hooks';

package/dist/esm/user-preferences/persistence-api.js

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

package/dist/esm/user-preferences/user-preferences-provider.js

@@ -0,0 +1,208 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+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 _regeneratorRuntime from "@babel/runtime/regenerator";
+export var UserPreferencesProvider = /*#__PURE__*/function () {
+  /**
+   * @param persistenceAPI - The persistence API to use for loading and updating user preferences
+   * @param defaultPreferences - The default user preferences to use
+   * @param initialUserPreferences - The initial user preferences to use (optional)
+   */
+  function UserPreferencesProvider(persistenceAPI, defaultPreferences) {
+    var _this$persistenceAPI$, _this$persistenceAPI;
+    _classCallCheck(this, UserPreferencesProvider);
+    _defineProperty(this, "callbacks", []);
+    _defineProperty(this, "userPreferences", {});
+    _defineProperty(this, "initialized", false);
+    this.persistenceAPI = persistenceAPI;
+    this.defaultPreferences = defaultPreferences;
+    this.resolvedUserPreferences = defaultPreferences;
+    var initialUserPreferences = (_this$persistenceAPI$ = (_this$persistenceAPI = this.persistenceAPI).getInitialUserPreferences) === null || _this$persistenceAPI$ === void 0 ? void 0 : _this$persistenceAPI$.call(_this$persistenceAPI);
+    if (initialUserPreferences) {
+      this.setUserPreferences(initialUserPreferences);
+    } else {
+      this.loadPreferences();
+    }
+  }
+  return _createClass(UserPreferencesProvider, [{
+    key: "isInitialized",
+    get: function get() {
+      return this.initialized;
+    }
+
+    /**
+     * This method fetches the latest user preferences
+     * @returns a promise that resolves with the user preferences, or rejects if error occurs
+     * @throws Error if there is an error loading user preferences
+     */
+  }, {
+    key: "loadPreferences",
+    value: (function () {
+      var _loadPreferences = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+        var userPreferences;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return this.persistenceAPI.loadUserPreferences();
+            case 2:
+              userPreferences = _context.sent;
+              this.setUserPreferences(userPreferences);
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function loadPreferences() {
+        return _loadPreferences.apply(this, arguments);
+      }
+      return loadPreferences;
+    }()
+    /**
+     * This method updates a user preference
+     * @param key
+     * @param value
+     * @returns a promise that resolves when the user preference is updated
+     * @throws Error if there is an error updating user preferences
+     */
+    )
+  }, {
+    key: "updatePreference",
+    value: (function () {
+      var _updatePreference = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(key, value) {
+        var userPreferences;
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return this.persistenceAPI.updateUserPreference(key, value);
+            case 2:
+              userPreferences = _context2.sent;
+              this.setUserPreferences(userPreferences);
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this);
+      }));
+      function updatePreference(_x, _x2) {
+        return _updatePreference.apply(this, arguments);
+      }
+      return updatePreference;
+    }()
+    /**
+     * get a user preference, Note that this function is a not async function,
+     * meaning that consumers should prefetch the user preference and make it available initially
+     * @param key
+     */
+    )
+  }, {
+    key: "getPreference",
+    value: function getPreference(key) {
+      return this.resolvedUserPreferences[key];
+    }
+
+    /**
+     * get all user preferences
+     */
+  }, {
+    key: "getPreferences",
+    value: function getPreferences() {
+      return this.resolvedUserPreferences;
+    }
+
+    /**
+     * This method fetches the latest user preferences
+     * @returns a function to unsubscribe from the updates
+     */
+  }, {
+    key: "onUpdate",
+    value: function onUpdate(_onUpdate) {
+      var _this = this;
+      this.callbacks.push(_onUpdate);
+
+      // Return the cleanup function to unsubscribe from the updates
+      return function () {
+        _this.callbacks = _this.callbacks.filter(function (callback) {
+          return callback !== _onUpdate;
+        });
+      };
+    }
+
+    /**
+     * This method is used to set the default user preferences,
+     * setting the default user preferences will also trigger an update
+     * This is useful when the default user preferences dynamically based on the context
+     * @param preferences
+     */
+  }, {
+    key: "setDefaultPreferences",
+    value: function setDefaultPreferences(preferences) {
+      this.defaultPreferences = preferences;
+      var hasUpdated = this.resolveUserPreferences();
+      if (hasUpdated) {
+        this.notifyUserPreferencesUpdated();
+      }
+    }
+  }, {
+    key: "setUserPreferences",
+    value: function setUserPreferences(userPreferences) {
+      this.userPreferences = userPreferences;
+      var hasUpdated = this.resolveUserPreferences();
+      if (hasUpdated || !this.initialized) {
+        this.notifyUserPreferencesUpdated();
+      }
+      if (!this.initialized) {
+        this.initialized = true;
+      }
+    }
+  }, {
+    key: "notifyUserPreferencesUpdated",
+    value: function notifyUserPreferencesUpdated() {
+      var _this2 = this;
+      this.callbacks.forEach(function (callback) {
+        callback(_this2.resolvedUserPreferences);
+      });
+    }
+
+    /**
+     * This method resolves the user preferences by merging the default preferences
+     * with the user preferences and filtering out any undefined or null values
+     * to avoid overwriting default preferences with null values
+     * @returns true if the user preferences were updated, false otherwise
+     */
+  }, {
+    key: "resolveUserPreferences",
+    value: function resolveUserPreferences() {
+      var _this3 = this;
+      // Merge default preferences with user preferences
+      // and filter out any undefined or null values
+      // to avoid overwriting default preferences with null values
+      var newResolvedUserPreferences = _objectSpread(_objectSpread({}, this.defaultPreferences), Object.fromEntries(Object.entries(this.userPreferences).filter(function (_ref) {
+        var _ref2 = _slicedToArray(_ref, 2),
+          v = _ref2[1];
+        return v !== undefined && v !== null;
+      })));
+
+      // if the user preferences is NOT initialized, we need to update and notify
+      // the user preferences
+      // if the user preferences is initialized, we need to check if the new user preferences
+      // is different from the old user preferences
+      var needUpdate = Object.entries(newResolvedUserPreferences).some(function (_ref3) {
+        var _ref4 = _slicedToArray(_ref3, 2),
+          key = _ref4[0],
+          value = _ref4[1];
+        return value !== _this3.resolvedUserPreferences[key];
+      });
+      if (needUpdate) {
+        this.resolvedUserPreferences = newResolvedUserPreferences;
+      }
+      return needUpdate;
+    }
+  }]);
+}();

package/dist/esm/user-preferences/user-preferences.js

@@ -0,0 +1 @@
+export var TOOLBAR_DOCKING_POSITIONS = ['top', 'none'];

package/dist/types/analytics/types/ai-definitions-events.d.ts

@@ -3,7 +3,9 @@ import { type OperationalAEP, type UIAEP } from './utils';
 type CommonAttributes = {
     readingAidsSessionId: string;
 };
-type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes, undefined>;
+type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes & {
+    wordCount: number;
+}, undefined>;
 type AutoHighlightClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.DECORATION, ACTION_SUBJECT_ID.AI_DEFINITIONS_AUTO_HIGHLIGHT, CommonAttributes, undefined>;
 type AIDefinitionsErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.AI_DEFINITIONS, ACTION_SUBJECT_ID, {
     errorMessage?: string;

package/dist/types/user-preferences/hooks.d.ts

@@ -0,0 +1,4 @@
+import { UserPreferencesProvider } from './user-preferences-provider';
+export declare function useResolvedUserPreferences(userPreferencesProvider: UserPreferencesProvider): {
+    resolvedUserPreferences: import("./user-preferences").ResolvedUserPreferences<import("./user-preferences").UserPreferences>;
+};

package/dist/types/user-preferences/index.d.ts

@@ -0,0 +1,5 @@
+export { UserPreferencesProvider } from './user-preferences-provider';
+export type { UserPreferences, ResolvedUserPreferences, ToolbarDocking } from './user-preferences';
+export type { PersistenceAPI } from './persistence-api';
+export { TOOLBAR_DOCKING_POSITIONS } from './user-preferences';
+export { useResolvedUserPreferences } from './hooks';

package/dist/types/user-preferences/persistence-api.d.ts

@@ -0,0 +1,23 @@
+import { UserPreferences } from './user-preferences';
+export type PersistenceAPI = {
+    /**
+     * Loads the user preferences
+     * @returns
+     */
+    loadUserPreferences: () => Promise<UserPreferences>;
+    /**
+     * Update a single user preference
+     * @param key
+     * @param value
+     * @returns
+     */
+    updateUserPreference: <K extends keyof UserPreferences>(key: K, value: UserPreferences[K]) => Promise<UserPreferences>;
+    /**
+     * Get the initial user preferences synchronously
+     * This function is called on initialization
+     * If not provided, loadUserPreferences will be called instead
+     * @param userPreferences
+     * @returns
+     */
+    getInitialUserPreferences?: () => UserPreferences | undefined;
+};

package/dist/types/user-preferences/user-preferences-provider.d.ts

@@ -0,0 +1,64 @@
+import { PersistenceAPI } from './persistence-api';
+import { ResolvedUserPreferences, UserPreferences } from './user-preferences';
+type UpdateCallback = (userPreferences: UserPreferences) => void;
+export declare class UserPreferencesProvider {
+    private callbacks;
+    private userPreferences;
+    private defaultPreferences;
+    private resolvedUserPreferences;
+    private initialized;
+    private persistenceAPI;
+    /**
+     * @param persistenceAPI - The persistence API to use for loading and updating user preferences
+     * @param defaultPreferences - The default user preferences to use
+     * @param initialUserPreferences - The initial user preferences to use (optional)
+     */
+    constructor(persistenceAPI: PersistenceAPI, defaultPreferences: ResolvedUserPreferences);
+    get isInitialized(): boolean;
+    /**
+     * This method fetches the latest user preferences
+     * @returns a promise that resolves with the user preferences, or rejects if error occurs
+     * @throws Error if there is an error loading user preferences
+     */
+    loadPreferences(): Promise<void>;
+    /**
+     * This method updates a user preference
+     * @param key
+     * @param value
+     * @returns a promise that resolves when the user preference is updated
+     * @throws Error if there is an error updating user preferences
+     */
+    updatePreference<K extends keyof UserPreferences>(key: K, value: UserPreferences[K]): Promise<void>;
+    /**
+     * get a user preference, Note that this function is a not async function,
+     * meaning that consumers should prefetch the user preference and make it available initially
+     * @param key
+     */
+    getPreference<K extends keyof ResolvedUserPreferences>(key: K): ResolvedUserPreferences[K];
+    /**
+     * get all user preferences
+     */
+    getPreferences(): ResolvedUserPreferences;
+    /**
+     * This method fetches the latest user preferences
+     * @returns a function to unsubscribe from the updates
+     */
+    onUpdate(onUpdate: UpdateCallback): () => void;
+    /**
+     * This method is used to set the default user preferences,
+     * setting the default user preferences will also trigger an update
+     * This is useful when the default user preferences dynamically based on the context
+     * @param preferences
+     */
+    setDefaultPreferences(preferences: ResolvedUserPreferences): void;
+    private setUserPreferences;
+    notifyUserPreferencesUpdated(): void;
+    /**
+     * This method resolves the user preferences by merging the default preferences
+     * with the user preferences and filtering out any undefined or null values
+     * to avoid overwriting default preferences with null values
+     * @returns true if the user preferences were updated, false otherwise
+     */
+    private resolveUserPreferences;
+}
+export {};

package/dist/types/user-preferences/user-preferences.d.ts

@@ -0,0 +1,10 @@
+export declare const TOOLBAR_DOCKING_POSITIONS: readonly ["top", "none"];
+export type ToolbarDocking = (typeof TOOLBAR_DOCKING_POSITIONS)[number];
+export type UserPreferences = {
+    toolbarDockingPosition?: ToolbarDocking;
+};
+type Must<T> = {
+    [P in keyof T]-?: NonNullable<T[P]>;
+};
+export type ResolvedUserPreferences = Must<UserPreferences>;
+export {};

package/dist/types-ts4.5/analytics/types/ai-definitions-events.d.ts

@@ -3,7 +3,9 @@ import { type OperationalAEP, type UIAEP } from './utils';
 type CommonAttributes = {
     readingAidsSessionId: string;
 };
-type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes, undefined>;
+type DefineButtonClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ACTION_SUBJECT_ID.AI_DEFINITIONS_DEFINE_BUTTON, CommonAttributes & {
+    wordCount: number;
+}, undefined>;
 type AutoHighlightClickedAEP = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.DECORATION, ACTION_SUBJECT_ID.AI_DEFINITIONS_AUTO_HIGHLIGHT, CommonAttributes, undefined>;
 type AIDefinitionsErrorAEP = OperationalAEP<ACTION.ERRORED, ACTION_SUBJECT.AI_DEFINITIONS, ACTION_SUBJECT_ID, {
     errorMessage?: string;

package/dist/types-ts4.5/user-preferences/hooks.d.ts

@@ -0,0 +1,4 @@
+import { UserPreferencesProvider } from './user-preferences-provider';
+export declare function useResolvedUserPreferences(userPreferencesProvider: UserPreferencesProvider): {
+    resolvedUserPreferences: import("./user-preferences").ResolvedUserPreferences<import("./user-preferences").UserPreferences>;
+};

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

@@ -0,0 +1,5 @@
+export { UserPreferencesProvider } from './user-preferences-provider';
+export type { UserPreferences, ResolvedUserPreferences, ToolbarDocking } from './user-preferences';
+export type { PersistenceAPI } from './persistence-api';
+export { TOOLBAR_DOCKING_POSITIONS } from './user-preferences';
+export { useResolvedUserPreferences } from './hooks';

package/dist/types-ts4.5/user-preferences/persistence-api.d.ts

@@ -0,0 +1,23 @@
+import { UserPreferences } from './user-preferences';
+export type PersistenceAPI = {
+    /**
+     * Loads the user preferences
+     * @returns
+     */
+    loadUserPreferences: () => Promise<UserPreferences>;
+    /**
+     * Update a single user preference
+     * @param key
+     * @param value
+     * @returns
+     */
+    updateUserPreference: <K extends keyof UserPreferences>(key: K, value: UserPreferences[K]) => Promise<UserPreferences>;
+    /**
+     * Get the initial user preferences synchronously
+     * This function is called on initialization
+     * If not provided, loadUserPreferences will be called instead
+     * @param userPreferences
+     * @returns
+     */
+    getInitialUserPreferences?: () => UserPreferences | undefined;
+};

package/dist/types-ts4.5/user-preferences/user-preferences-provider.d.ts

@@ -0,0 +1,64 @@
+import { PersistenceAPI } from './persistence-api';
+import { ResolvedUserPreferences, UserPreferences } from './user-preferences';
+type UpdateCallback = (userPreferences: UserPreferences) => void;
+export declare class UserPreferencesProvider {
+    private callbacks;
+    private userPreferences;
+    private defaultPreferences;
+    private resolvedUserPreferences;
+    private initialized;
+    private persistenceAPI;
+    /**
+     * @param persistenceAPI - The persistence API to use for loading and updating user preferences
+     * @param defaultPreferences - The default user preferences to use
+     * @param initialUserPreferences - The initial user preferences to use (optional)
+     */
+    constructor(persistenceAPI: PersistenceAPI, defaultPreferences: ResolvedUserPreferences);
+    get isInitialized(): boolean;
+    /**
+     * This method fetches the latest user preferences
+     * @returns a promise that resolves with the user preferences, or rejects if error occurs
+     * @throws Error if there is an error loading user preferences
+     */
+    loadPreferences(): Promise<void>;
+    /**
+     * This method updates a user preference
+     * @param key
+     * @param value
+     * @returns a promise that resolves when the user preference is updated
+     * @throws Error if there is an error updating user preferences
+     */
+    updatePreference<K extends keyof UserPreferences>(key: K, value: UserPreferences[K]): Promise<void>;
+    /**
+     * get a user preference, Note that this function is a not async function,
+     * meaning that consumers should prefetch the user preference and make it available initially
+     * @param key
+     */
+    getPreference<K extends keyof ResolvedUserPreferences>(key: K): ResolvedUserPreferences[K];
+    /**
+     * get all user preferences
+     */
+    getPreferences(): ResolvedUserPreferences;
+    /**
+     * This method fetches the latest user preferences
+     * @returns a function to unsubscribe from the updates
+     */
+    onUpdate(onUpdate: UpdateCallback): () => void;
+    /**
+     * This method is used to set the default user preferences,
+     * setting the default user preferences will also trigger an update
+     * This is useful when the default user preferences dynamically based on the context
+     * @param preferences
+     */
+    setDefaultPreferences(preferences: ResolvedUserPreferences): void;
+    private setUserPreferences;
+    notifyUserPreferencesUpdated(): void;
+    /**
+     * This method resolves the user preferences by merging the default preferences
+     * with the user preferences and filtering out any undefined or null values
+     * to avoid overwriting default preferences with null values
+     * @returns true if the user preferences were updated, false otherwise
+     */
+    private resolveUserPreferences;
+}
+export {};

package/dist/types-ts4.5/user-preferences/user-preferences.d.ts

@@ -0,0 +1,13 @@
+export declare const TOOLBAR_DOCKING_POSITIONS: readonly [
+    "top",
+    "none"
+];
+export type ToolbarDocking = (typeof TOOLBAR_DOCKING_POSITIONS)[number];
+export type UserPreferences = {
+    toolbarDockingPosition?: ToolbarDocking;
+};
+type Must<T> = {
+    [P in keyof T]-?: NonNullable<T[P]>;
+};
+export type ResolvedUserPreferences = Must<UserPreferences>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "105.1.0",
+	"version": "105.2.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -109,6 +109,7 @@
 		"./intl-error-boundary": "./src/ui/IntlErrorBoundary/index.tsx",
 		"./code-block": "./src/code-block/index.ts",
 		"./table": "./src/table/index.ts",
+		"./user-preferences": "./src/user-preferences/index.ts",
 		"./use-plugin-state-effect": "./src/hooks/usePluginStateEffect.ts",
 		"./use-shared-plugin-state-selector": "./src/hooks/useSharedPluginStateSelector/index.ts",
 		"./lazy-node-view": "./src/lazy-node-view/index.ts",
@@ -160,13 +161,13 @@
 		"@atlaskit/profilecard": "^23.11.0",
 		"@atlaskit/react-ufo": "^3.11.0",
 		"@atlaskit/section-message": "^8.2.0",
-		"@atlaskit/smart-card": "^37.1.0",
+		"@atlaskit/smart-card": "^38.0.0",
 		"@atlaskit/smart-user-picker": "^8.0.0",
 		"@atlaskit/spinner": "^18.0.0",
 		"@atlaskit/task-decision": "^19.2.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^18.0.0",
-		"@atlaskit/tmp-editor-statsig": "^4.20.0",
+		"@atlaskit/tmp-editor-statsig": "^4.21.0",
 		"@atlaskit/tokens": "^4.8.0",
 		"@atlaskit/tooltip": "^20.0.0",
 		"@atlaskit/width-detector": "^5.0.0",

package/user-preferences/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/editor-common/user-preferences",
+  "main": "../dist/cjs/user-preferences/index.js",
+  "module": "../dist/esm/user-preferences/index.js",
+  "module:es2019": "../dist/es2019/user-preferences/index.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/user-preferences/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/user-preferences/index.d.ts"
+      ]
+    }
+  }
+}