@pretextbook/pretext-html 0.1.1 → 0.3.0

package/dist/host.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Platform seam: everything in this package that touches the outside world.
+ *
+ * The renderer needs exactly three things from its host: read a file under a
+ * mounted directory (the XSL tree), read a file the caller named by path (the
+ * source, publication, docinfo), and know where this package's `assets/`
+ * directory is. Under Node all three are filesystem operations. In a browser
+ * they are `fetch`es. Confining them here is what lets the same renderer run
+ * in both — see host.browser.ts for the counterpart, swapped in at build time
+ * by vite.config.ts.
+ *
+ * Every read returns `undefined` rather than throwing when the target is
+ * missing. Callers turn that into their own domain behaviour (mounts.ts
+ * serves MISSING_FILE_STUB, xinclude.ts looks for an <xi:fallback>).
+ */
+/**
+ * Read `relPath` (posix, leading "/") beneath mount root `root`. Refuses to
+ * escape the mount: a `..` that climbs above `root` reads nothing.
+ */
+export declare function readMount(root: string, relPath: string): Promise<Uint8Array | undefined>;
+/** Read a caller-named file (source, publication, docinfo, xi:include). */
+export declare function readSource(location: string): Promise<string | undefined>;
+/**
+ * Serve this package's `assets/` from somewhere other than its own directory
+ * — the programmatic equivalent of the `PRETEXT_HTML_ASSETS` environment
+ * variable, which it takes precedence over. Must be called before the first
+ * render; the compiled stylesheet is cached per root.
+ */
+export declare function setAssetsBase(base: string): void;
+/**
+ * This package's `assets/` directory.
+ *
+ * Computed with path functions rather than `new URL(..., import.meta.url)` so
+ * vite's asset handling does not inline the file at build time. Works from
+ * both src/ and dist/, which sit at the same depth in the package. The
+ * overrides serve bundlers (the VS Code extension bundles this module and
+ * ships the assets elsewhere).
+ */
+export declare function assetsBase(): string;
+/** Join a child onto an assets-style root. */
+export declare function joinPath(root: string, child: string): string;

package/dist/index.browser.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Browser entry point (the "browser" export condition; see package.json).
+ *
+ * Identical to index.ts except that it drops `runCli` — the CLI reads argv and
+ * writes files, and importing it would drag `node:process` into a browser
+ * bundle — and adds `setAssetsBase`, which only the browser build needs.
+ *
+ * Requirements and caveats specific to this build:
+ *
+ *  - **WebAssembly JSPI** must be available. Check `isJspiAvailable()` before
+ *    calling `renderHtml` and fall back to a server-side build when it is
+ *    false; several engines still do not ship it.
+ *  - **Pass `sourceContent`.** There is no filesystem, so `sourcePath` serves
+ *    only as a virtual base for URL and xi:include resolution.
+ *  - **`xi:include`s are not resolved from disk.** Pre-merge them, or pass the
+ *    already-merged document as `sourceContent`.
+ *  - **Assets come from jsDelivr by default**, version-pinned to this package.
+ *    Call `setAssetsBase()` before the first render to self-host.
+ */
+export { renderHtml, defaultXslDir, isJspiAvailable, xpathStringLiteral, } from './renderer.js';
+export type { RenderOptions, RenderResult } from './renderer.js';
+export { findSourceMapEntry } from './sourcemap.js';
+export type { PtxSourceMap, SourceMapEntry } from './sourcemap.js';
+export { forcePortablePublication } from './publication.js';
+export { PREVIEW_THEME_MESSAGE, isPreviewTheme, previewThemeMessage, themeBridgeScript, injectThemeBridge, } from './theme.js';
+export type { PreviewTheme, PreviewThemeMessage } from './theme.js';
+export { setAssetsBase } from './host.js';
+export { setMountReader } from './mounts.js';
+export type { MountReader } from './mounts.js';