@docx-editor.dev/docx-to-pdf 2.22.0 → 2.23.0

package/docs/fonts.md

@@ -18,7 +18,7 @@ Sources resolve in this order:
 2. Installed fonts, unless `useSystemFonts` is `false`.
 3. Packaged substitutes.
 4. Your `fallbackFonts` sources.
-5. Supplemental packaged faces.
+5. Supplemental packaged faces, including `@docx-editor.dev/fonts-cjk` when it is installed.
 6. Document-embedded fonts.
 7. Your `lastResortFonts` sources.
 8. Generic substitutes for unresolved families.
@@ -27,6 +27,64 @@ Earlier sources take priority. Each option accepts one source or an ordered arra
 
 The default sources need no network access. A resolver that you supply can make network requests.
 
+## Add Chinese, Japanese, and Korean text
+
+The converter package does not include a Chinese, Japanese, or Korean (CJK) font. If your server has no suitable font, install the optional package:
+
+```sh
+npm install @docx-editor.dev/fonts-cjk
+```
+
+The converter declares this package as an optional peer dependency. Install a version that satisfies its peer dependency range. The converter finds the package at runtime and needs no configuration. Its Noto Sans CJK JP font supplies CJK characters that earlier sources do not cover. It also substitutes for unavailable families such as SimSun, MS Mincho, and Malgun Gothic.
+
+If you previously relied on bundled CJK coverage, add this package to your production dependencies. Keep the package external to your server bundle. Retain its `dist/` and `assets/` directories in their package locations. Include its license files when distributing the package.
+
+You can omit the package when installed fonts or your supplied fonts cover every required character. An installed package with missing or unreadable assets reports `font-origin-failed`. Inspect `result.fontResolution.originFailures` for the cause.
+
+When `useSystemFonts` is `true`, suitable installed fonts take priority. Setting `useSystemFonts: false` still permits the optional package and fonts that you supply.
+
+If no source covers a CJK character, export reports `missing-glyph`, and strict export fails. When the optional package is absent, the diagnostic names it. An unavailable CJK family uses a generic substitute and reports `font-substitution`.
+
+### CJK package API
+
+`@docx-editor.dev/fonts-cjk` runs on Node.js `^20.16.0 || >=22.3.0`. It exports the font family and its local file URL:
+
+| Export | Type | Value |
+| --- | --- | --- |
+| `NOTO_SANS_CJK_JP_FAMILY` | String literal | `'Noto Sans CJK JP'` |
+| `NOTO_SANS_CJK_JP_URL` | `URL` | A `file:` URL for `assets/NotoSansCJKjp-Regular.otf`. |
+
+Use the URL to read the font directly:
+
+```ts
+import { readFile } from 'node:fs/promises';
+import {
+  NOTO_SANS_CJK_JP_FAMILY,
+  NOTO_SANS_CJK_JP_URL,
+} from '@docx-editor.dev/fonts-cjk';
+
+const fontBytes = new Uint8Array(await readFile(NOTO_SANS_CJK_JP_URL));
+console.log(NOTO_SANS_CJK_JP_FAMILY, fontBytes.byteLength);
+```
+
+Automatic PDF fallback needs no direct import. If you supply `glyphFallbacks`, your list replaces the defaults. For this fallback, add an entry with `family: NOTO_SANS_CJK_JP_FAMILY`, `weight: 400`, and `style: 'normal'`.
+
+### CJK font coverage and licensing
+
+The package supplies Noto Sans CJK JP Regular as an OpenType font with CFF outlines. It contains one weight (`400`) and one style (`'normal'`). PDF export can synthesize bold and italic from the regular face.
+
+The package contains the Japanese regional face, without separate Chinese or Korean regional faces. Substitution can change glyph forms, line breaks, and page counts. Supply your own font through `fonts` when you need a specific regional face or designed style.
+
+The package reads its font from disk without network access. It does not bundle the font into JavaScript or install a browser font.
+
+The package code uses the Apache License 2.0. The font uses the SIL Open Font License, Version 1.1. The PDF converter uses the separate EigenPal Pro License.
+
+## Export Arabic and Hebrew text
+
+Default fallback fonts cover Arabic and Hebrew. Arabic fallback selection requires a font with Arabic shaping support. Arabic joining continues across formatting runs, including changes in text color. The PDF text layer preserves logical word order for Arabic, Persian, and Hebrew text extraction.
+
+When a selected face lacks bold or italic variants, the writer can draw synthetic styles. It preserves text extraction and glyph positions. To use your own designed variants, supply separate regular, bold, italic, and bold-italic font files.
+
 ## Supply a font file
 
 Use `createFontSource` from the converter package to validate your font bytes. This example expects your licensed regular font file and a document that requests `Application Sans`:
@@ -88,6 +146,6 @@ Each `font-origin-failed` diagnostic provides the source index, optional source
 | `font-substitution` diagnostic | Supply the requested family through `fonts` or review best-effort output. |
 | Strict font policy rejects conversion | Inspect the callback report for failed sources and missing face variants. |
 | Missing font assets after bundling | Keep converter packages external and copy their assets with deployment output. |
-| Missing glyphs | Supply a face that contains the requested characters. |
+| Missing glyphs | Supply a face that contains the requested characters. For CJK text, install `@docx-editor.dev/fonts-cjk`. |
 
 For server setup, see [Integrate PDF conversion](integrations.md).

package/docs/integrations.md

@@ -70,11 +70,12 @@ export default {
     '@docx-editor.dev/docx-to-pdf',
     '@docx-editor.dev/core',
     '@docx-editor.dev/fonts',
+    '@docx-editor.dev/fonts-cjk',
   ],
 };
 ```
 
-If you deploy a standalone bundle, include the converter's `assets/` directory and the fonts package's assets. Keep the package directory structure intact. Test the deployment artifact with a real conversion before release.
+For a standalone deployment, include the `assets/` directories from the converter and `@docx-editor.dev/fonts`. If you install `@docx-editor.dev/fonts-cjk`, include its `assets/` directory too. Keep the package directory structure intact. Test the deployment artifact with a real conversion before release.
 
 ## Convert a batch
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docx-editor.dev/docx-to-pdf",
-  "version": "2.22.0",
+  "version": "2.23.0",
   "private": false,
   "description": "Convert DOCX to PDF on Node.js with searchable text, embedded fonts, and comments.",
   "type": "module",
@@ -29,7 +29,7 @@
     "licenses"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "node ../../scripts/check-built-siblings.mjs && tsup",
     "typecheck": "tsc --noEmit",
     "check:consumer": "node scripts/check-consumer.mjs",
     "license:check": "license-check-and-add check -f license-check.json",
@@ -42,15 +42,22 @@
     "validation": "bun scripts/validator/launch.mjs"
   },
   "peerDependencies": {
-    "@docx-editor.dev/core": "~2.22.0"
+    "@docx-editor.dev/core": "~2.23.0",
+    "@docx-editor.dev/fonts-cjk": "~2.23.0"
+  },
+  "peerDependenciesMeta": {
+    "@docx-editor.dev/fonts-cjk": {
+      "optional": true
+    }
   },
   "dependencies": {
-    "@docx-editor.dev/fonts": "~2.22.0",
+    "@docx-editor.dev/fonts": "~2.23.0",
     "fontkit": "2.0.4",
     "pdf-lib": "1.17.1"
   },
   "devDependencies": {
     "@docx-editor.dev/core": "workspace:*",
+    "@docx-editor.dev/fonts-cjk": "workspace:*",
     "dejavu-fonts-ttf": "^2.37.3",
     "license-check-and-add": "^4.0.5",
     "pdfjs-dist": "5.4.624",

package/licenses/NotoSansCJK-OFL.txt

@@ -1,92 +0,0 @@
-This Font Software is licensed under the SIL Open Font License,
-Version 1.1.
-
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font
-creation efforts of academic and linguistic communities, and to
-provide a free and open framework in which fonts may be shared and
-improved in partnership with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply to
-any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software
-components as distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to,
-deleting, or substituting -- in part or in whole -- any of the
-components of the Original Version, by changing formats or by porting
-the Font Software to a new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed,
-modify, redistribute, and sell modified and unmodified copies of the
-Font Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components, in
-Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the
-corresponding Copyright Holder. This restriction only applies to the
-primary font name as presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created using
-the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.