@atlaskit/editor-common 106.6.2 → 106.7.0

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 = "106.6.2";
+var packageVersion = "106.7.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 = "106.6.2";
+var packageVersion = "106.7.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

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

@@ -1,17 +1,18 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { useEffect, useState } from 'react';
 /**
- *
- * @param userPreferencesProvider
- * @example
+ * This hook returns the latest user preference
+ * @param {UserPreferencesProvider} userPreferencesProvider an instance of UserPreferencesProvider
+ * @example const { resolvedUserPreferences } = edUserPreferences(userPreferencesProvider)
+ * @returns {ResolvedUserPreferences | null} the latest user preference
  */
 export function useResolvedUserPreferences(userPreferencesProvider) {
-  var _useState = useState(userPreferencesProvider.getPreferences()),
+  var _useState = useState((userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.getPreferences()) || null),
     _useState2 = _slicedToArray(_useState, 2),
     resolvedUserPreferences = _useState2[0],
     setResolvedUserPreferences = _useState2[1];
   useEffect(function () {
-    return userPreferencesProvider.onUpdate(function () {
+    return userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.onUpdate(function () {
       setResolvedUserPreferences(userPreferencesProvider.getPreferences());
     });
   }, [userPreferencesProvider]);

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

@@ -1,25 +1,27 @@
-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";
+import { areUserPreferencesEqual, mergeUserPreferences } from './utils';
 /**
- *
+ * This class is used to manage user preferences in the editor.
+ * It provides methods to load, update, and get user preferences,
+ * as well as a way to subscribe to updates.
+ * @example const userPreferencesProvider = new UserPreferencesProvider(persistenceAPI, defaultPreferences);
  */
 export var UserPreferencesProvider = /*#__PURE__*/function () {
   /**
+   * This is the constructor for the UserPreferencesProvider class.
    * @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)
-   * @example
+   * @example const userPreferencesProvider = new UserPreferencesProvider(persistenceAPI, defaultPreferences);
    */
   function UserPreferencesProvider(persistenceAPI, defaultPreferences) {
     var _this$persistenceAPI$, _this$persistenceAPI;
     _classCallCheck(this, UserPreferencesProvider);
-    _defineProperty(this, "callbacks", []);
+    _defineProperty(this, "updateCallbacks", []);
     _defineProperty(this, "userPreferences", {});
     _defineProperty(this, "initialized", false);
     this.persistenceAPI = persistenceAPI;
@@ -34,7 +36,9 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
   }
 
   /**
-   *
+   * This method returns the initialized state of the user preferences provider
+   * @returns true if the user preferences provider is initialized, false otherwise
+   * @example userPreferencesProvider.isInitialized
    */
   return _createClass(UserPreferencesProvider, [{
     key: "isInitialized",
@@ -46,7 +50,7 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
      * 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
-     * @example
+     * @example userPreferencesProvider.loadPreferences()
      */
   }, {
     key: "loadPreferences",
@@ -78,7 +82,7 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
      * @param value
      * @returns a promise that resolves when the user preference is updated
      * @throws Error if there is an error updating user preferences
-     * @example
+     * @example userPreferencesProvider.updatePreference('toolbarDockingPosition', 'top')
      */
     )
   }, {
@@ -109,7 +113,8 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
      * 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
-     * @example
+     * @returns the user preference
+     * @example userPreferencesProvider.getPreference('toolbarDockingPosition')
      */
     )
   }, {
@@ -120,7 +125,8 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
 
     /**
      * get all user preferences
-     * @example
+     * @returns the user preferences
+     * @example userPreferencesProvider.getPreferences()
      */
   }, {
     key: "getPreferences",
@@ -138,11 +144,11 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
     key: "onUpdate",
     value: function onUpdate(_onUpdate) {
       var _this = this;
-      this.callbacks.push(_onUpdate);
+      this.updateCallbacks.push(_onUpdate);
 
       // Return the cleanup function to unsubscribe from the updates
       return function () {
-        _this.callbacks = _this.callbacks.filter(function (callback) {
+        _this.updateCallbacks = _this.updateCallbacks.filter(function (callback) {
           return callback !== _onUpdate;
         });
       };
@@ -178,14 +184,14 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
     }
 
     /**
-     *
-     * @example
+     * This method is used to notify the user preferences updated
+     * @example userPreferencesProvider.notifyUserPreferencesUpdated()
      */
   }, {
     key: "notifyUserPreferencesUpdated",
     value: function notifyUserPreferencesUpdated() {
       var _this2 = this;
-      this.callbacks.forEach(function (callback) {
+      this.updateCallbacks.forEach(function (callback) {
         callback(_this2.resolvedUserPreferences);
       });
     }
@@ -195,31 +201,22 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
      * 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
-     * @example
+     * @example userPreferencesProvider.resolveUserPreferences()
      */
   }, {
     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;
-      })));
+      var newResolvedUserPreferences = mergeUserPreferences(this.userPreferences, this.defaultPreferences);
 
       // 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];
-      });
+      var isSame = areUserPreferencesEqual(newResolvedUserPreferences, this.resolvedUserPreferences);
+      var needUpdate = !isSame;
       if (needUpdate) {
         this.resolvedUserPreferences = newResolvedUserPreferences;
       }

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

@@ -1 +1,6 @@
-export var TOOLBAR_DOCKING_POSITIONS = ['top', 'none'];
+export var TOOLBAR_DOCKING_POSITIONS = ['top', 'none'];
+
+/**
+ * This type should contain all the user preferences
+ * And we do expect all the attributes to be defined
+ */

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

@@ -0,0 +1,35 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+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; }
+export var mergeUserPreferences = function mergeUserPreferences(userPreferences, defaultPreferences) {
+  var newResolvedUserPreferences = _objectSpread(_objectSpread({}, defaultPreferences), Object.fromEntries(Object.entries(userPreferences).filter(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+      v = _ref2[1];
+    return v !== undefined && v !== null;
+  })));
+  return newResolvedUserPreferences;
+};
+
+/**
+ * Compare two user preferences objects
+ * @param {ResolvedUserPreferences} left a ResolvedUserPreferences
+ * @param {ResolvedUserPreferences} right a ResolvedUserPreferences
+ * @returns true if the user preferences are the same, false otherwise
+ * @example
+ * const userPreferences1 = {
+ *   toolbarDockingPosition: 'top',
+ * };
+ * const userPreferences2 = {
+ *   toolbarDockingPosition: 'top',
+ * };
+ * compareUserPreferences(userPreferences1, userPreferences2); // true
+ */
+export var areUserPreferencesEqual = function areUserPreferencesEqual(left, right) {
+  return Object.entries(left).every(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+      key = _ref4[0],
+      value = _ref4[1];
+    return value === right[key];
+  });
+};

package/dist/esm/utils/processRawValue.js

@@ -1,6 +1,5 @@
 import { transformDedupeMarks, transformIndentationMarks, transformInvalidMediaContent, transformMediaLinkMarks, transformNestedTablesIncomingDocument, transformNodesMissingContent, transformTextLinkCodeMarks } from '@atlaskit/adf-utils/transforms';
 import { Fragment, Node } from '@atlaskit/editor-prosemirror/model';
-import { fg } from '@atlaskit/platform-feature-flags';
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '../analytics';
 import { sanitizeNodeForPrivacy } from './filter/privacy-filter';
 import { findAndTrackUnsupportedContentNodes } from './track-unsupported-content';
@@ -56,14 +55,11 @@ export function processRawValueWithoutValidation(schema, value, dispatchAnalytic
   } else {
     node = value;
   }
-  if (fg('platform_editor_use_nested_table_pm_nodes')) {
-    // Convert nested-table extensions into nested tables
-    var _transformNestedTable2 = transformNestedTablesWithAnalytics(node, dispatchAnalyticsEvent),
-      transformedAdf = _transformNestedTable2.transformedAdf;
-    return Node.fromJSON(schema, transformedAdf);
-  } else {
-    return Node.fromJSON(schema, node);
-  }
+
+  // Convert nested-table extensions into nested tables
+  var _transformNestedTable2 = transformNestedTablesWithAnalytics(node, dispatchAnalyticsEvent),
+    transformedAdf = _transformNestedTable2.transformedAdf;
+  return Node.fromJSON(schema, transformedAdf);
 }
 export function processRawValue(schema, value, providerFactory, sanitizePrivateContent, contentTransformer, dispatchAnalyticsEvent) {
   if (!value) {
@@ -191,11 +187,10 @@ export function processRawValue(schema, value, providerFactory, sanitizePrivateC
         eventType: EVENT_TYPE.OPERATIONAL
       });
     }
-    if (fg('platform_editor_use_nested_table_pm_nodes')) {
-      // Convert nested-table extensions into nested tables
-      var _transformNestedTable3 = transformNestedTablesWithAnalytics(transformedAdf, dispatchAnalyticsEvent);
-      transformedAdf = _transformNestedTable3.transformedAdf;
-    }
+
+    // Convert nested-table extensions into nested tables
+    var _transformNestedTable3 = transformNestedTablesWithAnalytics(transformedAdf, dispatchAnalyticsEvent);
+    transformedAdf = _transformNestedTable3.transformedAdf;
     if (dispatchAnalyticsEvent) {
       var _transformedAdf$conte;
       var hasSingleColumnLayout = (_transformedAdf$conte = transformedAdf.content) === null || _transformedAdf$conte === void 0 ? void 0 : _transformedAdf$conte.some(function (node) {

package/dist/types/i18n/en_ZZ.d.ts

@@ -333,6 +333,10 @@ declare const _default: {
     'fabric.editor.blockquote.description': string;
     'fabric.editor.blockquote2': string;
     'fabric.editor.bold': string;
+    'fabric.editor.breakout.resizeCodeBlock': string;
+    'fabric.editor.breakout.resizeElement': string;
+    'fabric.editor.breakout.resizeExpand': string;
+    'fabric.editor.breakout.resizeLayout': string;
     'fabric.editor.breakoutFullWidthLabel': string;
     'fabric.editor.breakoutWideWidthLabel': string;
     'fabric.editor.bug': string;

package/dist/types/i18n/hr.d.ts

@@ -780,6 +780,8 @@ declare const _default: {
     'fabric.editor.toolbarMediaTitle': string;
     'fabric.editor.toolbarPositionFixedAtTop': string;
     'fabric.editor.toolbarPositionInline': string;
+    'fabric.editor.toolbarPositionPinedAtTop': string;
+    'fabric.editor.toolbarPositionUnpined': string;
     'fabric.editor.tooltip.blockPanel': string;
     'fabric.editor.tooltip.bulletList': string;
     'fabric.editor.tooltip.decisionList': string;