@bendyline/squisq-formats 2.8.8 → 2.8.10

package/dist/plainHtml-B6IXcSet.d.ts

@@ -0,0 +1,148 @@
+import { HtmlPolicy, MarkdownDocument } from '@bendyline/squisq/markdown';
+import { Theme, ThemeRegistry } from '@bendyline/squisq/schemas';
+
+/**
+ * Plain HTML Export — semantic, player-free
+ *
+ * Renders a MarkdownDocument to a self-contained HTML string. Unlike
+ * `docToHtml` (which bundles the SquisqPlayer IIFE and renders SVG block
+ * cards), this output is what a reader-mode tool would produce: semantic
+ * `<h1>`/`<p>`/`<ul>`/etc. with a small embedded stylesheet, no JS, no
+ * runtime path-rewriting. Drives both the "Page" preview tab in the
+ * editor and the plain-style branch of the export dialog so what users
+ * see live matches the file they download.
+ *
+ * Image URLs default to the markdown's own paths. Pass `images` to
+ * substitute a different value per source URL — typically pre-resolved
+ * blob URLs (live preview) or data URIs (single-file export).
+ */
+
+interface PlainHtmlExportOptions {
+    /** Document title — populates `<title>` and is HTML-escaped. */
+    title?: string;
+    /**
+     * Substitution map for image `src` URLs. Keys are the URL exactly as
+     * it appears in the markdown source; values are the URL to emit in
+     * the rendered `<img src>`. URLs not present in the map fall through
+     * unchanged (so external `https://…` references still work).
+     */
+    images?: Map<string, string>;
+    /**
+     * Substitution map for anchor `href` URLs. Keys are the URL exactly
+     * as it appears in the markdown source (e.g. `'resume.md'`,
+     * `'resume.md#experience'`); values are the URL to emit. URLs not in
+     * the map pass through unchanged. Used by the recursive bundle
+     * exporter to rewrite `.md` references to `.html` so a static export
+     * of a linked document tree is internally browsable.
+     */
+    links?: Map<string, string>;
+    /**
+     * Optional Squisq theme. When provided, the rendered page uses the
+     * theme's colors and typography, and any Google-hosted fonts the
+     * theme references are loaded via a `<link>` to fonts.googleapis.com
+     * so the face renders correctly without host preloads.
+     *
+     * When omitted, the function falls back (in order) to {@link themeId}
+     * and then to `doc.frontmatter.themeId` — so an authored
+     * `themeId: warm-earth` in the doc's frontmatter styles the export
+     * automatically, without the caller having to wire theme resolution
+     * themselves.
+     */
+    theme?: Theme;
+    /**
+     * Optional theme id (e.g. `'warm-earth'`, `'gezellig'`). Convenient
+     * for hosts whose export dialog tracks themes by id — they can pass
+     * the id straight through instead of resolving to a `Theme` object.
+     * When both `theme` and `themeId` are provided, `theme` wins.
+     */
+    themeId?: string;
+    /** Explicit caller-owned registry for non-document custom themes. */
+    themeRegistry?: ThemeRegistry;
+    /**
+     * Optional FontAwesome CSS text to inline into the rendered page,
+     * replacing the default cross-origin `<link>` to cdnjs. Required for
+     * sandboxed iframe previews where tracking prevention or stricter
+     * origin policies can silently drop cross-origin font fetches —
+     * inlining keeps the icons resolvable purely from same-origin
+     * resources. Hosts typically gather this string by scraping
+     * `document.styleSheets` for `@font-face` rules whose family starts
+     * with `"Font Awesome"`. A CDN `<link>` is emitted only when this option
+     * is absent and {@link externalResources} is explicitly `allow`.
+     */
+    iconsCss?: string;
+    /**
+     * Whether this exporter may add remote font/icon stylesheets. Defaults to
+     * `deny`, keeping the generated file self-contained. Authored links and
+     * images are unaffected; bundle exporters are responsible for inlining or
+     * rewriting those document resources.
+     */
+    externalResources?: 'deny' | 'allow';
+    /**
+     * Raw HTML policy. Defaults to `sanitize`, which removes unsafe tags,
+     * event handlers, and executable URL schemes before emitting HTML.
+     */
+    htmlPolicy?: HtmlPolicy;
+    /**
+     * How a hosted video (a paragraph that is only a link to a YouTube, Vimeo,
+     * Loom or Wistia page, or that provider's `<iframe>` embed
+     * code) renders:
+     *
+     * - `player` (default) — the provider's player iframe;
+     * - `poster` — a static card linking to the video's page (the provider's
+     *   thumbnail where it serves one). For contexts where a player cannot run:
+     *   a preview iframe sandboxed without `allow-scripts` (nested frames
+     *   inherit the sandbox, so the player would load broken), or print.
+     */
+    videoEmbeds?: 'player' | 'poster';
+    /**
+     * Inline icons as SVG, keyed `family:name` (`solid:star`) — the `icons` that
+     * `prepareMarkdownDocForPlainHtml` (`@bendyline/squisq-formats/html-prepare`)
+     * returns when given `outlineIcons`, or `plainHtmlIcons` from
+     * `@bendyline/squisq-formats/html-icons` called directly. An icon found here
+     * is drawn as an inline `<svg>` in the text color and needs no Font Awesome
+     * stylesheet; any other icon keeps its Font Awesome markup (see
+     * {@link iconsCss}).
+     */
+    icons?: ReadonlyMap<string, PlainHtmlIcon>;
+}
+/** One icon's outline: an SVG path in a `0 0 width height` box whose height is 1em. */
+interface PlainHtmlIcon {
+    width: number;
+    height: number;
+    path: string;
+}
+/**
+ * Render a parsed markdown document as a complete, semantic HTML page.
+ *
+ * When `options.theme` is provided, the output adopts the theme's
+ * colors and typography. Google-hosted fonts referenced by the theme
+ * are loaded via a single `<link>` to fonts.googleapis.com so the page
+ * renders consistently when opened standalone.
+ */
+declare function markdownDocToPlainHtml(doc: MarkdownDocument, options?: PlainHtmlExportOptions): string;
+/**
+ * The pieces of a plain HTML page that belong to the document itself, for a
+ * host that places the document inside a page of its own (see
+ * `applyHtmlPageTemplate`).
+ */
+interface PlainHtmlParts {
+    /** The `title` option, unescaped. */
+    title: string;
+    /** The rendered document body, footnotes included. */
+    bodyHtml: string;
+    /**
+     * `<head>` markup for the CSS the body's own constructs need — feature
+     * sections, video embeds, SVG islands, icons — and nothing that styles the
+     * page around them: no theme typography, colors, fonts, or `body` rules.
+     */
+    featureHeadHtml: string;
+}
+/**
+ * Render a document's body and the functional CSS it depends on, without the
+ * page shell or theme stylesheet `markdownDocToPlainHtml` wraps around them.
+ * The theme (when one resolves) still informs body rendering, such as the
+ * color an SVG island's `currentColor` follows.
+ */
+declare function markdownDocToPlainHtmlParts(doc: MarkdownDocument, options?: PlainHtmlExportOptions): PlainHtmlParts;
+
+export { type PlainHtmlIcon as P, type PlainHtmlExportOptions as a, type PlainHtmlParts as b, markdownDocToPlainHtmlParts as c, markdownDocToPlainHtml as m };

package/dist/pptx/index.js

@@ -4,7 +4,7 @@ import {
   pptxToContainer,
   pptxToDoc,
   pptxToMarkdownDoc
-} from "../chunk-QU4EVC62.js";
+} from "../chunk-S5VXWSRR.js";
 import {
   analyzePptxLayouts,
   inspectPptxLayouts
@@ -18,7 +18,7 @@ import "../chunk-JU2RHXUB.js";
 import "../chunk-S5PCVMKU.js";
 import "../chunk-7AWFHP5U.js";
 import "../chunk-IIQYS2YH.js";
-import "../chunk-LBXBRFBZ.js";
+import "../chunk-DDMPZZJF.js";
 import "../chunk-JZR32FON.js";
 export {
   analyzePptxLayouts,

package/dist/readers-3P5A6A2A.js

@@ -0,0 +1,17 @@
+import {
+  csvDataReader,
+  defaultDataReaders,
+  parquetDataReader,
+  xlsxDataReader
+} from "./chunk-5HUHSLGA.js";
+import "./chunk-ATWVNF7D.js";
+import "./chunk-Q77KNJIN.js";
+import "./chunk-DXYWKZ52.js";
+import "./chunk-S5PCVMKU.js";
+import "./chunk-7AWFHP5U.js";
+export {
+  csvDataReader,
+  defaultDataReaders,
+  parquetDataReader,
+  xlsxDataReader
+};

package/dist/registry/index.js

@@ -9,7 +9,7 @@ import {
   defaultRegistry,
   prepareConversion,
   resolveConversionLimits
-} from "../chunk-GDUZJ75A.js";
+} from "../chunk-MJTPWLVV.js";
 import {
   ConversionError
 } from "../chunk-KXOZMWBS.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/squisq-formats",
-  "version": "2.8.8",
+  "version": "2.8.10",
   "description": "Document format converters — DOCX, PDF, OOXML import/export",
   "license": "MIT",
   "author": "Bendyline",
@@ -83,6 +83,16 @@
       "import": "./dist/html/index.js",
       "default": "./dist/html/index.js"
     },
+    "./html-icons": {
+      "types": "./dist/html/icons.d.ts",
+      "import": "./dist/html/icons.js",
+      "default": "./dist/html/icons.js"
+    },
+    "./html-prepare": {
+      "types": "./dist/html/prepare.d.ts",
+      "import": "./dist/html/prepare.js",
+      "default": "./dist/html/prepare.js"
+    },
     "./epub": {
       "types": "./dist/epub/index.d.ts",
       "import": "./dist/epub/index.js",
@@ -125,7 +135,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@bendyline/squisq": "2.13.7",
+    "@bendyline/squisq": "2.13.8",
     "@pdf-lib/fontkit": "1.1.1",
     "@pdf-lib/upng": "1.0.1",
     "@xmldom/xmldom": "0.9.12",