@fengwk/kchart 0.0.0-stage → 0.1.1

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.
Files changed (201) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/LICENSE +21 -0
  3. package/NOTICE.md +11 -0
  4. package/README.md +68 -2
  5. package/README.zh-CN.md +69 -0
  6. package/dist/LICENSE +21 -0
  7. package/dist/NOTICE.md +11 -0
  8. package/dist/assets/ICONS-LICENSE.txt +53 -0
  9. package/dist/assets/maps/LICENSE.md +75 -0
  10. package/dist/assets/maps/METADATA.md +9 -0
  11. package/dist/assets/maps/REGIONS.md +28 -0
  12. package/dist/assets/maps/us-states.geojson +1 -0
  13. package/dist/assets/maps/world.geojson +1 -0
  14. package/dist/esm/_virtual/_kchart-families.js +48 -0
  15. package/dist/esm/_virtual/_rolldown/runtime.js +12 -0
  16. package/dist/esm/assets/icons.js +11 -0
  17. package/dist/esm/assets/maps/us-states.js +3 -0
  18. package/dist/esm/assets/maps/world.js +3 -0
  19. package/dist/esm/assets/themes/claude.js +69 -0
  20. package/dist/esm/assets/themes/cloudmusic.js +62 -0
  21. package/dist/esm/assets/themes/kanagawa.js +67 -0
  22. package/dist/esm/assets/themes/obsidian.js +67 -0
  23. package/dist/esm/assets/themes/paper.js +61 -0
  24. package/dist/esm/assets/themes/terminal.js +60 -0
  25. package/dist/esm/assets/themes/tokyo.js +62 -0
  26. package/dist/esm/chart/basic.js +1313 -0
  27. package/dist/esm/chart/catalog.js +476 -0
  28. package/dist/esm/chart/composition.js +844 -0
  29. package/dist/esm/chart/context.js +189 -0
  30. package/dist/esm/chart/distribution.js +442 -0
  31. package/dist/esm/chart/fields.js +67 -0
  32. package/dist/esm/chart/maps.js +563 -0
  33. package/dist/esm/chart/mindmap.js +629 -0
  34. package/dist/esm/chart/multivariate.js +1229 -0
  35. package/dist/esm/chart/registry.js +108 -0
  36. package/dist/esm/chart/relations.js +949 -0
  37. package/dist/esm/chart/spec.js +1415 -0
  38. package/dist/esm/chart/stat-compare.js +302 -0
  39. package/dist/esm/chart/stat-trend.js +181 -0
  40. package/dist/esm/chart/statistics.js +1007 -0
  41. package/dist/esm/chart/unit-variants.js +645 -0
  42. package/dist/esm/chart/variants.js +552 -0
  43. package/dist/esm/core/color.js +197 -0
  44. package/dist/esm/core/context.js +256 -0
  45. package/dist/esm/core/diagnostics.js +23 -0
  46. package/dist/esm/core/format.js +167 -0
  47. package/dist/esm/core/geometry.js +130 -0
  48. package/dist/esm/core/icon-data.js +5 -0
  49. package/dist/esm/core/icons.js +173 -0
  50. package/dist/esm/core/scale.js +112 -0
  51. package/dist/esm/core/scene.js +234 -0
  52. package/dist/esm/core/svg.js +89 -0
  53. package/dist/esm/core/text.js +184 -0
  54. package/dist/esm/core/theme.js +318 -0
  55. package/dist/esm/diagram/agentflow.js +596 -0
  56. package/dist/esm/diagram/architecture.js +729 -0
  57. package/dist/esm/diagram/block.js +988 -0
  58. package/dist/esm/diagram/blocks.js +687 -0
  59. package/dist/esm/diagram/c4.js +1002 -0
  60. package/dist/esm/diagram/class.js +1158 -0
  61. package/dist/esm/diagram/cynefin.js +749 -0
  62. package/dist/esm/diagram/emphasis.js +7 -0
  63. package/dist/esm/diagram/er.js +657 -0
  64. package/dist/esm/diagram/eventmodeling.js +948 -0
  65. package/dist/esm/diagram/gantt-date.js +323 -0
  66. package/dist/esm/diagram/gantt.js +661 -0
  67. package/dist/esm/diagram/gitgraph.js +472 -0
  68. package/dist/esm/diagram/graph-layout.js +4046 -0
  69. package/dist/esm/diagram/graph-parse.js +1366 -0
  70. package/dist/esm/diagram/graph-route.js +490 -0
  71. package/dist/esm/diagram/graph.js +553 -0
  72. package/dist/esm/diagram/ishikawa.js +496 -0
  73. package/dist/esm/diagram/journey.js +512 -0
  74. package/dist/esm/diagram/kanban.js +280 -0
  75. package/dist/esm/diagram/label.js +56 -0
  76. package/dist/esm/diagram/layers.js +385 -0
  77. package/dist/esm/diagram/map-label.js +44 -0
  78. package/dist/esm/diagram/mindmap.js +277 -0
  79. package/dist/esm/diagram/numeric-composition.js +78 -0
  80. package/dist/esm/diagram/numeric-model.js +86 -0
  81. package/dist/esm/diagram/numeric-parse.js +205 -0
  82. package/dist/esm/diagram/numeric-radar.js +355 -0
  83. package/dist/esm/diagram/numeric-sankey.js +201 -0
  84. package/dist/esm/diagram/numeric-xy.js +422 -0
  85. package/dist/esm/diagram/packet.js +175 -0
  86. package/dist/esm/diagram/presentation.js +252 -0
  87. package/dist/esm/diagram/quadrant.js +297 -0
  88. package/dist/esm/diagram/railroad-parse.js +465 -0
  89. package/dist/esm/diagram/railroad.js +294 -0
  90. package/dist/esm/diagram/registry.js +296 -0
  91. package/dist/esm/diagram/relations.js +966 -0
  92. package/dist/esm/diagram/requirement.js +341 -0
  93. package/dist/esm/diagram/sequence.js +1228 -0
  94. package/dist/esm/diagram/shapes.js +366 -0
  95. package/dist/esm/diagram/source.js +538 -0
  96. package/dist/esm/diagram/support.js +153 -0
  97. package/dist/esm/diagram/swimlane-mermaid.js +140 -0
  98. package/dist/esm/diagram/swimlane.js +1186 -0
  99. package/dist/esm/diagram/time.js +748 -0
  100. package/dist/esm/diagram/timeline.js +376 -0
  101. package/dist/esm/diagram/tree-family-icon.js +22 -0
  102. package/dist/esm/diagram/treeview.js +293 -0
  103. package/dist/esm/diagram/usecase.js +852 -0
  104. package/dist/esm/diagram/venn.js +1038 -0
  105. package/dist/esm/diagram/wardley.js +838 -0
  106. package/dist/esm/index.d.ts +133 -0
  107. package/dist/esm/index.js +92 -0
  108. package/dist/esm/interaction.js +561 -0
  109. package/dist/esm/mermaid.d.ts +28 -0
  110. package/dist/esm/mermaid.js +70 -0
  111. package/dist/esm/node.d.ts +68 -0
  112. package/dist/esm/node.js +373 -0
  113. package/dist/esm/package.json +1 -0
  114. package/dist/esm/page-api.js +65 -0
  115. package/dist/esm/runtime.js +352 -0
  116. package/dist/esm/src/families.js +209 -0
  117. package/dist/page-api.js +1 -0
  118. package/dist/units/chart/basic.js +1 -0
  119. package/dist/units/chart/catalog.js +1 -0
  120. package/dist/units/chart/composition.js +1 -0
  121. package/dist/units/chart/context.js +1 -0
  122. package/dist/units/chart/distribution.js +1 -0
  123. package/dist/units/chart/fields.js +1 -0
  124. package/dist/units/chart/maps.js +1 -0
  125. package/dist/units/chart/mindmap.js +1 -0
  126. package/dist/units/chart/multivariate.js +1 -0
  127. package/dist/units/chart/registry.js +1 -0
  128. package/dist/units/chart/relations.js +1 -0
  129. package/dist/units/chart/spec.js +3 -0
  130. package/dist/units/chart/stat-compare.js +1 -0
  131. package/dist/units/chart/stat-trend.js +1 -0
  132. package/dist/units/chart/statistics.js +1 -0
  133. package/dist/units/chart/unit-variants.js +1 -0
  134. package/dist/units/chart/variants.js +1 -0
  135. package/dist/units/core/color.js +1 -0
  136. package/dist/units/core/context.js +1 -0
  137. package/dist/units/core/diagnostics.js +1 -0
  138. package/dist/units/core/format.js +1 -0
  139. package/dist/units/core/geometry.js +1 -0
  140. package/dist/units/core/icon-data.js +1 -0
  141. package/dist/units/core/icons.js +1 -0
  142. package/dist/units/core/scale.js +1 -0
  143. package/dist/units/core/scene.js +1 -0
  144. package/dist/units/core/svg.js +1 -0
  145. package/dist/units/core/text.js +2 -0
  146. package/dist/units/core/theme.js +1 -0
  147. package/dist/units/diagram/agentflow.js +12 -0
  148. package/dist/units/diagram/architecture.js +4 -0
  149. package/dist/units/diagram/block.js +2 -0
  150. package/dist/units/diagram/blocks.js +2 -0
  151. package/dist/units/diagram/c4.js +6 -0
  152. package/dist/units/diagram/class.js +5 -0
  153. package/dist/units/diagram/cynefin.js +4 -0
  154. package/dist/units/diagram/emphasis.js +1 -0
  155. package/dist/units/diagram/er.js +9 -0
  156. package/dist/units/diagram/eventmodeling.js +5 -0
  157. package/dist/units/diagram/gantt-date.js +1 -0
  158. package/dist/units/diagram/gantt.js +3 -0
  159. package/dist/units/diagram/gitgraph.js +2 -0
  160. package/dist/units/diagram/graph-layout.js +4 -0
  161. package/dist/units/diagram/graph-parse.js +9 -0
  162. package/dist/units/diagram/graph-route.js +1 -0
  163. package/dist/units/diagram/graph.js +1 -0
  164. package/dist/units/diagram/ishikawa.js +2 -0
  165. package/dist/units/diagram/journey.js +5 -0
  166. package/dist/units/diagram/kanban.js +2 -0
  167. package/dist/units/diagram/label.js +4 -0
  168. package/dist/units/diagram/layers.js +1 -0
  169. package/dist/units/diagram/map-label.js +1 -0
  170. package/dist/units/diagram/mindmap.js +2 -0
  171. package/dist/units/diagram/numeric-composition.js +1 -0
  172. package/dist/units/diagram/numeric-model.js +1 -0
  173. package/dist/units/diagram/numeric-parse.js +2 -0
  174. package/dist/units/diagram/numeric-radar.js +3 -0
  175. package/dist/units/diagram/numeric-sankey.js +2 -0
  176. package/dist/units/diagram/numeric-xy.js +2 -0
  177. package/dist/units/diagram/packet.js +2 -0
  178. package/dist/units/diagram/presentation.js +2 -0
  179. package/dist/units/diagram/quadrant.js +2 -0
  180. package/dist/units/diagram/railroad-parse.js +4 -0
  181. package/dist/units/diagram/railroad.js +1 -0
  182. package/dist/units/diagram/registry.js +2 -0
  183. package/dist/units/diagram/relations.js +3 -0
  184. package/dist/units/diagram/requirement.js +3 -0
  185. package/dist/units/diagram/sequence.js +2 -0
  186. package/dist/units/diagram/shapes.js +60 -0
  187. package/dist/units/diagram/source.js +20 -0
  188. package/dist/units/diagram/support.js +3 -0
  189. package/dist/units/diagram/swimlane-mermaid.js +3 -0
  190. package/dist/units/diagram/swimlane.js +2 -0
  191. package/dist/units/diagram/time.js +3 -0
  192. package/dist/units/diagram/timeline.js +2 -0
  193. package/dist/units/diagram/tree-family-icon.js +1 -0
  194. package/dist/units/diagram/treeview.js +2 -0
  195. package/dist/units/diagram/usecase.js +3 -0
  196. package/dist/units/diagram/venn.js +2 -0
  197. package/dist/units/diagram/wardley.js +4 -0
  198. package/dist/units/interaction.js +1 -0
  199. package/dist/units/runtime.js +1 -0
  200. package/dist/units.json +712 -0
  201. package/package.json +30 -4
@@ -0,0 +1,133 @@
1
+ export type Media = 'screen' | 'print';
2
+ export type Syntax = 'mermaid' | 'layers' | 'blocks' | 'swimlane';
3
+ export type Tones = readonly [string, string, string, string, string, string];
4
+ type Background = 'bg' | 'surface' | 'surface2';
5
+ type Status = 'new' | 'info' | 'ok' | 'warn' | 'danger' | 'ext';
6
+ type TextColor = 'fg1' | 'fg2' | 'fg3' | 'fg4';
7
+ type ColorRole = TextColor | Status | 'accent' | `tone${1 | 2 | 3 | 4 | 5 | 6}`;
8
+
9
+ export interface DiagramStyle {
10
+ radius: number;
11
+ smallRadius: number;
12
+ soft: number;
13
+ nodeBackground: Background;
14
+ }
15
+
16
+ export interface ThemeStyle extends DiagramStyle {
17
+ blockBackground: Background | 'transparent';
18
+ codeBackground: Background | 'node';
19
+ displayFont: string;
20
+ displayWeight: number;
21
+ numberFont: 'sans' | 'mono';
22
+ numberStyle: 'decimal' | 'decimal-leading-zero';
23
+ numberColor: ColorRole;
24
+ listMarker: ColorRole;
25
+ }
26
+
27
+ export type Theme = Readonly<Record<Background | TextColor | Status | 'line' | 'line2' | 'accent', string> & {
28
+ id?: string;
29
+ scheme: 'light' | 'dark';
30
+ fontFamily: string;
31
+ tones: Tones;
32
+ name?: string;
33
+ en?: string;
34
+ desc?: string;
35
+ frameInk?: string;
36
+ tint?: Readonly<{ hue: number; chroma: number }>;
37
+ style?: Readonly<Partial<ThemeStyle>>;
38
+ diagram?: Readonly<Partial<DiagramStyle>>;
39
+ }>;
40
+
41
+ export interface ChartSpec {
42
+ chart: string;
43
+ [field: string]: unknown;
44
+ }
45
+
46
+ export interface RenderOptions {
47
+ width?: number;
48
+ lang?: string;
49
+ theme?: string | Theme;
50
+ media?: Media;
51
+ frame?: boolean;
52
+ prefix?: string;
53
+ measure?: (text: string, size: number, weight: number, fontFamily: string) => number;
54
+ assets?: Record<string, unknown>;
55
+ }
56
+
57
+ export interface CheckOptions { syntax?: Syntax; lang?: string }
58
+ export interface DiagramOptions extends RenderOptions { syntax?: Syntax }
59
+ export interface ChartDiagnostic {
60
+ code: string;
61
+ message: string;
62
+ fix: string;
63
+ path?: string;
64
+ location?: { offset: number; line: number; column: number };
65
+ }
66
+ export interface DiagramDiagnostic {
67
+ code: string;
68
+ message: string;
69
+ fix: string;
70
+ line: number;
71
+ column: number;
72
+ topic: string;
73
+ /** Errors block rendering; warnings accompany a rendered SVG. */
74
+ severity: 'error' | 'warning';
75
+ }
76
+
77
+ export interface SceneNode {
78
+ tag: string;
79
+ attrs: Record<string, unknown>;
80
+ children?: SceneNode[];
81
+ text?: string;
82
+ meta?: Record<string, unknown>;
83
+ }
84
+
85
+ export interface Scene {
86
+ width: number;
87
+ height: number;
88
+ children: SceneNode[];
89
+ title?: string;
90
+ heading?: string;
91
+ subtitle?: string;
92
+ source?: string;
93
+ note?: string;
94
+ overflow?: { left: number; top: number; right: number; bottom: number };
95
+ }
96
+
97
+ export type RenderResult<D = ChartDiagnostic> =
98
+ | { svg: string; scene: Scene; diagnostics: D[] }
99
+ | { svg: null; scene: null; diagnostics: D[] };
100
+
101
+ export interface DiagramType {
102
+ readonly kind: string;
103
+ readonly syntax: Syntax;
104
+ readonly topic: string;
105
+ readonly aliases: readonly string[];
106
+ }
107
+
108
+ export interface ChartType {
109
+ readonly name: string;
110
+ readonly shape: string;
111
+ readonly required: readonly string[];
112
+ readonly optional: readonly string[];
113
+ readonly special: Readonly<Record<string, string | readonly string[]>>;
114
+ readonly arrayRoles: readonly string[];
115
+ readonly encodeForms: readonly (readonly string[])[];
116
+ readonly requiredSpecial: readonly string[];
117
+ }
118
+
119
+ export function render(spec: ChartSpec, options?: RenderOptions): Promise<RenderResult>;
120
+ export function diagram(source: string, options?: DiagramOptions): Promise<RenderResult<DiagramDiagnostic>>;
121
+ export function check(source: string, options?: CheckOptions): Promise<DiagramDiagnostic[]>;
122
+ export function theme(idOrObject?: string | Theme, options?: { media?: Media }): Theme;
123
+ export const themes: Readonly<Record<string, Theme>>;
124
+ export const catalog: Readonly<Record<string, ChartType>>;
125
+ export const diagramTypes: readonly DiagramType[];
126
+
127
+ /** Register Iconify geometry process-wide; a later registration replaces the same prefix:name. */
128
+ export function registerIcons(iconifyJson: {
129
+ prefix: string;
130
+ icons: Record<string, { body: string; width?: number; height?: number }>;
131
+ width?: number;
132
+ height?: number;
133
+ }): void;
@@ -0,0 +1,92 @@
1
+ import { createPageApi } from "./page-api.js";
2
+ import { catalog } from "./chart/catalog.js";
3
+ import { theme, themes } from "./core/theme.js";
4
+ import { prepareSource } from "./diagram/source.js";
5
+ import families_default from "./src/families.js";
6
+ import { loadFamily } from "./_virtual/_kchart-families.js";
7
+ import { registerIcons } from "./core/icons.js";
8
+ // index.js
9
+ var charts = /* @__PURE__ */ new Map();
10
+ var decorators = /* @__PURE__ */ new Map();
11
+ var diagrams = /* @__PURE__ */ new Map();
12
+ var types = [];
13
+ for (const [family, entry] of Object.entries(families_default)) {
14
+ for (const chart of entry.charts || []) charts.set(chart, family);
15
+ for (const [chart, variants] of Object.entries(entry.variants || {})) decorators.set(chart, {
16
+ family,
17
+ variants,
18
+ charts: Object.keys(entry.variants)
19
+ });
20
+ for (const [kind, { syntax = "mermaid", topic, aliases = [] }] of Object.entries(entry.diagrams || {})) {
21
+ for (const name of [kind, ...aliases]) diagrams.set(name.toLowerCase(), {
22
+ family,
23
+ syntax
24
+ });
25
+ types.push(Object.freeze({
26
+ kind,
27
+ syntax,
28
+ topic,
29
+ aliases: Object.freeze(aliases)
30
+ }));
31
+ }
32
+ }
33
+ var diagramTypes = Object.freeze(types);
34
+ var maps = /* #__PURE__ */ Object.assign({
35
+ "./assets/maps/us-states.geojson": () => import("./assets/maps/us-states.js").then((m) => m["default"]),
36
+ "./assets/maps/world.geojson": () => import("./assets/maps/world.js").then((m) => m["default"])
37
+ });
38
+ var plain = (value) => JSON.parse(JSON.stringify(value));
39
+ async function render(spec, options = {}) {
40
+ const chart = spec?.chart;
41
+ const family = charts.get(chart);
42
+ const candidate = decorators.get(chart);
43
+ const decorator = candidate?.variants.includes(spec.variant) ? candidate : void 0;
44
+ const bases = new Set(decorator ? decorator.charts.map((name) => charts.get(name)) : family ? [family] : []);
45
+ const name = spec?.data?.map?.asset;
46
+ const map = family === "chart/maps" && !options.assets && typeof name === "string" ? maps[`./assets/maps/${name}.geojson`] : void 0;
47
+ const [registryModule, chartSpec, context, layouts, variants, mapText] = await Promise.all([
48
+ import("./chart/registry.js"),
49
+ import("./chart/spec.js"),
50
+ import("./chart/context.js"),
51
+ Promise.all([...bases].map((id) => loadFamily[id]())),
52
+ decorator && loadFamily[decorator.family](),
53
+ map?.()
54
+ ]);
55
+ const registry = registryModule.createRegistry(chartSpec.validate);
56
+ for (const layout of layouts) layout.install(registry);
57
+ variants?.install(registry);
58
+ const api = createPageApi({
59
+ "chart/spec": chartSpec,
60
+ "chart/catalog": { catalog },
61
+ "chart/context": context,
62
+ "core/theme": {
63
+ theme,
64
+ themes
65
+ }
66
+ }, [], [], false, registry);
67
+ const assets = mapText === void 0 ? options.assets : { [name]: JSON.parse(mapText) };
68
+ return plain(api.render(spec, {
69
+ ...options,
70
+ assets
71
+ }));
72
+ }
73
+ async function diagramApi(source, options) {
74
+ const syntax = options.syntax || "mermaid";
75
+ const { kind } = prepareSource(source, {
76
+ syntax,
77
+ lang: options.lang
78
+ });
79
+ const selected = diagrams.get(kind.toLowerCase());
80
+ const family = selected?.syntax.toLowerCase() === syntax.toLowerCase() ? selected.family : void 0;
81
+ const [registry, unit] = await Promise.all([import("./diagram/registry.js"), family && loadFamily[family]()]);
82
+ const modules = { "diagram/registry": registry };
83
+ if (unit) modules[family] = unit;
84
+ return createPageApi(modules, [], diagramTypes, true);
85
+ }
86
+ async function diagram(source, options = {}) {
87
+ return plain((await diagramApi(source, options)).diagram(source, options));
88
+ }
89
+ async function check(source, options = {}) {
90
+ return plain((await diagramApi(source, options)).check(source, options));
91
+ }
92
+ export { catalog, check, diagram, diagramTypes, registerIcons, render, theme, themes };