@pretextbook/pretext-html 0.17.0 → 0.18.1

package/dist/index.d.ts

@@ -6,7 +6,7 @@ export type { SourceCacheOptions } from './source-cache.js';
 export type { SourceReader } from './xinclude.js';
 export { findSourceMapEntry } from './sourcemap.js';
 export type { PtxSourceMap, SourceMapEntry } from './sourcemap.js';
-export { forcePortablePublication } from './publication.js';
+export { forcePreviewPublication, forcePortablePublication, } from './publication.js';
 export type { PublicationOverrides } from './publication.js';
 export { detectRenderTarget } from './target.js';
 export type { RenderTarget } from './target.js';

package/dist/index.js

@@ -1,52 +1,53 @@
-import { O as s, P as i, S as t, b as a, d as n, a as o, c, e as l, f as p, g as d, i as P, h as E, m, o as S, p as v, r as u, j as A, k as f, l as g, n as h, s as B, q as _, x as w } from "./cli-C0JwLhuv.js";
-import { injectRevealBridge as L, isRevealView as x, revealBridgeScript as T } from "./reveal.js";
-import { describeAsset as G, missingAssetPlaceholder as I, missingAssetSvg as M, rewriteAssetUrls as j } from "./assets.js";
-import { PREVIEW_THEME_MESSAGE as V, injectThemeBridge as C, isPreviewTheme as D, previewThemeMessage as H, themeBridgeScript as k } from "./theme.js";
-import { PRINT_PREVIEW_GLOBAL as W, injectPrintPreview as y, listPrintouts as F, printPreviewBridgeScript as K, rootPrintoutId as X } from "./printout.js";
-import { LIVE_PATCH_GLOBAL as J, livePatchScript as U, patchDocument as Y, typesetPatch as z } from "./live-patch.js";
+import { O as i, P as s, S as t, b as a, d as o, a as n, c, e as l, f as p, g as P, h as d, i as E, j as m, m as v, o as S, p as u, r as A, k as f, l as g, n as h, q as B, s as w, t as _, x as R } from "./cli-CddPgMt-.js";
+import { injectRevealBridge as b, isRevealView as x, revealBridgeScript as T } from "./reveal.js";
+import { describeAsset as I, missingAssetPlaceholder as M, missingAssetSvg as j, rewriteAssetUrls as O } from "./assets.js";
+import { PREVIEW_THEME_MESSAGE as C, injectThemeBridge as D, isPreviewTheme as H, previewThemeMessage as k, themeBridgeScript as N } from "./theme.js";
+import { PRINT_PREVIEW_GLOBAL as y, injectPrintPreview as F, listPrintouts as K, printPreviewBridgeScript as X, rootPrintoutId as q } from "./printout.js";
+import { LIVE_PATCH_GLOBAL as U, livePatchScript as Y, patchDocument as z, typesetPatch as Q } from "./live-patch.js";
 export {
-  J as LIVE_PATCH_GLOBAL,
-  s as OFF_PAGE_MESSAGE,
-  i as PREVIEW_BANNER_STORAGE_KEY,
-  V as PREVIEW_THEME_MESSAGE,
-  W as PRINT_PREVIEW_GLOBAL,
+  U as LIVE_PATCH_GLOBAL,
+  i as OFF_PAGE_MESSAGE,
+  s as PREVIEW_BANNER_STORAGE_KEY,
+  C as PREVIEW_THEME_MESSAGE,
+  y as PRINT_PREVIEW_GLOBAL,
   t as SourceCache,
   a as buildSkeleton,
-  n as defaultSourceCache,
-  o as defaultXslDir,
-  G as describeAsset,
+  o as defaultSourceCache,
+  n as defaultXslDir,
+  I as describeAsset,
   c as detectRenderTarget,
   l as divisionLevel,
   p as findSourceMapEntry,
-  d as forcePortablePublication,
-  P as injectPreviewBanner,
-  y as injectPrintPreview,
-  L as injectRevealBridge,
-  C as injectThemeBridge,
-  E as isJspiAvailable,
-  D as isPreviewTheme,
+  P as forcePortablePublication,
+  d as forcePreviewPublication,
+  E as injectPreviewBanner,
+  F as injectPrintPreview,
+  b as injectRevealBridge,
+  D as injectThemeBridge,
+  m as isJspiAvailable,
+  H as isPreviewTheme,
   x as isRevealView,
-  F as listPrintouts,
-  U as livePatchScript,
-  m as measureDocument,
-  I as missingAssetPlaceholder,
-  M as missingAssetSvg,
+  K as listPrintouts,
+  Y as livePatchScript,
+  v as measureDocument,
+  M as missingAssetPlaceholder,
+  j as missingAssetSvg,
   S as openBornHiddenKnowls,
-  Y as patchDocument,
-  v as previewBannerScript,
-  H as previewThemeMessage,
-  K as printPreviewBridgeScript,
-  u as readPublicationLevels,
-  A as renderHtml,
-  f as replaceDivision,
+  z as patchDocument,
+  u as previewBannerScript,
+  k as previewThemeMessage,
+  X as printPreviewBridgeScript,
+  A as readPublicationLevels,
+  f as renderHtml,
+  g as replaceDivision,
   T as revealBridgeScript,
-  j as rewriteAssetUrls,
-  g as rewriteXrefLinks,
-  X as rootPrintoutId,
-  h as runCli,
-  B as setAssetsBase,
+  O as rewriteAssetUrls,
+  h as rewriteXrefLinks,
+  q as rootPrintoutId,
+  B as runCli,
+  w as setAssetsBase,
   _ as setMountReader,
-  k as themeBridgeScript,
-  z as typesetPatch,
-  w as xpathStringLiteral
+  N as themeBridgeScript,
+  Q as typesetPatch,
+  R as xpathStringLiteral
 };

package/dist/publication.d.ts

@@ -1,3 +1,4 @@
+import { Root } from 'xast';
 import { RenderTarget } from './target.js';
 /** Optional adjustments layered onto the publication file for a render. */
 export interface PublicationOverrides {
@@ -19,36 +20,46 @@ export interface PublicationOverrides {
     target?: RenderTarget;
 }
 /**
- * Return publication-file XML with `<html><platform portable="yes"/></html>`
- * forced, preserving everything else from `publicationXml` when given.
+ * Return publication-file XML with the preview's settings forced (see
+ * {@link PREVIEW_SETTINGS}), preserving everything else from `publicationXml`
+ * when given.
  *
- * Portable mode is forced for slideshows too, even though the reveal.js
- * conversion never chunks: it is what sets `$cdn-prefix`, and so what puts the
- * PreTeXt-side css and js (sagecell, syntax highlighting, the slide styling)
- * on the CDN rather than at a relative path that does not exist.
+ * The CDN host is forced for slideshows too: it is what sets `$cdn-prefix`, and
+ * so what puts the PreTeXt-side css and js (sagecell, syntax highlighting, the
+ * slide styling) on the CDN rather than at a relative path that does not
+ * exist.
  */
-export declare function forcePortablePublication(publicationXml?: string, overrides?: PublicationOverrides): string;
+export declare function forcePreviewPublication(publicationXml?: string, overrides?: PublicationOverrides): string;
 /**
- * Where a project's images live, as declared by
- * `<source><directories external generated/></source>`.
+ * The previous name of {@link forcePreviewPublication}, from when the preview
+ * forced PreTeXt's portable HTML mode.
+ *
+ * @deprecated Use {@link forcePreviewPublication}. The preview no longer uses
+ * portable mode, so the name no longer describes what this does.
+ */
+export declare const forcePortablePublication: typeof forcePreviewPublication;
+/**
+ * Where a project's images live. PreTeXt emits every asset URL under one of
+ * two fixed prefixes, `external/` and `generated/`, and these are the
+ * directories those prefixes stand for.
  *
  * Both paths are relative to the directory of the *main* source file — the one
  * holding `<pretext>` — not to whichever file is being rendered. See
  * RenderOptions.mainSourcePath.
  */
 export interface AssetDirectories {
-    /** e.g. "../assets/" — trailing slash, relative to the main source dir. */
+    /**
+     * e.g. "../assets/" — trailing slash, relative to the main source dir.
+     * Undefined when nothing declares one, which upstream reads as "this
+     * project has no external assets".
+     */
     external?: string;
-    /** e.g. "../generated-assets/" — likewise. */
-    generated?: string;
     /**
-     * True when the publication declares both attributes ("managed
-     * directories"). Only then does PreTeXt emit asset URLs under the fixed
-     * `external/` and `generated/` prefixes that {@link rewriteAssetUrls} keys
-     * on; legacy projects emit bare or `images/`-prefixed paths that cannot be
-     * told apart from anything else, so the preview leaves them alone.
+     * e.g. "../generated-assets/" — likewise. Always set: the directory is
+     * machine-owned, so an undeclared one defaults to "generated/" beside the
+     * source.
      */
-    managed: boolean;
+    generated: string;
 }
 /** The depths a publication file sets numbering and the contents list to. */
 export interface PublicationLevels {
@@ -72,7 +83,29 @@ export interface PublicationLevels {
  */
 export declare function readPublicationLevels(publicationXml?: string): PublicationLevels;
 /**
- * Read the asset directories from a publication file, falling back to the
- * defaults baked into MINIMAL_PUBLICATION when none is supplied.
+ * Read the asset directories the way PreTeXt resolves them (as of 2026-08,
+ * when managed directories became the only scheme):
+ *
+ * - **external** is a property of the source. The document's
+ *   `<docinfo><directories external="..."/>` wins; the publication file's
+ *   `source/directories/@external` is the deprecated fallback; with neither,
+ *   the project has no external assets.
+ * - **generated** is a publication setting, `source/directories/@generated`,
+ *   and defaults to "generated/" beside the source.
+ *
+ * `docinfoExternal` is the raw `@external` from the document's docinfo, which
+ * the caller reads from the source (see {@link docinfoExternalDirectory}). The
+ * publication file falls back to MINIMAL_PUBLICATION when none is supplied.
+ */
+export declare function readAssetDirectories(publicationXml?: string, docinfoExternal?: string): AssetDirectories;
+/**
+ * The raw `directories/@external` of a document's `<docinfo>`, or undefined
+ * when it declares none. `root` is a parsed document (whose `<pretext>` holds
+ * the docinfo), or a `<docinfo>` on its own — parsed, or as the XML string a
+ * fragment preview is given. Only the docinfo's direct `<directories>` child
+ * counts, as upstream's `$version-root/docinfo/directories` does.
+ *
+ * A string that does not parse declares nothing here; the transform reports
+ * the malformed docinfo itself.
  */
-export declare function readAssetDirectories(publicationXml?: string): AssetDirectories;
+export declare function docinfoExternalDirectory(root: Root | string): string | undefined;

package/dist/renderer.d.ts

@@ -97,8 +97,10 @@ export interface RenderOptions extends SourceOptions {
      */
     subtree?: SubtreeOptions;
     /**
-     * Path to a publication file. Its settings are respected except
-     * `<html><platform portable="yes"/></html>`, which the preview forces.
+     * Path to a publication file. Its settings are respected except the few a
+     * one-page, in-memory build cannot honour, which the preview forces: css/js
+     * from the CDN, chunk level 0, cross-references as links rather than knowls,
+     * and portable mode off. See publication.ts.
      */
     publicationPath?: string;
     /**
@@ -111,7 +113,7 @@ export interface RenderOptions extends SourceOptions {
      * ignored, and with no publication file at all it themes the synthesized
      * minimal one.
      *
-     * Portable builds load `theme-<name>.min.css` from the CDN, so an
+     * Previews load `theme-<name>.min.css` from the CDN, so an
      * unrecognised name renders an unstyled page. The themes the vendored
      * stylesheets know are default-modern (PreTeXt's own default), denver,
      * tacoma, salem, greeley and boulder; `custom` additionally needs a locally
@@ -378,15 +380,20 @@ export interface RenderResult {
     rootPrintout?: string;
     /**
      * Absolute directories that the `external/` and `generated/` URL prefixes in
-     * `html` refer to, resolved from the publication file against the main
-     * source file's directory. Feed these to `rewriteAssetUrls` to point the
-     * page at assets the host can actually serve (see assets.ts).
+     * `html` refer to, resolved against the main source file's directory the way
+     * PreTeXt resolves them (see readAssetDirectories). Feed these to
+     * `rewriteAssetUrls` to point the page at assets the host can actually
+     * serve (see assets.ts). That covers latex-image and PreFigure diagrams
+     * too, which the page links like any other image.
      *
-     * Absent for legacy projects that declare neither directory: those emit bare
-     * or `images/`-prefixed URLs that cannot be identified reliably.
-     */
-    assetDirs?: {
-        external: string;
+     * `generated` is always known, since an undeclared one defaults to
+     * `generated/` beside the source. `external` is absent when neither the
+     * docinfo nor the publication file declares it: the project then has no
+     * external assets, and any `external/` URL in the page is a dangling
+     * reference.
+     */
+    assetDirs: {
+        external?: string;
         generated: string;
     };
 }

package/dist/target.d.ts

@@ -2,7 +2,7 @@
  * Which PreTeXt conversion a render drives.
  *
  * The two share almost everything — the same assembly passes, the same
- * publication file, the same portable/CDN resource handling — and differ in
+ * publication file, the same CDN resource handling — and differ in
  * the stylesheet they enter through:
  *
  *   "html"   - assets/preview-html.xsl, wrapping pretext-html.xsl.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/pretext-html",
-  "version": "0.17.0",
+  "version": "0.18.1",
   "description": "Convert PreTeXt documents to HTML in pure JavaScript using the official PreTeXt XSLT stylesheets via libxslt-wasm. No Python or PreTeXt installation required.",
   "author": "Oscar Levin",
   "license": "MIT",