@dtducas/wh-forge-viewer 3.0.0-beta.1 → 3.0.0-beta.2

package/dist/index.d.ts

@@ -1343,6 +1343,45 @@ declare module '@dtducas/wh-forge-viewer' {
     propertyDatabase: boolean;
   }
 
+  // ── Comments Panel ──────────────────────────────────────────────────────
+
+  export interface ICommentReply {
+    id: string;
+    text: string;
+    authorName?: string;
+    createdAt: number;
+  }
+
+  /** Single comment item displayed in the CommentsPanel */
+  export interface ICommentItem {
+    id: string;
+    text: string;
+    authorName?: string;
+    authorCompany?: string;
+    createdAt: number;
+    status?: 'open' | 'resolved';
+    /** Zero-based page/sheet index this comment is linked to */
+    pageIndex?: number;
+    replies?: ICommentReply[];
+  }
+
+  export interface ICommentsPanelProps {
+    items: ICommentItem[];
+    onClose: () => void;
+    onItemClick?: (id: string) => void;
+    selectedItemId?: string;
+    /** If provided, shows a text input at the bottom for creating new comments */
+    onAddComment?: (text: string) => void;
+    /** If provided, shows a Reply button on each thread */
+    onReplyToComment?: (commentId: string, text: string) => void;
+    /** If provided, shows a Resolve button on open threads */
+    onResolveComment?: (commentId: string) => void;
+    /** If provided, shows a Reopen button on resolved threads */
+    onReopenComment?: (commentId: string) => void;
+  }
+
+  export function CommentsPanel(props: ICommentsPanelProps): JSX.Element;
+
   // ── Markups Panel ─────────────────────────────────────────────────────────
 
   /** Single markup item displayed in the MarkupsPanel */
@@ -1433,11 +1472,17 @@ declare module '@dtducas/wh-forge-viewer' {
   export interface ICollabAdapter {
     broadcastPatches(patches: ICanvasPatch[], room: ICollabRoom): Promise<void>;
     fetchScene(room: ICollabRoom): Promise<IFetchSceneResult>;
-    onRemotePatches(room: ICollabRoom, cb: (patches: ICanvasPatch[]) => void): () => void;
+    onRemotePatches(
+      room: ICollabRoom,
+      cb: (patches: ICanvasPatch[]) => void,
+    ): () => void;
     joinRoom(room: ICollabRoom): void | Promise<void>;
     leaveRoom(room: ICollabRoom): void | Promise<void>;
     /** Optional: subscribe to server-initiated full-scene replacements (e.g. version restore). */
-    onRemoteSceneReplace?(room: ICollabRoom, cb: (scene: ICanvasMarkupSceneV2) => void): () => void;
+    onRemoteSceneReplace?(
+      room: ICollabRoom,
+      cb: (scene: ICanvasMarkupSceneV2) => void,
+    ): () => void;
     /**
      * Optional: drain the durable outbox for a room.
      * Called after bootstrap to replay unACKed patches from a previous session.
@@ -1447,7 +1492,12 @@ declare module '@dtducas/wh-forge-viewer' {
     onReconnect?(cb: () => void): () => void;
   }
 
-  export type TCollabStatus = 'idle' | 'joining' | 'connected' | 'disconnected' | 'error';
+  export type TCollabStatus =
+    | 'idle'
+    | 'joining'
+    | 'connected'
+    | 'disconnected'
+    | 'error';
 
   export interface ICollabStatusEvent {
     status: TCollabStatus;
@@ -1506,6 +1556,24 @@ declare module '@dtducas/wh-forge-viewer' {
     markupItems?: IMarkupPanelItem[];
     /** Called when user clicks a markup row in the Markups panel. */
     onMarkupItemClick?: (id: string) => void;
+    /**
+     * Comment items to display in the Comments side panel.
+     * Build from your server-side comment thread data.
+     * @default []
+     */
+    commentItems?: ICommentItem[];
+    /** Called when user clicks a comment row in the Comments panel. */
+    onCommentItemClick?: (id: string) => void;
+    /** ID of the currently selected comment — highlights the row in the panel. */
+    selectedCommentId?: string;
+    /** If provided, shows a text input at the bottom of the Comments panel for creating new comments. */
+    onAddComment?: (text: string) => void;
+    /** If provided, shows a Reply button on each comment thread. */
+    onReplyToComment?: (commentId: string, text: string) => void;
+    /** If provided, shows a Resolve button on open comment threads. */
+    onResolveComment?: (commentId: string) => void;
+    /** If provided, shows a Reopen button on resolved comment threads. */
+    onReopenComment?: (commentId: string) => void;
     /**
      * Called when a shape is selected or deselected on the canvas.
      * Receives the shape `entityId` on selection, or `null` on deselect / toolbar close.
@@ -1607,7 +1675,10 @@ declare module '@dtducas/wh-forge-viewer' {
      * }
      * ```
      */
-    getExportViewablePages?: () => Array<{ pageIndex: number; viewableGuid: string }>;
+    getExportViewablePages?: () => Array<{
+      pageIndex: number;
+      viewableGuid: string;
+    }>;
 
     /**
      * Async callback to fetch canvas-scene/2 data for ALL pages from the server
@@ -1671,6 +1742,81 @@ declare module '@dtducas/wh-forge-viewer' {
      * ```
      */
     exportFontConfig?: IExportFontConfig;
+
+    // ── Submit Reply (consultant-reply mode) ───────────────────────────────
+    /**
+     * When provided, shows the "Submit Reply" button in the sidebar and renders
+     * the SubmitPanel. Pass null/undefined to hide the panel entirely.
+     */
+    submitConfig?: ISubmitConfig;
+    /** When true, the submit panel is read-only (reply already submitted). */
+    submitLocked?: boolean;
+    /** When true, shows "Replaced PDF" badge in the submit panel. */
+    submitReplaced?: boolean;
+    /** Pre-loaded status value from an existing draft. */
+    submitInitialStatus?: string | null;
+    /** Pre-loaded comment from an existing draft. */
+    submitInitialComment?: string;
+    /** Full audit log entries for the submit panel history section. */
+    submitHistory?: IMarkupReplyHistoryEntry[];
+    /** Whether a save is currently in progress. */
+    submitIsSaving?: boolean;
+    /** Error message from the last save attempt. */
+    submitSaveError?: string | null;
+    /** When true, triggers the "Saved ✓" flash on the save button. */
+    submitSavedFlash?: boolean;
+    /** Called with { status, comment, hasMarkup } when user clicks Save Draft. */
+    onSubmitSave?: (payload: ISubmitSavePayload) => void;
+    /**
+     * Async function to check whether markup shapes exist for the given viewableGUID.
+     * Called on save. If omitted, hasMarkup defaults to false.
+     */
+    checkSubmitHasMarkup?: (viewableGUID: string) => Promise<boolean>;
+    /**
+     * Which sidebar panel to open on initial render.
+     * Pass 'submit' to open the Submit Reply panel by default.
+     */
+    defaultActiveSidebarPanel?:
+      | 'sheets'
+      | 'markup'
+      | 'comments'
+      | 'submit'
+      | null;
+    /**
+     * Optional React content rendered at the top of the Markups panel, below the controls bar.
+     * Use to inject per-user/company visibility filter UI into the panel.
+     */
+    markupsPanelExtraContent?: React.ReactNode;
+  }
+
+  /** One entry in the audit log for a markup reply. */
+  export interface IMarkupReplyHistoryEntry {
+    status: string | null;
+    comment: string;
+    hasMarkup: boolean;
+    savedAt: string;
+    savedBy: string;
+    savedByName?: string;
+  }
+
+  /** Configuration for the consultant reply Submit panel. */
+  export interface ISubmitConfig {
+    drawingItemId: string;
+    rfaRef: string;
+    rev: string;
+    companyId: string;
+    companyShortName: string;
+    s3KeyPdf: string;
+    statusOptions: string[];
+    /** Map of status label → hex color for the custom dropdown. */
+    statusColors?: Record<string, string>;
+  }
+
+  /** Payload passed to onSubmitSave when user saves a draft reply. */
+  export interface ISubmitSavePayload {
+    status: string | null;
+    comment: string;
+    hasMarkup: boolean;
   }
 
   /**