@dskripchenko/diagrams 0.0.0-stage → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Measures with a table of glyph widths. Deterministic, which also makes it
+ * the measurer for tests and snapshots.
+ */
+export declare const approximateMeasurer: TextMeasurer;
+
+/**
+ * The best measurer the environment offers: a canvas when there is one,
+ * otherwise the glyph table.
+ */
+export declare function defaultMeasurer(): TextMeasurer;
+
+/** The diagram type a source declares on its first line, or null. */
+export declare function detect(source: string): DiagramType | null;
+
+/**
+ * The one error every parser and layout throws.
+ *
+ * A diagram source is written by a person, and the useful answer to "it does
+ * not render" is where and why — so the position is part of the error, not a
+ * guess the caller has to make from the message.
+ */
+export declare class DiagramError extends Error {
+    readonly line: number;
+    readonly column: number;
+    readonly hint?: string | undefined;
+    readonly name = "DiagramError";
+    /**
+     * @param message What is wrong, in a sentence.
+     * @param line 1-based line of the source, or 0 when the error is about the whole diagram.
+     * @param column 1-based column, or 0 when unknown.
+     * @param hint What to write instead, when there is an obvious answer.
+     */
+    constructor(message: string, line?: number, column?: number, hint?: string | undefined);
+}
+
+export declare type DiagramType = 'pie' | 'gantt' | 'flowchart' | 'sequence' | 'state';
+
+export declare interface FontSpec {
+    /** Pixels. */
+    size: number;
+    family: string;
+    weight?: 'normal' | 'bold';
+    style?: 'normal' | 'italic';
+}
+
+/** Parses without laying out: the diagram's structure, for tools and tests. */
+export declare function parse(source: string): unknown;
+
+/**
+ * Renders a diagram to an SVG string.
+ *
+ * @throws DiagramError when the source cannot be read; the error carries the line and column.
+ */
+export declare function render(source: string, options?: RenderOptions): RenderResult;
+
+export declare interface RenderOptions {
+    /** How text is measured; defaults to a canvas in the browser and a glyph table elsewhere. */
+    measureText?: TextMeasurer;
+    /**
+     * Prefix for every id inside the SVG. Must be unique on the page when the
+     * same diagram is shown twice; defaults to a hash of the source.
+     */
+    idPrefix?: string;
+    /** Accessible title; defaults to the diagram's own title or its type. */
+    title?: string;
+    /**
+     * Gantt charts: the date of the "today" line. Without it no line is drawn,
+     * so the output never depends on the clock.
+     */
+    today?: Date;
+}
+
+export declare interface RenderResult {
+    svg: string;
+    width: number;
+    height: number;
+    type: string;
+}
+
+export declare type TextMeasurer = (text: string, font: FontSpec) => TextSize;
+
+export declare interface TextSize {
+    width: number;
+    height: number;
+}
+
+/** Variable name → light-theme default. The documented theming surface. */
+export declare const THEME_VARIABLES: Readonly<Record<string, string>>;
+
+export { }