@atlaskit/editor-plugin-user-preferences 1.2.2 → 1.2.4

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-user-preferences
 
+## 1.2.4
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
+## 1.2.3
+
+### Patch Changes
+
+- [`4bc05c9f87780`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4bc05c9f87780) -
+  [ux] Fix toolbar blink CLS regression
+
 ## 1.2.2
 
 ### Patch Changes

package/dist/cjs/userPreferencesPlugin.js

@@ -33,6 +33,12 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
           userPreferencesProvider: userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
+      },
+      getUserPreferences: function getUserPreferences() {
+        if (!userPreferencesProvider) {
+          return undefined;
+        }
+        return userPreferencesProvider.getPreferences();
       }
     },
     getSharedState: function getSharedState(editorState) {

package/dist/es2019/userPreferencesPlugin.js

@@ -28,6 +28,12 @@ export const userPreferencesPlugin = ({
           userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
+      },
+      getUserPreferences: () => {
+        if (!userPreferencesProvider) {
+          return undefined;
+        }
+        return userPreferencesProvider.getPreferences();
       }
     },
     getSharedState(editorState) {

package/dist/esm/userPreferencesPlugin.js

@@ -27,6 +27,12 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
           userPreferencesProvider: userPreferencesProvider,
           editorAnalyticsApi: api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions
         });
+      },
+      getUserPreferences: function getUserPreferences() {
+        if (!userPreferencesProvider) {
+          return undefined;
+        }
+        return userPreferencesProvider.getPreferences();
       }
     },
     getSharedState: function getSharedState(editorState) {

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

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

package/dist/types/userPreferencesPluginType.d.ts

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-user-preferences",
-	"version": "1.2.2",
+	"version": "1.2.4",
 	"description": "UserPreferences plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,12 +34,12 @@
 		"@atlaskit/editor-plugin-analytics": "^3.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^11.0.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.25.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {