@diagrammo/dgmo 0.2.8 → 0.2.10

package/dist/index.d.cts

@@ -1,6 +1,32 @@
 import { EChartsOption } from 'echarts';
 import * as d3Scale from 'd3-scale';
 
+/**
+ * Render DGMO source to an SVG string.
+ *
+ * Automatically detects the chart type, selects the appropriate renderer,
+ * and returns a complete SVG document string.
+ *
+ * @param content - DGMO source text
+ * @param options - Optional theme and palette settings
+ * @returns SVG string, or empty string on error
+ *
+ * @example
+ * ```ts
+ * import { render } from '@diagrammo/dgmo';
+ *
+ * const svg = await render(`chart: pie
+ * title: Languages
+ * TypeScript: 45
+ * Python: 30
+ * Rust: 25`);
+ * ```
+ */
+declare function render(content: string, options?: {
+    theme?: 'light' | 'dark' | 'transparent';
+    palette?: string;
+}): Promise<string>;
+
 /**
  * Framework identifiers used by the .dgmo router.
  * Maps to the existing preview components and export paths.
@@ -171,6 +197,7 @@ interface ChartDataPoint {
 interface ParsedChart {
     type: ChartType;
     title?: string;
+    titleLineNumber?: number;
     series?: string;
     xlabel?: string;
     ylabel?: string;
@@ -179,6 +206,7 @@ interface ParsedChart {
     orientation?: 'horizontal' | 'vertical';
     color?: string;
     label?: string;
+    labels?: 'name' | 'value' | 'percent' | 'full';
     data: ChartDataPoint[];
     error?: string;
 }
@@ -235,6 +263,7 @@ interface ParsedHeatmapRow {
 interface ParsedEChart {
     type: EChartsChartType;
     title?: string;
+    titleLineNumber?: number;
     series?: string;
     seriesNames?: string[];
     seriesNameColors?: (string | undefined)[];
@@ -384,6 +413,7 @@ interface D3ExportDimensions {
 interface ParsedD3 {
     type: D3ChartType | null;
     title: string | null;
+    titleLineNumber: number | null;
     orientation: 'horizontal' | 'vertical';
     periods: string[];
     data: D3DataItem[];
@@ -565,6 +595,7 @@ interface SequenceGroup {
  */
 interface ParsedSequenceDgmo {
     title: string | null;
+    titleLineNumber: number | null;
     participants: SequenceParticipant[];
     messages: SequenceMessage[];
     elements: SequenceElement[];
@@ -661,6 +692,7 @@ interface GraphGroup {
 interface ParsedGraph {
     type: 'flowchart';
     title?: string;
+    titleLineNumber?: number;
     direction: GraphDirection;
     nodes: GraphNode[];
     edges: GraphEdge[];
@@ -729,6 +761,7 @@ interface SectionMessageGroup {
 }
 interface SequenceRenderOptions {
     collapsedSections?: Set<number>;
+    expandedNoteLines?: Set<number>;
     exportWidth?: number;
 }
 /**
@@ -777,6 +810,12 @@ declare function applyGroupOrdering(participants: SequenceParticipant[], groups:
  * Render a sequence diagram into the given container element.
  */
 declare function renderSequenceDiagram(container: HTMLDivElement, parsed: ParsedSequenceDgmo, palette: PaletteColors, isDark: boolean, _onNavigateToLine?: (line: number) => void, options?: SequenceRenderOptions): void;
+/**
+ * Build a mapping from each note's lineNumber to the lineNumber of its
+ * associated message (the last message before the note in document order).
+ * Used by the app to expand notes when cursor is on the associated message.
+ */
+declare function buildNoteMessageMap(elements: SequenceElement[]): Map<number, number>;
 
 /** Complete 16-entry Nord palette. */
 declare const nord: {
@@ -811,4 +850,4 @@ declare function resolveColor(color: string, palette?: {
 /** @deprecated Use getSeriesColors(palette) from '@/lib/palettes' instead. */
 declare const seriesColors: string[];
 
-export { type Activation, type ArcLink, type ArcNodeGroup, type ChartDataPoint, type ChartType, type D3ChartType, type D3ExportDimensions, DGMO_CHART_TYPE_MAP, type DgmoFramework, type EChartsChartType, type ElseIfBranch, type GraphDirection, type GraphEdge, type GraphGroup, type GraphNode, type GraphShape, type LayoutEdge, type LayoutGroup, type LayoutNode, type LayoutResult, type PaletteColors, type PaletteConfig, type ParsedChart, type ParsedD3, type ParsedEChart, type ParsedGraph, type ParsedQuadrant, type ParsedSequenceDgmo, type ParticipantType, RULE_COUNT, type RenderStep, type SectionMessageGroup, type SequenceBlock, type SequenceElement, type SequenceGroup, type SequenceMessage, type SequenceNote, type SequenceParticipant, type SequenceRenderOptions, type SequenceSection, addDurationToDate, applyGroupOrdering, applyPositionOverrides, boldPalette, buildEChartsOption, buildEChartsOptionFromChart, buildMermaidQuadrant, buildMermaidThemeVars, buildRenderSequence, buildThemeCSS, catppuccinPalette, colorNames, computeActivations, computeTimeTicks, contrastText, formatDateLabel, getAvailablePalettes, getDgmoFramework, getPalette, getSeriesColors, groupMessagesBySection, gruvboxPalette, hexToHSL, hexToHSLString, hslToHex, inferParticipantType, isSequenceBlock, isSequenceNote, isValidHex, layoutGraph, looksLikeFlowchart, looksLikeSequence, mute, nord, nordPalette, oneDarkPalette, orderArcNodes, parseChart, parseD3, parseDgmoChartType, parseEChart, parseFlowchart, parseQuadrant, parseSequenceDgmo, parseTimelineDate, registerPalette, renderArcDiagram, renderD3ForExport, renderEChartsForExport, renderFlowchart, renderFlowchartForExport, renderQuadrant, renderSequenceDiagram, renderSlopeChart, renderTimeline, renderVenn, renderWordCloud, resolveColor, rosePinePalette, seriesColors, shade, solarizedPalette, tint, tokyoNightPalette };
+export { type Activation, type ArcLink, type ArcNodeGroup, type ChartDataPoint, type ChartType, type D3ChartType, type D3ExportDimensions, DGMO_CHART_TYPE_MAP, type DgmoFramework, type EChartsChartType, type ElseIfBranch, type GraphDirection, type GraphEdge, type GraphGroup, type GraphNode, type GraphShape, type LayoutEdge, type LayoutGroup, type LayoutNode, type LayoutResult, type PaletteColors, type PaletteConfig, type ParsedChart, type ParsedD3, type ParsedEChart, type ParsedGraph, type ParsedQuadrant, type ParsedSequenceDgmo, type ParticipantType, RULE_COUNT, type RenderStep, type SectionMessageGroup, type SequenceBlock, type SequenceElement, type SequenceGroup, type SequenceMessage, type SequenceNote, type SequenceParticipant, type SequenceRenderOptions, type SequenceSection, addDurationToDate, applyGroupOrdering, applyPositionOverrides, boldPalette, buildEChartsOption, buildEChartsOptionFromChart, buildMermaidQuadrant, buildMermaidThemeVars, buildNoteMessageMap, buildRenderSequence, buildThemeCSS, catppuccinPalette, colorNames, computeActivations, computeTimeTicks, contrastText, formatDateLabel, getAvailablePalettes, getDgmoFramework, getPalette, getSeriesColors, groupMessagesBySection, gruvboxPalette, hexToHSL, hexToHSLString, hslToHex, inferParticipantType, isSequenceBlock, isSequenceNote, isValidHex, layoutGraph, looksLikeFlowchart, looksLikeSequence, mute, nord, nordPalette, oneDarkPalette, orderArcNodes, parseChart, parseD3, parseDgmoChartType, parseEChart, parseFlowchart, parseQuadrant, parseSequenceDgmo, parseTimelineDate, registerPalette, render, renderArcDiagram, renderD3ForExport, renderEChartsForExport, renderFlowchart, renderFlowchartForExport, renderQuadrant, renderSequenceDiagram, renderSlopeChart, renderTimeline, renderVenn, renderWordCloud, resolveColor, rosePinePalette, seriesColors, shade, solarizedPalette, tint, tokyoNightPalette };

package/dist/index.d.ts

@@ -1,6 +1,32 @@
 import { EChartsOption } from 'echarts';
 import * as d3Scale from 'd3-scale';
 
+/**
+ * Render DGMO source to an SVG string.
+ *
+ * Automatically detects the chart type, selects the appropriate renderer,
+ * and returns a complete SVG document string.
+ *
+ * @param content - DGMO source text
+ * @param options - Optional theme and palette settings
+ * @returns SVG string, or empty string on error
+ *
+ * @example
+ * ```ts
+ * import { render } from '@diagrammo/dgmo';
+ *
+ * const svg = await render(`chart: pie
+ * title: Languages
+ * TypeScript: 45
+ * Python: 30
+ * Rust: 25`);
+ * ```
+ */
+declare function render(content: string, options?: {
+    theme?: 'light' | 'dark' | 'transparent';
+    palette?: string;
+}): Promise<string>;
+
 /**
  * Framework identifiers used by the .dgmo router.
  * Maps to the existing preview components and export paths.
@@ -171,6 +197,7 @@ interface ChartDataPoint {
 interface ParsedChart {
     type: ChartType;
     title?: string;
+    titleLineNumber?: number;
     series?: string;
     xlabel?: string;
     ylabel?: string;
@@ -179,6 +206,7 @@ interface ParsedChart {
     orientation?: 'horizontal' | 'vertical';
     color?: string;
     label?: string;
+    labels?: 'name' | 'value' | 'percent' | 'full';
     data: ChartDataPoint[];
     error?: string;
 }
@@ -235,6 +263,7 @@ interface ParsedHeatmapRow {
 interface ParsedEChart {
     type: EChartsChartType;
     title?: string;
+    titleLineNumber?: number;
     series?: string;
     seriesNames?: string[];
     seriesNameColors?: (string | undefined)[];
@@ -384,6 +413,7 @@ interface D3ExportDimensions {
 interface ParsedD3 {
     type: D3ChartType | null;
     title: string | null;
+    titleLineNumber: number | null;
     orientation: 'horizontal' | 'vertical';
     periods: string[];
     data: D3DataItem[];
@@ -565,6 +595,7 @@ interface SequenceGroup {
  */
 interface ParsedSequenceDgmo {
     title: string | null;
+    titleLineNumber: number | null;
     participants: SequenceParticipant[];
     messages: SequenceMessage[];
     elements: SequenceElement[];
@@ -661,6 +692,7 @@ interface GraphGroup {
 interface ParsedGraph {
     type: 'flowchart';
     title?: string;
+    titleLineNumber?: number;
     direction: GraphDirection;
     nodes: GraphNode[];
     edges: GraphEdge[];
@@ -729,6 +761,7 @@ interface SectionMessageGroup {
 }
 interface SequenceRenderOptions {
     collapsedSections?: Set<number>;
+    expandedNoteLines?: Set<number>;
     exportWidth?: number;
 }
 /**
@@ -777,6 +810,12 @@ declare function applyGroupOrdering(participants: SequenceParticipant[], groups:
  * Render a sequence diagram into the given container element.
  */
 declare function renderSequenceDiagram(container: HTMLDivElement, parsed: ParsedSequenceDgmo, palette: PaletteColors, isDark: boolean, _onNavigateToLine?: (line: number) => void, options?: SequenceRenderOptions): void;
+/**
+ * Build a mapping from each note's lineNumber to the lineNumber of its
+ * associated message (the last message before the note in document order).
+ * Used by the app to expand notes when cursor is on the associated message.
+ */
+declare function buildNoteMessageMap(elements: SequenceElement[]): Map<number, number>;
 
 /** Complete 16-entry Nord palette. */
 declare const nord: {
@@ -811,4 +850,4 @@ declare function resolveColor(color: string, palette?: {
 /** @deprecated Use getSeriesColors(palette) from '@/lib/palettes' instead. */
 declare const seriesColors: string[];
 
-export { type Activation, type ArcLink, type ArcNodeGroup, type ChartDataPoint, type ChartType, type D3ChartType, type D3ExportDimensions, DGMO_CHART_TYPE_MAP, type DgmoFramework, type EChartsChartType, type ElseIfBranch, type GraphDirection, type GraphEdge, type GraphGroup, type GraphNode, type GraphShape, type LayoutEdge, type LayoutGroup, type LayoutNode, type LayoutResult, type PaletteColors, type PaletteConfig, type ParsedChart, type ParsedD3, type ParsedEChart, type ParsedGraph, type ParsedQuadrant, type ParsedSequenceDgmo, type ParticipantType, RULE_COUNT, type RenderStep, type SectionMessageGroup, type SequenceBlock, type SequenceElement, type SequenceGroup, type SequenceMessage, type SequenceNote, type SequenceParticipant, type SequenceRenderOptions, type SequenceSection, addDurationToDate, applyGroupOrdering, applyPositionOverrides, boldPalette, buildEChartsOption, buildEChartsOptionFromChart, buildMermaidQuadrant, buildMermaidThemeVars, buildRenderSequence, buildThemeCSS, catppuccinPalette, colorNames, computeActivations, computeTimeTicks, contrastText, formatDateLabel, getAvailablePalettes, getDgmoFramework, getPalette, getSeriesColors, groupMessagesBySection, gruvboxPalette, hexToHSL, hexToHSLString, hslToHex, inferParticipantType, isSequenceBlock, isSequenceNote, isValidHex, layoutGraph, looksLikeFlowchart, looksLikeSequence, mute, nord, nordPalette, oneDarkPalette, orderArcNodes, parseChart, parseD3, parseDgmoChartType, parseEChart, parseFlowchart, parseQuadrant, parseSequenceDgmo, parseTimelineDate, registerPalette, renderArcDiagram, renderD3ForExport, renderEChartsForExport, renderFlowchart, renderFlowchartForExport, renderQuadrant, renderSequenceDiagram, renderSlopeChart, renderTimeline, renderVenn, renderWordCloud, resolveColor, rosePinePalette, seriesColors, shade, solarizedPalette, tint, tokyoNightPalette };
+export { type Activation, type ArcLink, type ArcNodeGroup, type ChartDataPoint, type ChartType, type D3ChartType, type D3ExportDimensions, DGMO_CHART_TYPE_MAP, type DgmoFramework, type EChartsChartType, type ElseIfBranch, type GraphDirection, type GraphEdge, type GraphGroup, type GraphNode, type GraphShape, type LayoutEdge, type LayoutGroup, type LayoutNode, type LayoutResult, type PaletteColors, type PaletteConfig, type ParsedChart, type ParsedD3, type ParsedEChart, type ParsedGraph, type ParsedQuadrant, type ParsedSequenceDgmo, type ParticipantType, RULE_COUNT, type RenderStep, type SectionMessageGroup, type SequenceBlock, type SequenceElement, type SequenceGroup, type SequenceMessage, type SequenceNote, type SequenceParticipant, type SequenceRenderOptions, type SequenceSection, addDurationToDate, applyGroupOrdering, applyPositionOverrides, boldPalette, buildEChartsOption, buildEChartsOptionFromChart, buildMermaidQuadrant, buildMermaidThemeVars, buildNoteMessageMap, buildRenderSequence, buildThemeCSS, catppuccinPalette, colorNames, computeActivations, computeTimeTicks, contrastText, formatDateLabel, getAvailablePalettes, getDgmoFramework, getPalette, getSeriesColors, groupMessagesBySection, gruvboxPalette, hexToHSL, hexToHSLString, hslToHex, inferParticipantType, isSequenceBlock, isSequenceNote, isValidHex, layoutGraph, looksLikeFlowchart, looksLikeSequence, mute, nord, nordPalette, oneDarkPalette, orderArcNodes, parseChart, parseD3, parseDgmoChartType, parseEChart, parseFlowchart, parseQuadrant, parseSequenceDgmo, parseTimelineDate, registerPalette, render, renderArcDiagram, renderD3ForExport, renderEChartsForExport, renderFlowchart, renderFlowchartForExport, renderQuadrant, renderSequenceDiagram, renderSlopeChart, renderTimeline, renderVenn, renderWordCloud, resolveColor, rosePinePalette, seriesColors, shade, solarizedPalette, tint, tokyoNightPalette };