@memberjunction/ng-whiteboard 0.0.1 → 5.42.0

package/dist/lib/whiteboard-export.d.ts

@@ -0,0 +1,94 @@
+import { WhiteboardState } from './whiteboard-state';
+/**
+ * LIVE WHITEBOARD — EXPORT builders (pure, Angular-free).
+ *
+ * {@link BuildWhiteboardExportHtml} renders a board snapshot as ONE fully self-contained
+ * HTML document (inline CSS only, zero external references) suitable for "Download HTML"
+ * and the host's Print path; {@link BuildWhiteboardExportSvg} renders the same snapshot
+ * as a standalone SVG document for "Download SVG".
+ *
+ * Rendering model (mirrors the live board):
+ *  - BOX items (sticky / shape / text / image placeholder) become absolutely positioned
+ *    divs honoring the optional text-style fields (FontSize / FontFamily / FontWeight /
+ *    Color), each garnished with a small ownership chip (You / the agent's name);
+ *  - MARKDOWN panels render their formatted content through {@link RenderMarkdownInert}
+ *    (escape-FIRST, no raw-HTML passthrough); HTML widgets export as a placeholder card
+ *    (title + note + escaped source in a <details>) — live widget HTML is NEVER inlined
+ *    into the export document (no iframe sandbox exists there, so it would be XSS);
+ *  - VECTOR items (ink strokes, connectors, highlight regions) render in one inline SVG
+ *    layer underneath the boxes — connectors anchor to item centers via the engine's own
+ *    {@link WhiteboardState.ResolveEndpoint} bounds math, highlights become dashed
+ *    outlines;
+ *  - the palette is a light, paper-friendly literal palette (exports must stand alone, so
+ *    no design tokens here — this is the documented exception for self-contained output).
+ *
+ * SECURITY: every piece of user/agent-authored text (item text, labels, names, the title,
+ * the agent name, the timestamp) is HTML-escaped via {@link escapeHtml} before it touches
+ * the document. Output is deterministic for a given state + options (the caller passes
+ * `GeneratedAt`).
+ */
+/** Options for {@link BuildWhiteboardExportHtml}. */
+export interface WhiteboardExportOptions {
+    /** Document / header title (e.g. the board title). */
+    Title: string;
+    /** Display name of the session's agent — ownership chips + header byline. */
+    AgentName: string;
+    /** Preformatted generation timestamp (passed in so output stays deterministic). */
+    GeneratedAt: string;
+}
+/**
+ * Minimal, SAFE markdown → HTML renderer for the self-contained exports (the live board
+ * renders through the shared `mj-markdown` Angular component instead — this exists only
+ * because export builders are pure functions with no Angular available).
+ *
+ * SECURITY: ESCAPE-FIRST — the whole source is HTML-escaped before any formatting, so raw
+ * HTML in the markdown can never become live markup (NO passthrough, ever). Supported:
+ * headings, bold/italic, inline code, fenced code blocks, un/ordered lists, paragraphs,
+ * and links restricted to http(s)/mailto.
+ */
+export declare function RenderMarkdownInert(markdown: string): string;
+/**
+ * Build a fully self-contained HTML document for the given board snapshot — inline CSS
+ * only, light paper-friendly palette, header (title / generated-at / agent byline), the
+ * positioned board, ownership chips, item-count footer and print-friendly `@media print`
+ * rules. Deterministic for a given state + options; all text is HTML-escaped.
+ *
+ * Renders the ACTIVE page only — see {@link BuildWhiteboardExportHtmlAllPages} for the
+ * every-page document.
+ */
+export declare function BuildWhiteboardExportHtml(state: WhiteboardState, opts: WhiteboardExportOptions): string;
+/**
+ * Build a standalone SVG document of the board snapshot: box items as SVG rects / shapes /
+ * single-line text, plus the same vector layer (ink, connectors, highlight outlines).
+ * All text is escaped; output is deterministic for a given state.
+ *
+ * Renders the ACTIVE page only — see {@link BuildWhiteboardExportSvgPages} for one SVG
+ * document per page.
+ */
+export declare function BuildWhiteboardExportSvg(state: WhiteboardState): string;
+/** One page's rendered export document — the per-page output of the all-pages builders. */
+export interface WhiteboardPageExport {
+    /** The page's stable id (e.g. `page-2`). */
+    PageID: string;
+    /** The page's display name — callers typically suffix download filenames with it. */
+    PageName: string;
+    /** The fully rendered export document for that page. */
+    Content: string;
+}
+/**
+ * Build one standalone SVG document PER PAGE (SVG is a single-image format, so "all
+ * pages" means one file per page — the host downloads them sequentially, suffixing each
+ * filename with the page name). Page order matches the board's page strip; each entry's
+ * content is exactly what {@link BuildWhiteboardExportSvg} produces for that page.
+ */
+export declare function BuildWhiteboardExportSvgPages(state: WhiteboardState): WhiteboardPageExport[];
+/**
+ * Build ONE fully self-contained HTML document containing EVERY page of the board —
+ * each page renders as its own titled section ("name (n of m)") with the same
+ * board/chip/vector rendering as the single-page export, and the print CSS breaks
+ * between pages. The footer totals span all pages. Deterministic and escape-safe like
+ * the single-page builder. (The board's JSON/state persistence already carries all
+ * pages inherently — this is the human-readable counterpart.)
+ */
+export declare function BuildWhiteboardExportHtmlAllPages(state: WhiteboardState, opts: WhiteboardExportOptions): string;
+//# sourceMappingURL=whiteboard-export.d.ts.map

package/dist/lib/whiteboard-export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whiteboard-export.d.ts","sourceRoot":"","sources":["../../src/lib/whiteboard-export.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,eAAe,EAGhB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,qDAAqD;AACrD,MAAM,WAAW,uBAAuB;IACtC,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,WAAW,EAAE,MAAM,CAAC;CACrB;AA6ED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAoE5D;AAqPD;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,uBAAuB,GAAG,MAAM,CA0BvG;AAwED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAuBvE;AAID,2FAA2F;AAC3F,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,qFAAqF;IACrF,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;CACjB;AAgBD;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,eAAe,GAAG,oBAAoB,EAAE,CAM5F;AAED;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,uBAAuB,GAAG,MAAM,CAsC/G"}