schematex 0.5.0 → 0.5.2

package/dist/tools-BHWaJPOl.d.ts

@@ -0,0 +1,153 @@
+import { S as SchematexConfig } from './api-Cr_MxttI.js';
+import { q as DiagramType } from './types-WTr9W5Ud.js';
+
+/**
+ * Diagram registry — metadata for every diagram type Schematex supports.
+ *
+ * This is the index an LLM sees when calling `listDiagrams()`. Descriptions
+ * are tuned to help the model pick the right type for a user request.
+ */
+
+type DiagramCluster = "relationships" | "electrical-industrial" | "corporate-legal" | "causality-analysis" | "generic" | "strategy" | "knowledge" | "behavior-modeling" | "research" | "project-management";
+interface DiagramMeta {
+    /** Canonical type id — matches `DiagramType` and plugin keys. */
+    type: DiagramType;
+    /** Human-readable name. */
+    name: string;
+    /** One-sentence tagline. */
+    tagline: string;
+    /** When should an LLM pick this diagram? Written in "use X when …" form. */
+    useWhen: string;
+    /** Domain cluster for grouping. */
+    cluster: DiagramCluster;
+    /** Published standard the parser and layout follow. */
+    standard: string;
+    /** Path to the syntax doc key in the generated content bundle. */
+    syntaxKey: string;
+}
+declare const DIAGRAM_REGISTRY: readonly DiagramMeta[];
+declare function resolveDiagramType(type: string): DiagramType | undefined;
+declare function getDiagramMeta(type: string): DiagramMeta | undefined;
+declare function getAllDiagramTypes(): DiagramType[];
+
+/** Structured error type returned by the AI tool layer. */
+interface SchematexValidationError {
+    /** 1-based line number where the error occurred, if the parser reported it. */
+    line?: number;
+    /** 1-based column, if reported. */
+    column?: number;
+    /** Source snippet from the offending line, if the parser captured it. */
+    source?: string;
+    /** Human-readable error message. */
+    message: string;
+    /** Optional remediation hint. */
+    hint?: string;
+}
+
+/**
+ * AUTO-GENERATED by scripts/build-ai-content.mjs — do not edit by hand.
+ * Regenerate with: npm run build:ai
+ *
+ * Compiled content bundle for the AI tool layer. Keeps MDX content
+ * available to the published npm package without runtime fs access.
+ */
+interface GeneratedExample {
+    slug: string;
+    diagram: string;
+    title: string;
+    description: string;
+    standard: string;
+    tags: readonly string[];
+    complexity: number;
+    featured: boolean;
+    dsl: string;
+    notes: string;
+}
+
+/**
+ * Example library — runtime lookup over the bundled MDX examples.
+ */
+
+type Example = GeneratedExample;
+interface GetExamplesOptions {
+    /** Maximum number of examples to return. Default 5. */
+    limit?: number;
+    /** Prefer examples marked `featured: true` when set. */
+    preferFeatured?: boolean;
+    /** Maximum complexity (1–5). */
+    maxComplexity?: number;
+}
+
+/**
+ * Syntax lookup — LLM-facing per-diagram grammar reference.
+ *
+ * The default "canonical" view stays intentionally narrow for first-shot
+ * generation. The "reference" view preserves the fuller stripped-MDX docs
+ * when a caller needs advanced syntax or adapter coverage.
+ */
+
+type SyntaxDetail = "canonical" | "reference";
+interface SyntaxDoc {
+    key: string;
+    title: string;
+    detail: SyntaxDetail;
+    content: string;
+}
+
+/**
+ * AI-facing tool functions — the five tools an LLM uses to work with Schematex.
+ *
+ * Pure TypeScript, zero framework deps. Both the Vercel AI SDK adapter
+ * (ai-sdk.ts) and the MCP server wrap these functions.
+ */
+
+interface DiagramListItem {
+    type: string;
+    name: string;
+    tagline: string;
+    useWhen: string;
+    cluster: DiagramMeta["cluster"];
+    standard: string;
+}
+declare function listDiagrams(): DiagramListItem[];
+interface GetSyntaxResult {
+    type: string;
+    name: string;
+    standard: string;
+    syntax: SyntaxDoc;
+}
+interface GetSyntaxOptions {
+    /** `canonical` is the compact first-shot generation surface. */
+    detail?: SyntaxDetail;
+}
+declare function getSyntax(type: string, opts?: GetSyntaxOptions): GetSyntaxResult;
+interface GetExamplesResult {
+    type: string;
+    count: number;
+    examples: Example[];
+}
+declare function getExamples(type: string, opts?: GetExamplesOptions): GetExamplesResult;
+type ValidateDslResult = {
+    ok: true;
+    type: string | null;
+} | {
+    ok: false;
+    type: string | null;
+    errors: SchematexValidationError[];
+};
+declare function validateDsl(type: string | undefined, dsl: string): ValidateDslResult;
+type RenderDslResult = {
+    ok: true;
+    status: "valid" | "partial";
+    type: string | null;
+    svg: string;
+} | {
+    ok: false;
+    status: "invalid";
+    type: string | null;
+    svg: string;
+    errors: SchematexValidationError[];
+};
+declare function renderDsl(type: string | undefined, dsl: string, options?: Omit<SchematexConfig, "type">): RenderDslResult;
+
+export { DIAGRAM_REGISTRY as D, type Example as E, type GetExamplesOptions as G, type RenderDslResult as R, type SchematexValidationError as S, type ValidateDslResult as V, type DiagramCluster as a, type DiagramListItem as b, type DiagramMeta as c, type GetExamplesResult as d, type GetSyntaxOptions as e, type GetSyntaxResult as f, type SyntaxDetail as g, type SyntaxDoc as h, getAllDiagramTypes as i, getDiagramMeta as j, getExamples as k, getSyntax as l, listDiagrams as m, resolveDiagramType as n, renderDsl as r, validateDsl as v };

package/dist/tools-DlpuE76u.d.cts

@@ -0,0 +1,153 @@
+import { S as SchematexConfig } from './api-C5SECOxZ.cjs';
+import { q as DiagramType } from './types-WTr9W5Ud.cjs';
+
+/**
+ * Diagram registry — metadata for every diagram type Schematex supports.
+ *
+ * This is the index an LLM sees when calling `listDiagrams()`. Descriptions
+ * are tuned to help the model pick the right type for a user request.
+ */
+
+type DiagramCluster = "relationships" | "electrical-industrial" | "corporate-legal" | "causality-analysis" | "generic" | "strategy" | "knowledge" | "behavior-modeling" | "research" | "project-management";
+interface DiagramMeta {
+    /** Canonical type id — matches `DiagramType` and plugin keys. */
+    type: DiagramType;
+    /** Human-readable name. */
+    name: string;
+    /** One-sentence tagline. */
+    tagline: string;
+    /** When should an LLM pick this diagram? Written in "use X when …" form. */
+    useWhen: string;
+    /** Domain cluster for grouping. */
+    cluster: DiagramCluster;
+    /** Published standard the parser and layout follow. */
+    standard: string;
+    /** Path to the syntax doc key in the generated content bundle. */
+    syntaxKey: string;
+}
+declare const DIAGRAM_REGISTRY: readonly DiagramMeta[];
+declare function resolveDiagramType(type: string): DiagramType | undefined;
+declare function getDiagramMeta(type: string): DiagramMeta | undefined;
+declare function getAllDiagramTypes(): DiagramType[];
+
+/** Structured error type returned by the AI tool layer. */
+interface SchematexValidationError {
+    /** 1-based line number where the error occurred, if the parser reported it. */
+    line?: number;
+    /** 1-based column, if reported. */
+    column?: number;
+    /** Source snippet from the offending line, if the parser captured it. */
+    source?: string;
+    /** Human-readable error message. */
+    message: string;
+    /** Optional remediation hint. */
+    hint?: string;
+}
+
+/**
+ * AUTO-GENERATED by scripts/build-ai-content.mjs — do not edit by hand.
+ * Regenerate with: npm run build:ai
+ *
+ * Compiled content bundle for the AI tool layer. Keeps MDX content
+ * available to the published npm package without runtime fs access.
+ */
+interface GeneratedExample {
+    slug: string;
+    diagram: string;
+    title: string;
+    description: string;
+    standard: string;
+    tags: readonly string[];
+    complexity: number;
+    featured: boolean;
+    dsl: string;
+    notes: string;
+}
+
+/**
+ * Example library — runtime lookup over the bundled MDX examples.
+ */
+
+type Example = GeneratedExample;
+interface GetExamplesOptions {
+    /** Maximum number of examples to return. Default 5. */
+    limit?: number;
+    /** Prefer examples marked `featured: true` when set. */
+    preferFeatured?: boolean;
+    /** Maximum complexity (1–5). */
+    maxComplexity?: number;
+}
+
+/**
+ * Syntax lookup — LLM-facing per-diagram grammar reference.
+ *
+ * The default "canonical" view stays intentionally narrow for first-shot
+ * generation. The "reference" view preserves the fuller stripped-MDX docs
+ * when a caller needs advanced syntax or adapter coverage.
+ */
+
+type SyntaxDetail = "canonical" | "reference";
+interface SyntaxDoc {
+    key: string;
+    title: string;
+    detail: SyntaxDetail;
+    content: string;
+}
+
+/**
+ * AI-facing tool functions — the five tools an LLM uses to work with Schematex.
+ *
+ * Pure TypeScript, zero framework deps. Both the Vercel AI SDK adapter
+ * (ai-sdk.ts) and the MCP server wrap these functions.
+ */
+
+interface DiagramListItem {
+    type: string;
+    name: string;
+    tagline: string;
+    useWhen: string;
+    cluster: DiagramMeta["cluster"];
+    standard: string;
+}
+declare function listDiagrams(): DiagramListItem[];
+interface GetSyntaxResult {
+    type: string;
+    name: string;
+    standard: string;
+    syntax: SyntaxDoc;
+}
+interface GetSyntaxOptions {
+    /** `canonical` is the compact first-shot generation surface. */
+    detail?: SyntaxDetail;
+}
+declare function getSyntax(type: string, opts?: GetSyntaxOptions): GetSyntaxResult;
+interface GetExamplesResult {
+    type: string;
+    count: number;
+    examples: Example[];
+}
+declare function getExamples(type: string, opts?: GetExamplesOptions): GetExamplesResult;
+type ValidateDslResult = {
+    ok: true;
+    type: string | null;
+} | {
+    ok: false;
+    type: string | null;
+    errors: SchematexValidationError[];
+};
+declare function validateDsl(type: string | undefined, dsl: string): ValidateDslResult;
+type RenderDslResult = {
+    ok: true;
+    status: "valid" | "partial";
+    type: string | null;
+    svg: string;
+} | {
+    ok: false;
+    status: "invalid";
+    type: string | null;
+    svg: string;
+    errors: SchematexValidationError[];
+};
+declare function renderDsl(type: string | undefined, dsl: string, options?: Omit<SchematexConfig, "type">): RenderDslResult;
+
+export { DIAGRAM_REGISTRY as D, type Example as E, type GetExamplesOptions as G, type RenderDslResult as R, type SchematexValidationError as S, type ValidateDslResult as V, type DiagramCluster as a, type DiagramListItem as b, type DiagramMeta as c, type GetExamplesResult as d, type GetSyntaxOptions as e, type GetSyntaxResult as f, type SyntaxDetail as g, type SyntaxDoc as h, getAllDiagramTypes as i, getDiagramMeta as j, getExamples as k, getSyntax as l, listDiagrams as m, resolveDiagramType as n, renderDsl as r, validateDsl as v };

package/dist/{types-BOAsqHoU.d.cts → types-WTr9W5Ud.d.cts}

@@ -8,7 +8,7 @@
  *   - Layout:   DiagramAST → LayoutResult
  *   - Renderer: LayoutResult → SVG string
  */
-type DiagramType = "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert";
+type DiagramType = "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert" | "sequence";
 type GenogramMode = "medical" | "heritage";
 /**
  * Standard legend positions:
@@ -823,4 +823,4 @@ interface FlowchartLayoutResult {
     clusters: FlowchartLayoutCluster[];
 }
 
-export type { BlockAST as B, CircuitAST as C, DiagramPlugin as D, EntityAST as E, FishboneAST as F, Individual as I, LayoutConfig as L, PhyloTreeAST as P, RenderConfig as R, SLDAST as S, TimingAST as T, VennAST as V, DiagramAST as a, LayoutResult as b, PhyloLayoutNode as c, LegendOverrides as d, LadderAST as e, LadderRung as f, LadderElement as g, SLDNode as h, SLDNodeType as i, EntityNode as j, EntityEdge as k, VennLayoutResult as l, LogicGateAST as m, FlowchartAST as n, FlowchartLayoutResult as o, CircuitComponent as p, DiagramType as q };
+export type { BlockAST as B, CircuitAST as C, DiagramPlugin as D, EntityAST as E, FishboneAST as F, Individual as I, LayoutConfig as L, PhyloTreeAST as P, RenderConfig as R, SLDAST as S, TimingAST as T, VennAST as V, DiagramAST as a, LayoutResult as b, PhyloLayoutNode as c, LegendOverrides as d, LogicGateAST as e, CircuitComponent as f, LadderAST as g, LadderRung as h, LadderElement as i, SLDNode as j, SLDNodeType as k, EntityNode as l, EntityEdge as m, VennLayoutResult as n, FlowchartAST as o, FlowchartLayoutResult as p, DiagramType as q };

package/dist/{types-BOAsqHoU.d.ts → types-WTr9W5Ud.d.ts}

@@ -8,7 +8,7 @@
  *   - Layout:   DiagramAST → LayoutResult
  *   - Renderer: LayoutResult → SVG string
  */
-type DiagramType = "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert";
+type DiagramType = "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert" | "sequence";
 type GenogramMode = "medical" | "heritage";
 /**
  * Standard legend positions:
@@ -823,4 +823,4 @@ interface FlowchartLayoutResult {
     clusters: FlowchartLayoutCluster[];
 }
 
-export type { BlockAST as B, CircuitAST as C, DiagramPlugin as D, EntityAST as E, FishboneAST as F, Individual as I, LayoutConfig as L, PhyloTreeAST as P, RenderConfig as R, SLDAST as S, TimingAST as T, VennAST as V, DiagramAST as a, LayoutResult as b, PhyloLayoutNode as c, LegendOverrides as d, LadderAST as e, LadderRung as f, LadderElement as g, SLDNode as h, SLDNodeType as i, EntityNode as j, EntityEdge as k, VennLayoutResult as l, LogicGateAST as m, FlowchartAST as n, FlowchartLayoutResult as o, CircuitComponent as p, DiagramType as q };
+export type { BlockAST as B, CircuitAST as C, DiagramPlugin as D, EntityAST as E, FishboneAST as F, Individual as I, LayoutConfig as L, PhyloTreeAST as P, RenderConfig as R, SLDAST as S, TimingAST as T, VennAST as V, DiagramAST as a, LayoutResult as b, PhyloLayoutNode as c, LegendOverrides as d, LogicGateAST as e, CircuitComponent as f, LadderAST as g, LadderRung as h, LadderElement as i, SLDNode as j, SLDNodeType as k, EntityNode as l, EntityEdge as m, VennLayoutResult as n, FlowchartAST as o, FlowchartLayoutResult as p, DiagramType as q };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "schematex",
-  "version": "0.5.0",
-  "description": "Every diagram a doctor, engineer, or lawyer would actually use. 29 industry-standard diagrams (genogram, pedigree, ladder logic, SLD, FBD, SFC, P&ID, UML use case, PRISMA, phylo, fishbone, entity structure, ...) from a text DSL. Free, fully open source, made for AI. Pure SVG, zero dependencies.",
+  "version": "0.5.2",
+  "description": "Every diagram a doctor, engineer, or lawyer would actually use. 31 industry-standard diagrams (genogram, pedigree, ladder logic, SLD, FBD, SFC, P&ID, UML use case, UML sequence, PRISMA, phylo, fishbone, entity structure, ...) from a text DSL. Free, fully open source, made for AI. Pure SVG, zero dependencies.",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/dist/api-C5UcmT7n.d.cts

@@ -1,22 +0,0 @@
-interface SchematexConfig {
-    type?: "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert";
-    width?: number;
-    height?: number;
-    padding?: number;
-    theme?: string;
-    fontFamily?: string;
-}
-/**
- * Parse DSL text to the diagram's AST and return it as a plain object.
- * Useful for JSON serialization, programmatic inspection, or custom renderers.
- *
- * @example
- * ```ts
- * const ast = parse('genogram\n  alice [female]');
- * console.log(JSON.stringify(ast, null, 2));
- * ```
- */
-declare function parse(text: string, config?: SchematexConfig): unknown;
-declare function render(text: string, config?: SchematexConfig): string;
-
-export { type SchematexConfig as S, parse as p, render as r };

package/dist/api-C5UcmT7n.d.ts

@@ -1,22 +0,0 @@
-interface SchematexConfig {
-    type?: "genogram" | "ecomap" | "pedigree" | "phylo" | "sociogram" | "timing" | "logic" | "circuit" | "blockdiagram" | "ladder" | "sld" | "entity" | "fishbone" | "venn" | "flowchart" | "mindmap" | "matrix" | "orgchart" | "decisiontree" | "timeline" | "state" | "pid" | "erd" | "breadboard" | "bpmn" | "fbd" | "sfc" | "prisma" | "usecase" | "pert";
-    width?: number;
-    height?: number;
-    padding?: number;
-    theme?: string;
-    fontFamily?: string;
-}
-/**
- * Parse DSL text to the diagram's AST and return it as a plain object.
- * Useful for JSON serialization, programmatic inspection, or custom renderers.
- *
- * @example
- * ```ts
- * const ast = parse('genogram\n  alice [female]');
- * console.log(JSON.stringify(ast, null, 2));
- * ```
- */
-declare function parse(text: string, config?: SchematexConfig): unknown;
-declare function render(text: string, config?: SchematexConfig): string;
-
-export { type SchematexConfig as S, parse as p, render as r };