@nutrient-sdk/viewer 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -9290,7 +9290,7 @@ declare class Bookmark extends Bookmark_base {
     static fromSerializableObject: (bookmark: BookmarkJSON) => Bookmark;
 }
 
-declare const allowedToolbarTypes: ("link" | "ellipse" | "image" | "line" | "polygon" | "polyline" | "text" | "spacer" | "search" | "distance" | "note" | "comment" | "zoom-in" | "zoom-out" | "callout" | "arrow" | "highlighter" | "undo" | "redo" | "custom" | "print" | "pager" | "pan" | "debug" | "rectangle" | "ink" | "stamp" | "cloudy-rectangle" | "dashed-rectangle" | "cloudy-ellipse" | "dashed-ellipse" | "cloudy-polygon" | "dashed-polygon" | "text-highlighter" | "perimeter" | "ellipse-area" | "rectangle-area" | "polygon-area" | "sidebar-thumbnails" | "sidebar-document-outline" | "sidebar-annotations" | "sidebar-bookmarks" | "sidebar-signatures" | "sidebar-attachments" | "sidebar-layers" | "multi-annotations-selection" | "zoom-mode" | "linearized-download-indicator" | "annotate" | "ink-eraser" | "signature" | "document-editor" | "document-crop" | "export-pdf" | "layout-config" | "marquee-zoom" | "responsive-group" | "redact-text-highlighter" | "redact-rectangle" | "document-comparison" | "measure" | "form-creator" | "content-editor" | "ai-assistant")[];
+declare const allowedToolbarTypes: ("link" | "ellipse" | "image" | "line" | "polygon" | "polyline" | "text" | "spacer" | "search" | "distance" | "note" | "comment" | "zoom-in" | "zoom-out" | "callout" | "arrow" | "highlighter" | "undo" | "redo" | "custom" | "signature" | "ink" | "document-editor" | "print" | "layout-config" | "marquee-zoom" | "responsive-group" | "redact-text-highlighter" | "redact-rectangle" | "cloudy-rectangle" | "dashed-rectangle" | "cloudy-ellipse" | "dashed-ellipse" | "dashed-polygon" | "document-comparison" | "measure" | "form-creator" | "content-editor" | "perimeter" | "rectangle-area" | "ellipse-area" | "polygon-area" | "ai-assistant" | "sidebar-thumbnails" | "sidebar-document-outline" | "sidebar-annotations" | "sidebar-bookmarks" | "sidebar-signatures" | "sidebar-attachments" | "sidebar-layers" | "pager" | "multi-annotations-selection" | "pan" | "zoom-mode" | "linearized-download-indicator" | "annotate" | "text-highlighter" | "ink-eraser" | "stamp" | "rectangle" | "cloudy-polygon" | "document-crop" | "export-pdf" | "debug")[];
 
 /**
  * Describes the properties of a Tool Item.
@@ -9662,7 +9662,7 @@ type AnnotationPresetID$1 = string;
  * @memberof PSPDFKit.ToolbarItem
  */
 type ToolbarItemType = ToolItemType | (typeof allowedToolbarTypes)[number];
-type ToolbarItem = Omit<ToolItem, 'type'> & {
+type ToolbarItem$1 = Omit<ToolItem, 'type'> & {
     type: ToolbarItemType;
     mediaQueries?: string[];
     responsiveGroup?: string;
@@ -10691,7 +10691,7 @@ type DocumentEditorFooterItem = Omit<BasicDocumentEditorFooterItem, 'type' | 'on
     onPress?: (e: Event, documentEditorUIHandler: DocumentEditorUIHandler, id?: string) => void;
 });
 
-type BuiltInDocumentEditorToolbarItem = 'add' | 'remove' | 'duplicate' | 'rotate-left' | 'rotate-right' | 'move' | 'move-left' | 'move-right' | 'import-document' | 'spacer' | 'undo' | 'redo' | 'select-all' | 'select-none';
+type BuiltInDocumentEditorToolbarItem = 'add' | 'remove' | 'duplicate' | 'rotate-left' | 'rotate-right' | 'move' | 'move-left' | 'move-right' | 'import-document' | 'extract-pages' | 'spacer' | 'undo' | 'redo' | 'select-all' | 'select-none' | 'zoom-out' | 'zoom-in';
 /**
  * Describes the properties of a Document Editor Toolbar Item.
  *
@@ -12302,6 +12302,7 @@ type IWheelZoomMode = (typeof WheelZoomMode)[keyof typeof WheelZoomMode];
 /**
  * This object contains configuration options for zooming. It allows granular control over the viewer zooming behavior.
  * @public
+ * @typedef {Object} ZoomConfiguration
  * @memberof PSPDFKit
  * @summary Object containing setup for zooming.
  * @example
@@ -12327,7 +12328,6 @@ type IWheelZoomMode = (typeof WheelZoomMode)[keyof typeof WheelZoomMode];
  *     },
  *   },
  * });
- * @memberof PSPDFKit
  * @property {PSPDFKit.ZoomMode | undefined} zoomMode {@link PSPDFKit.ZoomMode} - Defines the zoom mode to use.
  * @property {PSPDFKit.WheelZoomMode | undefined} wheelZoomMode {@link PSPDFKit.WheelZoomMode} - Defines the scroll zoom mode to use.
  * @property {PSPDFKit.ZoomOptions | undefined} options - The zoom options to use.
@@ -12537,7 +12537,7 @@ type BuiltInAnnotationToolbarItem = {
     type: IAnnotationToolbarType;
 };
 type Shared = Omit<ToolItem, 'selected' | 'type'> & {
-    onPress?: (nativeEvent: MouseEvent, id?: string) => void;
+    onPress?: (nativeEvent: MouseEvent, id?: string | undefined) => void;
     iconClassName?: string;
     onIconPress?: (nativeEvent: MouseEvent, id?: string) => void;
 };
@@ -12718,7 +12718,7 @@ type OCGLayersVisibilityState = {
 };
 
 type ViewStateSetter = (currentState: ViewState) => ViewState;
-type ToolbarItemsSetter = (currentState: ToolbarItem[]) => ToolbarItem[];
+type ToolbarItemsSetter = (currentState: ToolbarItem$1[]) => ToolbarItem$1[];
 type StoredSignaturesSetter = (annotations: List<InkAnnotation | ImageAnnotation>) => List<InkAnnotation | ImageAnnotation>;
 type SearchStateSetter = (currentState: SearchState) => SearchState;
 type AnnotationPresetsSetter = (currentState: Record<string, AnnotationPreset$1>) => Record<string, AnnotationPreset$1>;
@@ -12744,6 +12744,7 @@ declare class Instance {
     getTextFromRects: (pageIndex: number, rects: List<Rect>) => Promise<string>;
     getDocumentPermissions: () => Promise<Record<IDocumentPermissions, boolean>>;
     currentZoomLevel: number;
+    annotationCreatorName: string | null;
     maximumZoomLevel: number;
     minimumZoomLevel: number;
     zoomStep: number;
@@ -12761,7 +12762,7 @@ declare class Instance {
     transformPageToRawSpace: (rect: Rect, pageIndex: number) => Inset;
     exportOffice: (options: ExportOfficeFlags) => Promise<ArrayBuffer>;
     exportPDF: (flags?: ExportPDFFlags) => Promise<ArrayBuffer>;
-    exportXFDF: () => Promise<string>;
+    exportXFDF: (ignorePageRotation?: boolean) => Promise<string>;
     exportInstantJSON: (version?: number) => Promise<InstantJSON>;
     renderPageAsArrayBuffer: (options: {
         width: number;
@@ -12793,8 +12794,8 @@ declare class Instance {
     contentDocument: Document | ShadowRoot;
     readonly viewState: ViewState;
     setViewState: (stateOrFunction: ViewStateSetter | ViewState) => void;
-    readonly toolbarItems: ToolbarItem[];
-    setToolbarItems: (stateOrFunction: ToolbarItemsSetter | ToolbarItem[]) => void;
+    readonly toolbarItems: ToolbarItem$1[];
+    setToolbarItems: (stateOrFunction: ToolbarItemsSetter | ToolbarItem$1[]) => void;
     setAnnotationToolbarItems: (annotationToolbarItemsCallback: AnnotationToolbarItemsCallback) => void;
     setInlineTextSelectionToolbarItems: (InlineTextSelectionToolbarItemsCallback: InlineTextSelectionToolbarItemsCallback) => void;
     annotationPresets: Record<AnnotationPresetID$1, AnnotationPreset$1>;
@@ -12813,7 +12814,7 @@ declare class Instance {
     getFormFields: () => Promise<List<FormField>>;
     getFormFieldValues: () => Record<string, null | string | Array<string>>;
     setFormFieldValues: (formFieldValues: Record<string, null | string | Array<string>>) => void;
-    getTextSelection: () => Record<string, any> | null | undefined;
+    getTextSelection: () => PublicTextSelection | null | undefined;
     getSelectedAnnotation: () => AnnotationsUnion | null | undefined;
     getSelectedAnnotations: () => List<AnnotationsUnion> | null | undefined;
     getAnnotationsGroups: () => Map<string, {
@@ -12891,7 +12892,6 @@ declare class Instance {
     getEmbeddedFiles: () => Promise<List<EmbeddedFile>>;
     getPageTabOrder: (pageIndex: number) => Promise<ID[]>;
     setPageTabOrder: (pageIndex: number, annotationIdsSortCallback: (tabOrderedAnnotations: AnnotationsUnion[]) => ID[]) => Promise<void>;
-    enableAlwaysScrollToZoom: boolean;
 }
 
 /**
@@ -13185,7 +13185,6 @@ interface IViewState {
     resolvedLayoutMode: ILayoutMode;
     sidebarWidth: number;
     disablePointSnapping: boolean;
-    enableAlwaysScrollToZoom: boolean;
     forceRenderWidgetsInAnnotationsOrder: boolean;
     prerenderedPageSpreads: number | null;
     showAIAssistant: boolean;
@@ -13871,77 +13870,34 @@ interface IHighlightState {
     rectsOnPage: List<Rect>;
 }
 
-declare const textComparisonActionCreators: {
-    setInstances: (payload: {
-        instanceA: Instance;
-        instanceB: Instance;
-    }) => {
-        type: "SET_INSTANCES";
-        payload: {
-            instanceA: Instance;
-            instanceB: Instance;
-        };
-    };
-    setToolbarItems: (payload: any) => {
-        type: "SET_TOOLBAR_ITEMS";
-        payload: any;
-    };
-    setInnerToolbarItems: (payload: any) => {
-        type: "SET_INNER_TOOLBAR_ITEMS";
-        payload: any;
-    };
-    setComparisonSidebarConfig: (payload: any) => {
-        type: "SET_COMPARISON_SIDEBAR_CONFIG";
-        payload: any;
-    };
-    setScrollLock: (payload: boolean) => {
-        type: "SET_SCROLL_LOCK";
-        payload: boolean;
-    };
-    setComparisonVisibility: (payload: boolean) => {
-        type: "SET_COMPARISON_VISIBILITY";
-        payload: boolean;
-    };
-    setTextComparisonChanges: (payload: List<TextComparisonChange>) => {
-        type: "SET_TEXT_COMPARISON_CHANGES";
-        payload: List<TextComparisonChange>;
-    };
-    setCurrentChangeIndex: (payload: number) => {
-        type: "SET_CURRENT_CHANGE_INDEX";
-        payload: number;
-    };
-};
-type ActionCreators = typeof textComparisonActionCreators;
-type TextComparisonAction = ReturnType<ActionCreators[keyof ActionCreators]>;
-
 /**
- * Describes the properties of a Text Comparison Toolbar Item.
+ * Describes the properties of a Text Comparison Instance Toolbar Item.
  * @public
  * @memberof PSPDFKit
- * @interface TextComparisonToolbarItem
+ * @interface TextComparisonInnerToolbarItem
  * @extends PSPDFKit.ToolItem
- * @seealso PSPDFKit.TextComparisonInstance#setToolbarItems PSPDFKit.TextComparisonConfiguration#toolbarItems
+ * @seealso PSPDFKit.TextComparisonInstance#setInnerToolbarItems PSPDFKit.TextComparisonConfiguration#instanceToolbarItems
  */
 /**
  * ***required***
  *
- * The type of a text comparison toolbar item.
+ * The type of a text comparison instance toolbar item.
  *
- * It can either be `custom` for user defined items or one from the {@link PSPDFKit.defaultTextComparisonToolbarItems}.
+ * It can either be `custom` for user defined items or one from the {@link PSPDFKit.defaultTextComparisonInnerToolbarItems}.
  *
  * Note: It is ***not*** possible to override this option for built-in toolbar items.
  * @example
  * // In your JavaScript
- * const toolbarItems = PSPDFKit.defaultTextComparisonToolbarItems
- * toolbarItems.push({ type: 'custom', ... })
+ * const innerToolbarItems = PSPDFKit.defaultTextComparisonInnerToolbarItems
+ * innerToolbarItems.push({ type: 'custom', ... })
  * PSPDFKit.loadTextComparison({
  *  ...otherOptions,
- *  toolbarItems
+ *  innerToolbarItems,
  * });
  * @public
  * @instance
  * @member {string} type
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Unique identifier for the item.
@@ -13949,67 +13905,67 @@ type TextComparisonAction = ReturnType<ActionCreators[keyof ActionCreators]>;
  * This is useful to identify items whose `type` is `custom`.
  * @example
  * // In your JavaScript
- * const toolbarItems = PSPDFKit.defaultTextComparisonToolbarItems
- * toolbarItems.push({ type: 'custom', id: 'my-button', ... })
+ * const innerToolbarItems = PSPDFKit.defaultTextComparisonInnerToolbarItems
+ * innerToolbarItems.push({ type: 'custom', id: 'my-button', ... })
  * PSPDFKit.loadTextComparison({
  *  ...otherOptions,
- *  toolbarItems
+ *  innerToolbarItems,
  * });
  *
  * Note: It is ***not*** possible to override this option for built-in text comparison toolbar items.
  * @public
  * @instance
  * @member {?string} id
- * @memberof PSPDFKit.ToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Useful to set a custom CSS class name on the item.
  *
- * For {@link PSPDFKit.defaultTextComparisonToolbarItems|default text comparison toolbar items} the `className` is appended to the default
+ * For {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default text comparison instance toolbar items} the `className` is appended to the default
  * item ones.
  * @public
  * @instance
  * @member {?string} className
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Icon for the item.
  *
  * The icon should either be an URL, a base64 encoded image or the HTML for an inline SVG.
- * This property can override the {@link PSPDFKit.defaultTextComparisonToolbarItems|default items}' ones.
+ * This property can override the {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default items}' ones.
  * @public
  * @instance
  * @member {?string} icon
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Whether a custom item is selected or not.
  *
- * The selected status of {@link PSPDFKit.defaultTextComparisonToolbarItems|default items} cannot be altered.
+ * The selected status of {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default items} cannot be altered.
  *
- * Note: It is ***not*** possible to override this option for built-in text comparison toolbar items.
+ * Note: It is ***not*** possible to override this option for built-in text comparison instance toolbar items.
  * @public
  * @instance
  * @member {?boolean} selected
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Whether the item is disabled or not.
  *
- * The property can be used to force a {@link PSPDFKit.defaultTextComparisonToolbarItems|default item} to be
+ * The property can be used to force a {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default item} to be
  * disabled by setting it to `true`.
  * @public
  * @instance
  * @member {?boolean} disabled
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * Callback to invoke when the item is clicked or tapped (on touch devices). It gets the `event` as
  * first argument, a document editor UI handler object as the second, and the `id` of the tool item as the third.
  * @public
  * @instance
- * @member {?PSPDFKit.TextComparisonToolbarItem.OnPressCallback} onPress
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @member {?PSPDFKit.TextComparisonInnerToolbarItem.OnPressCallback} onPress
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
 /**
  * @public
@@ -14017,45 +13973,45 @@ type TextComparisonAction = ReturnType<ActionCreators[keyof ActionCreators]>;
  * @param {MouseEvent|KeyboardEvent} event The event that is fired on press. `onPress` is also fired when pressing enter while the item has focus.
  * @param {PSPDFKit.DocumentEditorUIHandler} documentEditorUIHandler An instance object to set and retrieve different state properties of the document editor UI.
  * @param {string} id The tool item id.
- * @memberof PSPDFKit.TextComparisonToolbarItem
+ * @memberof PSPDFKit.TextComparisonInnerToolbarItem
  */
-declare const allowedTextComparisonToolbarItem: string[];
-type TextComparisonToolbarItemType = ToolItemType | (typeof allowedTextComparisonToolbarItem)[number];
-type TextComparisonToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
-    type: TextComparisonToolbarItemType;
+declare const allowedTextComparisonInnerToolbarItem: string[];
+type TextComparisonInnerToolbarItemType = ToolItemType | (typeof allowedTextComparisonInnerToolbarItem)[number];
+type TextComparisonInnerToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
+    type: TextComparisonInnerToolbarItemType;
     mediaQueries?: string[];
     responsiveGroup?: string;
     dropdownGroup?: string;
 };
 
 /**
- * Describes the properties of a Text Comparison Instance Toolbar Item.
+ * Describes the properties of a Text Comparison Toolbar Item.
  * @public
  * @memberof PSPDFKit
- * @interface TextComparisonInnerToolbarItem
+ * @interface TextComparisonToolbarItem
  * @extends PSPDFKit.ToolItem
- * @seealso PSPDFKit.TextComparisonInstance#setInnerToolbarItems PSPDFKit.TextComparisonConfiguration#instanceToolbarItems
+ * @seealso PSPDFKit.TextComparisonInstance#setToolbarItems PSPDFKit.TextComparisonConfiguration#toolbarItems
  */
 /**
  * ***required***
  *
- * The type of a text comparison instance toolbar item.
+ * The type of a text comparison toolbar item.
  *
- * It can either be `custom` for user defined items or one from the {@link PSPDFKit.defaultTextComparisonInnerToolbarItems}.
+ * It can either be `custom` for user defined items or one from the {@link PSPDFKit.defaultTextComparisonToolbarItems}.
  *
  * Note: It is ***not*** possible to override this option for built-in toolbar items.
  * @example
  * // In your JavaScript
- * const innerToolbarItems = PSPDFKit.defaultTextComparisonInnerToolbarItems
- * innerToolbarItems.push({ type: 'custom', ... })
+ * const toolbarItems = PSPDFKit.defaultTextComparisonToolbarItems
+ * toolbarItems.push({ type: 'custom', ... })
  * PSPDFKit.loadTextComparison({
  *  ...otherOptions,
- *  innerToolbarItems,
+ *  toolbarItems
  * });
  * @public
  * @instance
  * @member {string} type
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * Unique identifier for the item.
@@ -14063,67 +14019,67 @@ type TextComparisonToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
  * This is useful to identify items whose `type` is `custom`.
  * @example
  * // In your JavaScript
- * const innerToolbarItems = PSPDFKit.defaultTextComparisonInnerToolbarItems
- * innerToolbarItems.push({ type: 'custom', id: 'my-button', ... })
+ * const toolbarItems = PSPDFKit.defaultTextComparisonToolbarItems
+ * toolbarItems.push({ type: 'custom', id: 'my-button', ... })
  * PSPDFKit.loadTextComparison({
  *  ...otherOptions,
- *  innerToolbarItems,
+ *  toolbarItems
  * });
  *
  * Note: It is ***not*** possible to override this option for built-in text comparison toolbar items.
  * @public
  * @instance
  * @member {?string} id
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.ToolbarItem
  */
 /**
  * Useful to set a custom CSS class name on the item.
  *
- * For {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default text comparison instance toolbar items} the `className` is appended to the default
+ * For {@link PSPDFKit.defaultTextComparisonToolbarItems|default text comparison toolbar items} the `className` is appended to the default
  * item ones.
  * @public
  * @instance
  * @member {?string} className
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * Icon for the item.
  *
  * The icon should either be an URL, a base64 encoded image or the HTML for an inline SVG.
- * This property can override the {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default items}' ones.
+ * This property can override the {@link PSPDFKit.defaultTextComparisonToolbarItems|default items}' ones.
  * @public
  * @instance
  * @member {?string} icon
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * Whether a custom item is selected or not.
  *
- * The selected status of {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default items} cannot be altered.
+ * The selected status of {@link PSPDFKit.defaultTextComparisonToolbarItems|default items} cannot be altered.
  *
- * Note: It is ***not*** possible to override this option for built-in text comparison instance toolbar items.
+ * Note: It is ***not*** possible to override this option for built-in text comparison toolbar items.
  * @public
  * @instance
  * @member {?boolean} selected
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * Whether the item is disabled or not.
  *
- * The property can be used to force a {@link PSPDFKit.defaultTextComparisonInnerToolbarItems|default item} to be
+ * The property can be used to force a {@link PSPDFKit.defaultTextComparisonToolbarItems|default item} to be
  * disabled by setting it to `true`.
  * @public
  * @instance
  * @member {?boolean} disabled
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * Callback to invoke when the item is clicked or tapped (on touch devices). It gets the `event` as
  * first argument, a document editor UI handler object as the second, and the `id` of the tool item as the third.
  * @public
  * @instance
- * @member {?PSPDFKit.TextComparisonInnerToolbarItem.OnPressCallback} onPress
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @member {?PSPDFKit.TextComparisonToolbarItem.OnPressCallback} onPress
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
 /**
  * @public
@@ -14131,12 +14087,12 @@ type TextComparisonToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
  * @param {MouseEvent|KeyboardEvent} event The event that is fired on press. `onPress` is also fired when pressing enter while the item has focus.
  * @param {PSPDFKit.DocumentEditorUIHandler} documentEditorUIHandler An instance object to set and retrieve different state properties of the document editor UI.
  * @param {string} id The tool item id.
- * @memberof PSPDFKit.TextComparisonInnerToolbarItem
+ * @memberof PSPDFKit.TextComparisonToolbarItem
  */
-declare const allowedTextComparisonInnerToolbarItem: string[];
-type TextComparisonInnerToolbarItemType = ToolItemType | (typeof allowedTextComparisonInnerToolbarItem)[number];
-type TextComparisonInnerToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
-    type: TextComparisonInnerToolbarItemType;
+declare const allowedTextComparisonToolbarItem: string[];
+type TextComparisonToolbarItemType = ToolItemType | (typeof allowedTextComparisonToolbarItem)[number];
+type TextComparisonToolbarItem = Omit<ToolItem, 'type' | 'onPress'> & {
+    type: TextComparisonToolbarItemType;
     mediaQueries?: string[];
     responsiveGroup?: string;
     dropdownGroup?: string;
@@ -14394,6 +14350,49 @@ type StandaloneTextComparisonConfiguration = SharedTextComparisonConfiguration &
 };
 type TextComparisonConfiguration = StandaloneTextComparisonConfiguration;
 
+declare const textComparisonActionCreators: {
+    setInstances: (payload: {
+        instanceA: Instance;
+        instanceB: Instance;
+    }) => {
+        type: "SET_INSTANCES";
+        payload: {
+            instanceA: Instance;
+            instanceB: Instance;
+        };
+    };
+    setToolbarItems: (payload: List<ToolbarItem>) => {
+        type: "SET_TOOLBAR_ITEMS";
+        payload: List<ToolbarItem$1>;
+    };
+    setInnerToolbarItems: (payload: List<TextComparisonInnerToolbarItem>) => {
+        type: "SET_INNER_TOOLBAR_ITEMS";
+        payload: List<TextComparisonInnerToolbarItem>;
+    };
+    setComparisonSidebarConfig: (payload: TextComparisonSidebarConfiguration) => {
+        type: "SET_COMPARISON_SIDEBAR_CONFIG";
+        payload: TextComparisonSidebarConfiguration;
+    };
+    setScrollLock: (payload: boolean) => {
+        type: "SET_SCROLL_LOCK";
+        payload: boolean;
+    };
+    setComparisonVisibility: (payload: boolean) => {
+        type: "SET_COMPARISON_VISIBILITY";
+        payload: boolean;
+    };
+    setTextComparisonChanges: (payload: List<TextComparisonChange>) => {
+        type: "SET_TEXT_COMPARISON_CHANGES";
+        payload: List<TextComparisonChange>;
+    };
+    setCurrentChangeIndex: (payload: number) => {
+        type: "SET_CURRENT_CHANGE_INDEX";
+        payload: number;
+    };
+};
+type ActionCreators = typeof textComparisonActionCreators;
+type TextComparisonAction = ReturnType<ActionCreators[keyof ActionCreators]>;
+
 interface TextComparisonState {
     instanceA: Instance | null;
     instanceB: Instance | null;
@@ -15132,6 +15131,19 @@ type IProcessorEngine = (typeof ProcessorEngine)[keyof typeof ProcessorEngine];
  * @member {string} documentId
  * @memberof PSPDFKit.Configuration
  */
+/**
+ * ***Server only***
+ *
+ * The `session` token used to authenticate Web Viewer session with DWS Viewer API or Document Engine.
+ *
+ * @example
+ * PSPDFKit.load({ session: 'xxx.xxx.xxx' });
+ * @public
+ * @server
+ * @instance
+ * @member {string} session
+ * @memberof PSPDFKit.Configuration
+ */
 /**
  * ***required, Server only***
  *
@@ -15340,7 +15352,6 @@ type IProcessorEngine = (typeof ProcessorEngine)[keyof typeof ProcessorEngine];
  *
  * If your assets are served from a different origin, you have to include proper CORS headers:
  * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS}
- *
  * @example
  * PSPDFKit.load({ baseUrl: 'https://public-server.pspdfkit.com/' });
  * @instance
@@ -16898,7 +16909,7 @@ type SharedConfiguration = {
     baseUrl?: string;
     serverUrl?: string;
     styleSheets?: Array<string>;
-    toolbarItems?: Array<ToolbarItem>;
+    toolbarItems?: Array<ToolbarItem$1>;
     annotationPresets?: Record<AnnotationPresetID$1, AnnotationPreset$1>;
     stampAnnotationTemplates?: Array<StampAnnotation | ImageAnnotation>;
     autoSaveMode?: IAutoSaveMode;
@@ -16962,20 +16973,26 @@ type SharedConfiguration = {
     disableWebAssemblyStreaming?: boolean;
     overrideMemoryLimit?: number;
     baseCoreUrl?: string;
+    unifiedCommentsSupport?: boolean;
 };
 type Instant = {
     public: boolean;
 };
-type ServerConfiguration = SharedConfiguration & {
-    documentId: string;
+type ServerAuthPayloadConfiguration = {
     authPayload: {
         jwt: string;
     };
+};
+type ServerSessionAuthConfiguration = {
+    session: string;
+};
+type ServerConfiguration = SharedConfiguration & {
     instant: Instant[keyof Instant];
     anonymousComments?: boolean;
     mentionableUsers?: Array<MentionableUser>;
     maxMentionSuggestions?: number;
-};
+    documentId?: string;
+} & (ServerAuthPayloadConfiguration | ServerSessionAuthConfiguration);
 type StandaloneConfiguration = SharedConfiguration & {
     document: string | ArrayBuffer;
     baseProcessorEngineUrl?: string;
@@ -17763,6 +17780,7 @@ declare class DocumentDescriptor extends DocumentDescriptor_base {
     constructor(documentDescriptorOptions: IDocumentDescriptor);
 }
 
+type ToolbarItem = ToolbarItem$1;
 type AnnotationPreset = AnnotationPreset$1;
 type AnnotationPresetID = AnnotationPresetID$1;
 
@@ -19183,7 +19201,7 @@ declare const PSPDFKit: {
         readonly TYPE: "TYPE";
     };
     I18n: {
-        readonly locales: any;
+        readonly locales: string[];
         readonly messages: Record<string, Record<string, string>>;
         readonly preloadLocalizationData: (locale: string, options?: {
             baseUrl?: string | undefined;
@@ -19465,73 +19483,7 @@ declare const PSPDFKit: {
         TEXT_MARKUP_COLOR_PRESETS: ColorPreset[];
         NOTE_COLOR_PRESETS: ColorPreset[];
         PDF_JAVASCRIPT: boolean;
-        BREAKPOINT_MD_TOOLBAR: number; /**
-         * Annotation free rotate helper. Rotates a {@link AnnotationsUnion} by the provided angle in degrees,
-         * counter-clockwise. It only works with free rotatable annotations, such as {@link PSPDFKit.Annotations.TextAnnotation},
-         * {@link PSPDFKit.Annotations.ImageAnnotation} and {@link PSPDFKit.Annotations.StampAnnotation}.
-         *
-         * In order to rotate an annotation it's not enough to just change the rotation property. The annotation's
-         * bounding box need to be resized and repositioned as well so as to fit the rotated content inside.
-         *
-         * This helper facilitates this task by updating both the rotation property and the bounding box.
-         * @example <caption>Rotate a text annotation to 110 degrees.</caption>
-         * const annotation = new PSPDFKit.Annotations.TextAnnotation({
-         *   text: `This is a test text for rotating
-         * an annotation to 110 degrees.`,
-         *   boundingBox: new PSPDFKit.Geometry.Rect({
-         *     x: 300,
-         *     y: 300,
-         *     width: 246,
-         *     height: 44
-         *   }),
-         *   fontSize: 18,
-         *   font: "Helvetica"
-         * });
-         * const rotatedAnnotation = PSPDFKit.Annotations.rotate(
-         *   annotation,
-         *   110
-         * );
-         * instance.create(rotatedAnnotation.set('pageIndex', 0));
-         *
-         * There is an edge case where the original annotation is already rotated by a multiple of 45 degrees. In this case
-         * it's not possible to figure out the dimensions of the content, which will default to a square that fits in the bounding box.
-         * In order to use the correct content dimensions, you can optionally provide a {@link PSPDFKit.Geometry.Size} object
-         * that specifies the content's width and height, which should fit in the annotation's bounding box when using the
-         * annotation rotation.
-         *
-         * For cases when the original annotation is rotated by any other angle, the content dimensions are calculated automatically,
-         * but you can still provide this object if the annotation's bounding box does not correctly bound the content, so as to obtain
-         * an annotation with a correctly bounding box as a result.
-         * @example <caption>Rotate a 45 degree rotated annotation to 60 degrees.</caption>
-         * const rotated45Annotation = new PSPDFKit.Annotations.TextAnnotation({
-         *   text: `This is a test text for a 45
-         * degree rotated text annotation.`,
-         *   rotation: 45,
-         *   boundingBox: new PSPDFKit.Geometry.Rect({
-         *     x: 300,
-         *     y: 300,
-         *     width: 348,
-         *     height: 348
-         *   }),
-         *   fontSize: 18,
-         *   font: "Helvetica"
-         * });
-         * const rotated60Annotation = PSPDFKit.Annotations.rotate(
-         *   rotated45Annotation,
-         *   60,
-         *   new PSPDFKit.Geometry.Size({ width: 246, height: 44 })
-         * );
-         * instance.create(rotated60Annotation.set('pageIndex', 0));
-         *
-         * This helper does not check if the resulting rotated annotation overflows the page limits.
-         * @public
-         * @function rotate
-         * @memberof PSPDFKit.Annotations
-         * @param {PSPDFKit.Annotations.TextAnnotation | PSPDFKit.Annotations.ImageAnnotation | PSPDFKit.Annotations.StampAnnotation}
-         * @param {number} rotation Rotation angle in degrees
-         * @param {?PSPDFKit.Geometry.Size} contentSize Size of the annotation's content for annotations rotated a in multiple of 45 degrees.
-         * @returns {PSPDFKit.Annotations.TextAnnotation | PSPDFKit.Annotations.ImageAnnotation | PSPDFKit.Annotations.StampAnnotation}
-         */
+        BREAKPOINT_MD_TOOLBAR: number;
         BREAKPOINT_SM_TOOLBAR: number;
     };
     SearchPattern: {
@@ -19571,4 +19523,5 @@ declare const PSPDFKit: {
 
 type _Interfaces = Record<string, string>;
 
-export { Action, Annotation, type AnnotationJSONUnion, type AnnotationToolbarItem, type AnnotationsUnion, AnnotationsWillChangeReason, Bookmark, type BuildInput, type BuildInstructions, ButtonFormField, CheckBoxFormField, ChoiceFormField, Color, ComboBoxFormField, Comment, CommentMarkerAnnotation, type Configuration, Conformance, CustomOverlayItem, type DocumentEditorFooterItem, type DocumentEditorToolbarItem, DrawingPoint, EllipseAnnotation, type EllipseAnnotationJSON, Font, FormField, FormFieldValue, FormOption, GoToAction, GoToEmbeddedAction, GoToRemoteAction, HideAction, HighlightAnnotation, HighlightState, ImageAnnotation, type ImageAnnotationJSON, InkAnnotation, type InkAnnotationJSON, Inset, Instance, InstantClient, type _Interfaces as Interfaces, JavaScriptAction, LaunchAction, LineAnnotation, type LineAnnotationJSON, LinkAnnotation, List, ListBoxFormField, type MentionableUser, NamedAction, NoteAnnotation, type NoteAnnotationJSON, OutlineElement, PageInfo, Point, PolygonAnnotation, type PolygonAnnotationJSON, PolylineAnnotation, type PolylineAnnotationJSON, type ProcessingAuthPayload, RadioButtonFormField, Rect, RectangleAnnotation, type RectangleAnnotationJSON, RedactionAnnotation, type RedactionAnnotationJSON, ResetFormAction, SearchResult, SearchState, type ServerConfiguration, Set, ShapeAnnotation, type ShapeAnnotationsUnion, SignatureFormField, Size, SquiggleAnnotation, StampAnnotation, type StampAnnotationJSON, type StandaloneConfiguration, StrikeOutAnnotation, SubmitFormAction, type TemplateDataToPopulateDocument, TextAnnotation, type TextAnnotationJSON, _default as TextComparisonConfiguration, TextComparisonInstance, TextFormField, TextLine, TextMarkupAnnotation, type TextMarkupAnnotationJSON, type TextMarkupAnnotationsUnion, PublicTextSelection as TextSelection, type ToolbarItem, URIAction, UnderlineAnnotation, UnknownAnnotation, type UnknownAnnotationJSON, ViewState, WidgetAnnotation, type WidgetAnnotationJSON, PSPDFKit as default };
+export { Action, Annotation, AnnotationsWillChangeReason, Bookmark, ButtonFormField, CheckBoxFormField, ChoiceFormField, Color, ComboBoxFormField, Comment, CommentMarkerAnnotation, Conformance, CustomOverlayItem, DrawingPoint, EllipseAnnotation, Font, FormField, FormFieldValue, FormOption, GoToAction, GoToEmbeddedAction, GoToRemoteAction, HideAction, HighlightAnnotation, HighlightState, ImageAnnotation, InkAnnotation, Inset, Instance, InstantClient, JavaScriptAction, LaunchAction, LineAnnotation, LinkAnnotation, List, ListBoxFormField, NamedAction, NoteAnnotation, OutlineElement, PageInfo, Point, PolygonAnnotation, PolylineAnnotation, RadioButtonFormField, Rect, RectangleAnnotation, RedactionAnnotation, ResetFormAction, SearchResult, SearchState, Set, ShapeAnnotation, SignatureFormField, Size, SquiggleAnnotation, StampAnnotation, StrikeOutAnnotation, SubmitFormAction, TextAnnotation, _default as TextComparisonConfiguration, TextComparisonInstance, TextFormField, TextLine, TextMarkupAnnotation, PublicTextSelection as TextSelection, URIAction, UnderlineAnnotation, UnknownAnnotation, ViewState, WidgetAnnotation, PSPDFKit as default };
+export type { AnnotationJSONUnion, AnnotationToolbarItem, AnnotationsUnion, BuildInput, BuildInstructions, Configuration, DocumentEditorFooterItem, DocumentEditorToolbarItem, EllipseAnnotationJSON, ImageAnnotationJSON, InkAnnotationJSON, _Interfaces as Interfaces, LineAnnotationJSON, MentionableUser, NoteAnnotationJSON, PolygonAnnotationJSON, PolylineAnnotationJSON, ProcessingAuthPayload, RectangleAnnotationJSON, RedactionAnnotationJSON, ServerConfiguration, ShapeAnnotationsUnion, StampAnnotationJSON, StandaloneConfiguration, TemplateDataToPopulateDocument, TextAnnotationJSON, TextMarkupAnnotationJSON, TextMarkupAnnotationsUnion, ToolbarItem$1 as ToolbarItem, UnknownAnnotationJSON, WidgetAnnotationJSON };