@atlaskit/editor-common 106.6.1 → 106.7.0

package/dist/types-ts4.5/provider-factory/with-providers.d.ts

@@ -1,6 +1,6 @@
 import { PureComponent } from 'react';
 import type ProviderFactory from './provider-factory';
-import { type ProviderName, type Providers } from './types';
+import type { ProviderName, Providers } from './types';
 export interface Props {
     providerFactory: ProviderFactory;
     providers: ProviderName[];

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

@@ -1,9 +1,11 @@
-import { UserPreferencesProvider } from './user-preferences-provider';
+import { type ResolvedUserPreferences } from './user-preferences';
+import type { UserPreferencesProvider } from './user-preferences-provider';
 /**
- *
- * @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 declare function useResolvedUserPreferences(userPreferencesProvider: UserPreferencesProvider): {
-    resolvedUserPreferences: import("./user-preferences").ResolvedUserPreferences<import("./user-preferences").UserPreferences>;
+export declare function useResolvedUserPreferences(userPreferencesProvider?: UserPreferencesProvider): {
+    resolvedUserPreferences: ResolvedUserPreferences | null;
 };

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

@@ -11,7 +11,7 @@ export type PersistenceAPI = {
      * @param value
      * @returns
      */
-    updateUserPreference: <K extends keyof UserPreferences>(key: K, value: UserPreferences[K]) => Promise<UserPreferences>;
+    updateUserPreference: <K extends keyof UserPreferences>(key: K, value: UserPreferences[K]) => Promise<Pick<UserPreferences, K>>;
     /**
      * Get the initial user preferences synchronously
      * This function is called on initialization

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

@@ -2,31 +2,37 @@ import { type PersistenceAPI } from './persistence-api';
 import { type ResolvedUserPreferences, type UserPreferences } from './user-preferences';
 type UpdateCallback = (userPreferences: UserPreferences) => void;
 /**
- *
+ * 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 declare class UserPreferencesProvider {
-    private callbacks;
+    private updateCallbacks;
     private userPreferences;
     private defaultPreferences;
     private resolvedUserPreferences;
     private initialized;
     private persistenceAPI;
     /**
+     * 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);
      */
     constructor(persistenceAPI: PersistenceAPI, defaultPreferences: ResolvedUserPreferences);
     /**
-     *
+     * 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
      */
     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
-     * @example
+     * @example userPreferencesProvider.loadPreferences()
      */
     loadPreferences(): Promise<void>;
     /**
@@ -35,19 +41,21 @@ export declare class UserPreferencesProvider {
      * @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')
      */
     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
-     * @example
+     * @returns the user preference
+     * @example userPreferencesProvider.getPreference('toolbarDockingPosition')
      */
     getPreference<K extends keyof ResolvedUserPreferences>(key: K): ResolvedUserPreferences[K];
     /**
      * get all user preferences
-     * @example
+     * @returns the user preferences
+     * @example userPreferencesProvider.getPreferences()
      */
     getPreferences(): ResolvedUserPreferences;
     /**
@@ -67,8 +75,8 @@ export declare class UserPreferencesProvider {
     setDefaultPreferences(preferences: ResolvedUserPreferences): void;
     private setUserPreferences;
     /**
-     *
-     * @example
+     * This method is used to notify the user preferences updated
+     * @example userPreferencesProvider.notifyUserPreferencesUpdated()
      */
     notifyUserPreferencesUpdated(): void;
     /**
@@ -76,7 +84,7 @@ export declare class UserPreferencesProvider {
      * 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()
      */
     private resolveUserPreferences;
 }

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

@@ -6,8 +6,10 @@ export type ToolbarDocking = (typeof TOOLBAR_DOCKING_POSITIONS)[number];
 export type UserPreferences = {
     toolbarDockingPosition?: ToolbarDocking;
 };
-type Must<T> = {
-    [P in keyof T]-?: NonNullable<T[P]>;
+/**
+ * This type should contain all the user preferences
+ * And we do expect all the attributes to be defined
+ */
+export type ResolvedUserPreferences = {
+    toolbarDockingPosition: ToolbarDocking;
 };
-export type ResolvedUserPreferences = Must<UserPreferences>;
-export {};

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

@@ -0,0 +1,17 @@
+import { ResolvedUserPreferences, UserPreferences } from './user-preferences';
+export declare const mergeUserPreferences: (userPreferences: UserPreferences, defaultPreferences: ResolvedUserPreferences) => ResolvedUserPreferences;
+/**
+ * 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 declare const areUserPreferencesEqual: (left: ResolvedUserPreferences, right: ResolvedUserPreferences) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "106.6.1",
+	"version": "106.7.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -147,7 +147,7 @@
 		"@atlaskit/link-datasource": "^4.11.0",
 		"@atlaskit/link-picker": "^3.5.0",
 		"@atlaskit/media-card": "^79.3.0",
-		"@atlaskit/media-client": "^33.3.0",
+		"@atlaskit/media-client": "^33.4.0",
 		"@atlaskit/media-client-react": "^4.1.0",
 		"@atlaskit/media-common": "^12.1.0",
 		"@atlaskit/media-file-preview": "^0.11.0",
@@ -171,7 +171,7 @@
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^18.0.0",
 		"@atlaskit/tmp-editor-statsig": "^7.0.0",
-		"@atlaskit/tokens": "^5.1.0",
+		"@atlaskit/tokens": "^5.2.0",
 		"@atlaskit/tooltip": "^20.3.0",
 		"@atlaskit/width-detector": "^5.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -272,9 +272,6 @@
 		"platform-visual-refresh-icons": {
 			"type": "boolean"
 		},
-		"platform_editor_use_nested_table_pm_nodes": {
-			"type": "boolean"
-		},
 		"platform_editor_extension_fix_ssr_ref": {
 			"type": "boolean"
 		},
@@ -397,6 +394,9 @@
 		},
 		"platform_editor_breakout_resizing_hello_release": {
 			"type": "boolean"
+		},
+		"platform_editor_fix_unsubscribe_of_provider": {
+			"type": "boolean"
 		}
 	}
 }