@atlaskit/editor-common 105.2.2 → 105.2.4

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

@@ -6,11 +6,15 @@ 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)
+   * @example
    */
   function UserPreferencesProvider(persistenceAPI, defaultPreferences) {
     var _this$persistenceAPI$, _this$persistenceAPI;
@@ -28,6 +32,10 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
       this.loadPreferences();
     }
   }
+
+  /**
+   *
+   */
   return _createClass(UserPreferencesProvider, [{
     key: "isInitialized",
     get: function get() {
@@ -38,6 +46,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
      */
   }, {
     key: "loadPreferences",
@@ -69,6 +78,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
      */
     )
   }, {
@@ -99,6 +109,7 @@ 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
      */
     )
   }, {
@@ -109,6 +120,7 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
 
     /**
      * get all user preferences
+     * @example
      */
   }, {
     key: "getPreferences",
@@ -118,7 +130,9 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
 
     /**
      * This method fetches the latest user preferences
+     * @param onUpdate
      * @returns a function to unsubscribe from the updates
+     * @example
      */
   }, {
     key: "onUpdate",
@@ -139,6 +153,7 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
      * 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
      */
   }, {
     key: "setDefaultPreferences",
@@ -161,6 +176,11 @@ export var UserPreferencesProvider = /*#__PURE__*/function () {
         this.initialized = true;
       }
     }
+
+    /**
+     *
+     * @example
+     */
   }, {
     key: "notifyUserPreferencesUpdated",
     value: function notifyUserPreferencesUpdated() {
@@ -175,6 +195,7 @@ 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
      */
   }, {
     key: "resolveUserPreferences",

package/dist/esm/utils/imageLoader.js

@@ -43,10 +43,20 @@ export var withImageLoaderOld = function withImageLoaderOld(Wrapped) {
     _inherits(WithImageLoader, _Component);
     return _createClass(WithImageLoader, [{
       key: "componentDidMount",
-      value: function componentDidMount() {
+      value:
+      /**
+       *
+       * @example
+       */
+      function componentDidMount() {
         this.fetchImage(this.props);
       }
 
+      /**
+       *
+       * @param nextProps
+       * @example
+       */
       // Ignored via go/ees005
       // eslint-disable-next-line react/no-unsafe
     }, {
@@ -59,19 +69,33 @@ export var withImageLoaderOld = function withImageLoaderOld(Wrapped) {
           this.fetchImage(nextProps);
         }
       }
+
+      /**
+       *
+       * @example
+       */
     }, {
       key: "componentWillUnmount",
       value: function componentWillUnmount() {
         if (this.img) {
-          // Ignored via go/ees005
-          // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-          this.img.removeEventListener('load', this.onLoad);
-          // Ignored via go/ees005
-          // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-          this.img.removeEventListener('error', this.onError);
-          this.img = null;
+          if (!process.env.REACT_SSR) {
+            // Ignored via go/ees005
+            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+            this.img.removeEventListener('load', this.onLoad);
+            // Ignored via go/ees005
+            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+            this.img.removeEventListener('error', this.onError);
+            this.img = null;
+          }
         }
       }
+
+      /**
+       *
+       * @param root0
+       * @param root0.url
+       * @example
+       */
     }, {
       key: "fetchImage",
       value: function fetchImage(_ref) {
@@ -79,19 +103,26 @@ export var withImageLoaderOld = function withImageLoaderOld(Wrapped) {
         if (url) {
           if (!this.img) {
             this.img = new Image();
-            // Ignored via go/ees005
-            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-            this.img.addEventListener('load', this.onLoad);
-            // Ignored via go/ees005
-            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-            this.img.addEventListener('error', this.onError);
+            if (!process.env.REACT_SSR) {
+              // Ignored via go/ees005
+              // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+              this.img.addEventListener('load', this.onLoad);
+              // Ignored via go/ees005
+              // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+              this.img.addEventListener('error', this.onError);
+            }
           }
           this.img.src = url;
         }
       }
     }, {
       key: "render",
-      value: function render() {
+      value:
+      /**
+       *
+       * @example
+       */
+      function render() {
         var imageStatus = this.state.imageStatus;
         // Ignored via go/ees005
         // eslint-disable-next-line react/jsx-props-no-spreading
@@ -153,12 +184,14 @@ var withImageLoaderNew = function withImageLoaderNew(Wrapped) {
       key: "componentWillUnmount",
       value: function componentWillUnmount() {
         if (this.img) {
-          // Ignored via go/ees005
-          // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-          this.img.removeEventListener('load', this.onLoad);
-          // Ignored via go/ees005
-          // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-          this.img.removeEventListener('error', this.onError);
+          if (!process.env.REACT_SSR) {
+            // Ignored via go/ees005
+            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+            this.img.removeEventListener('load', this.onLoad);
+            // Ignored via go/ees005
+            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+            this.img.removeEventListener('error', this.onError);
+          }
           this.img = null;
         }
       }
@@ -169,12 +202,14 @@ var withImageLoaderNew = function withImageLoaderNew(Wrapped) {
         if (url) {
           if (!this.img) {
             this.img = new Image();
-            // Ignored via go/ees005
-            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-            this.img.addEventListener('load', this.onLoad);
-            // Ignored via go/ees005
-            // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-            this.img.addEventListener('error', this.onError);
+            if (!process.env.REACT_SSR) {
+              // Ignored via go/ees005
+              // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+              this.img.addEventListener('load', this.onLoad);
+              // Ignored via go/ees005
+              // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+              this.img.addEventListener('error', this.onError);
+            }
           }
           this.img.src = url;
         }

package/dist/types/analytics/types/alignment-events.d.ts

@@ -1,5 +1,5 @@
 import { ACTION, ACTION_SUBJECT, INPUT_METHOD, ACTION_SUBJECT_ID } from './enums';
-import { TrackAEP } from './utils';
+import { type TrackAEP } from './utils';
 type AlignmentUpdatedAEP = TrackAEP<ACTION.UPDATED, ACTION_SUBJECT.ALIGNMENT, ACTION_SUBJECT_ID, {
     alignmentType?: 'start' | 'end' | 'center';
     inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.FLOATING_TB | INPUT_METHOD.SHORTCUT;

package/dist/types/analytics/types/events.d.ts

@@ -11,7 +11,7 @@ import type { AIEventPayload } from './ai-events';
 import type { AIInlineSuggestionPayload } from './ai-inline-suggestion-events';
 import type { AIProactiveEventPayload } from './ai-proactive-events';
 import type { AIUnifiedEventPayload } from './ai-unified-events';
-import { AlignmentEventPayload } from './alignment-events';
+import type { AlignmentEventPayload } from './alignment-events';
 import type { AvatarEventPayload } from './avatar';
 import { type BreakoutEventPayload } from './breakout-events';
 import type { TextColorEventPayload } from './color-events';

package/dist/types/card/MediaAndEmbedsToolbar/index.d.ts

@@ -3,7 +3,7 @@ import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema'
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorAnalyticsAPI } from '../../analytics';
-import { Keymap } from '../../keymaps';
+import { type Keymap } from '../../keymaps';
 import type { Command, EditorContainerWidth, FloatingToolbarItem, Icon, NextEditorPlugin, PluginDependenciesAPI } from '../../types';
 type WidthPluginType = NextEditorPlugin<'width', {
     sharedState: EditorContainerWidth | undefined;

package/dist/types/collab/index.d.ts

@@ -380,6 +380,7 @@ export interface CollabParticipant {
     isGuest?: boolean;
     presenceId?: string;
     presenceActivity?: PresenceActivity;
+    isHydrated?: boolean;
 }
 export type ProviderParticipant = CollabParticipant & {
     userId: string;

package/dist/types/resizer/BreakoutResizer.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { EditorAnalyticsAPI } from '../analytics';
-import { GuidelineConfig } from '../guideline';
+import { type GuidelineConfig } from '../guideline';
 import { type EditorContainerWidth, type getPosHandlerNode } from '../types';
 type BreakoutSupportedNodes = 'layoutSection' | 'expand' | 'codeBlock';
 export declare const ignoreResizerMutations: (mutation: MutationRecord | {
@@ -26,6 +26,19 @@ type BreakoutResizerProps = {
  * correct ADF support.
  *
  * use experiment platform_editor_advanced_layouts
+ * @param root0
+ * @param root0.editorView
+ * @param root0.nodeType
+ * @param root0.getPos
+ * @param root0.getRef
+ * @param root0.disabled
+ * @param root0.getEditorWidth
+ * @param root0.parentRef
+ * @param root0.displayGuidelines
+ * @param root0.editorAnalyticsApi
+ * @param root0.displayGapCursor
+ * @param root0.onResizeStart
+ * @example
  */
 declare const BreakoutResizer: ({ editorView, nodeType, getPos, getRef, disabled, getEditorWidth, parentRef, displayGuidelines, editorAnalyticsApi, displayGapCursor, onResizeStart, }: BreakoutResizerProps) => React.JSX.Element;
 export { BreakoutResizer };

package/dist/types/resizer/ResizerBreakoutModeLabel.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { BreakoutMode } from '../types';
+import type { BreakoutMode } from '../types';
 type props = {
     layout: BreakoutMode;
 };

package/dist/types/types/text-formatting.d.ts

@@ -15,6 +15,7 @@ export interface TextFormattingOptions {
     responsiveToolbarMenu?: boolean;
 }
 export interface TextFormattingState {
+    isInitialised: boolean;
     emActive?: boolean;
     emDisabled?: boolean;
     emHidden?: boolean;

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

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

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

@@ -1,4 +1,4 @@
-import { UserPreferences } from './user-preferences';
+import { type UserPreferences } from './user-preferences';
 export type PersistenceAPI = {
     /**
      * Loads the user preferences

package/dist/types/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/dist/types-ts4.5/analytics/types/alignment-events.d.ts

@@ -1,5 +1,5 @@
 import { ACTION, ACTION_SUBJECT, INPUT_METHOD, ACTION_SUBJECT_ID } from './enums';
-import { TrackAEP } from './utils';
+import { type TrackAEP } from './utils';
 type AlignmentUpdatedAEP = TrackAEP<ACTION.UPDATED, ACTION_SUBJECT.ALIGNMENT, ACTION_SUBJECT_ID, {
     alignmentType?: 'start' | 'end' | 'center';
     inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.FLOATING_TB | INPUT_METHOD.SHORTCUT;

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

@@ -11,7 +11,7 @@ import type { AIEventPayload } from './ai-events';
 import type { AIInlineSuggestionPayload } from './ai-inline-suggestion-events';
 import type { AIProactiveEventPayload } from './ai-proactive-events';
 import type { AIUnifiedEventPayload } from './ai-unified-events';
-import { AlignmentEventPayload } from './alignment-events';
+import type { AlignmentEventPayload } from './alignment-events';
 import type { AvatarEventPayload } from './avatar';
 import { type BreakoutEventPayload } from './breakout-events';
 import type { TextColorEventPayload } from './color-events';

package/dist/types-ts4.5/card/MediaAndEmbedsToolbar/index.d.ts

@@ -3,7 +3,7 @@ import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema'
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorAnalyticsAPI } from '../../analytics';
-import { Keymap } from '../../keymaps';
+import { type Keymap } from '../../keymaps';
 import type { Command, EditorContainerWidth, FloatingToolbarItem, Icon, NextEditorPlugin, PluginDependenciesAPI } from '../../types';
 type WidthPluginType = NextEditorPlugin<'width', {
     sharedState: EditorContainerWidth | undefined;

package/dist/types-ts4.5/collab/index.d.ts

@@ -380,6 +380,7 @@ export interface CollabParticipant {
     isGuest?: boolean;
     presenceId?: string;
     presenceActivity?: PresenceActivity;
+    isHydrated?: boolean;
 }
 export type ProviderParticipant = CollabParticipant & {
     userId: string;

package/dist/types-ts4.5/resizer/BreakoutResizer.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { EditorAnalyticsAPI } from '../analytics';
-import { GuidelineConfig } from '../guideline';
+import { type GuidelineConfig } from '../guideline';
 import { type EditorContainerWidth, type getPosHandlerNode } from '../types';
 type BreakoutSupportedNodes = 'layoutSection' | 'expand' | 'codeBlock';
 export declare const ignoreResizerMutations: (mutation: MutationRecord | {
@@ -26,6 +26,19 @@ type BreakoutResizerProps = {
  * correct ADF support.
  *
  * use experiment platform_editor_advanced_layouts
+ * @param root0
+ * @param root0.editorView
+ * @param root0.nodeType
+ * @param root0.getPos
+ * @param root0.getRef
+ * @param root0.disabled
+ * @param root0.getEditorWidth
+ * @param root0.parentRef
+ * @param root0.displayGuidelines
+ * @param root0.editorAnalyticsApi
+ * @param root0.displayGapCursor
+ * @param root0.onResizeStart
+ * @example
  */
 declare const BreakoutResizer: ({ editorView, nodeType, getPos, getRef, disabled, getEditorWidth, parentRef, displayGuidelines, editorAnalyticsApi, displayGapCursor, onResizeStart, }: BreakoutResizerProps) => React.JSX.Element;
 export { BreakoutResizer };

package/dist/types-ts4.5/resizer/ResizerBreakoutModeLabel.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { BreakoutMode } from '../types';
+import type { BreakoutMode } from '../types';
 type props = {
     layout: BreakoutMode;
 };

package/dist/types-ts4.5/types/text-formatting.d.ts

@@ -15,6 +15,7 @@ export interface TextFormattingOptions {
     responsiveToolbarMenu?: boolean;
 }
 export interface TextFormattingState {
+    isInitialised: boolean;
     emActive?: boolean;
     emDisabled?: boolean;
     emHidden?: boolean;

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

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

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

@@ -1,4 +1,4 @@
-import { UserPreferences } from './user-preferences';
+import { type UserPreferences } from './user-preferences';
 export type PersistenceAPI = {
     /**
      * Loads the user preferences

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;
 }