@galacean/effects-plugin-dom-content 2.9.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2019-present Ant Group Co., Ltd. https://www.antgroup.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/dom-content-component.d.ts

@@ -0,0 +1,44 @@
+import type { Engine, Renderer } from '@galacean/effects';
+import { MaskableGraphic } from '@galacean/effects';
+/** DOM 内容组件：将 HTML/CSS 渲染为纹理，自动检测并覆盖同 item 上其他 MaskableGraphic 组件纹理 */
+export declare class DomContentComponent extends MaskableGraphic {
+    htmlContent: string;
+    contentWidth: number;
+    contentHeight: number;
+    contentScale: number;
+    /** 本组件独占持有的离屏 canvas，用于将 HTML 渲染结果转为纹理数据，onDestroy 时一并释放。 */
+    canvas: HTMLCanvasElement;
+    context: CanvasRenderingContext2D | null;
+    isDirty: boolean;
+    private rendering;
+    /** 异步任务取消标记：onDestroy 后置为 true，用于让 await 中的 updateTexture 回到同步段时立刻退出，避免泄漏纹理或写已释放的 material。 */
+    private asyncCancelled;
+    private targetComponent;
+    /** 内容版本号：每次 setContent 自增，用于丢弃过期的异步渲染结果，防止慢请求覆盖快请求。 */
+    private renderVersion;
+    /** 由本组件创建的纹理集合，仅这些纹理可被 dispose */
+    private ownedTextures;
+    /** 保存 target 组件的原始纹理，用于组件销毁时恢复 */
+    private originalTargetTexture;
+    constructor(engine: Engine);
+    setContent(html: string, width?: number, height?: number, scale?: number): void;
+    onAwake(): void;
+    onUpdate(dt: number): void;
+    render(renderer: Renderer): void;
+    onDestroy(): void;
+    /**
+     * 释放当前 renderer 上挂载的纹理（白纹理是引擎共享资源，不应释放）。
+     */
+    private disposeOwnTexture;
+    /**
+     * 将一张 image 绘制到内部 canvas，并据此创建纹理写入到本组件 renderer / material。
+     *
+     * @param width - 纹理宽度（像素）
+     * @param height - 纹理高度（像素）
+     * @param flipY - 是否翻转 Y 轴；为 false 时通过 canvas 变换预先翻转
+     * @param drawCallback - 实际绘制回调，接收已重置变换并清空的 2D 上下文
+     */
+    private renderImageToTexture;
+    private updateTexture;
+    private updateTargetTexture;
+}

package/dist/dom-content-loader.d.ts

@@ -0,0 +1,8 @@
+import { Plugin } from '@galacean/effects';
+/**
+ * DOM Content 插件 Loader
+ * 当前为空壳实现，组件在运行时由开发手动挂载，无需 JSON 数据解析
+ */
+export declare class DomContentLoader extends Plugin {
+    name: string;
+}

package/dist/dom-to-texture.d.ts

@@ -0,0 +1,27 @@
+export interface RenderOptions {
+    /** 自动内联 @font-face 外部字体，默认 true */
+    inlineFonts?: boolean;
+    /** 自动内联外部图片/资源 URL，默认 true */
+    inlineImages?: boolean;
+    /** 自动从宿主文档提取 CSS url(#id) 引用的 SVG 定义，默认 true */
+    extractDefs?: boolean;
+}
+/** 将 HTML 渲染为 Image 对象，默认自动执行内联字体/图片/提取 SVG 定义 */
+export declare function renderDOMToImage(html: string, width: number, height: number, scale?: number, options?: RenderOptions): Promise<HTMLImageElement>;
+/**
+ * 清理 HTML：转义危险标签，移除事件处理器和危险协议 URL 属性。
+ * 使用字符级扫描代替回溯正则，避免 ReDoS 漏洞。
+ */
+export declare function sanitizeSVGContent(html: string): string;
+/**
+ * 将 HTML 中外部资源 URL 转为 base64 内联，失败时保留原 URL
+ */
+export declare function inlineImageSources(html: string): Promise<string>;
+/**
+ * 将 @font-face 中的外部字体 URL 转为 base64 内联
+ */
+export declare function inlineFontSources(html: string): Promise<string>;
+/**
+ * 从宿主文档提取 CSS url(#id) 引用的 SVG 定义，支持 filter/clipPath/mask/gradient/pattern/marker
+ */
+export declare function extractSVGDefs(html: string): string;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './dom-content-component';
+export * from './dom-content-loader';
+export * from './dom-to-texture';
+export declare const version: string;