schematex 0.8.2 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -24,6 +24,19 @@ interface DiagramMeta {
24
24
  standard: string;
25
25
  /** Path to the syntax doc key in the generated content bundle. */
26
26
  syntaxKey: string;
27
+ /**
28
+ * Other *names* the same diagram goes by — what a user types as the noun
29
+ * ("single-line diagram" → sld, "cap table" → entity). One canonical CJK
30
+ * name may be included. Powers the "Also known as" line on doc pages, SEO
31
+ * synonyms, and LLM type routing. Goal: populate for every type (tracked P1).
32
+ */
33
+ aliases?: readonly string[];
34
+ /**
35
+ * Search-intent terms that are NOT names — use-cases, industries, standards,
36
+ * jobs-to-be-done ("PLC programming", "M&A due diligence", "IEC 61131-3").
37
+ * Powers SEO `keywords` meta + on-site search. Goal: populate every type (P1).
38
+ */
39
+ keywords?: readonly string[];
27
40
  }
28
41
  declare const DIAGRAM_REGISTRY: readonly DiagramMeta[];
29
42
  /**
@@ -116,6 +129,10 @@ interface DiagramListItem {
116
129
  useWhen: string;
117
130
  cluster: DiagramMeta["cluster"];
118
131
  standard: string;
132
+ /** Other names the same diagram goes by — helps map a user request to a type. */
133
+ aliases?: readonly string[];
134
+ /** Use-case / industry / standard search terms (not names). */
135
+ keywords?: readonly string[];
119
136
  }
120
137
  declare function listDiagrams(): DiagramListItem[];
121
138
  interface GetSyntaxResult {
@@ -167,4 +184,4 @@ type RenderDslResult = {
167
184
  };
168
185
  declare function renderDsl(type: string | undefined, dsl: string, options?: Omit<SchematexConfig, "type">): RenderDslResult;
169
186
 
170
- 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, DIAGRAM_SINCE as a, type DiagramCluster as b, type DiagramListItem as c, type DiagramMeta as d, type GetExamplesResult as e, type GetSyntaxOptions as f, type GetSyntaxResult as g, type SyntaxDetail as h, type SyntaxDoc as i, getAllDiagramTypes as j, getDiagramMeta as k, getDiagramSince as l, getExamples as m, getSyntax as n, listDiagrams as o, resolveDiagramType as p, renderDsl as r, validateDsl as v };
187
+ export { DIAGRAM_REGISTRY as D, type Example as E, type GetExamplesOptions as G, type RenderDslResult as R, type SyntaxDetail as S, type ValidateDslResult as V, DIAGRAM_SINCE as a, type DiagramCluster as b, type DiagramListItem as c, type DiagramMeta as d, type GetExamplesResult as e, type GetSyntaxOptions as f, type GetSyntaxResult as g, type SchematexValidationError as h, type SyntaxDoc as i, getAllDiagramTypes as j, getDiagramMeta as k, getDiagramSince as l, getExamples as m, getSyntax as n, listDiagrams as o, resolveDiagramType as p, renderDsl as r, validateDsl as v };
@@ -24,6 +24,19 @@ interface DiagramMeta {
24
24
  standard: string;
25
25
  /** Path to the syntax doc key in the generated content bundle. */
26
26
  syntaxKey: string;
27
+ /**
28
+ * Other *names* the same diagram goes by — what a user types as the noun
29
+ * ("single-line diagram" → sld, "cap table" → entity). One canonical CJK
30
+ * name may be included. Powers the "Also known as" line on doc pages, SEO
31
+ * synonyms, and LLM type routing. Goal: populate for every type (tracked P1).
32
+ */
33
+ aliases?: readonly string[];
34
+ /**
35
+ * Search-intent terms that are NOT names — use-cases, industries, standards,
36
+ * jobs-to-be-done ("PLC programming", "M&A due diligence", "IEC 61131-3").
37
+ * Powers SEO `keywords` meta + on-site search. Goal: populate every type (P1).
38
+ */
39
+ keywords?: readonly string[];
27
40
  }
28
41
  declare const DIAGRAM_REGISTRY: readonly DiagramMeta[];
29
42
  /**
@@ -116,6 +129,10 @@ interface DiagramListItem {
116
129
  useWhen: string;
117
130
  cluster: DiagramMeta["cluster"];
118
131
  standard: string;
132
+ /** Other names the same diagram goes by — helps map a user request to a type. */
133
+ aliases?: readonly string[];
134
+ /** Use-case / industry / standard search terms (not names). */
135
+ keywords?: readonly string[];
119
136
  }
120
137
  declare function listDiagrams(): DiagramListItem[];
121
138
  interface GetSyntaxResult {
@@ -167,4 +184,4 @@ type RenderDslResult = {
167
184
  };
168
185
  declare function renderDsl(type: string | undefined, dsl: string, options?: Omit<SchematexConfig, "type">): RenderDslResult;
169
186
 
170
- 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, DIAGRAM_SINCE as a, type DiagramCluster as b, type DiagramListItem as c, type DiagramMeta as d, type GetExamplesResult as e, type GetSyntaxOptions as f, type GetSyntaxResult as g, type SyntaxDetail as h, type SyntaxDoc as i, getAllDiagramTypes as j, getDiagramMeta as k, getDiagramSince as l, getExamples as m, getSyntax as n, listDiagrams as o, resolveDiagramType as p, renderDsl as r, validateDsl as v };
187
+ export { DIAGRAM_REGISTRY as D, type Example as E, type GetExamplesOptions as G, type RenderDslResult as R, type SyntaxDetail as S, type ValidateDslResult as V, DIAGRAM_SINCE as a, type DiagramCluster as b, type DiagramListItem as c, type DiagramMeta as d, type GetExamplesResult as e, type GetSyntaxOptions as f, type GetSyntaxResult as g, type SchematexValidationError as h, type SyntaxDoc as i, getAllDiagramTypes as j, getDiagramMeta as k, getDiagramSince as l, getExamples as m, getSyntax as n, listDiagrams as o, resolveDiagramType as p, renderDsl as r, validateDsl as v };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "schematex",
3
- "version": "0.8.2",
3
+ "version": "0.9.0",
4
4
  "description": "Every diagram a doctor, engineer, or lawyer would actually use. 36 industry-standard diagrams (genogram, pedigree, ladder logic, SLD, FBD, SFC, P&ID, UML class, UML use case, UML sequence, fault tree, bowtie, PRISMA, phylo, fishbone, entity structure, ...) from a text DSL. Free, fully open source, made for AI. Pure SVG, zero dependencies.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",