inkoxide 0.1.0 → 0.2.0

package/README.md

@@ -19,7 +19,7 @@ automatically (as optional dependencies) for the current platform:
 | macOS x64             | `@inkoxide/darwin-x64`      |
 | Windows x64           | `@inkoxide/win32-x64-msvc`  |
 
-Linux glibc builds need glibc 2.35 or newer. Node.js 18 or newer.
+Linux glibc builds need glibc 2.35 or newer. Node.js 22 or newer; ES modules only.
 Other platforms: build from source with `scripts/build-node.sh`, which
 puts `inkoxide.<platform>.node` next to the loader.
 
@@ -52,5 +52,9 @@ try {
 console.log(validate(JSON.stringify(doc)));
 ```
 
-Options, defaults and error codes are typed in `index.d.ts` and described
-in `docs/API.md`. Schema reference: `docs/SCHEMA.md` and `schema/EXAMPLES.md`.
+Options, defaults and error codes are typed in `index.d.ts` and described in the
+[API reference](https://github.com/eddiesr93/inkoxide/blob/main/docs/API.md). The document
+format is in the [schema reference](https://github.com/eddiesr93/inkoxide/blob/main/docs/SCHEMA.md)
+and the [example documents](https://github.com/eddiesr93/inkoxide/blob/main/packages/schema/EXAMPLES.md).
+To write documents as React components, use
+[`@inkoxide/render`](https://www.npmjs.com/package/@inkoxide/render).

package/index.d.ts

@@ -1,5 +1,5 @@
 // Public contract of the `inkoxide` npm package. Hand-written; keep in
-// sync with crates/node/src/lib.rs and npm/index.js.
+// sync with crates/node/src/lib.rs and index.js.
 
 /**
  * Codes of document problems, from `validate` and from a failed `render`

package/index.js

@@ -1,9 +1,12 @@
-'use strict';
 // Loader for the native binding plus the JS-side error type. Hand-written
 // and reviewed together with index.d.ts (the public contract).
 
-const { existsSync } = require('node:fs');
-const { join } = require('node:path');
+import { existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+
+// Native addons (.node files) load through require, also from an ES module.
+const require = createRequire(import.meta.url);
 
 function isMusl() {
   if (process.platform !== 'linux') return false;
@@ -24,7 +27,7 @@ function platformTriple() {
 
 function loadNative() {
   const triple = platformTriple();
-  const local = join(__dirname, `inkoxide.${triple}.node`);
+  const local = fileURLToPath(new URL(`inkoxide.${triple}.node`, import.meta.url));
   if (existsSync(local)) return require(local);
   try {
     return require(`@inkoxide/${triple}`);
@@ -38,7 +41,7 @@ function loadNative() {
 
 const native = loadNative();
 
-class InkoxideError extends Error {
+export class InkoxideError extends Error {
   constructor(code, path, message) {
     super(path ? `${code} at ${path}: ${message}` : `${code}: ${message}`);
     this.name = 'InkoxideError';
@@ -101,26 +104,22 @@ function toUint8Array(b) {
   return new Uint8Array(b.buffer, b.byteOffset, b.byteLength);
 }
 
-// Plain `exports.x =` assignments so ESM `import { render } from 'inkoxide'`
-// sees named exports.
-exports.InkoxideError = InkoxideError;
-exports.registerFont = (id, data) => call(native.registerFont, [id, data]);
-exports.unregisterFont = (id) => call(native.unregisterFont, [id]);
-exports.registerHyphenationPatterns = (lang, data) =>
+export const registerFont = (id, data) => call(native.registerFont, [id, data]);
+export const unregisterFont = (id) => call(native.unregisterFont, [id]);
+export const registerHyphenationPatterns = (lang, data) =>
   call(native.registerHyphenationPatterns, [lang, data]);
-exports.unregisterHyphenationPatterns = (lang) =>
-  call(native.unregisterHyphenationPatterns, [lang]);
-exports.validate = (doc, format, images) =>
+export const unregisterHyphenationPatterns = (lang) => call(native.unregisterHyphenationPatterns, [lang]);
+export const validate = (doc, format, images) =>
   call(native.validate, [doc, format ?? undefined, images ?? undefined]);
-exports.render = async (doc, options) => {
+export const render = async (doc, options) => {
   try {
     return toUint8Array(await native.render(doc, options ?? undefined));
   } catch (e) {
     throw wrapError(e);
   }
 };
-exports.renderSync = (doc, options) =>
+export const renderSync = (doc, options) =>
   toUint8Array(call(native.renderSync, [doc, options ?? undefined]));
-exports.version = () => call(native.version, []);
-// Test hook (not public API): a panic behind the native boundary.
-Object.defineProperty(exports, '__testPanic', { value: () => call(native.__testPanic, []) });
+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, []);

package/package.json

@@ -1,27 +1,36 @@
 {
   "name": "inkoxide",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Native PDF layout and rendering engine: declarative document tree in, PDF bytes out.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/eddiesr93/inkoxide.git"
+    "url": "git+https://github.com/eddiesr93/inkoxide.git",
+    "directory": "packages/inkoxide"
   },
+  "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "index.js",
     "index.d.ts"
   ],
   "engines": {
-    "node": ">= 18"
+    "node": ">=22"
   },
   "optionalDependencies": {
-    "@inkoxide/linux-x64-gnu": "0.1.0",
-    "@inkoxide/linux-x64-musl": "0.1.0",
-    "@inkoxide/linux-arm64-gnu": "0.1.0",
-    "@inkoxide/darwin-arm64": "0.1.0",
-    "@inkoxide/darwin-x64": "0.1.0",
-    "@inkoxide/win32-x64-msvc": "0.1.0"
+    "@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"
   }
 }