@c2-markdown-ui/mdui-lang 0.0.0-stage → 0.4.4

package/dist/types.d.ts

@@ -0,0 +1,495 @@
+/** 比较运算符：eq 相等（默认，向后兼容）；gt/gte/lt/lte/ne 为数值/时间戳比较 */
+export type FieldWhenOp = 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'ne';
+/** 字段显示条件：依赖字段的值等于 values 任一时显示该字段（form 内联动显隐） */
+export interface FieldWhen {
+    /** 依赖字段的 id */
+    field: string;
+    /** 匹配值列表（任一相等即显示） */
+    values: string[];
+    /** 比较运算符，缺省 eq（相等）。数值/时间戳字段可用 gt/gte/lt/lte/ne（DSL: when:field:>18） */
+    op?: FieldWhenOp;
+}
+/** 多条件显示（AND 组合）：所有条件同时满足才显示该字段。
+ *  单条件时保持 FieldWhen 对象形态（向后兼容）；多条件时为数组。
+ *  DSL 书写为重复 when 修饰符：`when:a:1,2 when:b:3` */
+export type FieldWhenList = FieldWhen | FieldWhen[];
+/** 条件组合：all 为且（全部满足），any 为或（任一满足），两组同时存在时取交集（all 且 any）。
+ *  DSL 书写为 `when:`（且）与 `when-any:`（或）修饰符的重复叠加 */
+export interface FieldWhenGroup {
+    /** 且条件组：全部满足（DSL: when:field:v1,v2） */
+    all?: FieldWhen[];
+    /** 或条件组：任一满足（DSL: when-any:field:v1,v2） */
+    any?: FieldWhen[];
+}
+/** 字段条件显示的完整取值形态：
+ *  - FieldWhen：单条件（向后兼容）
+ *  - FieldWhen[]：多条件 AND（向后兼容）
+ *  - FieldWhenGroup：显式且/或分组（支持 OR） */
+export type FieldWhenValue = FieldWhen | FieldWhen[] | FieldWhenGroup;
+/** 纯文字组件：col/form 内展示静态文字 */
+export interface TextWidget {
+    type: "text";
+    id?: string;
+    /** 文字内容 */
+    text: string;
+    /** 字号：12-48，默认 14 */
+    size?: number;
+    /** 字体颜色（十六进制或 CSS 颜色名） */
+    color?: string;
+    /** 加粗 */
+    bold?: boolean;
+    /** 文字对齐：left（默认）/ center / right */
+    align?: "left" | "center" | "right";
+    /** 是否启用 Alert 提示风格（参考 antd Alert） */
+    alert?: boolean;
+    /** Alert 风格：info（默认）/ warning / error */
+    alertStyle?: "info" | "warning" | "error";
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+export interface TextInputWidget {
+    type: "text-input";
+    id?: string;
+    label?: string;
+    placeholder?: string;
+    default?: string;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填：label 前显示红色 *，提交时空值校验不通过 */
+    required?: boolean;
+    /** 正则校验规则（JS 正则源字符串，如 ^[a-zA-Z0-9_]{3,20}$） */
+    pattern?: string;
+    /** 校验失败时的提示文案，默认"格式不正确" */
+    message?: string;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+export interface ButtonGroupWidget {
+    type: "button-group";
+    id?: string;
+    label?: string;
+    choices: string[];
+    default?: string;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填（button-group 必有选中值，required 主要用于语义标记与校验输出） */
+    required?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 单个按钮组件 */
+export interface ButtonWidget {
+    type: "button";
+    id?: string;
+    /** 按钮文字 */
+    label?: string;
+    /** 背景色（支持十六进制 #3b82f6 或 CSS 颜色名） */
+    color?: string;
+    /** 字体颜色（支持十六进制 #ffffff 或 CSS 颜色名） */
+    textColor?: string;
+    /** 尺寸：small / medium / large，默认 medium */
+    size?: "small" | "medium" | "large";
+    /** 是否禁用 */
+    disabled?: boolean;
+}
+export interface SelectWidget {
+    type: "select";
+    id?: string;
+    label?: string;
+    choices: string[];
+    default?: string;
+    /** 远端数据源 URL：设置后运行时 fetch 拉取选项，choices 作为后备/初始选项 */
+    url?: string;
+    /** 是否可搜索：开启后下拉面板内置搜索框，按 key/value 与 label 过滤选项 */
+    searchable?: boolean;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填（select 必有选中值，required 主要用于语义标记与校验输出） */
+    required?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 级联选择器数据节点（嵌套树形结构，参考 antd Cascader 的数据源格式）
+ *  取值字段兼容 value/key（无 value 时用 key）；aria-label/data-title 等额外字段会被保留但组件不使用；
+ *  无 label 时回退取值展示；无 children 或 children 为空视为叶子节点 */
+export interface CascadeNode {
+    /** 节点取值（表单实际取值，各层级以 / 连接后组成完整路径） */
+    value?: string | number;
+    /** 取值别名（key:label 风格数据源，无 value 时生效） */
+    key?: string | number;
+    /** 展示文案，缺省时用取值 */
+    label?: string | number;
+    /** 子节点（无或空数组 = 叶子） */
+    children?: CascadeNode[];
+    /** 其余透传字段（如 aria-label、data-title 等） */
+    [extra: string]: any;
+}
+/** 级联选择器（参考 antd Cascader）
+ *  静态数据源两种格式（兼容共存），二者同时存在时 data 优先：
+ *  1. choices：扁平路径数组，每项用 / 分隔层级，每段支持 key:label（如 [zj:浙江/hz:杭州]）
+ *  2. data：嵌套对象树数组（CascadeNode[]），如 [{value:'zj',label:'浙江',children:[...]}]
+ *  url：远端数据源，设置后运行时 fetch 拉取（响应为 data 同构的 JSON 树对象），
+ *  choices/data 作为后备/初始选项 */
+export interface CascaderWidget {
+    type: "cascade";
+    id?: string;
+    label?: string;
+    choices: string[];
+    /** 嵌套对象树数据源（与扁平路径 choices 兼容共存，优先于 choices） */
+    data?: CascadeNode[];
+    /** 远端数据源 URL：设置后运行时 fetch 拉取选项（响应为 CascadeNode[] 或 {data|options|...} 包裹） */
+    url?: string;
+    /** 懒加载模式（url 存在时生效）：首次只拉取根级，点击父级后以 url?parent=<value> 逐级请求子级；
+     *  未开启时一次请求返回整棵嵌套树 */
+    lazy?: boolean;
+    /** 默认值：完整路径（如 zj/hz/xhq，叶子 value 的 / 连接串） */
+    default?: string;
+    /** 占位提示文案 */
+    placeholder?: string;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填：未选完整路径时校验不通过 */
+    required?: boolean;
+    /** 校验失败时的提示文案 */
+    message?: string;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+export interface SelectMultiWidget {
+    type: "select-multi";
+    id?: string;
+    label?: string;
+    /** 选项：字符串数组（每项支持 key:label 格式）或对象数组（{key|value,label}，表单取值为 key/value，展示 label） */
+    choices: string[] | Array<{
+        value: string;
+        label: string;
+    }>;
+    default?: string | string[];
+    /** 远端数据源 URL：设置后运行时 fetch 拉取选项，choices 作为后备/初始选项 */
+    url?: string;
+    /** 选项排列方向：vertical 纵向（默认）/ horizontal 横向 */
+    direction?: "vertical" | "horizontal";
+    /** 自定义布局：每行显示的列数（设置后按 N 列网格排列，优先于 direction） */
+    columns?: number;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填：至少勾选一项 */
+    required?: boolean;
+    /** 校验失败时的提示文案，默认"请至少选择一项" */
+    message?: string;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 单选组件（参考 antd Radio.Group）：默认圆点单选样式，button 标记切换为按钮组样式
+ *  （对应 antd optionType:button，合并了按钮组的视觉功能） */
+export interface RadioGroupWidget {
+    type: "radio-group";
+    id?: string;
+    label?: string;
+    /** 选项：字符串数组（每项支持 key:label 格式）或对象数组（{key|value,label}，表单取值为 key/value，展示 label） */
+    choices: string[] | Array<{
+        value: string;
+        label: string;
+    }>;
+    /** 默认选中值（单值） */
+    default?: string;
+    /** 按钮样式：渲染为按钮组（antd Radio optionType:button）而非圆点单选 */
+    button?: boolean;
+    /** 远端数据源 URL：设置后运行时 fetch 拉取选项，choices 作为后备/初始选项 */
+    url?: string;
+    /** 选项排列方向：vertical 纵向（默认）/ horizontal 横向 */
+    direction?: "vertical" | "horizontal";
+    /** 自定义布局：每行显示的列数（设置后按 N 列网格排列，优先于 direction） */
+    columns?: number;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填 */
+    required?: boolean;
+    /** 校验失败时的提示文案 */
+    message?: string;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+export interface SliderWidget {
+    type: "slider";
+    id?: string;
+    label?: string;
+    min: number;
+    max: number;
+    step?: number;
+    default?: number;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填（slider 始终有值，仅用于语义标记） */
+    required?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 开关组件（参考 antd Switch）：布尔切换控件，可配置选中/未选中文案 */
+export interface SwitchWidget {
+    type: "switch";
+    id?: string;
+    label?: string;
+    /** 默认是否选中（缺省 false） */
+    default?: boolean;
+    /** 选中时展示的文案（antd checkedChildren） */
+    checkedText?: string;
+    /** 未选中时展示的文案（antd unCheckedChildren） */
+    unCheckedText?: string;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填（switch 始终有值，仅用于语义标记） */
+    required?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 日期选择框（参考 antd DatePicker） */
+export interface DatePickerWidget {
+    type: "date-picker";
+    id?: string;
+    label?: string;
+    /** 选择模式：date 仅日期（默认）/ datetime 日期+时间 */
+    picker?: "date" | "datetime";
+    /** 范围选择：start 为开始时间、end 为结束时间，缺省单选 */
+    range?: boolean;
+    /** 默认值：时间戳（毫秒）或格式化时间字符串；range 模式为 [start, end] */
+    default?: number | string | (number | string)[];
+    /** 显示格式：YYYY-MM-DD（默认）/ YYYY/MM/DD / YYYY-MM-DD HH:mm:ss 等 */
+    format?: string;
+    /** 占位提示文案 */
+    placeholder?: string;
+    /** 禁用当前日期之前的日期（不可选） */
+    disableBeforeNow?: boolean;
+    /** 禁用当前日期之后的日期（不可选） */
+    disableAfterNow?: boolean;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填 */
+    required?: boolean;
+    /** 校验失败时的提示文案 */
+    message?: string;
+    /** 是否禁用（整组件不可交互） */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 数字输入框（参考 antd InputNumber） */
+export interface NumberInputWidget {
+    type: "number-input";
+    id?: string;
+    label?: string;
+    /** 最小值 */
+    min?: number;
+    /** 最大值 */
+    max?: number;
+    /** 步长（点击上下按钮的增减量），默认 1 */
+    step?: number;
+    /** 数值精度（小数位数，0-100） */
+    precision?: number;
+    default?: number;
+    /** 占位提示文案 */
+    placeholder?: string;
+    /** 表单项说明：渲染在 label 后的 ⓘ 图标，悬浮显示 tooltip */
+    hint?: string;
+    /** 是否必填：空值提交校验不通过 */
+    required?: boolean;
+    /** 校验失败时的提示文案 */
+    message?: string;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 在 form row 内占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 显示条件（form 内联动显隐） */
+    when?: FieldWhenValue;
+}
+/** 表单行（类似 antd Row）：fields 为行内字段，gutter 为列间距（px） */
+export interface FormRow {
+    /** 列间距（px），类似 antd Row 的 gutter */
+    gutter?: number;
+    /** 行内字段列表 */
+    fields: Widget[];
+}
+/** 栅格列（独立栅格组件 row 的 col）：可嵌套任意 widget */
+export interface GridCol {
+    /** 占据的栅格数（1-24，类似 antd Col 的 span），缺省自动均分 */
+    span?: number;
+    /** 左侧偏移栅格数 */
+    offset?: number;
+    /** 垂直对齐：top / middle / bottom */
+    align?: 'top' | 'middle' | 'bottom';
+    /** 列内子组件 */
+    widget?: Widget;
+}
+/** 独立栅格布局组件（类似 antd Row）：24 栅格行，col 为列 */
+export interface RowWidget {
+    type: "row";
+    id?: string;
+    /** 列间距（px），类似 antd Row 的 gutter */
+    gutter?: number;
+    /** 水平排列方式：left（默认）/ center / right / between */
+    justify?: 'left' | 'center' | 'right' | 'between';
+    /** 垂直对齐：top / middle（默认）/ bottom */
+    align?: 'top' | 'middle' | 'bottom';
+    /** 栅格列 */
+    cols: GridCol[];
+}
+export interface FormWidget {
+    type: "form";
+    id?: string;
+    submitLabel?: string;
+    /** 取消按钮文案（如 "取消"），未设置则不显示 */
+    cancelLabel?: string;
+    /** 清空/重置按钮文案（如 "清空"），未设置则不显示 */
+    resetLabel?: string;
+    /** 按钮组对齐方式：left / center / right，默认 left */
+    buttonsAlign?: "left" | "center" | "right";
+    /** 字段 label 与内容的布局：vertical 上下（默认）/ horizontal 左右 */
+    layout?: "vertical" | "horizontal";
+    /** 左右布局时 label 的宽度（px），默认 80 */
+    labelWidth?: number;
+    /** 左右布局时内容区域的宽度（px 或省略自适应填满） */
+    contentWidth?: number;
+    /** 全局横排模式：所有字段自动 flex-wrap 横排 */
+    inline?: boolean;
+    /** 每行显示的列数（配合 inline 使用，默认自适应） */
+    columns?: number;
+    /** 是否禁用：级联禁用所有字段与按钮 */
+    disabled?: boolean;
+    /** 传统的扁平字段列表（纵向堆叠） */
+    fields: Widget[];
+    /** 使用 row 分组的行布局：每个 row 内的字段横排 */
+    rows?: FormRow[];
+}
+export interface ChartWidget {
+    type: "chart-line" | "chart-bar" | "chart-pie" | "chart-scatter";
+    id?: string;
+    title?: string;
+    height?: number;
+    /** 远端数据源 URL：设置后运行时 fetch 拉取（CSV 文本或 JSON），本地 CSV 作为初始/后备数据 */
+    url?: string;
+    /** 是否展示图例：未设置时自动判断（多数据集或饼图时展示） */
+    legend?: boolean;
+    /** 表单字段栅格宽度（1-24，嵌入表单时生效） */
+    span?: number;
+    /** 条件显示：依赖字段的取值命中时才展示（嵌入表单时生效） */
+    when?: FieldWhenValue;
+    labels: string[];
+    datasets: Array<{
+        label: string;
+        data: number[];
+    }>;
+    options?: Record<string, any>;
+}
+export interface MultipleChoiceQuestionWidget {
+    type: "multiple-choice-question";
+    id?: string;
+    question: string;
+    choices: string[];
+    correctAnswer?: string;
+    showFeedback?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+}
+export interface ShortAnswerQuestionWidget {
+    type: "short-answer-question";
+    id?: string;
+    question: string;
+    placeholder?: string;
+    correctAnswer?: string;
+    correctAnswers?: string[];
+    showFeedback?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+}
+export interface QuizQuestion {
+    id: string;
+    type: "mcq" | "short-answer";
+    question: string;
+    points: number;
+    choices?: string[];
+    correctAnswer?: string;
+    placeholder?: string;
+    correctAnswers?: string[];
+}
+export interface QuizWidget {
+    type: "quiz";
+    id?: string;
+    title: string;
+    questions: QuizQuestion[];
+    showScore?: boolean;
+    showProgress?: boolean;
+    passingScore?: number;
+    /** 是否禁用：级联禁用所有题目 */
+    disabled?: boolean;
+}
+export type Widget = TextWidget | TextInputWidget | ButtonGroupWidget | ButtonWidget | SelectWidget | SelectMultiWidget | RadioGroupWidget | CascaderWidget | SliderWidget | SwitchWidget | DatePickerWidget | NumberInputWidget | FormWidget | RowWidget | ChartWidget | MultipleChoiceQuestionWidget | ShortAnswerQuestionWidget | QuizWidget;
+export interface ParseResult {
+    success: boolean;
+    widget?: Widget;
+    error?: string;
+}
+/**
+ * Result from streaming-aware parsing.
+ * Provides partial widget data even when input is incomplete.
+ */
+export interface StreamingParseResult {
+    /** Whether parsing completed successfully with all required fields */
+    complete: boolean;
+    /** Detected widget type (available even for incomplete input) */
+    detectedType?: string;
+    /** Partial or complete widget data */
+    widget?: Partial<Widget> & {
+        type: string;
+    };
+    /** What's still needed to complete parsing */
+    pending?: {
+        /** True if we're waiting for an unclosed bracket */
+        unclosedBracket?: boolean;
+        /** True if we're waiting for an unclosed quote */
+        unclosedQuote?: boolean;
+        /** True if we're waiting for more questions in a quiz */
+        awaitingQuestions?: boolean;
+        /** True if we're waiting for more fields in a form */
+        awaitingFields?: boolean;
+        /** True if we're waiting for more CSV data in a chart */
+        awaitingData?: boolean;
+    };
+    /** Error message if parsing failed completely */
+    error?: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,39 @@
 {
+  "version": "0.4.4",
+  "description": "DSL parser for markdown-ui widgets",
   "name": "@c2-markdown-ui/mdui-lang",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "markdown",
+    "dsl",
+    "parser",
+    "widgets"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}