@atlaskit/editor-common 105.2.1 → 105.2.3

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

@@ -1,6 +1,9 @@
-import { PersistenceAPI } from './persistence-api';
-import { ResolvedUserPreferences, UserPreferences } from './user-preferences';
+import { type PersistenceAPI } from './persistence-api';
+import { type ResolvedUserPreferences, type UserPreferences } from './user-preferences';
 type UpdateCallback = (userPreferences: UserPreferences) => void;
+/**
+ *
+ */
 export declare class UserPreferencesProvider {
     private callbacks;
     private userPreferences;
@@ -12,13 +15,18 @@ export declare 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)
+     * @example
      */
     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
+     * @example
      */
     loadPreferences(): Promise<void>;
     /**
@@ -27,21 +35,26 @@ 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
      */
     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
      */
     getPreference<K extends keyof ResolvedUserPreferences>(key: K): ResolvedUserPreferences[K];
     /**
      * get all user preferences
+     * @example
      */
     getPreferences(): ResolvedUserPreferences;
     /**
      * This method fetches the latest user preferences
+     * @param onUpdate
      * @returns a function to unsubscribe from the updates
+     * @example
      */
     onUpdate(onUpdate: UpdateCallback): () => void;
     /**
@@ -49,15 +62,21 @@ export declare class UserPreferencesProvider {
      * 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
+     * @example
      */
     setDefaultPreferences(preferences: ResolvedUserPreferences): void;
     private setUserPreferences;
+    /**
+     *
+     * @example
+     */
     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
+     * @example
      */
     private resolveUserPreferences;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "105.2.1",
+	"version": "105.2.3",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -128,23 +128,23 @@
 		"@atlaskit/analytics-next": "^11.0.0",
 		"@atlaskit/atlassian-context": "^0.2.0",
 		"@atlaskit/button": "^23.0.0",
-		"@atlaskit/code": "^17.1.0",
+		"@atlaskit/code": "^17.2.0",
 		"@atlaskit/codemod-utils": "^4.2.0",
 		"@atlaskit/css": "^0.10.0",
 		"@atlaskit/custom-steps": "^0.11.0",
-		"@atlaskit/dropdown-menu": "^14.1.0",
+		"@atlaskit/dropdown-menu": "^14.2.0",
 		"@atlaskit/editor-json-transformer": "^8.24.0",
 		"@atlaskit/editor-palette": "^2.1.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
 		"@atlaskit/editor-tables": "^2.9.0",
-		"@atlaskit/emoji": "^69.1.0",
+		"@atlaskit/emoji": "^69.2.0",
 		"@atlaskit/icon": "^26.0.0",
 		"@atlaskit/icon-object": "^7.1.0",
 		"@atlaskit/link-datasource": "^4.10.0",
 		"@atlaskit/link-picker": "^3.2.0",
 		"@atlaskit/media-card": "^79.2.0",
-		"@atlaskit/media-client": "^33.0.0",
+		"@atlaskit/media-client": "^33.1.0",
 		"@atlaskit/media-client-react": "^4.0.0",
 		"@atlaskit/media-common": "^12.0.0",
 		"@atlaskit/media-file-preview": "^0.11.0",
@@ -153,12 +153,12 @@
 		"@atlaskit/media-viewer": "^52.0.0",
 		"@atlaskit/mention": "^24.1.0",
 		"@atlaskit/menu": "^5.0.0",
-		"@atlaskit/onboarding": "^14.0.0",
+		"@atlaskit/onboarding": "^14.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/platform-feature-flags-react": "^0.2.0",
 		"@atlaskit/popper": "^7.0.0",
 		"@atlaskit/primitives": "^14.7.0",
-		"@atlaskit/profilecard": "^23.11.0",
+		"@atlaskit/profilecard": "^23.12.0",
 		"@atlaskit/react-ufo": "^3.11.0",
 		"@atlaskit/section-message": "^8.2.0",
 		"@atlaskit/smart-card": "^38.0.0",
@@ -199,14 +199,14 @@
 		"w3c-keyname": "^2.1.8"
 	},
 	"peerDependencies": {
-		"@atlaskit/media-core": "^36.0.0",
+		"@atlaskit/media-core": "^36.1.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"devDependencies": {
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/media-core": "^36.0.0",
+		"@atlaskit/media-core": "^36.1.0",
 		"@atlaskit/media-test-helpers": "^36.0.0",
 		"@atlaskit/util-data-test": "^18.0.0",
 		"@atlaskit/visual-regression": "workspace:^",