@ym-print/renderer-dom 0.0.0-stage → 0.1.0-rc.1

package/LICENSE

@@ -0,0 +1,8 @@
+UNLICENSED
+
+Copyright (c) 2026 YmPrintUnit contributors. All rights reserved.
+
+No open-source license is granted for the original YmPrintUnit code.
+
+Third-party components retain their own licenses. See THIRD_PARTY_NOTICES.md
+and dependency-licenses.json; this notice does not change those licenses.

package/README.md

@@ -1,3 +1,81 @@
-# Temporary Holding Version
+# @ym-print/renderer-dom
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+YmPrintUnit 的浏览器渲染模块，提供系统字体测量、SVG 页面、PNG/JPEG、超大图片分条、浏览器打印和本地 PDF 页面导入。
+
+## npm 安装
+
+首次 npm 发布完成后安装预发布版：
+
+```sh
+pnpm add @ym-print/renderer-dom@next
+```
+
+正式版发布后将 `@next` 改为 `@latest`。原始代码保持 `UNLICENSED`，详见随包附带的 `LICENSE`；第三方许可见 `THIRD_PARTY_NOTICES.md`。
+
+## 使用环境
+
+在桌面 Chrome / Edge 145 及以上的 Web 页面中使用，并以 HTTPS 或 localhost 部署。页面文字通过系统 `font-family` 渲染。
+
+## 字体测量
+
+```ts
+import {BrowserFont} from '@ym-print/renderer-dom';
+
+const font = new BrowserFont('"Microsoft YaHei", "PingFang SC", sans-serif');
+const widthUm = font.measure('采购订单', 12000);
+font.clear();
+```
+
+`BrowserFont` 可传入 `@ym-print/core` 的 `layoutTemplate()`。复用测量器时，在所属业务流程结束后调用 `clear()` 释放测量缓存。
+
+## 渲染页面
+
+```ts
+import {createPageElement} from '@ym-print/renderer-dom';
+import type {LayoutDocument} from '@ym-print/core';
+
+export function showPages(container: HTMLElement, layout: LayoutDocument) {
+  container.replaceChildren(...layout.pages.map(page =>
+    createPageElement(page, container.ownerDocument, layout.font.family),
+  ));
+}
+```
+
+页面尺寸使用毫米，内部绘制使用 SVG。`LayoutDocument` 由排版内核或独立打印 SDK 生成。
+
+## 浏览器打印
+
+```ts
+import {preparePrintFrame} from '@ym-print/renderer-dom';
+import type {LayoutDocument} from '@ym-print/core';
+
+export async function printPages(layout: LayoutDocument, signal?: AbortSignal) {
+  const session = await preparePrintFrame(layout, undefined, {signal});
+  try {
+    session.print();
+    return session;
+  } catch (error) {
+    session.dispose();
+    throw error;
+  }
+}
+```
+
+打印内容在独立 iframe 中生成。`afterprint` 自动清理会话；业务流程提前结束时调用 `session.dispose()`，或通过传入的 `AbortSignal` 取消。
+
+## 图片与 PDF 页面
+
+`exportPagePng()`、`exportPageJpeg()` 输出单页图片，`exportPageImageStrips()` 按条带输出超大页面。`importPdfPages()` 将本地 PDF 页转换为图片元素。
+
+使用 Vite 并启用 PDF 页面导入时，配置本地资源插件：
+
+```ts
+import {defineConfig} from 'vite';
+import {ymPrintPdfAssets} from '@ym-print/renderer-dom/vite';
+
+export default defineConfig({plugins:[ymPrintPdfAssets()]});
+```
+
+插件提供开发服务器资源响应，并在生产构建时复制 PDF 辅助资源。其他构建工具可将本包 `dist/pdf-assets/` 复制到站点的 `/ym-print-assets/`。
+
+子目录部署时，向 `importPdfPages()` 的 `assetBaseUrl` 传入完整资源目录 URL，并保留结尾 `/`。离线使用时，由宿主应用部署和缓存这些资源。

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,37 @@
+# Third-party notices
+
+@ym-print/renderer-dom 0.1.0-rc.1 — original code: UNLICENSED.
+
+Bundled code and external packages keep their original licenses. Optional peers are loaded through their documented opt-in entry.
+
+| Package | License | Delivery | Notices |
+| --- | --- | --- | --- |
+| @oxc-project/types@0.155.0 | MIT | external | [LICENSE](third-party-licenses/@oxc-project__types@0.155.0/LICENSE) |
+| @rolldown/pluginutils@1.0.1 | MIT | external | [LICENSE](third-party-licenses/@rolldown__pluginutils@1.0.1/LICENSE) |
+| detect-libc@2.1.2 | Apache-2.0 | external | [LICENSE](third-party-licenses/detect-libc@2.1.2/LICENSE) |
+| fdir@6.5.0 | MIT | external | [LICENSE](third-party-licenses/fdir@6.5.0/LICENSE) |
+| lightningcss@1.33.0 | MPL-2.0 | external | [LICENSE](third-party-licenses/lightningcss@1.33.0/LICENSE) |
+| nanoid@3.3.20 | MIT | external | [LICENSE](third-party-licenses/nanoid@3.3.20/LICENSE) |
+| pdfjs-dist@6.4.299 | Apache-2.0 | bundled | [LICENSE](third-party-licenses/pdfjs-dist@6.4.299/LICENSE) |
+| picocolors@1.1.1 | ISC | external | [LICENSE](third-party-licenses/picocolors@1.1.1/LICENSE) |
+| picomatch@4.0.7 | MIT | external | [LICENSE](third-party-licenses/picomatch@4.0.7/LICENSE) |
+| postcss@8.5.32 | MIT | external | [LICENSE](third-party-licenses/postcss@8.5.32/LICENSE) |
+| rolldown@1.2.15 | MIT | external | [LICENSE](third-party-licenses/rolldown@1.2.15/LICENSE) |
+| source-map-js@1.2.2 | BSD-3-Clause | external | [LICENSE](third-party-licenses/source-map-js@1.2.2/LICENSE) |
+| tinyglobby@0.2.17 | MIT | external | [LICENSE](third-party-licenses/tinyglobby@0.2.17/LICENSE) |
+| vite@8.3.5 | MIT | optional-peer | [LICENSE.md](third-party-licenses/vite@8.3.5/LICENSE.md) |
+
+## PDF import resource licenses
+
+These optional PDF import assets retain their upstream terms, including the Liberation GPLv2 font exceptions. They are not covered by the original-code license. See each upstream notice for the applicable terms.
+
+- BSD-3-Clause (Adobe CMaps): [original notice](dist/pdf-assets/cmaps/LICENSE)
+- BSD-3-Clause (PDFium/Foxit fonts): [original notice](dist/pdf-assets/standard_fonts/LICENSE_FOXIT)
+- GPL-2.0 with Liberation font exceptions; exact terms in upstream file: [original notice](dist/pdf-assets/standard_fonts/LICENSE_LIBERATION)
+- BSD-3-Clause AND Apache-2.0 (upstream combined notice): [original notice](dist/pdf-assets/wasm/LICENSE_JBIG2)
+- Apache-2.0: [original notice](dist/pdf-assets/wasm/LICENSE_PDFJS_JBIG2)
+- BSD-2-Clause: [original notice](dist/pdf-assets/wasm/LICENSE_OPENJPEG)
+- BSD-2-Clause: [original notice](dist/pdf-assets/wasm/LICENSE_PDFJS_OPENJPEG)
+- MIT: [original notice](dist/pdf-assets/wasm/LICENSE_QCMS)
+- MIT: [original notice](dist/pdf-assets/wasm/LICENSE_PDFJS_QCMS)
+- CC0-1.0: [original notice](dist/pdf-assets/iccs/LICENSE)

package/dependency-licenses.json

@@ -0,0 +1,228 @@
+{
+  "package": "@ym-print/renderer-dom",
+  "version": "0.1.0-rc.1",
+  "license": "UNLICENSED",
+  "licenseScope": "original YmPrintUnit code only",
+  "dependencies": [
+    {
+      "name": "@oxc-project/types",
+      "version": "0.155.0",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/@oxc-project__types@0.155.0/LICENSE",
+          "sha256": "95ced5ecf1133fbf41d409b5555c86c344f83f3b019926057ddbc07cfdcc27b3"
+        }
+      ]
+    },
+    {
+      "name": "@rolldown/pluginutils",
+      "version": "1.0.1",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/@rolldown__pluginutils@1.0.1/LICENSE",
+          "sha256": "e1919b3b98b8bf6c1b99fcc60a0ed46027c97ac947432e1278446c9606f50161"
+        }
+      ]
+    },
+    {
+      "name": "detect-libc",
+      "version": "2.1.2",
+      "license": "Apache-2.0",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/detect-libc@2.1.2/LICENSE",
+          "sha256": "b40930bbcf80744c86c46a12bc9da056641d722716c378f5659b9e555ef833e1"
+        }
+      ]
+    },
+    {
+      "name": "fdir",
+      "version": "6.5.0",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/fdir@6.5.0/LICENSE",
+          "sha256": "9a39f2aadab11a3697edd668ff2d8ad885b649737b7ab4d3bf12b34e5ada0c86"
+        }
+      ]
+    },
+    {
+      "name": "lightningcss",
+      "version": "1.33.0",
+      "license": "MPL-2.0",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/lightningcss@1.33.0/LICENSE",
+          "sha256": "5eba353fe5076ac3432177f8ab1cf75e3afcd0584251e37c3bfead5f447d040e"
+        }
+      ]
+    },
+    {
+      "name": "nanoid",
+      "version": "3.3.20",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/nanoid@3.3.20/LICENSE",
+          "sha256": "da4db1480d9beea3483a2eda5c53b22238d0827d57da162b48f122e04d2d9987"
+        }
+      ]
+    },
+    {
+      "name": "pdfjs-dist",
+      "version": "6.4.299",
+      "license": "Apache-2.0",
+      "kind": "bundled",
+      "notices": [
+        {
+          "path": "third-party-licenses/pdfjs-dist@6.4.299/LICENSE",
+          "sha256": "0d542e0c8804e39aa7f37eb00da5a762149dc682d7829451287e11b938e94594"
+        }
+      ]
+    },
+    {
+      "name": "picocolors",
+      "version": "1.1.1",
+      "license": "ISC",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/picocolors@1.1.1/LICENSE",
+          "sha256": "6582629e2979466878f6014313dcc2f3756c9616148682227ce3063dde310750"
+        }
+      ]
+    },
+    {
+      "name": "picomatch",
+      "version": "4.0.7",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/picomatch@4.0.7/LICENSE",
+          "sha256": "d0cd141b0c322fded5dfad1d4645bb2fedfc05b7321fe1009469638190d59ef9"
+        }
+      ]
+    },
+    {
+      "name": "postcss",
+      "version": "8.5.32",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/postcss@8.5.32/LICENSE",
+          "sha256": "5be1f3465bba68a626777f984878814aaf35e7ef8e9fd314d469bcf887050fb8"
+        }
+      ]
+    },
+    {
+      "name": "rolldown",
+      "version": "1.2.15",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/rolldown@1.2.15/LICENSE",
+          "sha256": "23ecfff35a5a2e80d92142f75228912c3b1abc4b5a8337a821ff4397e2f9f734"
+        }
+      ]
+    },
+    {
+      "name": "source-map-js",
+      "version": "1.2.2",
+      "license": "BSD-3-Clause",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/source-map-js@1.2.2/LICENSE",
+          "sha256": "6cb0631f71c7749763fd3dd1d5bee52dd1070ec17f2edc1710079ad070bd2fbd"
+        }
+      ]
+    },
+    {
+      "name": "tinyglobby",
+      "version": "0.2.17",
+      "license": "MIT",
+      "kind": "external",
+      "notices": [
+        {
+          "path": "third-party-licenses/tinyglobby@0.2.17/LICENSE",
+          "sha256": "22c68811e174cbbfb3813d4135918df4f540959c14d872e601d9abe83d3cde8f"
+        }
+      ]
+    },
+    {
+      "name": "vite",
+      "version": "8.3.5",
+      "license": "MIT",
+      "kind": "optional-peer",
+      "notices": [
+        {
+          "path": "third-party-licenses/vite@8.3.5/LICENSE.md",
+          "sha256": "a22152baa1aef74402443008e767e7c689a524c0909d19b0431d97f5ab066a13"
+        }
+      ]
+    }
+  ],
+  "resourceLicenses": [
+    {
+      "path": "dist/pdf-assets/cmaps/LICENSE",
+      "license": "BSD-3-Clause (Adobe CMaps)",
+      "sha256": "aa92ab5a472974865a96fd4a4e9c13bb41bf6fe1b309cb6b8da48bc9e19839a2"
+    },
+    {
+      "path": "dist/pdf-assets/standard_fonts/LICENSE_FOXIT",
+      "license": "BSD-3-Clause (PDFium/Foxit fonts)",
+      "sha256": "b578cdd2345840ada550bd12519533812320d5f1d21cf4c1c7e1b1b0a31c98b7"
+    },
+    {
+      "path": "dist/pdf-assets/standard_fonts/LICENSE_LIBERATION",
+      "license": "GPL-2.0 with Liberation font exceptions; exact terms in upstream file",
+      "sha256": "d2c4d5b3e115a519cb58eb691aa64538397e2611f9ebe801392cf9667997e7dc"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_JBIG2",
+      "license": "BSD-3-Clause AND Apache-2.0 (upstream combined notice)",
+      "sha256": "9e66b7f1b934a28b37f3bc4dac97915de1674271e79a0a88182a18ed9731b4d1"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_PDFJS_JBIG2",
+      "license": "Apache-2.0",
+      "sha256": "aad3cce09842e00e9e11ad5e8fef8cc02fbc3a3768fe2f007443b9cee37aaee5"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_OPENJPEG",
+      "license": "BSD-2-Clause",
+      "sha256": "a6af136f3e15038a666b61f376612a07d9a4e48cb7c01adbf3e33b3f14ab49b6"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_PDFJS_OPENJPEG",
+      "license": "BSD-2-Clause",
+      "sha256": "717fc62da03292dbb4dd0c8280bd4ce7bb8550dcf31d772bc93455fb50313425"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_QCMS",
+      "license": "MIT",
+      "sha256": "36d847ae882f6574ebc72f56a4f354e4f104fde4a584373496482e97d52d31bc"
+    },
+    {
+      "path": "dist/pdf-assets/wasm/LICENSE_PDFJS_QCMS",
+      "license": "MIT",
+      "sha256": "508a77d2e7b51d98adeed32648ad124b7b30241a8e70b2e72c99f92d8e5874d1"
+    },
+    {
+      "path": "dist/pdf-assets/iccs/LICENSE",
+      "license": "CC0-1.0",
+      "sha256": "286e4fd7b447330b2c88e23890e3cd0a9d38cb398d4a59cb247f578ccbda3213"
+    }
+  ]
+}

package/dist/browser-support.d.ts

@@ -0,0 +1,2 @@
+/** PDF.js modern build and its worker share this requirement; never patch host prototypes. */
+export declare function assertPdfImportSupport(): void;

package/dist/image-density.d.ts

@@ -0,0 +1,2 @@
+/** Canvas encodes 96 DPI by default. Store the requested density without re-encoding pixels. */
+export declare function withImageDensity(blob: Blob, dpi: number): Promise<Blob>;

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { LayoutDocument, LayoutPage } from '@ym-print/core';
+export { BrowserFont } from './system-font.js';
+export declare const FONT_FAMILY = "YmPrintNoto";
+export declare function createPageElement(page: LayoutPage, doc?: Document, fontFamily?: string): HTMLElement;
+export declare function renderLayout(container: HTMLElement, layout: LayoutDocument): void;
+export declare function fontFaceCss(url: string): string;
+export declare function createPrintHtml(layout: LayoutDocument, embeddedFontDataUrl?: string): string;
+export declare function fontDataUrl(bytes: Uint8Array): string;
+export interface PrintFrameSession {
+    readonly frame: HTMLIFrameElement;
+    readonly html: string;
+    isDisposed: () => boolean;
+    print: () => void;
+    dispose: () => void;
+    /** Returns an unsubscribe function. Subscribers are released on dispose. */
+    onAfterPrint: (callback: () => void) => () => void;
+}
+export interface PrintFrameOptions {
+    signal?: AbortSignal;
+    timeoutMs?: number;
+}
+export declare function preparePrintFrame(layout: LayoutDocument, bytes?: Uint8Array, options?: PrintFrameOptions): Promise<PrintFrameSession>;
+export * from './raster.js';
+export type { ImportedPdfPage, PdfImportOptions } from './pdf-import.js';
+export declare function importPdfPages(bytes: Uint8Array, options?: import('./pdf-import.js').PdfImportOptions): Promise<import("./pdf-import.js").ImportedPdfPage[]>;