@uigraph/sdk 1.2.12 → 1.2.13

package/dist/index.d.cts

@@ -914,4 +914,95 @@ declare function convertMermaidToReactFlowWithContext(mermaidCode: string, conte
 //#region src/uig-converter/index.d.ts
 declare function convertUiGraphToMermaid(input: UiGraphInput, options?: UiGraphOptions): UigOutput;
 //#endregion
-export { AstToSqlGenerator, AstToUiConverter, BasicDetailsSchema, C4Boundary, C4BoundaryKind, C4DiagramData, C4DiagramType, C4Direction, C4Element, C4ElementKind, C4ElementShape, C4ElementStyle, C4LayoutConfig, C4NodeType, C4RelDirection, C4RelStyle, C4Relationship, C4_COLORS, C4_LAYOUT, CheckConstraintAST, ColumnAST, ComponentInputType, ConstraintAST, CustomData, DataTypeAST, DefaultValueAST, DialectIdSchema, DocumentCollectionSchema, DocumentIndexSchema, DynamoAttributeSchema, DynamoEditorSchema, DynamoGsiSchema, EditorSupportedDialectSchema, ForeignKeyConstraintAST, IndexAST, IndexColumnAST, IndexMethodAST, JsonEditorSchema, LinkOrFileValue, MermaidEdge, MermaidNode, MongoCollectionSchema, MongoEditorSchema, MongoIndexFieldSchema, MongoIndexSchema, MongoNestedFieldSchema, NestedFieldSchema, NoSqlFieldSchema, PrimaryKeyConstraintAST, RFComponentField, ReactFlowData, ReferentialActionAST, SEQUENCE_LAYOUT, SchemaAST, SchemaDialect, SchemaUIRepresentation, SequenceActivation, SequenceArrowHead, SequenceAutonumber, SequenceBlock, SequenceBlockSection, SequenceBlockType, SequenceBox, SequenceDiagramData, SequenceMessage, SequenceNote, SequenceParticipant, SequenceParticipantLink, SequenceParticipantType, ServerComponentField, ServerComponentFieldInput, SqlToAstParser, SubgraphInfo, SubgraphLayout, TParsedColumn, TParsedForeignKey, TParsedIndex, TParsedSchema, TParsedTable, TableAST, TableOptionsAST, UniqueConstraintAST, buildMetaData, computeDiagramSyncHash, contextSchema, convertC4MermaidToReactFlow, convertC4ToReactFlow, convertDynamoSchemaToAst, convertJsonSchemaToAst, convertMermaidToReactFlow, convertMermaidToReactFlowWithContext, convertMongoSchemaToAst, convertNoSQLToAst, convertReactFlowToC4Mermaid, convertReactFlowToC4UiGraph, convertReactFlowToSequenceMermaid, convertReactFlowToSequenceUiGraph, convertUiGraphToMermaid, estimateSequenceMessageBoxSize, flattenMetaData, generateTableNodeId, generateUUID, getC4ElementColors, isC4Diagram, isC4ReactFlowDiagram, isSequenceDiagram, parseC4Diagram, sanitizeMermaidLabels, syncBaseData };
+//#region src/registry/node-types.d.ts
+declare const SHAPE_IDS: readonly ["rectangle", "rounded-rect", "ellipse", "diamond", "triangle", "parallelogram", "trapezoid", "hexagon", "document", "cylinder", "delay", "off-page-connector", "display", "collate", "sort", "terminator", "or", "database", "multiple-documents", "subroutine", "manual-input", "summing-junction", "internal-storage"];
+type ShapeId = (typeof SHAPE_IDS)[number];
+declare const STROKE_STYLES: readonly ["solid", "dashed", "dotted"];
+type StrokeStyleId = (typeof STROKE_STYLES)[number];
+type DiagramTypeId = 'flowchart' | 'sequence' | 'c4';
+/** Style fields a beautify-style patch may carry, independent of node tag. */
+type NodeStylePatchInput = {
+  fill?: string;
+  stroke?: string;
+  strokeWidth?: number;
+  strokeStyle?: StrokeStyleId;
+  cornerRadius?: number;
+  textColor?: string;
+  textFontSize?: number;
+  shape?: ShapeId;
+};
+type NodeTypeSpec = {
+  tag: string;
+  diagramTypes: DiagramTypeId[];
+  isContainer: boolean;
+  /** Whether AI/beautify is allowed to resize this node type directly. */
+  geometryEditable: boolean;
+  /** Valid `data.shape` values for this tag, if it supports shapes. */
+  shapes?: readonly ShapeId[];
+  /** Maps a generic style patch onto this node type's own `data` field names. */
+  mapStylePatch: (patch: NodeStylePatchInput) => Record<string, unknown>;
+};
+/**
+ * Canonical per-node-tag registry, shared by generate, beautify, and (later)
+ * MCP tools, so node-type vocabulary and style-field mapping live in exactly
+ * one place instead of being re-declared per consumer.
+ */
+declare const NODE_TYPE_REGISTRY: Record<string, NodeTypeSpec>;
+declare function getNodeTypeSpec(type: string | undefined): NodeTypeSpec | undefined;
+/** Replaces the old per-route `buildNodeDataPatch` switch statement. */
+declare function buildNodeStyleDataPatch(type: string | undefined, patch: NodeStylePatchInput): Record<string, unknown>;
+declare function isGeometryEditableNodeType(type: string | undefined): boolean;
+//#endregion
+//#region src/registry/themes.d.ts
+/**
+ * Beautify's color source of truth. Instead of asking an LLM to invent raw
+ * hex values per request (inconsistent contrast, no guarantee a container's
+ * fill differs from its boundary, no way to keep edge labels legible when
+ * the palette changes), the model picks a themeId and assigns each node a
+ * semantic role — the actual colors always come from here, pre-chosen and
+ * checked for contrast once, not re-derived per call.
+ */
+declare const THEME_ROLES: readonly ["boundary", "client", "service", "data", "messaging", "neutral"];
+type ThemeRole = (typeof THEME_ROLES)[number];
+type ThemeColorPair = {
+  fill: string;
+  stroke: string;
+};
+type ThemeSpec = {
+  id: string;
+  label: string;
+  description: string;
+  mode: 'dark' | 'light';
+  /** Surfaced in the beautify prompt so a free-text request ("soft pastel")
+   * can be matched to the closest catalog theme. */
+  promptHint: string;
+  /** Text color used on every role-colored node (boundary included). */
+  nodeText: string;
+  /**
+   * Color for anything drawn directly on the app's canvas rather than on a
+   * node's own fill — currently just sequence diagram participants (their
+   * name and lifeline have no box, no fill, and can never have one). The
+   * canvas is a fixed dark `#141925` regardless of the chosen theme's mode,
+   * so this must always be light/bright enough to read against it — it is
+   * NOT the same requirement as `nodeText`, which is chosen to read against
+   * that theme's own (possibly light) role fills.
+   */
+  canvasText: string;
+  roles: Record<ThemeRole, ThemeColorPair>;
+  edge: {
+    stroke: string;
+    strokeWidth: number;
+    labelBackground: string;
+    labelText: string;
+    emphasizedStroke: string;
+    emphasizedStrokeWidth: number;
+  };
+};
+declare const DEFAULT_THEME_ID = "professional";
+declare const THEME_REGISTRY: Record<string, ThemeSpec>;
+declare function getTheme(themeId: string | undefined): ThemeSpec;
+/** Renders the catalog as prompt context so the model can match a free-text
+ * style request to the closest theme instead of inventing colors. */
+declare function buildThemeCatalogPromptContext(): string;
+//#endregion
+export { AstToSqlGenerator, AstToUiConverter, BasicDetailsSchema, C4Boundary, C4BoundaryKind, C4DiagramData, C4DiagramType, C4Direction, C4Element, C4ElementKind, C4ElementShape, C4ElementStyle, C4LayoutConfig, C4NodeType, C4RelDirection, C4RelStyle, C4Relationship, C4_COLORS, C4_LAYOUT, CheckConstraintAST, ColumnAST, ComponentInputType, ConstraintAST, CustomData, DEFAULT_THEME_ID, DataTypeAST, DefaultValueAST, type DiagramTypeId, DialectIdSchema, DocumentCollectionSchema, DocumentIndexSchema, DynamoAttributeSchema, DynamoEditorSchema, DynamoGsiSchema, EditorSupportedDialectSchema, ForeignKeyConstraintAST, IndexAST, IndexColumnAST, IndexMethodAST, JsonEditorSchema, LinkOrFileValue, MermaidEdge, MermaidNode, MongoCollectionSchema, MongoEditorSchema, MongoIndexFieldSchema, MongoIndexSchema, MongoNestedFieldSchema, NODE_TYPE_REGISTRY, NestedFieldSchema, NoSqlFieldSchema, type NodeStylePatchInput, type NodeTypeSpec, PrimaryKeyConstraintAST, RFComponentField, ReactFlowData, ReferentialActionAST, SEQUENCE_LAYOUT, SHAPE_IDS, STROKE_STYLES, SchemaAST, SchemaDialect, SchemaUIRepresentation, SequenceActivation, SequenceArrowHead, SequenceAutonumber, SequenceBlock, SequenceBlockSection, SequenceBlockType, SequenceBox, SequenceDiagramData, SequenceMessage, SequenceNote, SequenceParticipant, SequenceParticipantLink, SequenceParticipantType, ServerComponentField, ServerComponentFieldInput, type ShapeId, SqlToAstParser, type StrokeStyleId, SubgraphInfo, SubgraphLayout, THEME_REGISTRY, THEME_ROLES, TParsedColumn, TParsedForeignKey, TParsedIndex, TParsedSchema, TParsedTable, TableAST, TableOptionsAST, type ThemeColorPair, type ThemeRole, type ThemeSpec, UniqueConstraintAST, buildMetaData, buildNodeStyleDataPatch, buildThemeCatalogPromptContext, computeDiagramSyncHash, contextSchema, convertC4MermaidToReactFlow, convertC4ToReactFlow, convertDynamoSchemaToAst, convertJsonSchemaToAst, convertMermaidToReactFlow, convertMermaidToReactFlowWithContext, convertMongoSchemaToAst, convertNoSQLToAst, convertReactFlowToC4Mermaid, convertReactFlowToC4UiGraph, convertReactFlowToSequenceMermaid, convertReactFlowToSequenceUiGraph, convertUiGraphToMermaid, estimateSequenceMessageBoxSize, flattenMetaData, generateTableNodeId, generateUUID, getC4ElementColors, getNodeTypeSpec, getTheme, isC4Diagram, isC4ReactFlowDiagram, isGeometryEditableNodeType, isSequenceDiagram, parseC4Diagram, sanitizeMermaidLabels, syncBaseData };

package/dist/index.d.mts

@@ -914,4 +914,95 @@ declare function convertMermaidToReactFlowWithContext(mermaidCode: string, conte
 //#region src/uig-converter/index.d.ts
 declare function convertUiGraphToMermaid(input: UiGraphInput, options?: UiGraphOptions): UigOutput;
 //#endregion
-export { AstToSqlGenerator, AstToUiConverter, BasicDetailsSchema, C4Boundary, C4BoundaryKind, C4DiagramData, C4DiagramType, C4Direction, C4Element, C4ElementKind, C4ElementShape, C4ElementStyle, C4LayoutConfig, C4NodeType, C4RelDirection, C4RelStyle, C4Relationship, C4_COLORS, C4_LAYOUT, CheckConstraintAST, ColumnAST, ComponentInputType, ConstraintAST, CustomData, DataTypeAST, DefaultValueAST, DialectIdSchema, DocumentCollectionSchema, DocumentIndexSchema, DynamoAttributeSchema, DynamoEditorSchema, DynamoGsiSchema, EditorSupportedDialectSchema, ForeignKeyConstraintAST, IndexAST, IndexColumnAST, IndexMethodAST, JsonEditorSchema, LinkOrFileValue, MermaidEdge, MermaidNode, MongoCollectionSchema, MongoEditorSchema, MongoIndexFieldSchema, MongoIndexSchema, MongoNestedFieldSchema, NestedFieldSchema, NoSqlFieldSchema, PrimaryKeyConstraintAST, RFComponentField, ReactFlowData, ReferentialActionAST, SEQUENCE_LAYOUT, SchemaAST, SchemaDialect, SchemaUIRepresentation, SequenceActivation, SequenceArrowHead, SequenceAutonumber, SequenceBlock, SequenceBlockSection, SequenceBlockType, SequenceBox, SequenceDiagramData, SequenceMessage, SequenceNote, SequenceParticipant, SequenceParticipantLink, SequenceParticipantType, ServerComponentField, ServerComponentFieldInput, SqlToAstParser, SubgraphInfo, SubgraphLayout, TParsedColumn, TParsedForeignKey, TParsedIndex, TParsedSchema, TParsedTable, TableAST, TableOptionsAST, UniqueConstraintAST, buildMetaData, computeDiagramSyncHash, contextSchema, convertC4MermaidToReactFlow, convertC4ToReactFlow, convertDynamoSchemaToAst, convertJsonSchemaToAst, convertMermaidToReactFlow, convertMermaidToReactFlowWithContext, convertMongoSchemaToAst, convertNoSQLToAst, convertReactFlowToC4Mermaid, convertReactFlowToC4UiGraph, convertReactFlowToSequenceMermaid, convertReactFlowToSequenceUiGraph, convertUiGraphToMermaid, estimateSequenceMessageBoxSize, flattenMetaData, generateTableNodeId, generateUUID, getC4ElementColors, isC4Diagram, isC4ReactFlowDiagram, isSequenceDiagram, parseC4Diagram, sanitizeMermaidLabels, syncBaseData };
+//#region src/registry/node-types.d.ts
+declare const SHAPE_IDS: readonly ["rectangle", "rounded-rect", "ellipse", "diamond", "triangle", "parallelogram", "trapezoid", "hexagon", "document", "cylinder", "delay", "off-page-connector", "display", "collate", "sort", "terminator", "or", "database", "multiple-documents", "subroutine", "manual-input", "summing-junction", "internal-storage"];
+type ShapeId = (typeof SHAPE_IDS)[number];
+declare const STROKE_STYLES: readonly ["solid", "dashed", "dotted"];
+type StrokeStyleId = (typeof STROKE_STYLES)[number];
+type DiagramTypeId = 'flowchart' | 'sequence' | 'c4';
+/** Style fields a beautify-style patch may carry, independent of node tag. */
+type NodeStylePatchInput = {
+  fill?: string;
+  stroke?: string;
+  strokeWidth?: number;
+  strokeStyle?: StrokeStyleId;
+  cornerRadius?: number;
+  textColor?: string;
+  textFontSize?: number;
+  shape?: ShapeId;
+};
+type NodeTypeSpec = {
+  tag: string;
+  diagramTypes: DiagramTypeId[];
+  isContainer: boolean;
+  /** Whether AI/beautify is allowed to resize this node type directly. */
+  geometryEditable: boolean;
+  /** Valid `data.shape` values for this tag, if it supports shapes. */
+  shapes?: readonly ShapeId[];
+  /** Maps a generic style patch onto this node type's own `data` field names. */
+  mapStylePatch: (patch: NodeStylePatchInput) => Record<string, unknown>;
+};
+/**
+ * Canonical per-node-tag registry, shared by generate, beautify, and (later)
+ * MCP tools, so node-type vocabulary and style-field mapping live in exactly
+ * one place instead of being re-declared per consumer.
+ */
+declare const NODE_TYPE_REGISTRY: Record<string, NodeTypeSpec>;
+declare function getNodeTypeSpec(type: string | undefined): NodeTypeSpec | undefined;
+/** Replaces the old per-route `buildNodeDataPatch` switch statement. */
+declare function buildNodeStyleDataPatch(type: string | undefined, patch: NodeStylePatchInput): Record<string, unknown>;
+declare function isGeometryEditableNodeType(type: string | undefined): boolean;
+//#endregion
+//#region src/registry/themes.d.ts
+/**
+ * Beautify's color source of truth. Instead of asking an LLM to invent raw
+ * hex values per request (inconsistent contrast, no guarantee a container's
+ * fill differs from its boundary, no way to keep edge labels legible when
+ * the palette changes), the model picks a themeId and assigns each node a
+ * semantic role — the actual colors always come from here, pre-chosen and
+ * checked for contrast once, not re-derived per call.
+ */
+declare const THEME_ROLES: readonly ["boundary", "client", "service", "data", "messaging", "neutral"];
+type ThemeRole = (typeof THEME_ROLES)[number];
+type ThemeColorPair = {
+  fill: string;
+  stroke: string;
+};
+type ThemeSpec = {
+  id: string;
+  label: string;
+  description: string;
+  mode: 'dark' | 'light';
+  /** Surfaced in the beautify prompt so a free-text request ("soft pastel")
+   * can be matched to the closest catalog theme. */
+  promptHint: string;
+  /** Text color used on every role-colored node (boundary included). */
+  nodeText: string;
+  /**
+   * Color for anything drawn directly on the app's canvas rather than on a
+   * node's own fill — currently just sequence diagram participants (their
+   * name and lifeline have no box, no fill, and can never have one). The
+   * canvas is a fixed dark `#141925` regardless of the chosen theme's mode,
+   * so this must always be light/bright enough to read against it — it is
+   * NOT the same requirement as `nodeText`, which is chosen to read against
+   * that theme's own (possibly light) role fills.
+   */
+  canvasText: string;
+  roles: Record<ThemeRole, ThemeColorPair>;
+  edge: {
+    stroke: string;
+    strokeWidth: number;
+    labelBackground: string;
+    labelText: string;
+    emphasizedStroke: string;
+    emphasizedStrokeWidth: number;
+  };
+};
+declare const DEFAULT_THEME_ID = "professional";
+declare const THEME_REGISTRY: Record<string, ThemeSpec>;
+declare function getTheme(themeId: string | undefined): ThemeSpec;
+/** Renders the catalog as prompt context so the model can match a free-text
+ * style request to the closest theme instead of inventing colors. */
+declare function buildThemeCatalogPromptContext(): string;
+//#endregion
+export { AstToSqlGenerator, AstToUiConverter, BasicDetailsSchema, C4Boundary, C4BoundaryKind, C4DiagramData, C4DiagramType, C4Direction, C4Element, C4ElementKind, C4ElementShape, C4ElementStyle, C4LayoutConfig, C4NodeType, C4RelDirection, C4RelStyle, C4Relationship, C4_COLORS, C4_LAYOUT, CheckConstraintAST, ColumnAST, ComponentInputType, ConstraintAST, CustomData, DEFAULT_THEME_ID, DataTypeAST, DefaultValueAST, type DiagramTypeId, DialectIdSchema, DocumentCollectionSchema, DocumentIndexSchema, DynamoAttributeSchema, DynamoEditorSchema, DynamoGsiSchema, EditorSupportedDialectSchema, ForeignKeyConstraintAST, IndexAST, IndexColumnAST, IndexMethodAST, JsonEditorSchema, LinkOrFileValue, MermaidEdge, MermaidNode, MongoCollectionSchema, MongoEditorSchema, MongoIndexFieldSchema, MongoIndexSchema, MongoNestedFieldSchema, NODE_TYPE_REGISTRY, NestedFieldSchema, NoSqlFieldSchema, type NodeStylePatchInput, type NodeTypeSpec, PrimaryKeyConstraintAST, RFComponentField, ReactFlowData, ReferentialActionAST, SEQUENCE_LAYOUT, SHAPE_IDS, STROKE_STYLES, SchemaAST, SchemaDialect, SchemaUIRepresentation, SequenceActivation, SequenceArrowHead, SequenceAutonumber, SequenceBlock, SequenceBlockSection, SequenceBlockType, SequenceBox, SequenceDiagramData, SequenceMessage, SequenceNote, SequenceParticipant, SequenceParticipantLink, SequenceParticipantType, ServerComponentField, ServerComponentFieldInput, type ShapeId, SqlToAstParser, type StrokeStyleId, SubgraphInfo, SubgraphLayout, THEME_REGISTRY, THEME_ROLES, TParsedColumn, TParsedForeignKey, TParsedIndex, TParsedSchema, TParsedTable, TableAST, TableOptionsAST, type ThemeColorPair, type ThemeRole, type ThemeSpec, UniqueConstraintAST, buildMetaData, buildNodeStyleDataPatch, buildThemeCatalogPromptContext, computeDiagramSyncHash, contextSchema, convertC4MermaidToReactFlow, convertC4ToReactFlow, convertDynamoSchemaToAst, convertJsonSchemaToAst, convertMermaidToReactFlow, convertMermaidToReactFlowWithContext, convertMongoSchemaToAst, convertNoSQLToAst, convertReactFlowToC4Mermaid, convertReactFlowToC4UiGraph, convertReactFlowToSequenceMermaid, convertReactFlowToSequenceUiGraph, convertUiGraphToMermaid, estimateSequenceMessageBoxSize, flattenMetaData, generateTableNodeId, generateUUID, getC4ElementColors, getNodeTypeSpec, getTheme, isC4Diagram, isC4ReactFlowDiagram, isGeometryEditableNodeType, isSequenceDiagram, parseC4Diagram, sanitizeMermaidLabels, syncBaseData };