@mrsf/marp-mrsf 0.4.8

package/dist/controller.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Sidemark — MrsfController: overlay gutter architecture.
+ *
+ * The controller is the runtime engine for interactive MRSF rendering.
+ * It reads comment data from the DOM (embedded `<script type="application/mrsf+json">`)
+ * or constructor options, creates gutter overlay columns, positions
+ * badges/buttons at the correct vertical offsets, and handles all
+ * user interactions (tooltips, selection, action buttons).
+ *
+ * Usage:
+ *   import { MrsfController } from "@mrsf/plugin-shared/controller";
+ *
+ *   const ctrl = new MrsfController(document.querySelector(".my-content")!, {
+ *     interactive: true,
+ *     gutterPosition: "left",
+ *   });
+ *   // ctrl.destroy() to clean up
+ *
+ * Events dispatched on document:
+ *   - mrsf:resolve   { commentId, line, ... }
+ *   - mrsf:unresolve { commentId, line, ... }
+ *   - mrsf:reply     { commentId, line, ... }
+ *   - mrsf:edit      { commentId, line, ... }
+ *   - mrsf:delete    { commentId, line, ... }
+ *   - mrsf:navigate  { commentId, line, ... }
+ *   - mrsf:add       { commentId: null, line, selectionText?, ... }
+ *   - mrsf:submit    { action, commentId, text?, line?, ... }
+ */
+import type { CommentThread } from "./types.js";
+import type { MrsfGutterRenderers } from "./gutter.js";
+export type MrsfAction = "resolve" | "unresolve" | "reply" | "edit" | "delete" | "navigate" | "add";
+export interface MrsfActionDetail {
+    commentId: string | null;
+    line: number | null;
+    action: MrsfAction;
+    selectionText?: string | null;
+    start_line?: number | null;
+    end_line?: number | null;
+    start_column?: number | null;
+    end_column?: number | null;
+}
+export interface MrsfSubmitDetail {
+    action: "add" | "edit" | "reply" | "resolve" | "unresolve" | "delete";
+    commentId: string | null;
+    text: string;
+    type?: string | null;
+    severity?: "low" | "medium" | "high" | null;
+    line?: number | null;
+    end_line?: number | null;
+    start_column?: number | null;
+    end_column?: number | null;
+    selection_text?: string | null;
+}
+export interface MrsfControllerOptions {
+    /** Show gutter on left or right side. Default: "right". */
+    gutterPosition?: "left" | "right";
+    /** Enable interactive actions (add, resolve, reply, etc.). Default: false. */
+    interactive?: boolean;
+    /** Comment data passed directly (overrides embedded script). */
+    comments?: CommentThread[];
+    /**
+     * Render inline text highlights for comments that have `selected_text`.
+     * Wraps matching text in `<mark>` elements with hover tooltips.
+     * Default: true.
+     */
+    inlineHighlights?: boolean;
+    gutterRenderers?: MrsfGutterRenderers;
+}
+export declare class MrsfController {
+    private container;
+    private opts;
+    private threads;
+    private gutterLeft;
+    private gutterRight;
+    private activeTooltip;
+    private floatingAddButton;
+    private overlayEl;
+    private lastSelectionText;
+    private resizeObserver;
+    private mutationObserver;
+    private styleInjected;
+    private inlineMarks;
+    private inlineTooltipEl;
+    private orphanedSection;
+    private refreshQueued;
+    private handleResizeBound;
+    private handleMutationBound;
+    private handleClickBound;
+    private handleSelectionBound;
+    constructor(container: HTMLElement, options?: MrsfControllerOptions);
+    /** Remove all controller DOM and listeners. */
+    destroy(): void;
+    /** Recalculate gutter positions after async layout changes such as Mermaid renders. */
+    refresh(): void;
+    private loadCommentData;
+    private buildThreadMap;
+    private findCommentById;
+    private orderThreadsForDisplay;
+    private setupOverlayStructure;
+    private createGutter;
+    /** Build badge/add-button elements for each line in the gutter(s). */
+    private renderGutterItems;
+    private primaryGutter;
+    private shouldExpandRange;
+    private addVisibleLinesForElement;
+    /** Collect all unique line numbers from data-mrsf-line elements, expanding multi-line ranges. */
+    private collectLines;
+    private resolveThreadDisplayLine;
+    private collectThreadDisplayMap;
+    private createBadgeItem;
+    private createAddItem;
+    private createAddButton;
+    /** Measure [data-mrsf-line] elements and set gutter item Y offsets. */
+    positionGutterItems(): void;
+    private suppressAddItemsThatShareBadgeTargets;
+    private handleMutations;
+    private isExternalContentMutation;
+    private isControllerOwnedNode;
+    private queueRefresh;
+    private findDirectElementForLine;
+    private calculateItemTop;
+    /**
+     * Find the element whose start-line/end-line range contains the given line.
+     * Used for positioning gutter items on expanded multi-line elements.
+     */
+    private findElementForLine;
+    /**
+     * Render orphaned comments (whose line doesn't match any DOM element)
+     * in a dedicated section at the bottom of the container.
+     */
+    private renderOrphanedSection;
+    /**
+     * For comments with `selected_text`, find the matching text in the DOM
+     * and wrap it in a `<mark class="mrsf-inline-highlight">` element with
+     * hover/click behaviour to show the comment tooltip.
+     */
+    private renderInlineHighlights;
+    /**
+     * Strip common inline markdown syntax so `selected_text` from source
+     * can be matched against rendered text content.
+     */
+    private static stripInlineMarkdown;
+    /**
+     * Walk text nodes inside `root` to find `text`, then wrap the matching
+     * range in a `<mark>` element. Falls back to markdown-stripped matching.
+     */
+    private wrapSelectedText;
+    private showInlineTooltip;
+    private applyThemeVariables;
+    private hideInlineTimeout;
+    private scheduleHideInlineTooltip;
+    private cancelHideInlineTooltip;
+    private hideInlineTooltip;
+    /** Remove all inline marks, unwrapping their contents back to text. */
+    private removeInlineHighlights;
+    private toggleTooltip;
+    private showTooltip;
+    private hideTooltip;
+    private handleClick;
+    private handleSelectionChange;
+    private selectionBelongsToContainer;
+    private findSelectionAnchor;
+    private ensureFloatingAddButton;
+    private hideFloatingAddButton;
+    private showFloatingAddButton;
+    private injectStyles;
+    private closeOverlay;
+    private openForm;
+    private openConfirm;
+}
+export declare function refreshAll(): void;
+export declare function autoInit(): void;
+//# sourceMappingURL=controller.d.ts.map