@bendyline/squisq-formats 2.8.10 → 2.8.11

package/dist/{chunk-QPJHAMOW.js → chunk-4SPMLGOG.js}

@@ -1247,6 +1247,7 @@ function titleForFilename(path, mdDoc) {
 // src/html/pageTemplate.ts
 var HTML_PAGE_TEMPLATE_CONTENT_START = "<!-- squisq:content -->";
 var HTML_PAGE_TEMPLATE_CONTENT_END = "<!-- /squisq:content -->";
+var HTML_PAGE_TEMPLATE_IMAGE_SLOT = "og-image";
 var HtmlPageTemplateError = class extends Error {
   constructor(issues) {
     super(
@@ -1293,6 +1294,10 @@ function analyzeTemplate(html) {
       isTemplate: tags.some(isLightSlot),
       defaultSlotCount: defaultSlots.length,
       namedSlots,
+      usesImage: namedSlots.includes(HTML_PAGE_TEMPLATE_IMAGE_SLOT) || tags.some((tag) => {
+        if (tag.kind !== "start" || tag.name !== "meta" || tag.inert) return false;
+        return IMAGE_URL_META.has(metaKey(tag) ?? "");
+      }),
       errors: errors.sort((a, b) => a.line - b.line)
     }
   };
@@ -1304,19 +1309,24 @@ function applyHtmlPageTemplate(template, content, options = {}) {
   const { tags, slots, inspection } = analyzeTemplate(template);
   if (inspection.errors.length > 0) throw new HtmlPageTemplateError(inspection.errors);
   const values = content.values ?? {};
-  const valueFor = (name) => name === "title" ? content.title : values[name];
+  const { image } = content;
+  const valueFor = (name) => name === "title" ? content.title : name === HTML_PAGE_TEMPLATE_IMAGE_SLOT ? void 0 : values[name];
+  const slotMarkup = (name) => {
+    if (name === null) {
+      return `${HTML_PAGE_TEMPLATE_CONTENT_START}
+${content.bodyHtml}
+${HTML_PAGE_TEMPLATE_CONTENT_END}`;
+    }
+    if (name === HTML_PAGE_TEMPLATE_IMAGE_SLOT) return image && imageElement(image);
+    const value = valueFor(name);
+    return value === void 0 ? void 0 : escapeHtml3(value);
+  };
   const edits = [];
   const replacements = /* @__PURE__ */ new Set();
   for (const slot of slots) {
-    const value = slot.name === null ? void 0 : valueFor(slot.name);
-    if (slot.name === null || value !== void 0) {
-      const replacement = {
-        start: slot.start,
-        end: slot.end,
-        text: slot.name === null ? `${HTML_PAGE_TEMPLATE_CONTENT_START}
-${content.bodyHtml}
-${HTML_PAGE_TEMPLATE_CONTENT_END}` : escapeHtml3(value ?? "")
-      };
+    const markup = slotMarkup(slot.name);
+    if (markup !== void 0) {
+      const replacement = { start: slot.start, end: slot.end, text: markup };
       edits.push(replacement);
       replacements.add(replacement);
     } else {
@@ -1337,8 +1347,8 @@ ${HTML_PAGE_TEMPLATE_CONTENT_END}` : escapeHtml3(value ?? "")
   }
   for (const tag of tags) {
     if (tag.kind !== "start" || tag.name !== "meta" || tag.inert) continue;
-    const key = (attributeValue(tag, "name") ?? attributeValue(tag, "property"))?.toLowerCase();
-    const value = key ? metaValue(key, content.title, values.description) : void 0;
+    const key = metaKey(tag);
+    const value = key ? metaValue(key, content.title, values.description, image) : void 0;
     if (value === void 0) continue;
     const contentAttribute = tag.attributes.find((attribute) => attribute.name === "content");
     const text = `content="${escapeAttr2(value)}"`;
@@ -1615,11 +1625,34 @@ function fillTitleText(text, valueFor) {
 }
 var TITLE_META = /* @__PURE__ */ new Set(["og:title", "twitter:title"]);
 var DESCRIPTION_META = /* @__PURE__ */ new Set(["description", "og:description", "twitter:description"]);
-function metaValue(key, title, description) {
+var IMAGE_URL_META = /* @__PURE__ */ new Set([
+  "og:image",
+  "og:image:url",
+  "og:image:secure_url",
+  "twitter:image",
+  "twitter:image:src"
+]);
+var IMAGE_ALT_META = /* @__PURE__ */ new Set(["og:image:alt", "twitter:image:alt"]);
+function metaKey(tag) {
+  return (attributeValue(tag, "name") ?? attributeValue(tag, "property"))?.toLowerCase();
+}
+function metaValue(key, title, description, image) {
   if (TITLE_META.has(key)) return title;
   if (DESCRIPTION_META.has(key)) return description;
+  if (!image) return void 0;
+  if (IMAGE_URL_META.has(key)) return image.url;
+  if (IMAGE_ALT_META.has(key)) return image.alt;
+  if (key === "og:image:width" || key === "og:image:height") {
+    const size = key === "og:image:width" ? image.width : image.height;
+    return size === void 0 ? void 0 : String(size);
+  }
+  if (key === "og:image:type") return image.type;
   return void 0;
 }
+function imageElement(image) {
+  const size = image.width !== void 0 && image.height !== void 0 ? ` width="${String(image.width)}" height="${String(image.height)}"` : "";
+  return `<img src="${escapeAttr2(image.src ?? image.url)}" alt="${escapeAttr2(image.alt ?? "")}"${size}>`;
+}
 function headInsertionPoint(tags) {
   for (const tag of tags) {
     if (tag.inert) continue;
@@ -2691,6 +2724,7 @@ export {
   collectLinkRefs,
   HTML_PAGE_TEMPLATE_CONTENT_START,
   HTML_PAGE_TEMPLATE_CONTENT_END,
+  HTML_PAGE_TEMPLATE_IMAGE_SLOT,
   HtmlPageTemplateError,
   isHtmlPageTemplate,
   inspectHtmlPageTemplate,

package/dist/{chunk-NCDY3EOL.js → chunk-D2JA3MLG.js}

@@ -6,7 +6,7 @@ import {
 import {
   convert,
   defaultRegistry
-} from "./chunk-MJTPWLVV.js";
+} from "./chunk-JINVU6QA.js";
 import {
   ConversionError
 } from "./chunk-KXOZMWBS.js";

package/dist/html/index.d.ts

@@ -48,6 +48,8 @@ declare function extractFilename(path: string): string;
  * - `<slot name="title">` receives the document title, and
  *   `<slot name="KEY">` the caller's value for `KEY` (typically a
  *   frontmatter field), inserted as text;
+ * - `<slot name="og-image">` receives the page's social preview picture, when
+ *   the caller supplies one, as an `<img>`;
  * - a slot with no value is replaced by its children — the standard fallback
  *   content — so a template opened directly in a browser previews with its
  *   placeholders.
@@ -57,7 +59,7 @@ declare function extractFilename(path: string): string;
  *
  * `<title>` cannot contain elements, so slots written inside it are matched
  * as text; a `<title>` without one is replaced by the document title.
- * Existing description and Open Graph / Twitter title and description
+ * Existing description and Open Graph / Twitter title, description, and image
  * `<meta>` tags receive the document's values. Relative URLs in the template
  * are rewritten so they still resolve from the generated page's location.
  *
@@ -69,6 +71,28 @@ declare function extractFilename(path: string): string;
 declare const HTML_PAGE_TEMPLATE_CONTENT_START = "<!-- squisq:content -->";
 /** Marks the end of the injected document body in a templated page. */
 declare const HTML_PAGE_TEMPLATE_CONTENT_END = "<!-- /squisq:content -->";
+/** The named slot that receives the page's social preview picture. */
+declare const HTML_PAGE_TEMPLATE_IMAGE_SLOT = "og-image";
+/** A page's social preview picture: its Open Graph and Twitter card image. */
+interface HtmlPageTemplateImage {
+    /**
+     * URL written to the image `<meta>` tags. Social sites expect an absolute
+     * URL; a relative one is written as given.
+     */
+    url: string;
+    /**
+     * URL the `og-image` slot's `<img>` loads, typically relative to the page
+     * so it also shows before the site is published. Default: {@link url}.
+     */
+    src?: string;
+    /** Size in pixels. */
+    width?: number;
+    height?: number;
+    /** Text alternative. */
+    alt?: string;
+    /** Media type, such as `image/png`. */
+    type?: string;
+}
 interface HtmlPageTemplateContent {
     /** Rendered document body. Inserted as-is; the caller sanitizes it. */
     bodyHtml: string;
@@ -82,9 +106,16 @@ interface HtmlPageTemplateContent {
     title: string;
     /**
      * Text for named slots, keyed by slot name. `description` also fills
-     * description `<meta>` tags. `title` comes from {@link title}.
+     * description `<meta>` tags. `title` comes from {@link title}, and
+     * `og-image` from {@link image}.
      */
     values?: Readonly<Record<string, string | undefined>>;
+    /**
+     * The page's social preview picture. Fills the template's `og-image` slot
+     * and the Open Graph / Twitter image `<meta>` tags it declares; without
+     * one, both keep what the template wrote.
+     */
+    image?: HtmlPageTemplateImage;
 }
 interface HtmlPageTemplateOptions {
     /**
@@ -111,6 +142,12 @@ interface HtmlPageTemplateInspection {
     defaultSlotCount: number;
     /** Distinct named slots, in document order. */
     namedSlots: string[];
+    /**
+     * True when a supplied {@link HtmlPageTemplateContent.image} would appear
+     * in the page: the template has an `og-image` slot or an Open Graph /
+     * Twitter image `<meta>` tag. A host can skip drawing a picture otherwise.
+     */
+    usesImage: boolean;
     /** Problems that make {@link applyHtmlPageTemplate} refuse the template. */
     errors: HtmlPageTemplateIssue[];
 }
@@ -350,4 +387,4 @@ declare function docToHtml(doc: Doc, options: HtmlExportOptions): string;
  */
 declare function docToHtmlZip(doc: Doc, options: HtmlZipExportOptions): Promise<Blob>;
 
-export { HTML_PAGE_TEMPLATE_CONTENT_END, HTML_PAGE_TEMPLATE_CONTENT_START, type HtmlBundleOptions, HtmlExportOptions, type HtmlPageTemplateContent, HtmlPageTemplateError, type HtmlPageTemplateInspection, type HtmlPageTemplateIssue, type HtmlPageTemplateOptions, type HtmlZipExportOptions, type PlainHtmlBundleOptions, applyHtmlPageTemplate, arrayBufferToBase64DataUrl, collectLinkRefs, docToHtml, docToHtmlZip, extractFilename, extractHtmlPageTemplateContent, inferMimeType, inspectHtmlPageTemplate, isHtmlPageTemplate, markdownDocsToHtmlBundle, markdownDocsToPlainHtmlBundle };
+export { HTML_PAGE_TEMPLATE_CONTENT_END, HTML_PAGE_TEMPLATE_CONTENT_START, HTML_PAGE_TEMPLATE_IMAGE_SLOT, type HtmlBundleOptions, HtmlExportOptions, type HtmlPageTemplateContent, HtmlPageTemplateError, type HtmlPageTemplateImage, type HtmlPageTemplateInspection, type HtmlPageTemplateIssue, type HtmlPageTemplateOptions, type HtmlZipExportOptions, type PlainHtmlBundleOptions, applyHtmlPageTemplate, arrayBufferToBase64DataUrl, collectLinkRefs, docToHtml, docToHtmlZip, extractFilename, extractHtmlPageTemplateContent, inferMimeType, inspectHtmlPageTemplate, isHtmlPageTemplate, markdownDocsToHtmlBundle, markdownDocsToPlainHtmlBundle };

package/dist/html/index.js

@@ -1,6 +1,7 @@
 import {
   HTML_PAGE_TEMPLATE_CONTENT_END,
   HTML_PAGE_TEMPLATE_CONTENT_START,
+  HTML_PAGE_TEMPLATE_IMAGE_SLOT,
   HtmlPageTemplateError,
   applyHtmlPageTemplate,
   collectImagePaths,
@@ -18,7 +19,7 @@ import {
   markdownDocToPlainHtmlParts,
   markdownDocsToHtmlBundle,
   markdownDocsToPlainHtmlBundle
-} from "../chunk-QPJHAMOW.js";
+} from "../chunk-4SPMLGOG.js";
 import {
   arrayBufferToBase64DataUrl,
   extractFilename,
@@ -30,6 +31,7 @@ import "../chunk-JZR32FON.js";
 export {
   HTML_PAGE_TEMPLATE_CONTENT_END,
   HTML_PAGE_TEMPLATE_CONTENT_START,
+  HTML_PAGE_TEMPLATE_IMAGE_SLOT,
   HtmlPageTemplateError,
   applyHtmlPageTemplate,
   arrayBufferToBase64DataUrl,

package/dist/index.js

@@ -5,7 +5,7 @@ import {
   htmlToMarkdown,
   htmlToMarkdownDoc,
   htmlToMarkdownDocSync
-} from "./chunk-QPJHAMOW.js";
+} from "./chunk-4SPMLGOG.js";
 import {
   docToEpub,
   markdownDocToEpub
@@ -29,7 +29,7 @@ import {
   renderOutsideInDocument,
   withOutsideInMarkdownEditing,
   withOutsideInMetadata
-} from "./chunk-NCDY3EOL.js";
+} from "./chunk-D2JA3MLG.js";
 import {
   OUTSIDE_IN_FORMAT_IDS,
   OUTSIDE_IN_OUTPUT_TEMPLATE_KEY,
@@ -45,7 +45,7 @@ import {
   defaultRegistry,
   prepareConversion,
   resolveConversionLimits
-} from "./chunk-MJTPWLVV.js";
+} from "./chunk-JINVU6QA.js";
 import {
   ConversionError
 } from "./chunk-KXOZMWBS.js";

package/dist/outside-in/index.js

@@ -7,7 +7,7 @@ import {
   renderOutsideInDocument,
   withOutsideInMarkdownEditing,
   withOutsideInMetadata
-} from "../chunk-NCDY3EOL.js";
+} from "../chunk-D2JA3MLG.js";
 import {
   OUTSIDE_IN_FORMAT_IDS,
   OUTSIDE_IN_OUTPUT_TEMPLATE_KEY,
@@ -15,7 +15,7 @@ import {
   isOutsideInTargetPath,
   resolveOutsideInLayout
 } from "../chunk-WJTC5OD6.js";
-import "../chunk-MJTPWLVV.js";
+import "../chunk-JINVU6QA.js";
 import "../chunk-KXOZMWBS.js";
 import "../chunk-7AWFHP5U.js";
 export {

package/dist/registry/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/squisq-formats",
-  "version": "2.8.10",
+  "version": "2.8.11",
   "description": "Document format converters — DOCX, PDF, OOXML import/export",
   "license": "MIT",
   "author": "Bendyline",
@@ -135,7 +135,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@bendyline/squisq": "2.13.8",
+    "@bendyline/squisq": "2.13.9",
     "@pdf-lib/fontkit": "1.1.1",
     "@pdf-lib/upng": "1.0.1",
     "@xmldom/xmldom": "0.9.12",