@nutrient-sdk/viewer 1.7.0-nightly.20250903 → 1.7.0-nightly.20250905

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-
+// @ts-nocheck
 /**
  * This class should be used to create custom Immutable Record. It will overwrite the default
  * `Immutable#equals()` method to include the class name. if we don't do this, two different classes
@@ -469,7 +468,7 @@ T;
  * @property {string} summary - AI-generated summary of document changes
  * @property {string[]} categories - Array of AI-detected change categories
  * @property {DocumentComparisonResult} changes - Standard document comparison result
- * @property {AIComparisonPhase} phase - Current phase of the AI comparison process
+ * @property {IAIComparisonPhase} phase - Current phase of the AI comparison process
  * @property {AIComparisonError | null} error - Error information if comparison failed
  * @property {AIADocumentChangeTaggingItem[]} [taggedChanges] - Changes tagged with categories (optional)
  * @property {AIADocumentChangePayload[]} [transformedChanges] - Transformed changes for AI processing (optional)
@@ -479,7 +478,7 @@ declare interface AIComparisonData {
   summary: string;
   categories: string[];
   changes: DocumentComparisonResult;
-  phase: AIComparisonPhase;
+  phase: IAIComparisonPhase;
   error: AIComparisonError | null;
   taggedChanges?: AIADocumentChangeTaggingItem[];
   transformedChanges?: AIADocumentChangePayload[];
@@ -524,13 +523,13 @@ declare const AIComparisonOperationType: {
  * @property {NutrientViewer.AIComparisonPhase} COMPLETED Comparison process completed successfully
  * @property {NutrientViewer.AIComparisonPhase} ERROR Error occurred during comparison
  */
-declare enum AIComparisonPhase {
-  IDLE = "IDLE",
-  LOADING = "LOADING",
-  ANALYZING = "ANALYZING",
-  TAGGING = "TAGGING",
-  COMPLETED = "COMPLETED",
-  ERROR = "ERROR",}
+declare const AIComparisonPhase: {
+  readonly IDLE: "IDLE";
+  readonly LOADING: "LOADING";
+  readonly ANALYZING: "ANALYZING";
+  readonly TAGGING: "TAGGING";
+  readonly COMPLETED: "COMPLETED";
+  readonly ERROR: "ERROR";};
 
 /**
  * Result returned by AI-powered document comparison operations. This union type represents
@@ -621,7 +620,7 @@ declare const allowedTextComparisonInnerToolbarItem: string[];
  */
 declare const allowedTextComparisonToolbarItem: string[];
 
-declare const allowedToolbarTypes: ("text" | "search" | "link" | "ellipse" | "image" | "line" | "polygon" | "polyline" | "spacer" | "note" | "distance" | "comment" | "zoom-in" | "zoom-out" | "callout" | "arrow" | "highlighter" | "undo" | "redo" | "custom" | "signature" | "print" | "ink" | "pager" | "pan" | "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" | "pager-expanded" | "sidebar-thumbnails" | "sidebar-document-outline" | "sidebar-annotations" | "sidebar-bookmarks" | "sidebar-signatures" | "sidebar-attachments" | "sidebar-layers" | "multi-annotations-selection" | "zoom-mode" | "linearized-download-indicator" | "annotate" | "text-highlighter" | "ink-eraser" | "stamp" | "rectangle" | "cloudy-polygon" | "document-editor" | "document-crop" | "export-pdf" | "debug")[];
+declare const allowedToolbarTypes: ("text" | "search" | "link" | "ellipse" | "image" | "line" | "polygon" | "polyline" | "spacer" | "note" | "distance" | "comment" | "zoom-in" | "zoom-out" | "callout" | "arrow" | "highlighter" | "undo" | "redo" | "custom" | "signature" | "print" | "ink" | "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" | "pager-expanded" | "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-editor" | "document-crop" | "export-pdf" | "debug")[];
 
 /**
  * @classdesc
@@ -5565,6 +5564,13 @@ declare class CommentMarkerAnnotationSerializer extends AnnotationSerializer {
   toJSON(): CommentMarkerAnnotationJSON;
   static fromJSON(id: InstantID | null, json: Omit<CommentMarkerAnnotationJSON, 'id' | 'group' | 'permissions'>, options?: ICollaboratorPermissionsOptions): CommentMarkerAnnotation;}
 
+declare type CommentParams = {
+  /**
+   * Unique ID for the comment.
+   */
+  id: string;};
+
+
 declare function CommentPermissionMixin<T extends Class<BaseMixin>>(Base: T): {
   new (...args: any[]): {
     /**
@@ -5850,6 +5856,64 @@ declare function CommentsMixin<T extends Class<BaseMixin>>(Base: T): {
 
 T;
 
+declare type CommentThreadParams = {
+  /**
+   * ID for the comment thread.
+   */
+  id: string;};
+
+
+/**
+ * Slots for partial customization of the comment thread.
+ */
+declare type CommentThreadUI = {
+  /**
+   * Use this to render a custom UI in the header (top area) of the UI.
+   */
+  header?: UIFactory<CommentThreadParams>;
+  /**
+   * Use this to render a custom UI in the footer (bottom area) of the UI.
+   */
+  footer?: UIFactory<CommentThreadParams>;
+  /**
+   * Use this to customize the editor area.
+   */
+  editor?: UIFactory<CommentThreadParams>;
+  /**
+   * Use this to customize each comment fully or provide slots for partial customization.
+   */
+  comment?: CommentUIConfig;};
+
+
+declare type CommentThreadUIConfig = CommentThreadUIFactory | CommentThreadUI;
+
+/**
+ * UI function for full customization of CommentThread.
+ */
+declare type CommentThreadUIFactory = UIFactory<CommentThreadParams>;
+
+declare type CommentUI = {
+  /**
+   * Use this to render a custom UI in the header (top area) of the UI.
+   */
+  header?: UIFactory<CommentParams>;
+  /**
+   * Use this to render a custom UI in the footer (bottom area) of the UI
+   */
+  footer?: UIFactory<CommentParams>;
+  /**
+   * Use this to customize the body of the comment.
+   */
+  body?: UIFactory<CommentParams>;};
+
+
+declare type CommentUIConfig = CommentUIFactory | CommentUI;
+
+/**
+ * UI function for full customization of Comment.
+ */
+declare type CommentUIFactory = UIFactory<CommentParams>;
+
 /**
  * Represents a pair of documents to be compared.
  * @public
@@ -8993,6 +9057,8 @@ declare interface IAIComparisonOperationOptions extends IComparisonOperationOpti
 
 declare type IAIComparisonOperationType = (typeof AIComparisonOperationType)[keyof typeof AIComparisonOperationType];
 
+declare type IAIComparisonPhase = (typeof AIComparisonPhase)[keyof typeof AIComparisonPhase];
+
 declare type IAlignment = (typeof Alignment)[keyof typeof Alignment];
 
 declare type IAnnotationJSON = Omit<BaseAnnotationJSON, 'id' | 'group' | 'permissions'>;
@@ -9468,12 +9534,7 @@ declare type ImportPageIndex = Array<number | Range_4>;
 declare interface INamedAction extends ActionCtorProps {
   action?: string;}
 
-declare class InheritableImmutableRecord<T extends Record<string, unknown>> extends InheritableImmutableRecord_base implements __dangerousImmutableRecordFactory<T> {
-  constructor(values?: Partial<T> | Iterable<[string, unknown]>);}
-
-declare interface InheritableImmutableRecord<T extends Record<string, unknown>> extends __dangerousImmutableRecordFactory<T> {}
-
-declare const InheritableImmutableRecord_base: unknown;
+declare const InheritableImmutableRecord: new <T extends Record<string, unknown>>(values?: Iterable<[string, unknown]> | Partial<T> | undefined) => __dangerousImmutableRecordFactory<T>;
 
 /**
  * The blend mode defines how the color of the annotation will be applied to its background.
@@ -10072,7 +10133,7 @@ declare interface IShapeAnnotation extends AnnotationProperties {
 
 declare type IShowSignatureValidationStatusMode = (typeof ShowSignatureValidationStatusMode)[keyof typeof ShowSignatureValidationStatusMode];
 
-declare type ISidebarMode = (typeof SidebarMode)[keyof typeof SidebarMode];
+declare type ISidebarMode = (typeof SidebarMode)[keyof typeof SidebarMode] | (string & {});
 
 declare type ISidebarPlacement = (typeof SidebarPlacement)[keyof typeof SidebarPlacement];
 
@@ -13293,6 +13354,7 @@ declare function MiscellaneousMixin<T extends Class<BaseMixin>>(Base: T): {
      * @param {NutrientViewer.CustomUIConfiguration | NutrientViewer.Instance~CustomUIConfigurationSetter} customUIConfigurationOrCustomUIConfigurationSetter
          */
     setCustomUIConfiguration(customUIConfigurationOrCustomUIConfigurationSetter: ((customUI: CustomUI | null) => CustomUI) | Partial<Record<"Sidebar", Partial<{
+      [x: string & {}]: Renderer;
       CUSTOM: Renderer;
       ANNOTATIONS: Renderer;
       BOOKMARKS: Renderer;
@@ -14404,6 +14466,14 @@ declare const NutrientViewer: {
     readonly ANALYZE: "analyze";
     readonly TAG: "tag";};
 
+  AIComparisonPhase: {
+    readonly IDLE: "IDLE";
+    readonly LOADING: "LOADING";
+    readonly ANALYZING: "ANALYZING";
+    readonly TAGGING: "TAGGING";
+    readonly COMPLETED: "COMPLETED";
+    readonly ERROR: "ERROR";};
+
   /**
    * Merges the properties extracted from the location.hash into the {@link NutrientViewer.ViewState}.
    *
@@ -20674,7 +20744,42 @@ declare type SharedConfiguration = {
    */
   onCommentCreationStart?: OnCommentCreationStartCallback;
   documentEditorConfiguration?: documentEditorUIConfig;
-  ui?: any;
+  /**
+   * In-place UI customization API for the supported components using slots.
+   * Refer to {@link https://www.nutrient.io/guides/web/user-interface/ui-customization/introduction/|this guide} to get started.
+   *
+   * Can be used to:
+   * - fully replace the default component UI with a custom one
+   * - insert a custom UI at a predefined slot in an existing component
+   * - replace an existing slot in a component with your own custom UI
+   *
+   * See the list of supported slots {@link https://www.nutrient.io/guides/web/user-interface/ui-customization/supported-slots/|here}.
+   * @example
+   * NutrientViewer.load({
+   *   ui: {
+   *     commentThread: {
+   *       header: (instance, id) => {
+   *         const header = document.createElement('div');
+   *         header.innerText = 'Custom Comment Thread Header';
+   *
+   *         return {
+   *           render: (params) => header,
+   *           onMount: (id) => {
+   *             console.log(`Comment thread header mounted`);
+   *           },
+   *           onUnmount: (id) => {
+   *             console.log(`Comment thread header unmounted`);
+   *           }
+   *         };
+   *       }
+   *     }
+   *   }
+   * });
+   * @public
+   * @member {?NutrientViewer.UI} ui
+   * @memberof NutrientViewer.Configuration
+   */
+  ui?: UI;
   /**
    * ***Server only***
    *
@@ -20836,6 +20941,7 @@ declare const ShowSignatureValidationStatusMode: {
 
 /**
  * Controls the current sidebar mode in the viewer.
+ * It can also be a custom string corresponding to a custom sidebar id.
  * @public
  * @readonly
  * @memberof NutrientViewer
@@ -20944,6 +21050,13 @@ T extends AttachmentsSidebarOptions ? {
   [SidebarMode.ATTACHMENTS]: AttachmentsSidebarOptions;} :
 never;
 
+declare type SidebarParams = {
+  /**
+   * ID for the sidebar.
+   */
+  id: string;};
+
+
 /**
  * Controls the sidebar placement.
  * @public
@@ -20959,6 +21072,8 @@ declare const SidebarPlacement: {
   readonly END: "END";};
 
 
+declare type SidebarUI = Record<string, UIFactory<SidebarParams>>;
+
 declare type Signature = InkAnnotation | ImageAnnotation;
 
 declare type SignatureAppearance = {
@@ -21616,6 +21731,25 @@ export declare class Size extends Size_base {
 
 declare const Size_base: Record_2.Factory<ISize>;
 
+declare type Slot<Params> = {
+  /**
+   * The render function is called whenever any `params` change that may affect the UI and expects a DOM element to be returned.
+   *
+   * This may be called any number of times.
+   * You should treat this as a pure function and always return a DOM element based on the current `params`.
+   */
+  render?: (params: Params) => HTMLElement | null;
+  /**
+   * Invoked once, when the component is mounted to the DOM.
+   * Use it for setup tasks such as attaching event listeners, firing analytics events, etc.
+   */
+  onMount?: (id: string) => void;
+  /**
+   * Invoked once, when the component is unmounted from the DOM.
+   * Use it for cleanup tasks such as removing event listeners, etc.
+   */
+  onUnmount?: (id: string) => void;};
+
 /**
  * @classdesc
  * A squiggle markup annotation. Please refer to {@link NutrientViewer.Annotations.MarkupAnnotation} for
@@ -23304,9 +23438,9 @@ declare const textComparisonActionCreators: {
     type: "SET_AI_COMPARISON_DATA";
     payload: AIComparisonData | null;};
 
-  updateAIComparisonPhase: (phase: AIComparisonPhase) => {
+  updateAIComparisonPhase: (phase: IAIComparisonPhase) => {
     type: "UPDATE_AI_COMPARISON_PHASE";
-    payload: AIComparisonPhase;};
+    payload: IAIComparisonPhase;};
 
   setAIComparisonError: (error: AIComparisonError | null) => {
     type: "SET_AI_COMPARISON_ERROR";
@@ -25135,6 +25269,21 @@ declare type TwoStepSignatureCallback = (arg0: {
   dataToBeSigned: ArrayBuffer;}) =>
 Promise<ArrayBuffer | SignatureCallbackResponsePkcs7 | SignatureCallbackResponseRaw>;
 
+declare interface UI {
+  /**
+   * Replace the entire comment thread component UI with a custom implementation by passing a function.
+   * Or customize it partly by passing an object configuration.
+   *
+   * The UI customization function is invoked when the SDK is ready to render a comment thread.
+   */
+  commentThread?: CommentThreadUIConfig;
+  /**
+   * UI Customization for custom sidebars.
+   * Use this to render a custom sidebar by passing a function.
+   */
+  sidebar?: SidebarUI;}
+
+
 /**
  * Indicates which UI element certain JavaScript `Date` instance will be rendered in.
  * Used as part of {@link NutrientViewer.Configuration#dateTimeString}.
@@ -25160,6 +25309,12 @@ declare const UIElement: {
   readonly Sidebar: "Sidebar";};
 
 
+/**
+ * A factory function that creates a UI customization slot.
+ * It can receive instance and an id, returning a slot object with lifecycle methods.
+ */
+declare type UIFactory<Params> = (instance: Instance | null, id: string) => Slot<Params>;
+
 declare type UIRendererConfiguration = {
   node: Node;
   onRenderItem?: ItemCustomRenderer;};

package/dist/nutrient-viewer-lib/{chunk-848-c305e43a222de666.js → chunk-848-3296fd6974df867d.js}

@@ -1,5 +1,5 @@
 /*!
- * Nutrient Web SDK 1.7.0-29b8a9f (https://www.nutrient.io/sdk/web)
+ * Nutrient Web SDK 1.7.0-395f82e (https://www.nutrient.io/sdk/web)
  *
  * Copyright (c) 2016-2025 PSPDFKit GmbH. All rights reserved.
  *