@airalogy/aimd-renderer 2.4.1 → 2.6.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.
- package/LICENSE +201 -0
- package/README.md +10 -5
- package/README.zh-CN.md +10 -5
- package/dist/__tests__/renderer.test.d.ts +2 -0
- package/dist/__tests__/renderer.test.d.ts.map +1 -0
- package/dist/aimd-renderer.css +1 -1
- package/dist/common/annotateStepReferences.d.ts +10 -0
- package/dist/common/annotateStepReferences.d.ts.map +1 -0
- package/dist/common/assignerHighlighting.d.ts +14 -0
- package/dist/common/assignerHighlighting.d.ts.map +1 -0
- package/dist/common/assignerVisibility.d.ts +33 -0
- package/dist/common/assignerVisibility.d.ts.map +1 -0
- package/dist/common/eventKeys.d.ts +20 -0
- package/dist/common/eventKeys.d.ts.map +1 -0
- package/dist/common/figureNumbering.d.ts +30 -0
- package/dist/common/figureNumbering.d.ts.map +1 -0
- package/dist/common/processor.d.ts +96 -0
- package/dist/common/processor.d.ts.map +1 -0
- package/dist/common/quiz-preview.d.ts +11 -0
- package/dist/common/quiz-preview.d.ts.map +1 -0
- package/dist/common/unified-token-renderer.d.ts +124 -0
- package/dist/common/unified-token-renderer.d.ts.map +1 -0
- package/dist/html/index.d.ts +9 -0
- package/dist/html/index.d.ts.map +1 -0
- package/dist/html.js +1 -1
- package/dist/index.d.ts +23 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +270 -225
- package/dist/locales.d.ts +52 -0
- package/dist/locales.d.ts.map +1 -0
- package/dist/{processor-Cv8E7QsA.js → processor-CHbNEcN8.js} +2977 -2212
- package/dist/vue/index.d.ts +10 -0
- package/dist/vue/index.d.ts.map +1 -0
- package/dist/vue/vue-renderer.d.ts +159 -0
- package/dist/vue/vue-renderer.d.ts.map +1 -0
- package/dist/vue.js +10 -9
- package/package.json +17 -17
- package/src/__tests__/renderer.test.ts +220 -2
- package/src/common/processor.ts +177 -43
- package/src/common/unified-token-renderer.ts +106 -26
- package/src/index.ts +3 -0
- package/src/locales.ts +5 -0
- package/src/styles/katex.css +109 -0
- package/src/vue/index.ts +3 -0
- package/src/vue/vue-renderer.ts +320 -50
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Vue rendering exports
|
|
3
|
+
*/
|
|
4
|
+
export { type AimdComponentRenderer, type AimdRendererContext, type AssetResolver, createAssetRenderer, createCodeBlockRenderer, createComponentRenderer, createEmbeddedRenderer, createMermaidRenderer, createStepCardRenderer, loadShikiHighlighter, type CodeBlockRendererOptions, type ElementRenderer, hastToVue, renderToVNodes, type LoadShikiHighlighterOptions, type AimdStepCardRendererOptions, type ShikiHighlighter, type VueRendererOptions, } from './vue-renderer';
|
|
5
|
+
export { renderToVue, createRenderer, defaultRenderer, } from '../common/processor';
|
|
6
|
+
export { createAimdRendererMessages, DEFAULT_AIMD_RENDERER_LOCALE, resolveAimdRendererLocale, } from '../locales';
|
|
7
|
+
export type { RenderContext, RenderMode, ProcessorOptions, } from '@airalogy/aimd-core/types';
|
|
8
|
+
export type { AimdAssignerVisibility, AimdRendererOptions, RenderResult } from '../common/processor';
|
|
9
|
+
export type { AimdRendererI18nOptions, AimdRendererLocale, AimdRendererMessages, AimdRendererMessagesInput, } from '../locales';
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vue/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,SAAS,EACT,cAAc,EACd,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,GACxB,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,WAAW,EACX,cAAc,EACd,eAAe,GAChB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,yBAAyB,GAC1B,MAAM,YAAY,CAAA;AAEnB,YAAY,EACV,aAAa,EACb,UAAU,EACV,gBAAgB,GACjB,MAAM,2BAA2B,CAAA;AAElC,YAAY,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACpG,YAAY,EACV,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,YAAY,CAAA"}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import type { Element, Root as HastRoot, RootContent } from "hast";
|
|
2
|
+
import type { Component, VNode, VNodeChild } from "vue";
|
|
3
|
+
import type { AimdNode, RenderContext } from "@airalogy/aimd-core/types";
|
|
4
|
+
import type { AimdRendererI18nOptions, AimdRendererLocale, AimdRendererMessages } from "../locales";
|
|
5
|
+
/**
|
|
6
|
+
* Extended Element data type
|
|
7
|
+
*/
|
|
8
|
+
export interface AimdElementData {
|
|
9
|
+
aimd?: AimdNode;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* AIMD component renderer function type
|
|
13
|
+
* Can return VNode directly or a Promise for async rendering
|
|
14
|
+
*/
|
|
15
|
+
export type AimdComponentRenderer = (node: AimdNode, ctx: AimdRendererContext, children?: VNodeChild[]) => VNode | Promise<VNode> | null;
|
|
16
|
+
/**
|
|
17
|
+
* Element renderer function type
|
|
18
|
+
*/
|
|
19
|
+
export type ElementRenderer = (node: Element, children: VNodeChild[], ctx: AimdRendererContext) => VNode | null;
|
|
20
|
+
export interface AimdRendererContext extends RenderContext {
|
|
21
|
+
locale: AimdRendererLocale;
|
|
22
|
+
messages: AimdRendererMessages;
|
|
23
|
+
}
|
|
24
|
+
export interface AimdStepCardRendererOptions {
|
|
25
|
+
showScopeLabel?: boolean;
|
|
26
|
+
showCheckBadge?: boolean;
|
|
27
|
+
bodyClassName?: string;
|
|
28
|
+
className?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Render options
|
|
32
|
+
*/
|
|
33
|
+
export interface VueRendererOptions {
|
|
34
|
+
/**
|
|
35
|
+
* Built-in renderer locale
|
|
36
|
+
*/
|
|
37
|
+
locale?: AimdRendererI18nOptions["locale"];
|
|
38
|
+
/**
|
|
39
|
+
* Optional overrides for built-in renderer copy
|
|
40
|
+
*/
|
|
41
|
+
messages?: AimdRendererI18nOptions["messages"];
|
|
42
|
+
/**
|
|
43
|
+
* Render mode shorthand (used when context is not provided)
|
|
44
|
+
*/
|
|
45
|
+
mode?: RenderContext["mode"];
|
|
46
|
+
/**
|
|
47
|
+
* Quiz preview visibility shorthand (used when context is not provided)
|
|
48
|
+
*/
|
|
49
|
+
quizPreview?: RenderContext["quizPreview"];
|
|
50
|
+
/**
|
|
51
|
+
* Render context
|
|
52
|
+
*/
|
|
53
|
+
context?: RenderContext & Partial<Pick<AimdRendererContext, "locale" | "messages">>;
|
|
54
|
+
/**
|
|
55
|
+
* Custom AIMD component renderers
|
|
56
|
+
* Override default renderers or add new ones
|
|
57
|
+
*/
|
|
58
|
+
aimdRenderers?: Record<string, AimdComponentRenderer>;
|
|
59
|
+
/**
|
|
60
|
+
* Custom HTML element renderers
|
|
61
|
+
* Render specific HTML tags with custom components
|
|
62
|
+
*/
|
|
63
|
+
elementRenderers?: Record<string, ElementRenderer>;
|
|
64
|
+
/**
|
|
65
|
+
* Component map for rendering Vue components by tag name
|
|
66
|
+
* e.g., { 'step-renderer': StepRendererComponent }
|
|
67
|
+
*/
|
|
68
|
+
componentMap?: Record<string, Component>;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Figure context for tracking figure numbers and references
|
|
72
|
+
*/
|
|
73
|
+
export interface FigureContext {
|
|
74
|
+
/** Map from fig ID to sequence number */
|
|
75
|
+
figureNumbers: Map<string, number>;
|
|
76
|
+
/** Current figure sequence counter */
|
|
77
|
+
sequence: number;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Convert HAST node to Vue VNode
|
|
81
|
+
*/
|
|
82
|
+
export declare function hastToVue(node: HastRoot | RootContent, options?: VueRendererOptions, figCtx?: FigureContext): VNodeChild;
|
|
83
|
+
/**
|
|
84
|
+
* Convert HAST tree to Vue VNode array
|
|
85
|
+
*/
|
|
86
|
+
export declare function renderToVNodes(tree: HastRoot, options?: VueRendererOptions): VNode[];
|
|
87
|
+
/**
|
|
88
|
+
* Create a custom AIMD renderer that wraps a Vue component
|
|
89
|
+
*/
|
|
90
|
+
export declare function createComponentRenderer(component: Component, propsMapper?: (node: AimdNode, ctx: AimdRendererContext) => Record<string, unknown>): AimdComponentRenderer;
|
|
91
|
+
export declare function createStepCardRenderer(options?: AimdStepCardRendererOptions): AimdComponentRenderer;
|
|
92
|
+
/**
|
|
93
|
+
* Shiki highlighter type (compatible with @shikijs/core)
|
|
94
|
+
*/
|
|
95
|
+
export interface ShikiHighlighter {
|
|
96
|
+
codeToHtml: (code: string, options: {
|
|
97
|
+
lang: string;
|
|
98
|
+
theme: string;
|
|
99
|
+
}) => string;
|
|
100
|
+
codeToTokensBase?: (code: string, options: {
|
|
101
|
+
lang: string;
|
|
102
|
+
theme: string;
|
|
103
|
+
}) => Array<Array<{
|
|
104
|
+
content: string;
|
|
105
|
+
color?: string;
|
|
106
|
+
bgColor?: string;
|
|
107
|
+
fontStyle?: number;
|
|
108
|
+
htmlStyle?: string | Record<string, string>;
|
|
109
|
+
}>>;
|
|
110
|
+
codeToTokensWithThemes?: (code: string, options: {
|
|
111
|
+
lang: string;
|
|
112
|
+
themes: Record<string, string>;
|
|
113
|
+
}) => Array<Array<{
|
|
114
|
+
content: string;
|
|
115
|
+
variants: Record<string, {
|
|
116
|
+
color: string;
|
|
117
|
+
}>;
|
|
118
|
+
}>>;
|
|
119
|
+
}
|
|
120
|
+
export interface CodeBlockRendererOptions {
|
|
121
|
+
theme?: string;
|
|
122
|
+
lineNumbers?: boolean;
|
|
123
|
+
wrap?: boolean;
|
|
124
|
+
className?: string;
|
|
125
|
+
}
|
|
126
|
+
export interface LoadShikiHighlighterOptions {
|
|
127
|
+
themes?: string[];
|
|
128
|
+
langs?: string[];
|
|
129
|
+
}
|
|
130
|
+
export declare function loadShikiHighlighter(options?: LoadShikiHighlighterOptions): Promise<ShikiHighlighter>;
|
|
131
|
+
/**
|
|
132
|
+
* Create code block element renderer with Shiki support
|
|
133
|
+
* @param highlighter - Shiki highlighter instance (can be reactive ref)
|
|
134
|
+
* @param defaultTheme - Default theme to use
|
|
135
|
+
*/
|
|
136
|
+
export declare function createCodeBlockRenderer(highlighter: ShikiHighlighter | null | (() => ShikiHighlighter | null), optionsOrTheme?: string | CodeBlockRendererOptions): ElementRenderer;
|
|
137
|
+
/**
|
|
138
|
+
* Create Mermaid diagram element renderer
|
|
139
|
+
* @param MermaidComponent - Vue component to render Mermaid diagrams
|
|
140
|
+
*/
|
|
141
|
+
export declare function createMermaidRenderer(MermaidComponent: Component): ElementRenderer;
|
|
142
|
+
/**
|
|
143
|
+
* Asset resolver function type
|
|
144
|
+
*/
|
|
145
|
+
export type AssetResolver = (id: string) => Promise<{
|
|
146
|
+
url: string;
|
|
147
|
+
} | null>;
|
|
148
|
+
/**
|
|
149
|
+
* Create image element renderer with asset resolution
|
|
150
|
+
* @param AssetComponent - Vue component to render assets (optional)
|
|
151
|
+
* @param getAsset - Function to resolve asset ID to URL
|
|
152
|
+
*/
|
|
153
|
+
export declare function createAssetRenderer(getAsset?: AssetResolver, AssetComponent?: Component): ElementRenderer;
|
|
154
|
+
/**
|
|
155
|
+
* Create iframe/video element renderer for embedded content
|
|
156
|
+
* @param EmbeddedComponent - Vue component to render embedded content
|
|
157
|
+
*/
|
|
158
|
+
export declare function createEmbeddedRenderer(EmbeddedComponent: Component): ElementRenderer;
|
|
159
|
+
//# sourceMappingURL=vue-renderer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vue-renderer.d.ts","sourceRoot":"","sources":["../../src/vue/vue-renderer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAoB,WAAW,EAAE,MAAM,MAAM,CAAA;AACpF,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACvD,OAAO,KAAK,EAAE,QAAQ,EAA8B,aAAa,EAAE,MAAM,2BAA2B,CAAA;AASpG,OAAO,KAAK,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAUnG;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,mBAAmB,EACxB,QAAQ,CAAC,EAAE,UAAU,EAAE,KACpB,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;AAElC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,UAAU,EAAE,EACtB,GAAG,EAAE,mBAAmB,KACrB,KAAK,GAAG,IAAI,CAAA;AAEjB,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,MAAM,EAAE,kBAAkB,CAAA;IAC1B,QAAQ,EAAE,oBAAoB,CAAA;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAunBD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAC,UAAU,CAAC,CAAA;IAC9C;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAA;IACnF;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IACrD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAClD;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;CACzC;AA6BD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yCAAyC;IACzC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAiOD;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,QAAQ,GAAG,WAAW,EAC5B,OAAO,GAAE,kBAAuB,EAChC,MAAM,CAAC,EAAE,aAAa,GACrB,UAAU,CA8IZ;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,kBAAuB,GAC/B,KAAK,EAAE,CAiBT;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,SAAS,EACpB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,mBAAmB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClF,qBAAqB,CAKvB;AAED,wBAAgB,sBAAsB,CACpC,OAAO,GAAE,2BAAgC,GACxC,qBAAqB,CAmLvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAC9E,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC,CAAC,CAAA;IACnN,sBAAsB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KAAK,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC,CAAC,CAAA;CACrL;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AA8BD,wBAAsB,oBAAoB,CACxC,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,gBAAgB,CAAC,CAgB3B;AAmGD;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,gBAAgB,GAAG,IAAI,GAAG,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC,EACtE,cAAc,GAAE,MAAM,GAAG,wBAAmD,GAC3E,eAAe,CAwFjB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,gBAAgB,EAAE,SAAS,GAC1B,eAAe,CAgCjB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAAA;AAE3E;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,CAAC,EAAE,aAAa,EACxB,cAAc,CAAC,EAAE,SAAS,GACzB,eAAe,CAuBjB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,iBAAiB,EAAE,SAAS,GAC3B,eAAe,CASjB"}
|
package/dist/vue.js
CHANGED
|
@@ -1,17 +1,18 @@
|
|
|
1
|
-
import { D as a, c as
|
|
1
|
+
import { D as a, c as s, f as d, g as n, h as t, i as o, j as R, k as c, l as i, m as l, n as m, o as A, q as E, s as h, e as g } from "./processor-CHbNEcN8.js";
|
|
2
2
|
export {
|
|
3
3
|
a as DEFAULT_AIMD_RENDERER_LOCALE,
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
s as createAimdRendererMessages,
|
|
5
|
+
d as createAssetRenderer,
|
|
6
6
|
n as createCodeBlockRenderer,
|
|
7
7
|
t as createComponentRenderer,
|
|
8
8
|
o as createEmbeddedRenderer,
|
|
9
9
|
R as createMermaidRenderer,
|
|
10
10
|
c as createRenderer,
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
i as createStepCardRenderer,
|
|
12
|
+
l as defaultRenderer,
|
|
13
|
+
m as hastToVue,
|
|
14
|
+
A as loadShikiHighlighter,
|
|
15
|
+
E as renderToVNodes,
|
|
16
|
+
h as renderToVue,
|
|
17
|
+
g as resolveAimdRendererLocale
|
|
17
18
|
};
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@airalogy/aimd-renderer",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.
|
|
5
|
-
"description": "AIMD rendering engines for HTML and Vue",
|
|
4
|
+
"version": "2.6.0",
|
|
5
|
+
"description": "AIMD (Airalogy Markdown) rendering engines for HTML and Vue",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "https://github.com/airalogy/
|
|
10
|
-
"directory": "packages/aimd-renderer"
|
|
9
|
+
"url": "https://github.com/airalogy/airalogy.git",
|
|
10
|
+
"directory": "packages/npm/aimd-renderer"
|
|
11
11
|
},
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/airalogy/
|
|
13
|
+
"url": "https://github.com/airalogy/airalogy/issues"
|
|
14
14
|
},
|
|
15
|
-
"homepage": "https://github.com/airalogy/
|
|
15
|
+
"homepage": "https://github.com/airalogy/airalogy/tree/main/packages/npm/aimd-renderer#readme",
|
|
16
16
|
"keywords": [
|
|
17
17
|
"aimd",
|
|
18
18
|
"markdown",
|
|
@@ -47,21 +47,13 @@
|
|
|
47
47
|
"dist",
|
|
48
48
|
"src"
|
|
49
49
|
],
|
|
50
|
-
"scripts": {
|
|
51
|
-
"type-check": "tsc --noEmit",
|
|
52
|
-
"build:types": "tsc --emitDeclarationOnly --declaration --outDir dist",
|
|
53
|
-
"build": "vite build && pnpm run build:types",
|
|
54
|
-
"dev": "vite build --watch",
|
|
55
|
-
"test": "pnpm run build && node --test ./tests/*.test.mjs"
|
|
56
|
-
},
|
|
57
50
|
"peerDependencies": {
|
|
58
51
|
"vue": "^3.5.17"
|
|
59
52
|
},
|
|
60
53
|
"dependencies": {
|
|
61
|
-
"@airalogy/aimd-core": "workspace:^",
|
|
62
54
|
"@types/hast": "^3.0.4",
|
|
63
55
|
"hast-util-to-html": "^9.0.5",
|
|
64
|
-
"katex": "
|
|
56
|
+
"katex": "^0.16.28",
|
|
65
57
|
"rehype-katex": "^7.0.1",
|
|
66
58
|
"rehype-raw": "^7.0.0",
|
|
67
59
|
"remark-breaks": "^4.0.0",
|
|
@@ -71,7 +63,8 @@
|
|
|
71
63
|
"remark-rehype": "^11.1.2",
|
|
72
64
|
"shiki": "^2.5.0",
|
|
73
65
|
"unified": "^11.0.5",
|
|
74
|
-
"vfile": "^6.0.3"
|
|
66
|
+
"vfile": "^6.0.3",
|
|
67
|
+
"@airalogy/aimd-core": "^2.8.0"
|
|
75
68
|
},
|
|
76
69
|
"devDependencies": {
|
|
77
70
|
"@types/node": "^24.3.0",
|
|
@@ -80,5 +73,12 @@
|
|
|
80
73
|
"vite": "^7.1.3",
|
|
81
74
|
"vite-tsconfig-paths": "^5.1.4",
|
|
82
75
|
"vue": "^3.5.17"
|
|
76
|
+
},
|
|
77
|
+
"scripts": {
|
|
78
|
+
"type-check": "tsc --noEmit",
|
|
79
|
+
"build:types": "tsc --emitDeclarationOnly --declaration --outDir dist",
|
|
80
|
+
"build": "vite build && pnpm run build:types",
|
|
81
|
+
"dev": "vite build --watch",
|
|
82
|
+
"test": "pnpm run build && node --test ./tests/*.test.mjs"
|
|
83
83
|
}
|
|
84
|
-
}
|
|
84
|
+
}
|
|
@@ -9,7 +9,7 @@ import {
|
|
|
9
9
|
createRenderer,
|
|
10
10
|
} from '../common/processor'
|
|
11
11
|
import { getFinalIndent, parseFieldTag } from '../index'
|
|
12
|
-
import { createStepCardRenderer } from '../vue/vue-renderer'
|
|
12
|
+
import { createCodeBlockRenderer, createStepCardRenderer } from '../vue/vue-renderer'
|
|
13
13
|
|
|
14
14
|
function findVNodeByType(node: any, expectedType: string): any | null {
|
|
15
15
|
if (!node || typeof node !== 'object') {
|
|
@@ -109,8 +109,16 @@ describe('resolveQuizPreviewOptions', () => {
|
|
|
109
109
|
|
|
110
110
|
describe('parseAndExtract', () => {
|
|
111
111
|
it('extracts var fields', () => {
|
|
112
|
-
const fields = parseAndExtract('{{var|temperature: float = 36.5}}')
|
|
112
|
+
const fields = parseAndExtract('{{var|temperature: float = 36.5, gt = 0}}')
|
|
113
113
|
expect(fields.var).toContain('temperature')
|
|
114
|
+
expect(fields.var_definitions?.[0]).toMatchObject({
|
|
115
|
+
id: 'temperature',
|
|
116
|
+
type: 'float',
|
|
117
|
+
default: 36.5,
|
|
118
|
+
kwargs: {
|
|
119
|
+
gt: 0,
|
|
120
|
+
},
|
|
121
|
+
})
|
|
114
122
|
})
|
|
115
123
|
|
|
116
124
|
it('extracts step fields', () => {
|
|
@@ -141,6 +149,38 @@ describe('parseAndExtract', () => {
|
|
|
141
149
|
expect(fields.var).toContain('age')
|
|
142
150
|
expect(fields.step.length).toBeGreaterThan(0)
|
|
143
151
|
})
|
|
152
|
+
|
|
153
|
+
it('extracts multiline var tables with object-list defaults', () => {
|
|
154
|
+
const content = `{{var|monitoring_sites: list[MonitoringSite] = [
|
|
155
|
+
{"site_id": "S01", "latitude": 30.0, "longitude": 120.0, "elevation_m": 128.0},
|
|
156
|
+
{"site_id": "S02", "latitude": 30.1, "longitude": 120.1, "elevation_m": 82.0}
|
|
157
|
+
],
|
|
158
|
+
title = "Monitoring sites",
|
|
159
|
+
subvars = [
|
|
160
|
+
var(site_id: str, title = "Site ID"),
|
|
161
|
+
var(latitude: float, title = "Latitude"),
|
|
162
|
+
var(longitude: float, title = "Longitude"),
|
|
163
|
+
var(elevation_m: float, title = "Elevation")
|
|
164
|
+
]
|
|
165
|
+
}}`
|
|
166
|
+
const fields = parseAndExtract(content)
|
|
167
|
+
|
|
168
|
+
expect(fields.var_table[0]).toMatchObject({
|
|
169
|
+
id: 'monitoring_sites',
|
|
170
|
+
title: 'Monitoring sites',
|
|
171
|
+
type_annotation: 'list[MonitoringSite]',
|
|
172
|
+
default: [
|
|
173
|
+
{ site_id: 'S01', latitude: 30, longitude: 120, elevation_m: 128 },
|
|
174
|
+
{ site_id: 'S02', latitude: 30.1, longitude: 120.1, elevation_m: 82 },
|
|
175
|
+
],
|
|
176
|
+
})
|
|
177
|
+
expect(fields.var_table[0]?.subvars.map(subvar => subvar.id)).toEqual([
|
|
178
|
+
'site_id',
|
|
179
|
+
'latitude',
|
|
180
|
+
'longitude',
|
|
181
|
+
'elevation_m',
|
|
182
|
+
])
|
|
183
|
+
})
|
|
144
184
|
})
|
|
145
185
|
|
|
146
186
|
// ---------------------------------------------------------------------------
|
|
@@ -160,6 +200,51 @@ describe('renderToHtmlSync', () => {
|
|
|
160
200
|
expect(html).toContain('temperature')
|
|
161
201
|
})
|
|
162
202
|
|
|
203
|
+
it('renders AIMD var field display metadata', () => {
|
|
204
|
+
const { html, fields } = renderToHtmlSync('{{var|record_date: str, title="Record date", description="ISO date", examples=["2026-05-26", "2026-05-27"]}}')
|
|
205
|
+
expect(fields.var_definitions?.[0]?.title).toBe('Record date')
|
|
206
|
+
expect(fields.var_definitions?.[0]?.description).toBe('ISO date')
|
|
207
|
+
expect(fields.var_definitions?.[0]?.examples).toEqual(['2026-05-26', '2026-05-27'])
|
|
208
|
+
expect(html).toContain('data-aimd-title="Record date"')
|
|
209
|
+
expect(html).toContain('data-aimd-description="ISO date"')
|
|
210
|
+
expect(html).toContain('data-aimd-examples="2026-05-26, 2026-05-27"')
|
|
211
|
+
expect(html).toContain('Record date')
|
|
212
|
+
expect(html).toContain('record_date')
|
|
213
|
+
expect(html).toContain('ISO date')
|
|
214
|
+
expect(html).toContain('aria-label="ISO date')
|
|
215
|
+
expect(html).not.toContain('title="ISO date')
|
|
216
|
+
expect(html).not.toContain('aimd-field__description')
|
|
217
|
+
expect(html).toContain('aimd-field__metadata-popover')
|
|
218
|
+
expect(html).toContain('aimd-field__metadata-examples')
|
|
219
|
+
expect(html).toContain('aimd-field__metadata-example')
|
|
220
|
+
expect(html).toContain('tabindex="0"')
|
|
221
|
+
expect(html).toContain('2026-05-26')
|
|
222
|
+
})
|
|
223
|
+
|
|
224
|
+
it('renders AIMD var_table and column display metadata', () => {
|
|
225
|
+
const { html, fields } = renderToHtmlSync('{{var_table|samples, title="Samples", description="Measured rows", examples=["S-001 row"], subvars=[var(sample_id: str, title="Sample ID", description="Tube identifier", examples=["S-001"])]}}')
|
|
226
|
+
expect(fields.var_table[0]?.title).toBe('Samples')
|
|
227
|
+
expect(fields.var_table[0]?.description).toBe('Measured rows')
|
|
228
|
+
expect(fields.var_table[0]?.examples).toEqual(['S-001 row'])
|
|
229
|
+
expect(fields.var_table[0]?.subvars[0]?.title).toBe('Sample ID')
|
|
230
|
+
expect(fields.var_table[0]?.subvars[0]?.examples).toEqual(['S-001'])
|
|
231
|
+
expect(html).toContain('Samples')
|
|
232
|
+
expect(html).toContain('samples')
|
|
233
|
+
expect(html).toContain('Measured rows')
|
|
234
|
+
expect(html).toContain('S-001 row')
|
|
235
|
+
expect(html).toContain('data-column-id="sample_id"')
|
|
236
|
+
expect(html).toContain('Sample ID')
|
|
237
|
+
expect(html).toContain('Tube identifier')
|
|
238
|
+
expect(html).toContain('aria-label="Measured rows')
|
|
239
|
+
expect(html).toContain('aria-label="Tube identifier')
|
|
240
|
+
expect(html).not.toContain('title="Measured rows')
|
|
241
|
+
expect(html).not.toContain('title="Tube identifier')
|
|
242
|
+
expect(html).not.toContain('aimd-field__description')
|
|
243
|
+
expect(html).toContain('aimd-field__metadata-popover')
|
|
244
|
+
expect(html).toContain('aimd-field__metadata-example')
|
|
245
|
+
expect(html).toContain('S-001')
|
|
246
|
+
})
|
|
247
|
+
|
|
163
248
|
it('returns extracted fields alongside HTML', () => {
|
|
164
249
|
const { fields } = renderToHtmlSync('{{step|wash}} and {{check|verify}}')
|
|
165
250
|
expect(fields.step.length).toBeGreaterThan(0)
|
|
@@ -173,6 +258,51 @@ describe('renderToHtmlSync', () => {
|
|
|
173
258
|
expect(html).toContain('<td')
|
|
174
259
|
})
|
|
175
260
|
|
|
261
|
+
it('renders true/false quiz options and report answers', () => {
|
|
262
|
+
const { html, fields } = renderToHtmlSync(
|
|
263
|
+
[
|
|
264
|
+
'```quiz',
|
|
265
|
+
'id: q_true_false',
|
|
266
|
+
'type: true_false',
|
|
267
|
+
'stem: "The sample stayed cold."',
|
|
268
|
+
'answer: true',
|
|
269
|
+
'```',
|
|
270
|
+
].join('\n'),
|
|
271
|
+
{ mode: 'report' },
|
|
272
|
+
)
|
|
273
|
+
|
|
274
|
+
expect(fields.quiz[0].type).toBe('true_false')
|
|
275
|
+
expect(html).toContain('True/false')
|
|
276
|
+
expect(html).toContain('true. True')
|
|
277
|
+
expect(html).toContain('false. False')
|
|
278
|
+
expect(html).toContain('Answer: true')
|
|
279
|
+
})
|
|
280
|
+
|
|
281
|
+
it('extracts true/false option followups', () => {
|
|
282
|
+
const { fields } = renderToHtmlSync(
|
|
283
|
+
[
|
|
284
|
+
'```quiz',
|
|
285
|
+
'id: q_true_false_followups',
|
|
286
|
+
'type: true_false',
|
|
287
|
+
'stem: "Was precipitate observed?"',
|
|
288
|
+
'options:',
|
|
289
|
+
' - key: true',
|
|
290
|
+
' text: "Yes"',
|
|
291
|
+
' followups:',
|
|
292
|
+
' - key: color',
|
|
293
|
+
' type: str',
|
|
294
|
+
' title: Color',
|
|
295
|
+
' - key: false',
|
|
296
|
+
' text: "No"',
|
|
297
|
+
'```',
|
|
298
|
+
].join('\n'),
|
|
299
|
+
)
|
|
300
|
+
|
|
301
|
+
expect(fields.quiz[0].options?.[0]?.followups).toEqual([
|
|
302
|
+
{ key: 'color', type: 'str', required: true, title: 'Color' },
|
|
303
|
+
])
|
|
304
|
+
})
|
|
305
|
+
|
|
176
306
|
it('supports host custom element renderers for AIMD nodes', () => {
|
|
177
307
|
const { html } = renderToHtmlSync(
|
|
178
308
|
"{{step|verify, 2, title='Verify Output', subtitle='Cross-check', check=True, result=True}}\n\nStep body content.",
|
|
@@ -275,6 +405,94 @@ describe('renderToHtmlSync', () => {
|
|
|
275
405
|
})
|
|
276
406
|
|
|
277
407
|
describe('renderToVue', () => {
|
|
408
|
+
it('renders code blocks with line numbers and wrapping classes', async () => {
|
|
409
|
+
const { nodes } = await renderToVue(
|
|
410
|
+
'```json\n{\n "model":"qwen3.6-flash","enable_search":true\n}\n```',
|
|
411
|
+
{
|
|
412
|
+
elementRenderers: {
|
|
413
|
+
pre: createCodeBlockRenderer(null, {
|
|
414
|
+
lineNumbers: true,
|
|
415
|
+
wrap: true,
|
|
416
|
+
}),
|
|
417
|
+
},
|
|
418
|
+
},
|
|
419
|
+
)
|
|
420
|
+
|
|
421
|
+
const pre = findVNodeByType(nodes[0], 'pre') as any
|
|
422
|
+
expect(pre).toBeTruthy()
|
|
423
|
+
expect(pre.props.class).toContain('aimd-code-block')
|
|
424
|
+
expect(pre.props.class).toContain('aimd-code-block--line-numbers')
|
|
425
|
+
expect(pre.props.class).toContain('aimd-code-block--wrap')
|
|
426
|
+
expect(pre.props['data-lang']).toBe('json')
|
|
427
|
+
const code = findVNodeByType(pre, 'code') as any
|
|
428
|
+
expect(code.children).toHaveLength(3)
|
|
429
|
+
expect(code.children[1].children[1].props.style['--aimd-code-wrap-indent']).toBe('2ch')
|
|
430
|
+
expect(collectVNodeText(pre)).toContain('1')
|
|
431
|
+
expect(collectVNodeText(pre)).toContain('qwen3.6-flash')
|
|
432
|
+
})
|
|
433
|
+
|
|
434
|
+
it('keeps blank code lines visible without adding an extra line for the trailing markdown fence newline', async () => {
|
|
435
|
+
const { nodes } = await renderToVue(
|
|
436
|
+
'```json\n{\n\n "model": "qwen3.6-flash"\n}\n```',
|
|
437
|
+
{
|
|
438
|
+
elementRenderers: {
|
|
439
|
+
pre: createCodeBlockRenderer(null, {
|
|
440
|
+
lineNumbers: true,
|
|
441
|
+
wrap: true,
|
|
442
|
+
}),
|
|
443
|
+
},
|
|
444
|
+
},
|
|
445
|
+
)
|
|
446
|
+
|
|
447
|
+
const pre = findVNodeByType(nodes[0], 'pre') as any
|
|
448
|
+
const code = findVNodeByType(pre, 'code') as any
|
|
449
|
+
expect(code.children).toHaveLength(4)
|
|
450
|
+
expect(code.children[1].children[1].children).toBe('\u00a0')
|
|
451
|
+
expect(code.children[2].children[1].props.style['--aimd-code-wrap-indent']).toBe('2ch')
|
|
452
|
+
})
|
|
453
|
+
|
|
454
|
+
it('uses Shiki token output when a highlighter is available', async () => {
|
|
455
|
+
const highlighter = {
|
|
456
|
+
codeToHtml: (code: string) => code,
|
|
457
|
+
codeToTokensBase: () => [
|
|
458
|
+
[
|
|
459
|
+
{ content: ' ', color: '#24292e' },
|
|
460
|
+
{ content: '"model"', color: '#005cc5' },
|
|
461
|
+
],
|
|
462
|
+
],
|
|
463
|
+
}
|
|
464
|
+
const { nodes } = await renderToVue('```json\n "model"\n```', {
|
|
465
|
+
elementRenderers: {
|
|
466
|
+
pre: createCodeBlockRenderer(highlighter, {
|
|
467
|
+
lineNumbers: true,
|
|
468
|
+
wrap: true,
|
|
469
|
+
}),
|
|
470
|
+
},
|
|
471
|
+
})
|
|
472
|
+
|
|
473
|
+
const pre = findVNodeByType(nodes[0], 'pre') as any
|
|
474
|
+
const code = findVNodeByType(pre, 'code') as any
|
|
475
|
+
const tokenSpans = code.children[0].children[1].children
|
|
476
|
+
expect(tokenSpans[0].props.style).toEqual({ color: '#24292e' })
|
|
477
|
+
expect(tokenSpans[1].props.style).toEqual({ color: '#005cc5' })
|
|
478
|
+
expect(tokenSpans[1].children).toBe('"model"')
|
|
479
|
+
})
|
|
480
|
+
|
|
481
|
+
it('keeps the legacy plain pre fallback when called with a theme string and no highlighter', async () => {
|
|
482
|
+
const { nodes } = await renderToVue('```json\n{"model":"qwen"}\n```', {
|
|
483
|
+
elementRenderers: {
|
|
484
|
+
pre: createCodeBlockRenderer(null, 'github-light'),
|
|
485
|
+
},
|
|
486
|
+
})
|
|
487
|
+
|
|
488
|
+
const pre = findVNodeByType(nodes[0], 'pre') as any
|
|
489
|
+
expect(pre.props.class).toBe('language-json')
|
|
490
|
+
expect(pre.props.class).not.toContain('aimd-code-block')
|
|
491
|
+
const code = findVNodeByType(pre, 'code') as any
|
|
492
|
+
expect(code.props.class).toBe('language-json')
|
|
493
|
+
expect(code.children).toBe('{"model":"qwen"}')
|
|
494
|
+
})
|
|
495
|
+
|
|
278
496
|
it('renders host-ready step cards with grouped body content', async () => {
|
|
279
497
|
const { nodes } = await renderToVue(
|
|
280
498
|
"{{step|verify, 2, title='Verify Output', subtitle='Cross-check', check=True}}\n\nStep body content.",
|