inkoxide 0.2.0 → 0.4.0

package/README.md

@@ -48,7 +48,7 @@ try {
   console.error(e.code, e.path, e.message);
 }
 
-// All problems at once, without rendering: [{ code, path, message }, …]
+// The problems at once (at most 100), without rendering: [{ code, path, message }, …]
 console.log(validate(JSON.stringify(doc)));
 ```
 

package/index.d.ts

@@ -54,7 +54,10 @@ export interface RenderOptions {
    * `meta.creationDate`. With neither set no date is written. Default: none.
    */
   creationDate?: string;
-  /** Worker threads for this render. Default: all cores. `1` renders on one thread. */
+  /**
+   * Worker threads for this render. Default: all cores. `1` renders on the libuv thread that
+   * runs it, with no parallelism inside, so concurrent renders do not wait for each other.
+   */
   threads?: number;
   /** Embed only the glyphs the document uses. Default `true`; `false` embeds whole fonts. */
   subsetFonts?: boolean;
@@ -84,7 +87,7 @@ export class InkoxideError extends Error {
   readonly path: string;
 }
 
-/** Registers (or replaces) a TrueType or CFF OpenType font in the process-wide cache. */
+/** Registers (or replaces) a TrueType, CFF OpenType, WOFF or WOFF2 font in the process-wide cache. */
 export function registerFont(id: string, data: Uint8Array): void;
 /** Removes a registered font; returns whether it existed. */
 export function unregisterFont(id: string): boolean;
@@ -92,16 +95,18 @@ export function unregisterFont(id: string): boolean;
  * Registers (or replaces), for all later renders, TeX hyphenation patterns
  * for a language: a hyph-utf8 file such as `hyph-en-us.tex` with
  * `\patterns{…}` and optional `\hyphenation{…}` groups, in UTF-8.
- * `lang` is a BCP-47 tag (`"en"`, `"en-GB"`); patterns apply to its
- * language. Registered patterns win over the built-in ones. Throws
- * `HYPHENATION_ERROR` for malformed patterns.
+ * `lang` is a BCP-47 tag with a two- or three-letter language (`"en"`,
+ * `"en-GB"`, `"haw"`). Text uses the patterns of its own tag, else of the
+ * nearest less specific one (`"en-GB"`, then `"en"`), else the built-in
+ * ones. Throws `HYPHENATION_ERROR` for a malformed tag or patterns.
  */
 export function registerHyphenationPatterns(lang: string, data: Uint8Array | string): void;
-/** Removes registered patterns; returns whether there were any. */
+/** Removes the patterns registered for exactly `lang`; returns whether there were any. */
 export function unregisterHyphenationPatterns(lang: string): boolean;
 /**
  * Validates a document against the schema and the registered fonts. Image
- * references are checked only when `images` is given.
+ * references are checked only when `images` is given. Returns at most 100
+ * problems; one in the document's structure is returned alone.
  */
 export function validate(
   doc: Uint8Array | string,

package/index.js

@@ -121,5 +121,6 @@ export const render = async (doc, options) => {
 export const renderSync = (doc, options) =>
   toUint8Array(call(native.renderSync, [doc, options ?? undefined]));
 export const version = () => call(native.version, []);
-// Test hook, not public API and not in index.d.ts: a panic behind the native boundary.
-export const __testPanic = () => call(native.__testPanic, []);
+// Test hook, not public API and not in index.d.ts: a panic behind the native boundary. A
+// non-enumerable property of InkoxideError, so it is not on the module namespace.
+Object.defineProperty(InkoxideError, '__testPanic', { value: () => call(native.__testPanic, []) });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inkoxide",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Native PDF layout and rendering engine: declarative document tree in, PDF bytes out.",
   "license": "MIT",
   "repository": {
@@ -26,11 +26,11 @@
     "node": ">=22"
   },
   "optionalDependencies": {
-    "@inkoxide/linux-x64-gnu": "0.2.0",
-    "@inkoxide/linux-x64-musl": "0.2.0",
-    "@inkoxide/linux-arm64-gnu": "0.2.0",
-    "@inkoxide/darwin-arm64": "0.2.0",
-    "@inkoxide/darwin-x64": "0.2.0",
-    "@inkoxide/win32-x64-msvc": "0.2.0"
+    "@inkoxide/linux-x64-gnu": "0.4.0",
+    "@inkoxide/linux-x64-musl": "0.4.0",
+    "@inkoxide/linux-arm64-gnu": "0.4.0",
+    "@inkoxide/darwin-arm64": "0.4.0",
+    "@inkoxide/darwin-x64": "0.4.0",
+    "@inkoxide/win32-x64-msvc": "0.4.0"
   }
 }