@vvfx/svg2ir 0.0.0-stage → 0.0.1-beta.0

package/dist/parse-svg/bridge.d.ts

@@ -0,0 +1,10 @@
+import type EditableSVG from './svg-parser';
+export type EditableSVGConstructor = typeof EditableSVG;
+/**
+ * 将浏览器 ESM/CJS 互操作和 Node CJS 入口统一为同一个构造器。
+ * parser 只依赖这个边界，不依赖具体模块系统的默认导出形式。
+ */
+export declare function resolveEditableSVGConstructor(moduleValue: unknown): EditableSVGConstructor;
+/** 配置 Node 发行入口使用的构造器。 */
+export declare function setEditableSVGConstructor(constructor: EditableSVGConstructor): void;
+export declare function createEditableSVG(...args: ConstructorParameters<EditableSVGConstructor>): EditableSVG;

package/dist/parse-svg/node.d.ts

@@ -0,0 +1,3 @@
+import ParseableSVG from './svg-parser';
+export default ParseableSVG;
+export { ParseableSVG };

package/dist/parse-svg/read-presentation-attribute.d.ts

@@ -0,0 +1,5 @@
+/** 读取 SVG presentation attribute，inline style 的同名属性优先。 */
+export declare function readPresentationAttribute(node: {
+    getAttribute?: (name: string) => string | null;
+} | null | undefined, attributeName: string): string | null;
+export declare function readInlineStyleProperty(style: string | null, propertyName: string): string | null;

package/dist/parse-svg/svg-parser.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 只读 SVG 解析器。svg2ir 用它把 SVG 字符串解析成可查询/可读属性的 svg.js 文档树,
+ * 再在其上做 SVG→IR 转换;不涉及任何 SVG 编辑/约束/布局能力。
+ *
+ * 提供的能力(对齐 svg2ir 实际消费的读切片):
+ *   - 构造:SVG 字符串 → svg.js 文档树;对每个 <text> 规整 dx/dy→x/y、补 fill 兜底
+ *   - getAttr:带 SVG 继承的属性读取(沿父 <g> 上溯,id/svg 根终止,font-size 数值化)
+ *   - stringify:序列化回 SVG 字符串(清临时属性 + 去 svg.js 内部标记)
+ *   - find/findOne/attr/node:透出 svg.js 原生查询与根节点
+ *
+ * 底层复用 @svgdotjs/svg.js。本模块只封装 svg2ir 依赖的读语义,不含处理容错的全部角落。
+ */
+import { type Svg as SVGDocument, type Element as SVGElementNode } from '@svgdotjs/svg.js';
+export type { Svg as SVGDocument, Element as SVGElementNode } from '@svgdotjs/svg.js';
+interface ParseableSVGOptions {
+    /** SVG 解析器构造选项。 */
+    [key: string]: unknown;
+}
+/**
+ * 只读 SVG 解析器。读切片语义:
+ *   - 构造时对每个 <text> 规整:text 级 dx/dy 烘焙进 x/y(清掉 dx/dy);无 fill 时沿父继承/从首个 tspan 提/兜底 #000。
+ *   - getAttr 沿父链继承上溯(SVG CSS 式),id 与已到 svg 根终止,font-size 含 px 时数值化。
+ *   - stringify 用 svg.js 序列化,清临时属性 + 去 svgjs:data。
+ */
+export default class ParseableSVG {
+    readonly svg: SVGDocument;
+    constructor(svgStr: string, _options?: ParseableSVGOptions);
+    /**
+     * 读属性,带 SVG 继承。元素自身无值时沿 parent() 上溯;id 与已到 svg 根终止返回 null;
+     * font-size 含 px 时数值化为 number。propagation=false 时不上溯。
+     */
+    getAttr(element: SVGElementNode, attributeName: string, propagation?: boolean): string | number | null;
+    /**
+     * 构造时对每个 <text> 规整属性。
+     *   - text 级 dx/dy 烘焙进 x/y，并移除 dx/dy
+     *   - text 自身无 fill 时沿父继承/从首个 tspan 提/兜底 #000
+     * svg2ir 解析依赖这段规整,故无条件执行。
+     */
+    private initTexts;
+    /** 读数值属性(string 去 px 转 number,非数/空返 0)。 */
+    private getNumAttr;
+    /** 序列化回 SVG 字符串:清 data-tmp- 临时属性 + 去 svg.js 内部 svgjs:data 标记。 */
+    stringify(): string;
+}
+/** SVG parser 的包内类型别名，运行时与类型均指向 ParseableSVG。 */
+export { ParseableSVG as EditableSVG };

package/dist/svg-preserved-data.d.ts

@@ -0,0 +1,78 @@
+import type { IRAnimatedProperty, IRBezierPath, IRColor, IRVec3 } from '@vvfx/animation-ir';
+/** SVG 富文本单个片段的保留数据。 */
+export interface SVGPreservedTextSpan {
+    text: string;
+    fontSize?: string;
+    color?: string;
+    bold?: boolean;
+    italic?: boolean;
+    newLine: boolean;
+    dx?: number;
+    dxRaw?: string;
+    dy?: number;
+    dyRaw?: string;
+}
+/** SVG 文本层在核心 IR 之外保留的富文本数据。 */
+export interface SVGPreservedTextData {
+    spans: SVGPreservedTextSpan[];
+    fontFamily: string;
+    fontWeight: number;
+    fontStyle: 'normal' | 'italic' | 'oblique';
+    isPathText: boolean;
+    deltaWyForRich?: number;
+}
+/** SVG paint 动画在核心 IR 之外保留的数据。 */
+export type SVGPreservedPaintAnimation = {
+    kind: 'context';
+    staticElementOpacity: number;
+    layerOpacityMultiplier: number;
+    paintOpacity: {
+        fill: number;
+        stroke: number;
+    };
+    solidColorAlpha: {
+        fill: number;
+        stroke: number;
+    };
+    gradientStopColorAlpha: {
+        fill: number[];
+        stroke: number[];
+    };
+    geometryScale?: IRAnimatedProperty<IRVec3>;
+} | {
+    kind: 'opacity';
+    target: 'fill' | 'stroke';
+    opacity: IRAnimatedProperty<number>;
+    alphaBase: number;
+} | {
+    kind: 'solid-color';
+    target: 'fill' | 'stroke';
+    color: IRAnimatedProperty<IRColor>;
+} | {
+    kind: 'gradient-stop-color';
+    target: 'fill' | 'stroke';
+    paintIndex: number;
+    stopIndex: number;
+    color: IRAnimatedProperty<IRColor>;
+} | {
+    kind: 'stroke-width';
+    width: IRAnimatedProperty<number>;
+};
+/** SVG 形状路径的动画时间线。 */
+export interface SVGPreservedShapeAnimation {
+    keyframes: Array<{
+        time: number;
+        paths: IRBezierPath[];
+    }>;
+}
+/** GE Runtime 可加载的 SVG 字体定义。 */
+export interface SVGFontDefinition {
+    fontFamily: string;
+    fontURL: string;
+}
+/** SVG parser 输出、GE 和静态分层适配阶段消费的旁路数据。 */
+export interface SVGPreservedData {
+    textDataByLayerId: Map<string, SVGPreservedTextData>;
+    paintAnimationsByLayerId: Map<string, SVGPreservedPaintAnimation[]>;
+    shapeAnimationsByLayerId?: Map<string, SVGPreservedShapeAnimation>;
+}

package/dist/svg2ge-adapter/assemble.d.ts

@@ -0,0 +1,5 @@
+import { type ConvertResult } from '../common/types';
+import type { SVGPreservedData } from '../svg-preserved-data';
+import type { SVGToGEOptions, SVGToGEResult } from './types';
+/** 从已解析的 IR 和 SVG 保留数据生成 GE 场景。 */
+export declare function assembleSVGGE(parsed: ConvertResult, options?: SVGToGEOptions, preservedData?: SVGPreservedData): SVGToGEResult;

package/dist/svg2ge-adapter/convert.d.ts

@@ -0,0 +1,5 @@
+import type { SVGSource } from '../common/types';
+import type { SVGPreservedData } from '../svg-preserved-data';
+import type { SVGToGEOptions, SVGToGEResult } from './types';
+/** SVG→GE 显式入口。传入 preservedData 时应用 SVG 专属后处理。 */
+export declare function convertSVGToGE(source: SVGSource, options?: SVGToGEOptions, preservedData?: SVGPreservedData): SVGToGEResult;

package/dist/svg2ge-adapter/converter/animation.d.ts

@@ -0,0 +1,10 @@
+/** 将 IR 动画关键帧编码为 Effects Bezier 曲线。 */
+import type { IRAnimatedProperty } from '@vvfx/animation-ir';
+import { type BezierKeyframeValue } from '@galacean/effects-specification';
+/** 与 ge-ir IRToGETimeContext 同构的图层可见帧区间。 */
+export interface IRToGETimeContext {
+    startFrame: number;
+    endFrame: number;
+}
+/** 把 1D 动画属性编码为 Effects BezierKeyframeValue 曲线(单维外层数组)。 */
+export declare function convertIRScalarKeyframesToGE(property: IRAnimatedProperty<number>, timeContext: IRToGETimeContext): BezierKeyframeValue[][] | undefined;

package/dist/svg2ge-adapter/converter/data-path.d.ts

@@ -0,0 +1,6 @@
+/** SVG 专属 Effects 转换使用的 DataPath 和实体 ID 辅助。 */
+import type { DataPath } from '@galacean/effects-specification';
+/** 生成 32 位十六进制 Effects 实体 ID(与 ge-ir createId 同构)。 */
+export declare function createId(): string;
+/** 把 ID 包装成 Effects DataPath 引用。 */
+export declare function toDataPath(id: string): DataPath;

package/dist/svg2ge-adapter/normalize-shape-animation.d.ts

@@ -0,0 +1,2 @@
+import type { SVGPreservedShapeAnimation } from '../svg-preserved-data';
+export declare function normalizeShapeAnimationForGE(animation: SVGPreservedShapeAnimation): SVGPreservedShapeAnimation | undefined;

package/dist/svg2ge-adapter/post-process/apply-fonts.d.ts

@@ -0,0 +1,6 @@
+import type { JSONScene } from '@galacean/effects-specification';
+/** 将调用方提供的字体定义写入 Effects Runtime 场景。 */
+export declare function applyFonts(scene: JSONScene, fonts?: readonly {
+    fontFamily: string;
+    fontURL: string;
+}[]): void;

package/dist/svg2ge-adapter/post-process/apply-shape-geometry-animation.d.ts

@@ -0,0 +1,4 @@
+import type { IRScene } from '@vvfx/animation-ir';
+import { type JSONScene } from '@galacean/effects-specification';
+import type { SVGPreservedShapeAnimation } from '../../svg-preserved-data';
+export declare function applyShapeGeometryAnimations(scene: JSONScene, ir: IRScene, animationsByLayerId: ReadonlyMap<string, SVGPreservedShapeAnimation> | undefined): void;

package/dist/svg2ge-adapter/post-process/apply-shape-paint-animation.d.ts

@@ -0,0 +1,4 @@
+import type { IRScene } from '@vvfx/animation-ir';
+import { type JSONScene } from '@galacean/effects-specification';
+import type { SVGPreservedPaintAnimation } from '../../svg-preserved-data';
+export declare function applyShapePaintAnimation(scene: JSONScene, ir: IRScene, paintAnimationByLayerIndex: ReadonlyMap<string, readonly SVGPreservedPaintAnimation[]>): void;

package/dist/svg2ge-adapter/post-process/paint-animation-sampling.d.ts

@@ -0,0 +1,13 @@
+/**
+ * SVG paint animation 的时间采样逻辑。
+ *
+ * 该模块只根据 IR animated property 计算指定帧的值，不直接修改 Effects scene。
+ */
+import type { IRAnimatedProperty, IRColor, IRVec3 } from '@vvfx/animation-ir';
+export declare function sampleScalarProperty(property: IRAnimatedProperty<number>, frame: number): number;
+export declare function sampleVectorProperty(property: Extract<IRAnimatedProperty<IRVec3>, {
+    type: 'keyframed';
+}>, frame: number): IRVec3;
+export declare function sampleColorProperty(property: Extract<IRAnimatedProperty<IRColor>, {
+    type: 'keyframed';
+}>, frame: number): IRColor;

package/dist/svg2ge-adapter/post-process/restore-gradient-uv.d.ts

@@ -0,0 +1,3 @@
+import type { JSONScene } from '@galacean/effects-specification';
+/** 修正 ge-ir 2D→3D 坐标映射后的 SVG 归一化渐变坐标。 */
+export declare function restoreGradientUV(scene: JSONScene, compositionWidth: number, compositionHeight: number): void;

package/dist/svg2ge-adapter/post-process/rewrite-text-components.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 将 Effects TextComponent 转换为 RichTextComponent，并将逐段样式编码为 markup。
+ * 文本尺寸字段和 textPath 标记保留在 Effects 场景中。
+ */
+import { type JSONScene } from '@galacean/effects-specification';
+import type { SVGPreservedTextData } from '../../svg-preserved-data';
+interface RewriteTextComponentsToRichTextInput {
+    textDataByLayerId: ReadonlyMap<string, SVGPreservedTextData>;
+    itemLayerIds: Readonly<Record<string, string>>;
+}
+/** 按 IR Layer ID 应用 SVG 富文本保留数据。 */
+export declare function rewriteTextComponentsToRichText(scene: JSONScene, input: RewriteTextComponentsToRichTextInput): void;
+export {};

package/dist/svg2ge-adapter/pre-process.d.ts

@@ -0,0 +1,7 @@
+import type { IRScene } from '@vvfx/animation-ir';
+import type { SVGPreservedPaintAnimation, SVGPreservedShapeAnimation } from '../svg-preserved-data';
+export declare function applyShapeAnimationBasePaths(ir: IRScene, animationsByLayerId: ReadonlyMap<string, SVGPreservedShapeAnimation> | undefined): void;
+/** convertIRToGE 用 IR 副本展开 hold 过渡点,result.ir 仍保留解析原始关键帧。 */
+export declare function expandIRHoldTransitions(ir: IRScene): IRScene;
+/** applyShapePaintAnimation 消费的 paint 动画属性同样展开 hold 过渡点(内部 sink,不外露)。 */
+export declare function expandPaintAnimationHoldKeyframes(map: Map<string, SVGPreservedPaintAnimation[]>): void;

package/dist/svg2ge-adapter/types.d.ts

@@ -0,0 +1,11 @@
+import type { JSONScene } from '@galacean/effects-specification';
+import type { ConvertOptions, SVG2IRWarning } from '../common/types';
+import type { SVGFontDefinition } from '../svg-preserved-data';
+export interface SVGToGEOptions extends ConvertOptions {
+    fonts?: readonly SVGFontDefinition[];
+}
+export interface SVGToGEResult {
+    /** 由 convertIRToGE 生成并可选经过 SVG 专属适配的 Effects JSONScene。 */
+    data: JSONScene;
+    warnings: SVG2IRWarning[];
+}

package/dist/svg2ir/assemble.d.ts

@@ -0,0 +1,9 @@
+import { type IRScene } from '@vvfx/animation-ir';
+import type { ConvertOptions } from '../common/types';
+import type { SVGPreservedPaintAnimation, SVGPreservedShapeAnimation, SVGPreservedTextData } from '../svg-preserved-data';
+export interface ParseSVGToIROptions extends ConvertOptions {
+    textDataCollector?: Map<string, SVGPreservedTextData>;
+    paintAnimationsCollector?: Map<string, SVGPreservedPaintAnimation[]>;
+    shapeAnimationCollector?: Map<string, SVGPreservedShapeAnimation>;
+}
+export declare function parseSVGToIRScene(svgString: string, options?: ParseSVGToIROptions): IRScene;

package/dist/svg2ir/convert-arc.d.ts

@@ -0,0 +1,10 @@
+/**
+ * SVG 圆弧到三次 Bezier 的转换。
+ *
+ * path 命令归一化只消费 `arcToCubics`，具体圆弧几何和细分规则集中在这里。
+ */
+/** 椭圆弧(轴对齐,xAxisRotation=0)→多段三次贝塞尔。
+ *  已正确支持 rx==ry 的圆角矩形/圆形弧(largeArc/sweep 语义完整);
+ *  当前无法稳定映射的椭圆弧会退化为直线。
+ */
+export declare function arcToCubics(x0: number, y0: number, rx: number, ry: number, x1: number, y1: number, largeArc: boolean, sweep: boolean, arcSegmentAngle?: number): number[][];

package/dist/svg2ir/convert.d.ts

@@ -0,0 +1,21 @@
+import type { ConvertOptions, ConvertResult, SVGSource } from '../common/types';
+import type { SVGPreservedData, SVGPreservedPaintAnimation, SVGPreservedShapeAnimation, SVGPreservedTextData } from '../svg-preserved-data';
+interface SVGPreservedDataCollectors {
+    textDataByLayerId: Map<string, SVGPreservedTextData>;
+    paintAnimationsByLayerId: Map<string, SVGPreservedPaintAnimation[]>;
+    shapeAnimationsByLayerId: Map<string, SVGPreservedShapeAnimation>;
+}
+/**
+ * 把 SVG 转为 Animation IR。Effects lowering 由 `convertSVGToGE` 负责。
+ *
+ * 该函数是 SVG→IR 的底层入口，供 Effects 转换器和 IR 测试复用。
+ */
+export declare function convertSVGToIR(source: SVGSource, options?: ConvertOptions): ConvertResult;
+export type SplitSVGOptions = ConvertOptions;
+export interface SplitSVGResult extends ConvertResult {
+    preservedData: SVGPreservedData;
+}
+/** Convert SVG to IR and retain the GE-side data needed for source-specific lowering. */
+export declare function splitSVG(source: SVGSource, options?: SplitSVGOptions): SplitSVGResult;
+export declare function parseSVGToIRWithPreservedData(source: SVGSource, options?: ConvertOptions, collectors?: SVGPreservedDataCollectors): ConvertResult;
+export {};

package/dist/svg2ir/converter/clip/apply-mask.d.ts

@@ -0,0 +1,4 @@
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element } from '@svgdotjs/svg.js';
+import type { IRLayer, IRMask } from '@vvfx/animation-ir';
+export declare function applyClipMask<T extends IRLayer>(es: EditableSVG, el: Element, layer: T, clipMasks: Map<string, IRMask>): T;

package/dist/svg2ir/converter/clip/build-clip-mask.d.ts

@@ -0,0 +1,35 @@
+/**
+ * SVG <clipPath> → IRMask(挂到被裁图层的 mask 字段)。
+ *
+ * IR 只负责把 mask 几何挂到被裁图层；IR→Effects 的结构组装由 `@vvfx/ge-ir` 负责。
+ *
+ * 收集 clipPath 内所有形状几何,合并成一个 IRBezierPath(多 subpath 并集语义)的 points/handles。
+ * clipPath 内 path/polygon/polyline/rect 可直接收集，circle/ellipse 使用 cubic 圆弧；
+ * clip-rule even-odd/nonzero 不处理；IR mask 使用默认规则。
+ *
+ * 被裁元素通过 clip-path="url(#id)" 引用,svg2ir 扫描时把对应 IRMask 挂到该元素图层。
+ */
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element as SVGElementNode } from '@svgdotjs/svg.js';
+import type { IRMask } from '@vvfx/animation-ir';
+/**
+ * 从 clipPath/mask 元素合并所有子形状几何 → IRMask{path}（当前合并为单点集）。
+ *
+ * 支持子元素为直接形状(rect/circle/path...)或 `<use href="#shapeId">` 引用声明区形状。
+ *
+ * **坐标基准(mask 真正的坑)**:SVG mask content 在 `maskContentUnits=userSpaceOnUse`(默认)下,
+ * "userSpace" = **mask 元素所在的 userSpace**——即 mask 元素自身 transform + 祖先 `<g>` transform
+ * 累乘后的空间。mask 与被裁 `<image>` 可能位于同一个带 transform 的 `<g>` 里,故 content
+ * 形状的 (0,0) 是 g 局部原点，需要累计 g 的 transform 才能得到 SVG 绝对坐标。clipPath 通常位于
+ * defs 中并直接使用文档坐标，因此保持局部坐标；mask 则累计其宿主变换后再与被裁图层对齐。
+ */
+export declare function buildClipMask(es: EditableSVG, clipPathEl: SVGElementNode, rootEl?: SVGElementNode, applyAncestorTransform?: boolean, applyShapeOwnTransform?: boolean): IRMask | null;
+/**
+ * 构建 `<g mask="url(#X)">` 的组级 mask。
+ * mask 坐标与子代使用同一 comp-absolute 坐标系；定义几何先在局部收集，
+ * 再叠加宿主 g 的祖先变换和自身 transform。解析不到 mask 或没有形状时返回 null。
+ */
+export declare function buildGroupMaskForG(es: EditableSVG, gEl: SVGElementNode, rootEl: SVGElementNode): IRMask | null;
+/** 按 id 查 DOM element。优先全文档 ownerDocument.getElementById(被引用形状常在别处 <defs>,
+ * 不在 mask/clipPath 子树内,querySelector 限子树会漏);fallback querySelector 子树 + rootEl 查。 */
+export declare function findById(el: SVGElementNode, id: string): globalThis.Element | null;

package/dist/svg2ir/converter/clip/collect-geometry.d.ts

@@ -0,0 +1,32 @@
+import type { IRBezierPath } from '@vvfx/animation-ir';
+import { type SVGMatrix } from '../../matrix';
+type MaskPoint = {
+    x: number;
+    y: number;
+};
+export interface MaskGeometry {
+    paths: IRBezierPath[];
+}
+/** 把单个 SVG 形状转换为一个或多个独立 mask 轮廓，并保留曲线控制柄。 */
+export declare function collectShapeGeometry(el: {
+    node: globalThis.Element;
+}, tag: string, geometry: MaskGeometry, applyShapeOwnTransform?: boolean): void;
+export declare function transformVector(matrix: SVGMatrix, vector: MaskPoint): MaskPoint;
+type MaskPolygon = Array<{
+    x: number;
+    y: number;
+}>;
+/** 多边形是否为轴对齐矩形(4 个角,边与坐标轴平行)。 */
+export declare function isAxisAlignedRect(pts: MaskPolygon, eps?: number): boolean;
+/** mask pts 的轴对齐 bbox 是否罩住 shapeBbox(每边余 eps)。非轴对齐 mask 不在此判(走 pointInPolygon)。 */
+export declare function rangeCovers(pts: MaskPolygon, bbox: {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+}, eps: number): boolean;
+/** 判断 rebase 后的 mask 尺寸是否明显偏离被裁区域。 */
+export declare function maskSizeAbnormal(pts: MaskPolygon, w: number, h: number): boolean;
+/** 判断 mask 是否完全覆盖被裁区域。矩形使用 bbox，其他形状检查区域四角。 */
+export declare function maskCoversFull(pts: MaskPolygon, w: number, h: number): boolean;
+export {};

package/dist/svg2ir/converter/clip/warn-unsupported.d.ts

@@ -0,0 +1,7 @@
+import type { Element as SVGElementNode } from '@svgdotjs/svg.js';
+import { type SVG2IRWarning } from '../../../common/types';
+/**
+ * 报告 IR mask 无法保留的 SVG clip/mask 语义。
+ * 几何路径本身仍然支持；warning 用于显式说明坐标或 alpha 语义的降级。
+ */
+export declare function warnUnsupportedClipMaskFeatures(el: SVGElementNode, tag: 'clippath' | 'mask', emit: (warning: SVG2IRWarning) => void, strict: boolean): void;

package/dist/svg2ir/converter/diagnostics/collect-warnings.d.ts

@@ -0,0 +1,6 @@
+import type { SVG2IRWarning, SVG2IRWarningCode } from '../../../common/types';
+export declare function collectWarning(emit: (w: SVG2IRWarning) => void, code: SVG2IRWarningCode, message: string, elementSelector: string | undefined, strict: boolean | undefined): void;
+/** 元素定位提示:tag#id 或 tag:nth。供 warning 的 elementSelector 用。 */
+export declare function describeElement(el: {
+    node?: Element | null;
+}): string | undefined;

package/dist/svg2ir/converter/diagnostics/inspect-filter.d.ts

@@ -0,0 +1,4 @@
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element } from '@svgdotjs/svg.js';
+/** 判断 filter 是否替换原始图形。 */
+export declare function filterReplacesSource(es: EditableSVG, el: Element, rootEl: Element): boolean;

package/dist/svg2ir/converter/diagnostics/warn-unsupported.d.ts

@@ -0,0 +1,8 @@
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element } from '@svgdotjs/svg.js';
+import type { SVG2IRWarning, SVG2IRWarningCode } from '../../../common/types';
+/** 检查图层属性并报告无法写入 IR 的 SVG 特性。 */
+export declare function warnUnsupportedAttributes(es: EditableSVG, el: Element, tag: string, emit: (w: SVG2IRWarning) => void, strict: boolean, idEls: ReadonlyMap<string, Element>, flattenGradientToSolid?: boolean, dashSynthesized?: boolean): void;
+export declare function warnGradAttr(es: EditableSVG, gradEl: Element, gradTag: string, attr: string, refTag: string, emit: (w: SVG2IRWarning) => void, strict: boolean, selector: string | undefined): void;
+export declare function warnAttr(es: EditableSVG, el: Element, tag: string, attr: string, noneDefault: string, code: SVG2IRWarningCode, msg: string, emit: (w: SVG2IRWarning) => void, strict: boolean, selector: string | undefined): void;
+export declare function warnTextPaintDropped(es: EditableSVG, el: Element, selector: string | undefined, emit: (w: SVG2IRWarning) => void, strict: boolean): void;

package/dist/svg2ir/converter/image/parse-image.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 将 SVG image 元素解析为 IR image layer 和 image asset。
+ */
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element } from '@svgdotjs/svg.js';
+import { type IRImageAsset, type IRImageLayer } from '@vvfx/animation-ir';
+/** 解析 image 图层和对应资源；图层标识由图层转换器补齐。 */
+export declare function parseImageLayer(es: EditableSVG, el: Element, imageNaturalSizes?: ReadonlyMap<string, {
+    width: number;
+    height: number;
+}>, resourceBaseUrl?: string): {
+    layer: Omit<IRImageLayer, 'id' | 'name' | 'time'>;
+    asset: IRImageAsset;
+} | null;

package/dist/svg2ir/converter/layers/build-layers.d.ts

@@ -0,0 +1,8 @@
+import type { IRAsset, IRLayer } from '@vvfx/animation-ir';
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import { type SVGLayerBuildOptions } from './conversion-session';
+export type { SVGLayerBuildOptions } from './conversion-session';
+export declare function buildSVGLayers(es: EditableSVG, options: SVGLayerBuildOptions): {
+    layers: IRLayer[];
+    assets: IRAsset[];
+};

package/dist/svg2ir/converter/layers/conversion-session.d.ts

@@ -0,0 +1,161 @@
+import type EditableSVG from '../../../parse-svg/svg-parser';
+import type { Element } from '@svgdotjs/svg.js';
+import type { IRAsset, IRLayer, IRMask, IRShape, IRTextContent } from '@vvfx/animation-ir';
+import type { SVG2IRWarning } from '../../../common/types';
+import type { SVGPreservedPaintAnimation, SVGPreservedShapeAnimation, SVGPreservedTextData } from '../../../svg-preserved-data';
+/** 构造 layer 转换会话所需的输入。 */
+export interface SVGLayerBuildOptions {
+    frameRate: number;
+    durationSeconds: number;
+    emit: (warning: SVG2IRWarning) => void;
+    strict: boolean;
+    width: number;
+    height: number;
+    textDataByLayerId?: Map<string, SVGPreservedTextData>;
+    measureText?: (fontDesc: string, text: string) => {
+        width: number;
+    };
+    imageNaturalSizes?: Map<string, {
+        width: number;
+        height: number;
+    }>;
+    resourceBaseUrl?: string;
+    smilDurationSink?: {
+        value: number;
+    };
+    paintAnimationsByLayerId?: Map<string, SVGPreservedPaintAnimation[]>;
+    shapeAnimationsByLayerId?: Map<string, SVGPreservedShapeAnimation>;
+}
+/** 各元素转换器共享的只读环境。 */
+export interface SVGConversionEnvironment {
+    readonly es: EditableSVG;
+    readonly rootEl: Element;
+    readonly frameRate: number;
+    readonly durationSeconds: number;
+    readonly outFrame: number;
+    readonly emit: (warning: SVG2IRWarning) => void;
+    readonly strict: boolean;
+    readonly width: number;
+    readonly height: number;
+    readonly compCenterX: number;
+    readonly compCenterY: number;
+    readonly smilDurationSink?: {
+        value: number;
+    };
+}
+/** SVG 文档索引。 */
+export interface SVGElementLookup {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly idShapes: ReadonlyMap<string, IRShape>;
+    readonly idGroups: ReadonlyMap<string, Element>;
+    readonly idSymbols: ReadonlyMap<string, Element>;
+    readonly idImages: ReadonlyMap<string, Element>;
+    readonly symbolShapesById: ReadonlyMap<string, Array<{
+        element: Element;
+        shape: IRShape;
+    }>>;
+    readonly idTextEls: ReadonlyMap<string, Element>;
+    readonly idTextPureUse: ReadonlySet<string>;
+}
+/** 图层转换器可写入的输出接口。 */
+export interface LayerOutput {
+    allocateLayerIndex: () => number;
+    peekLayerIndex: () => number;
+    appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+    appendAsset: (asset: IRAsset) => void;
+    registerTextFontAsset: (content: IRTextContent, info: SVGPreservedTextData) => void;
+}
+/** 单次 SVG 转换的完整状态。 */
+export interface SVGConversionSession extends SVGConversionEnvironment, SVGElementLookup, LayerOutput {
+    readonly all: Element[];
+    readonly clipMasks: ReadonlyMap<string, IRMask>;
+    readonly groupMaskGNodeToIndex: Map<globalThis.Element, number>;
+    readonly layers: IRLayer[];
+    readonly assets: IRAsset[];
+    readonly textDataByLayerId?: Map<string, SVGPreservedTextData>;
+    readonly measureText?: (fontDesc: string, text: string) => {
+        width: number;
+    };
+    readonly imageNaturalSizes?: Map<string, {
+        width: number;
+        height: number;
+    }>;
+    readonly resourceBaseUrl?: string;
+    readonly paintAnimationsByLayerId?: Map<string, SVGPreservedPaintAnimation[]>;
+    readonly shapeAnimationsByLayerId?: Map<string, SVGPreservedShapeAnimation>;
+    readonly isDeclarationContext: (element: Element) => boolean;
+    readonly nearestMaskedGroupAncestor: (element: Element) => number | undefined;
+    readonly withGroupParent: <T extends IRLayer>(layer: T, element: Element) => T;
+    readonly warnReferencedClipMaskFeatures: (element: Element) => void;
+}
+/** Shape 元素转换所需的上下文。 */
+export interface ShapeConversionContext extends SVGConversionEnvironment {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly allocateLayerIndex: () => number;
+    readonly appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+    readonly paintAnimationsByLayerId?: Map<string, SVGPreservedPaintAnimation[]>;
+    readonly shapeAnimationsByLayerId?: Map<string, SVGPreservedShapeAnimation>;
+}
+/** Text 元素转换所需的上下文。 */
+export interface TextConversionContext extends SVGConversionEnvironment {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly measureText?: (fontDesc: string, text: string) => {
+        width: number;
+    };
+    readonly textDataByLayerId?: Map<string, SVGPreservedTextData>;
+    readonly allocateLayerIndex: () => number;
+    readonly peekLayerIndex: () => number;
+    readonly appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+    readonly registerTextFontAsset: (content: IRTextContent, info: SVGPreservedTextData) => void;
+}
+/** Image 元素转换所需的上下文。 */
+export interface ImageConversionContext extends SVGConversionEnvironment {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly imageNaturalSizes?: ReadonlyMap<string, {
+        width: number;
+        height: number;
+    }>;
+    readonly resourceBaseUrl?: string;
+    readonly allocateLayerIndex: () => number;
+    readonly appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+    readonly appendAsset: (asset: IRAsset) => void;
+}
+/** Use / symbol 元素转换所需的上下文。 */
+export interface UseConversionContext extends SVGConversionEnvironment {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly idShapes: ReadonlyMap<string, IRShape>;
+    readonly idGroups: ReadonlyMap<string, Element>;
+    readonly idSymbols: ReadonlyMap<string, Element>;
+    readonly idImages: ReadonlyMap<string, Element>;
+    readonly symbolShapesById: ReadonlyMap<string, Array<{
+        element: Element;
+        shape: IRShape;
+    }>>;
+    readonly idTextEls: ReadonlyMap<string, Element>;
+    readonly idTextPureUse: ReadonlySet<string>;
+    readonly allocateLayerIndex: () => number;
+    readonly peekLayerIndex: () => number;
+    readonly appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+    readonly registerTextFontAsset: (content: IRTextContent, info: SVGPreservedTextData) => void;
+    readonly textDataByLayerId?: Map<string, SVGPreservedTextData>;
+    readonly measureText?: (fontDesc: string, text: string) => {
+        width: number;
+    };
+    readonly imageNaturalSizes?: ReadonlyMap<string, {
+        width: number;
+        height: number;
+    }>;
+    readonly resourceBaseUrl?: string;
+    readonly appendAsset: (asset: IRAsset) => void;
+}
+/** Group 元素转换所需的上下文。 */
+export interface GroupConversionContext extends SVGConversionEnvironment {
+    readonly idEls: ReadonlyMap<string, Element>;
+    readonly groupMaskGNodeToIndex: Map<globalThis.Element, number>;
+    readonly allocateLayerIndex: () => number;
+    readonly appendLayer: (layer: IRLayer, element: Element, applyElementClip?: boolean) => void;
+}
+export declare function createSVGConversionSession(es: EditableSVG, options: SVGLayerBuildOptions): SVGConversionSession;
+export declare function createSVGConversionEnvironment(session: SVGConversionSession): SVGConversionEnvironment;
+export declare function createSVGElementLookup(session: SVGConversionSession): SVGElementLookup;
+export declare function createLayerOutput(session: SVGConversionSession): LayerOutput;

package/dist/svg2ir/converter/layers/convert-group-element.d.ts

@@ -0,0 +1,3 @@
+import type { Element } from '@svgdotjs/svg.js';
+import type { GroupConversionContext } from './conversion-session';
+export declare function convertGroupElement(element: Element, context: GroupConversionContext): void;

package/dist/svg2ir/converter/layers/convert-image-element.d.ts

@@ -0,0 +1,3 @@
+import type { Element } from '@svgdotjs/svg.js';
+import type { ImageConversionContext } from './conversion-session';
+export declare function convertImageElement(element: Element, context: ImageConversionContext): void;

package/dist/svg2ir/converter/layers/convert-shape-element.d.ts

@@ -0,0 +1,3 @@
+import type { Element } from '@svgdotjs/svg.js';
+import type { ShapeConversionContext } from './conversion-session';
+export declare function convertShapeElement(element: Element, context: ShapeConversionContext): void;

package/dist/svg2ir/converter/layers/convert-text-element.d.ts

@@ -0,0 +1,3 @@
+import type { Element } from '@svgdotjs/svg.js';
+import type { TextConversionContext } from './conversion-session';
+export declare function convertTextElement(element: Element, context: TextConversionContext): void;

package/dist/svg2ir/converter/layers/convert-use-element.d.ts

@@ -0,0 +1,3 @@
+import type { Element } from '@svgdotjs/svg.js';
+import type { UseConversionContext } from './conversion-session';
+export declare function convertUseElement(element: Element, context: UseConversionContext): void;

package/dist/svg2ir/converter/layers/element-categories.d.ts

@@ -0,0 +1,2 @@
+export declare const SVG_DECLARATION_CONTEXT_TAGS: Set<string>;
+export declare const SVG_UNSUPPORTED_ELEMENT_TAGS: Set<string>;