@squinch/core 0.1.0

package/dist/render/svg.d.ts

@@ -0,0 +1,75 @@
+import type { Theme } from "../themes/index.js";
+import type { Positioned } from "../layout/layout.js";
+import type { Hue, SNote } from "../model/types.js";
+export interface RenderOpts {
+    highlight?: string[];
+    /** The view's `color #tag hue` statements — already applied to the graph by
+     *  resolution; the renderer only needs them for the legend, where a tag is
+     *  the one label a hue can honestly carry. */
+    colors?: {
+        tag: string;
+        hue: Hue;
+    }[];
+    notes?: SNote[];
+    showDescriptions?: boolean;
+    /** `legend auto` — a key of the styles this render actually uses. */
+    legend?: boolean;
+    /** drafting-style corner block (bottom-right), free-form key/values */
+    titleblock?: Record<string, string>;
+    /** view title — the titleblock headline */
+    title?: string;
+    /** Embed the subsetted faces via @font-face (default true), so the SVG
+     *  renders with the exact font the metrics were measured from even in
+     *  sandboxed contexts like GitHub's <img>. Off = smaller output for hosts
+     *  that already serve the fonts. */
+    embedFonts?: boolean;
+    /** Reveal this many hops of a `show flow`, dimming everything the request has
+     *  not reached yet and picking out the current one. A viewer concern — the
+     *  DSL declares the flow, the presenter walks it — so it lives here and not
+     *  in the model. Omitted, the whole flow shows at once, as before.
+     *
+     *  Counted over the hops **visible in this view**, not the flow's declared
+     *  numbering: a flow that starts two systems away has its opening steps
+     *  lifted out of a scoped view, and walking declared numbers there would
+     *  spend the first presses on frames where nothing happens. `1` is always
+     *  the first hop you can actually see. Badges still read their declared
+     *  number — that's the flow's real shape. */
+    flowStep?: number;
+    /** Hand id-bearing definitions out instead of emitting them inline, keyed by
+     *  id. The interactive HTML export puts every view in one document, where
+     *  fragment references resolve document-wide — so one `<symbol id="sq-aws-
+     *  lambda">` serves all of them and the bodies keep their `<use href="#…">`
+     *  untouched. Measured on `examples/microservices`: 27 KB of shared defs
+     *  against 126 KB if every view carried its own.
+     *
+     *  Setting the same id to *different* markup throws. That turns "symbols,
+     *  gradients and clip paths are theme-free" from a thing we believe into a
+     *  build-time assertion — it fires the day someone themes one. */
+    collectDefs?: Map<string, string>;
+    /** Suffix for the one def whose content does depend on the theme (`sq-hatch`
+     *  bakes `t.border`), so a document carrying two palettes does not have to
+     *  pick one. Applied by the emitter to both definition and reference, so
+     *  nothing downstream rewrites strings. */
+    defsScope?: string;
+}
+/** The @font-face rules alone. Exported because the interactive HTML export
+ *  hoists them into one <style> for the whole document instead of repeating
+ *  33 KB of base64 in every view. One implementation of the rule either way.
+ *
+ *  `used` names extra `family:weight` faces to embed. The HTML export passes
+ *  every face rather than a union of what its views drew: one document holds
+ *  many views, any of which may be re-rendered client-side, so a hoisted set
+ *  that happened to miss mono would silently fall back mid-navigation. */
+export declare function fontFaceCSS(t: Theme, used?: Iterable<string>): string;
+/** Every face the bundle carries — the HTML export's hoisted set. */
+export declare function allFaces(): string[];
+/** Anything with a box: a node, a pill, a badge, a chip, a note, a reserved
+ *  band. The annotation layers all resolve collisions against each other, so
+ *  they need one shared vocabulary rather than three that agree by accident. */
+export interface Rect {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export declare function renderSVG(p: Positioned, t: Theme, opts?: RenderOpts): string;