@mteditor/renderer-mini 0.0.0-stage → 0.1.1

package/dist/theme-CXitJYrs.d.cts

@@ -0,0 +1,214 @@
+import { MtMiniPlatform, MtMiniMode, MtPreRenderedIndex, MtMiniNode, MtDegradationEntry, MtSerializeStats } from '@mteditor/document';
+
+/**
+ * `@mteditor/renderer-mini` 的公开契约。
+ *
+ * 本包**不自己序列化 nodes**，只做三件事：
+ * 通道解析、主题字面量注入、平台能力表。`nodes` 一律来自
+ * `@mteditor/document` 的 `serializeDocumentToMini`。
+ */
+
+/**
+ * 通道选择。
+ *
+ * `'auto'` 表示交由渲染器按 `maxNodes` 判定——
+ * 宿主不知道该选哪个通道正是它存在的理由。
+ */
+type MtMiniChannelOption = 'auto' | MtMiniMode;
+/**
+ * 主题。
+ *
+ * 字符串为内置主题名，对象为自定义字面量表（键含 `--` 前缀，
+ * 与 `@mteditor/document` 的 `themeTokens` 同形）。
+ */
+type MtMiniTheme = 'light' | 'dark' | Record<string, string>;
+/**
+ * 平台能力描述。
+ *
+ * **`verified` 是这张表的准入条件**：明令禁止「凭猜测共用一份映射表」
+ * 未实测的平台不得以「看起来能跑」的形态进入渲染路径。
+ */
+interface MtMiniCapabilities {
+    /** 平台标识 */
+    platform: MtMiniPlatform;
+    /** 白名单是否**经过实测核实**；未核实者不得被渲染路径使用 */
+    verified: boolean;
+    /** `rich-text` 受信任标签白名单 */
+    tags: readonly string[];
+    /** 全局支持的属性名（微信仅 `class` 与 `style`） */
+    globalAttrs: readonly string[];
+    /** 是否支持 `id` 属性（微信不支持） */
+    supportsId: boolean;
+    /** 逐标签的属性白名单 */
+    tagAttrs: Readonly<Record<string, readonly string[]>>;
+    /** `rich-text` 下不可表达、必须拆到 `rich-text` 之外的原生组件名 */
+    nativeComponents: readonly string[];
+}
+/** 渲染选项 */
+interface MtMiniRenderOptions {
+    /** 目标平台，缺省 `'wechat'`。未实测核实的平台会被 `resolveCapabilities` 拒绝 */
+    platform?: MtMiniPlatform;
+    /** 渲染通道，缺省 `'auto'` */
+    mode?: MtMiniChannelOption;
+    /**
+     * `mode: 'auto'` 的降级阈值，单位是**文档节点数**，缺省 `3000`。
+     * 判定发生在序列化**之前**。
+     */
+    maxNodes?: number;
+    /** 内置主题名或自定义字面量表，缺省 `'light'` */
+    theme?: MtMiniTheme;
+    /**
+     * 主题字面量补充/覆盖，与 `theme` 合并后**后者优先**。
+     * 用途：宿主已有一套后台下发的品牌色，只覆盖少数几个键。
+     */
+    themeTokens?: Record<string, string>;
+    /** 预渲染产物索引（公式 SVG / 代码高亮） */
+    preRendered?: MtPreRenderedIndex;
+}
+/**
+ * 自动通道切换的记录。
+ *
+ * 要求自动降级「发出 warn」。渲染器不持有事件总线，故 warn 的载体就是这个
+ * **显式字段**而不是 `console.warn`——后者在宿主项目里会被彻底淹没，
+ * 而「功能没按预期生效但也没有报错」是本项目出现次数最多的失败模式。
+ */
+interface MtMiniChannelSwitch {
+    /** 未触发阈值时的通道 */
+    from: MtMiniMode;
+    /** 实际使用的通道 */
+    to: MtMiniMode;
+    /** 触发判定的文档节点数 */
+    nodeCount: number;
+    /** 判定所用的阈值 */
+    maxNodes: number;
+}
+/**
+ * 渲染结果。
+ *
+ * 刻意**不提供关闭降级报告的开关**（与 `renderer-web` 的差异）：
+ * 小程序端 `rich-text` 通道会把 `video` / `audio` / 公式降级成文本，
+ * 这类损失用户会直接看到。留一个「关掉报告」的开关等于给静默留后门
+ * —— 要求降级必须可被调用方取到。
+ */
+interface MtMiniRenderResult {
+    /** 目标平台 */
+    platform: MtMiniPlatform;
+    /**
+     * **实际使用**的通道。`mode: 'auto'` 传入时这里是解析后的结果，
+     * 宿主必须按它选择 `<rich-text nodes>` 或递归组件。
+     */
+    mode: MtMiniMode;
+    /** 小程序 nodes（**Array 形式**） */
+    nodes: MtMiniNode[];
+    /** 降级报告；无降级时为空数组。**始终返回**，不可关闭 */
+    report: MtDegradationEntry[];
+    /** 序列化统计（节点数 / 最大深度 / 字节数） */
+    stats: MtSerializeStats;
+    /**
+     * 自动通道切换记录；`mode` 非 `'auto'` 或未触发阈值时为 `null`。
+     * 与 `report` 分开的理由：`report` 描述的是**内容表达损失**，
+     * 而通道切换是**渲染策略**——混在一起会让「报告为空」读不出「内容无损」。
+     */
+    autoSwitched: MtMiniChannelSwitch | null;
+}
+
+/**
+ * 各端 `rich-text` 能力表。
+ *
+ * **准入条件：必须实测核实。** 各子路径必须各自维护映射差异，
+ * 禁止共用一份映射表；反过来说，**没有实测过就不能让别人用**——
+ * 一份「看起来能跑」的错误白名单比明确的报错危险得多。
+ *
+ * 因此本文件当前只包含 `wechat`。支付宝 / 抖音的表在各自实测完成后
+ * （需各自开发者工具）追加，并同时回填待确认项。
+ */
+
+/**
+ * 微信小程序 `rich-text` 受信任标签白名单（**已核实**）。
+ *
+ * 顺序与官方文档一致，便于逐条比对；`Set` 查询由调用方按需构造。
+ */
+declare const MT_WECHAT_RICH_TEXT_TAGS: readonly string[];
+/**
+ * 逐标签属性白名单（**已核实**）。
+ *
+ * 未在表中的标签不接受额外属性；全局属性（`class` / `style`）单独由
+ * `globalAttrs` 描述。**`id` 不在任何一张表里** —— 微信全局不支持 `id`。
+ */
+declare const MT_WECHAT_TAG_ATTRS: Readonly<Record<string, readonly string[]>>;
+/**
+ * 小程序平台能力表。
+ *
+ * 当前只登记 `wechat`（已核实）。缺失的平台在
+ * `resolveCapabilities` 处**抛错**，不做容错。
+ */
+declare const MT_MINI_CAPABILITIES: Readonly<Partial<Record<MtMiniPlatform, MtMiniCapabilities>>>;
+/**
+ * 取某个平台的能力表。
+ *
+ * @param platform 平台标识
+ * @returns 该平台的能力描述
+ * @throws {RangeError} 该平台尚未实测核实
+ *
+ * @example
+ * ```ts
+ * resolveCapabilities('wechat').supportsId // false
+ * resolveCapabilities('alipay')            // 抛 RangeError：尚未实测
+ * ```
+ */
+declare const resolveCapabilities: (platform: MtMiniPlatform) => MtMiniCapabilities;
+
+/**
+ * 内置主题字面量。
+ *
+ * ## 为什么这份数据必须存在于本包
+ *
+ * 小程序端 `rich-text` 内的 `style` **不参与宿主 CSS 变量继承**，
+ * 所有主题值必须在序列化时解析为字面量，而 `@mteditor/theme-default`
+ * 只产出 CSS、没有 JS 导出 —— 若要求宿主自备这份表，每个项目都要手抄
+ * `tokens.css` 的 65 个键，抄错还**没有报错**（本仓库自己就踩过：
+ * `mini.ts` 读的 `--mt-font-mono` 与 `tokens.css` 的 `--mt-font-family-mono`
+ * 不一致，两个引用点恒走 fallback）。
+ *
+ * ## 与 tokens.css 的关系：允许独立，禁止无守卫地独立
+ *
+ * 本文件是 `packages/theme-default/src/tokens.css` 的**逐键镜像**
+ * （`dark` 是 `light` 上的部分覆盖，与 CSS 的层叠语义一致）。
+ * `scripts/check-theme-tokens.mjs` 断言两者键集合与取值完全一致 ——
+ * 改任一侧而漏改另一侧会让 `pnpm verify` 失败。
+ *
+ * 取值风格与 CSS 一致：保留 `rgb(37 99 235 / 18%)` 这类现代空格语法，
+ * 不自作主张转换为逗号语法（`@mteditor/document` 原样内联，不做解析）。
+ */
+
+/** 亮色主题：`tokens.css` 中 `:root, [data-mt-theme='light']` 块的完整镜像 */
+declare const MT_MINI_TOKENS_LIGHT: Readonly<Record<string, string>>;
+/**
+ * 暗色主题对亮色的**覆盖项**（与 `tokens.css` 的 `[data-mt-theme='dark']` 块一致）。
+ *
+ * 单独导出是为了让卡口脚本能分别比对「覆盖集」与「派生全集」——
+ * 若只导出派生的全集，CSS 里删掉一个覆盖项（于是暗色回退到亮色值）
+ * 在 TS 侧不可见。
+ */
+declare const MT_MINI_TOKENS_DARK_OVERRIDES: Readonly<Record<string, string>>;
+/** 暗色主题全集（亮色为基底 + 覆盖项） */
+declare const MT_MINI_TOKENS_DARK: Readonly<Record<string, string>>;
+/**
+ * 解析主题字面量表。
+ *
+ * 合并顺序：内置名（或自定义表）→ `themeTokens` 覆盖项。
+ *
+ * @param theme 内置主题名或自定义字面量表，缺省 `'light'`
+ * @param override 覆盖项，键含 `--` 前缀；缺省不覆盖
+ * @returns 可直接传给 `serializeDocumentToMini` 的 `themeTokens`
+ *
+ * @example
+ * ```ts
+ * resolveThemeTokens('dark')                       // 65 个键的暗色表
+ * resolveThemeTokens(undefined, { '--mt-color-link': '#f00' })
+ * // 亮色表，但链接色为 #f00
+ * ```
+ */
+declare const resolveThemeTokens: (theme?: MtMiniTheme, override?: Record<string, string>) => Record<string, string>;
+
+export { type MtMiniRenderOptions as M, type MtMiniRenderResult as a, MT_MINI_CAPABILITIES as b, MT_MINI_TOKENS_DARK as c, MT_MINI_TOKENS_LIGHT as d, MT_WECHAT_RICH_TEXT_TAGS as e, MT_WECHAT_TAG_ATTRS as f, type MtMiniCapabilities as g, type MtMiniChannelOption as h, type MtMiniChannelSwitch as i, type MtMiniTheme as j, resolveThemeTokens as k, MT_MINI_TOKENS_DARK_OVERRIDES as l, resolveCapabilities as r };

package/dist/theme-CXitJYrs.d.ts

@@ -0,0 +1,214 @@
+import { MtMiniPlatform, MtMiniMode, MtPreRenderedIndex, MtMiniNode, MtDegradationEntry, MtSerializeStats } from '@mteditor/document';
+
+/**
+ * `@mteditor/renderer-mini` 的公开契约。
+ *
+ * 本包**不自己序列化 nodes**，只做三件事：
+ * 通道解析、主题字面量注入、平台能力表。`nodes` 一律来自
+ * `@mteditor/document` 的 `serializeDocumentToMini`。
+ */
+
+/**
+ * 通道选择。
+ *
+ * `'auto'` 表示交由渲染器按 `maxNodes` 判定——
+ * 宿主不知道该选哪个通道正是它存在的理由。
+ */
+type MtMiniChannelOption = 'auto' | MtMiniMode;
+/**
+ * 主题。
+ *
+ * 字符串为内置主题名，对象为自定义字面量表（键含 `--` 前缀，
+ * 与 `@mteditor/document` 的 `themeTokens` 同形）。
+ */
+type MtMiniTheme = 'light' | 'dark' | Record<string, string>;
+/**
+ * 平台能力描述。
+ *
+ * **`verified` 是这张表的准入条件**：明令禁止「凭猜测共用一份映射表」
+ * 未实测的平台不得以「看起来能跑」的形态进入渲染路径。
+ */
+interface MtMiniCapabilities {
+    /** 平台标识 */
+    platform: MtMiniPlatform;
+    /** 白名单是否**经过实测核实**；未核实者不得被渲染路径使用 */
+    verified: boolean;
+    /** `rich-text` 受信任标签白名单 */
+    tags: readonly string[];
+    /** 全局支持的属性名（微信仅 `class` 与 `style`） */
+    globalAttrs: readonly string[];
+    /** 是否支持 `id` 属性（微信不支持） */
+    supportsId: boolean;
+    /** 逐标签的属性白名单 */
+    tagAttrs: Readonly<Record<string, readonly string[]>>;
+    /** `rich-text` 下不可表达、必须拆到 `rich-text` 之外的原生组件名 */
+    nativeComponents: readonly string[];
+}
+/** 渲染选项 */
+interface MtMiniRenderOptions {
+    /** 目标平台，缺省 `'wechat'`。未实测核实的平台会被 `resolveCapabilities` 拒绝 */
+    platform?: MtMiniPlatform;
+    /** 渲染通道，缺省 `'auto'` */
+    mode?: MtMiniChannelOption;
+    /**
+     * `mode: 'auto'` 的降级阈值，单位是**文档节点数**，缺省 `3000`。
+     * 判定发生在序列化**之前**。
+     */
+    maxNodes?: number;
+    /** 内置主题名或自定义字面量表，缺省 `'light'` */
+    theme?: MtMiniTheme;
+    /**
+     * 主题字面量补充/覆盖，与 `theme` 合并后**后者优先**。
+     * 用途：宿主已有一套后台下发的品牌色，只覆盖少数几个键。
+     */
+    themeTokens?: Record<string, string>;
+    /** 预渲染产物索引（公式 SVG / 代码高亮） */
+    preRendered?: MtPreRenderedIndex;
+}
+/**
+ * 自动通道切换的记录。
+ *
+ * 要求自动降级「发出 warn」。渲染器不持有事件总线，故 warn 的载体就是这个
+ * **显式字段**而不是 `console.warn`——后者在宿主项目里会被彻底淹没，
+ * 而「功能没按预期生效但也没有报错」是本项目出现次数最多的失败模式。
+ */
+interface MtMiniChannelSwitch {
+    /** 未触发阈值时的通道 */
+    from: MtMiniMode;
+    /** 实际使用的通道 */
+    to: MtMiniMode;
+    /** 触发判定的文档节点数 */
+    nodeCount: number;
+    /** 判定所用的阈值 */
+    maxNodes: number;
+}
+/**
+ * 渲染结果。
+ *
+ * 刻意**不提供关闭降级报告的开关**（与 `renderer-web` 的差异）：
+ * 小程序端 `rich-text` 通道会把 `video` / `audio` / 公式降级成文本，
+ * 这类损失用户会直接看到。留一个「关掉报告」的开关等于给静默留后门
+ * —— 要求降级必须可被调用方取到。
+ */
+interface MtMiniRenderResult {
+    /** 目标平台 */
+    platform: MtMiniPlatform;
+    /**
+     * **实际使用**的通道。`mode: 'auto'` 传入时这里是解析后的结果，
+     * 宿主必须按它选择 `<rich-text nodes>` 或递归组件。
+     */
+    mode: MtMiniMode;
+    /** 小程序 nodes（**Array 形式**） */
+    nodes: MtMiniNode[];
+    /** 降级报告；无降级时为空数组。**始终返回**，不可关闭 */
+    report: MtDegradationEntry[];
+    /** 序列化统计（节点数 / 最大深度 / 字节数） */
+    stats: MtSerializeStats;
+    /**
+     * 自动通道切换记录；`mode` 非 `'auto'` 或未触发阈值时为 `null`。
+     * 与 `report` 分开的理由：`report` 描述的是**内容表达损失**，
+     * 而通道切换是**渲染策略**——混在一起会让「报告为空」读不出「内容无损」。
+     */
+    autoSwitched: MtMiniChannelSwitch | null;
+}
+
+/**
+ * 各端 `rich-text` 能力表。
+ *
+ * **准入条件：必须实测核实。** 各子路径必须各自维护映射差异，
+ * 禁止共用一份映射表；反过来说，**没有实测过就不能让别人用**——
+ * 一份「看起来能跑」的错误白名单比明确的报错危险得多。
+ *
+ * 因此本文件当前只包含 `wechat`。支付宝 / 抖音的表在各自实测完成后
+ * （需各自开发者工具）追加，并同时回填待确认项。
+ */
+
+/**
+ * 微信小程序 `rich-text` 受信任标签白名单（**已核实**）。
+ *
+ * 顺序与官方文档一致，便于逐条比对；`Set` 查询由调用方按需构造。
+ */
+declare const MT_WECHAT_RICH_TEXT_TAGS: readonly string[];
+/**
+ * 逐标签属性白名单（**已核实**）。
+ *
+ * 未在表中的标签不接受额外属性；全局属性（`class` / `style`）单独由
+ * `globalAttrs` 描述。**`id` 不在任何一张表里** —— 微信全局不支持 `id`。
+ */
+declare const MT_WECHAT_TAG_ATTRS: Readonly<Record<string, readonly string[]>>;
+/**
+ * 小程序平台能力表。
+ *
+ * 当前只登记 `wechat`（已核实）。缺失的平台在
+ * `resolveCapabilities` 处**抛错**，不做容错。
+ */
+declare const MT_MINI_CAPABILITIES: Readonly<Partial<Record<MtMiniPlatform, MtMiniCapabilities>>>;
+/**
+ * 取某个平台的能力表。
+ *
+ * @param platform 平台标识
+ * @returns 该平台的能力描述
+ * @throws {RangeError} 该平台尚未实测核实
+ *
+ * @example
+ * ```ts
+ * resolveCapabilities('wechat').supportsId // false
+ * resolveCapabilities('alipay')            // 抛 RangeError：尚未实测
+ * ```
+ */
+declare const resolveCapabilities: (platform: MtMiniPlatform) => MtMiniCapabilities;
+
+/**
+ * 内置主题字面量。
+ *
+ * ## 为什么这份数据必须存在于本包
+ *
+ * 小程序端 `rich-text` 内的 `style` **不参与宿主 CSS 变量继承**，
+ * 所有主题值必须在序列化时解析为字面量，而 `@mteditor/theme-default`
+ * 只产出 CSS、没有 JS 导出 —— 若要求宿主自备这份表，每个项目都要手抄
+ * `tokens.css` 的 65 个键，抄错还**没有报错**（本仓库自己就踩过：
+ * `mini.ts` 读的 `--mt-font-mono` 与 `tokens.css` 的 `--mt-font-family-mono`
+ * 不一致，两个引用点恒走 fallback）。
+ *
+ * ## 与 tokens.css 的关系：允许独立，禁止无守卫地独立
+ *
+ * 本文件是 `packages/theme-default/src/tokens.css` 的**逐键镜像**
+ * （`dark` 是 `light` 上的部分覆盖，与 CSS 的层叠语义一致）。
+ * `scripts/check-theme-tokens.mjs` 断言两者键集合与取值完全一致 ——
+ * 改任一侧而漏改另一侧会让 `pnpm verify` 失败。
+ *
+ * 取值风格与 CSS 一致：保留 `rgb(37 99 235 / 18%)` 这类现代空格语法，
+ * 不自作主张转换为逗号语法（`@mteditor/document` 原样内联，不做解析）。
+ */
+
+/** 亮色主题：`tokens.css` 中 `:root, [data-mt-theme='light']` 块的完整镜像 */
+declare const MT_MINI_TOKENS_LIGHT: Readonly<Record<string, string>>;
+/**
+ * 暗色主题对亮色的**覆盖项**（与 `tokens.css` 的 `[data-mt-theme='dark']` 块一致）。
+ *
+ * 单独导出是为了让卡口脚本能分别比对「覆盖集」与「派生全集」——
+ * 若只导出派生的全集，CSS 里删掉一个覆盖项（于是暗色回退到亮色值）
+ * 在 TS 侧不可见。
+ */
+declare const MT_MINI_TOKENS_DARK_OVERRIDES: Readonly<Record<string, string>>;
+/** 暗色主题全集（亮色为基底 + 覆盖项） */
+declare const MT_MINI_TOKENS_DARK: Readonly<Record<string, string>>;
+/**
+ * 解析主题字面量表。
+ *
+ * 合并顺序：内置名（或自定义表）→ `themeTokens` 覆盖项。
+ *
+ * @param theme 内置主题名或自定义字面量表，缺省 `'light'`
+ * @param override 覆盖项，键含 `--` 前缀；缺省不覆盖
+ * @returns 可直接传给 `serializeDocumentToMini` 的 `themeTokens`
+ *
+ * @example
+ * ```ts
+ * resolveThemeTokens('dark')                       // 65 个键的暗色表
+ * resolveThemeTokens(undefined, { '--mt-color-link': '#f00' })
+ * // 亮色表，但链接色为 #f00
+ * ```
+ */
+declare const resolveThemeTokens: (theme?: MtMiniTheme, override?: Record<string, string>) => Record<string, string>;
+
+export { type MtMiniRenderOptions as M, type MtMiniRenderResult as a, MT_MINI_CAPABILITIES as b, MT_MINI_TOKENS_DARK as c, MT_MINI_TOKENS_LIGHT as d, MT_WECHAT_RICH_TEXT_TAGS as e, MT_WECHAT_TAG_ATTRS as f, type MtMiniCapabilities as g, type MtMiniChannelOption as h, type MtMiniChannelSwitch as i, type MtMiniTheme as j, resolveThemeTokens as k, MT_MINI_TOKENS_DARK_OVERRIDES as l, resolveCapabilities as r };

package/dist/uni-app/index.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/uni-app/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/uni-app/index.d.cts

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

package/dist/uni-app/index.d.ts

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

package/dist/uni-app/index.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/uni-app/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}