@fieldnotes/core 0.51.0 → 0.52.0

package/README.md

@@ -164,9 +164,30 @@ const blob = await viewport.exportImage({
 });
 ```
 
-HTML elements are currently excluded from image exports. Remote images are requested with anonymous
-CORS using their original URLs; failures are omitted from the result and reported through
-`onAssetError` when supplied.
+Remote images are requested with anonymous CORS using their original URLs; failures are omitted from
+the result and reported through `onAssetError` when supplied.
+
+Application-owned HTML embeds require an explicit rasterization hook. Return a ready canvas-compatible
+image source; Field Notes applies the element's size, rotation, paint order, and layer opacity in both
+PNG and SVG exports:
+
+```typescript
+const options = {
+  htmlTimeoutMs: 10_000,
+  renderHtml: async (element) => {
+    const node = document.querySelector(`[data-element-id="${element.id}"]`);
+    return node ? rasterizeToCanvas(node) : null; // application or library implementation
+  },
+  onHtmlError: ({ elementId, reason }) => {
+    console.warn(`Could not export HTML element ${elementId}: ${reason}`);
+  },
+};
+
+const png = await viewport.exportImage(options);
+const svg = await viewport.exportSVG(options);
+```
+
+Without `renderHtml`, embeds remain omitted and can be observed through `onHtmlError`.
 
 ## Performance Monitoring
 

package/dist/index.cjs

@@ -5442,6 +5442,67 @@ function renderTextOnCanvas(ctx, text) {
   ctx.restore();
 }
 
+// src/canvas/html-export.ts
+var DEFAULT_HTML_TIMEOUT_MS = 1e4;
+var TIMEOUT = /* @__PURE__ */ Symbol("html-export-timeout");
+function validateHtmlExportOptions(options) {
+  const timeoutMs = options.htmlTimeoutMs ?? DEFAULT_HTML_TIMEOUT_MS;
+  if (!Number.isFinite(timeoutMs) || timeoutMs <= 0) {
+    throw new RangeError("htmlTimeoutMs must be a finite number greater than 0");
+  }
+  return timeoutMs;
+}
+async function renderHtmlElements(elements, options) {
+  const timeoutMs = validateHtmlExportOptions(options);
+  const sources = /* @__PURE__ */ new Map();
+  await Promise.all(
+    elements.map(async (element) => {
+      if (!options.renderHtml) {
+        options.onHtmlError?.({
+          elementId: element.id,
+          htmlType: element.htmlType,
+          reason: "unsupported"
+        });
+        return;
+      }
+      let timer;
+      try {
+        const timeout = new Promise((resolve) => {
+          timer = setTimeout(() => resolve(TIMEOUT), timeoutMs);
+        });
+        const result = await Promise.race([Promise.resolve(options.renderHtml(element)), timeout]);
+        if (result === TIMEOUT) {
+          options.onHtmlError?.({
+            elementId: element.id,
+            htmlType: element.htmlType,
+            reason: "timeout"
+          });
+          return;
+        }
+        if (!result) {
+          options.onHtmlError?.({
+            elementId: element.id,
+            htmlType: element.htmlType,
+            reason: "render"
+          });
+          return;
+        }
+        sources.set(element.id, result);
+      } catch (cause) {
+        options.onHtmlError?.({
+          elementId: element.id,
+          htmlType: element.htmlType,
+          reason: "render",
+          cause
+        });
+      } finally {
+        if (timer !== void 0) clearTimeout(timer);
+      }
+    })
+  );
+  return sources;
+}
+
 // src/canvas/export-image.ts
 var DEFAULT_IMAGE_TIMEOUT_MS = 1e4;
 var DEFAULT_MAX_DIMENSION = 16384;
@@ -5646,6 +5707,7 @@ async function exportImage(store, options = {}, layerManager) {
   const scale = positiveOption(options.scale, 2, "scale");
   const padding = nonNegativeOption(options.padding, 0, "padding");
   validateExportResourceOptions(options);
+  validateHtmlExportOptions(options);
   const background = options.background ?? "#ffffff";
   const filter = options.filter;
   const allElements = store.getAll();
@@ -5659,6 +5721,8 @@ async function exportImage(store, options = {}, layerManager) {
   const height = Math.ceil(bounds.h * scale);
   assertExportSize(width, height, options);
   const imageCache = await loadImages(visibleElements, options);
+  const htmlElements = visibleElements.filter((el) => el.type === "html");
+  const htmlSources = await renderHtmlElements(htmlElements, options);
   const canvas = document.createElement("canvas");
   canvas.width = width;
   canvas.height = height;
@@ -5683,6 +5747,24 @@ async function exportImage(store, options = {}, layerManager) {
       return;
     }
     if (el.type === "html") {
+      const source = htmlSources.get(el.id);
+      if (!source) return;
+      const b = getElementBounds(el);
+      try {
+        withRotation(
+          target,
+          el,
+          b ? center(b) : el.position,
+          () => target.drawImage(source, el.position.x, el.position.y, el.size.w, el.size.h)
+        );
+      } catch (cause) {
+        options.onHtmlError?.({
+          elementId: el.id,
+          htmlType: el.htmlType,
+          reason: "render",
+          cause
+        });
+      }
       return;
     }
     if (el.type === "image") {
@@ -5838,7 +5920,7 @@ function emitArrow(arrow, store) {
   return out;
 }
 function emitImage(image, dataUri) {
-  const href = dataUri ?? image.src;
+  const href = dataUri ?? ("src" in image ? image.src : "");
   if (!href) return "";
   const { x, y } = image.position;
   const { w, h } = image.size;
@@ -6042,6 +6124,7 @@ async function exportSvg(store, options = {}, layerManager) {
   const padding = nonNegativeOption(options.padding, 0, "padding");
   const rasterScale = positiveOption(options.rasterScale, 2, "rasterScale");
   validateExportResourceOptions(options);
+  validateHtmlExportOptions(options);
   const filter = options.filter;
   const allElements = store.getAll();
   let visibleElements = layerManager ? allElements.filter((el) => layerManager.isLayerVisible(el.layerId)) : allElements;
@@ -6056,6 +6139,9 @@ async function exportSvg(store, options = {}, layerManager) {
   );
   const imageCache = await loadImages(remoteImages, options);
   const imageDataUris = encodeImages(visibleElements, imageCache, rasterScale, options);
+  const htmlElements = visibleElements.filter((el) => el.type === "html");
+  const htmlSources = await renderHtmlElements(htmlElements, options);
+  const htmlDataUris = encodeHtmlElements(htmlElements, htmlSources, rasterScale, options);
   const grids = visibleElements.filter((el) => el.type === "grid");
   const firstGrid = grids[0];
   let body = "";
@@ -6064,7 +6150,15 @@ async function exportSvg(store, options = {}, layerManager) {
   }
   const layerBodies = /* @__PURE__ */ new Map();
   for (const el of visibleElements) {
-    const emitted = emitElement(el, imageDataUris, rasterScale, firstGrid, store, options);
+    const emitted = emitElement(
+      el,
+      imageDataUris,
+      htmlDataUris,
+      rasterScale,
+      firstGrid,
+      store,
+      options
+    );
     layerBodies.set(el.layerId, (layerBodies.get(el.layerId) ?? "") + emitted);
   }
   for (const [layerId, emitted] of layerBodies) {
@@ -6078,7 +6172,7 @@ async function exportSvg(store, options = {}, layerManager) {
   }
   return `<svg xmlns="http://www.w3.org/2000/svg" width="${n(bounds.w)}" height="${n(bounds.h)}" viewBox="${n(bounds.x)} ${n(bounds.y)} ${n(bounds.w)} ${n(bounds.h)}">${body}</svg>`;
 }
-function emitElement(el, imageDataUris, rasterScale, firstGrid, store, resourceOptions) {
+function emitElement(el, imageDataUris, htmlDataUris, rasterScale, firstGrid, store, resourceOptions) {
   switch (el.type) {
     case "stroke":
       return withRotationSvg(el, emitStroke(el));
@@ -6097,11 +6191,62 @@ function emitElement(el, imageDataUris, rasterScale, firstGrid, store, resourceO
     case "grid":
       return "";
     case "html":
-      return "";
+      return withRotationSvg(el, emitImage(el, htmlDataUris.get(el.id)));
     default:
       return "";
   }
 }
+function encodeHtmlElements(elements, sources, rasterScale, options) {
+  const encoded = /* @__PURE__ */ new Map();
+  for (const element of elements) {
+    const source = sources.get(element.id);
+    if (!source) continue;
+    const width = Math.max(1, Math.ceil(element.size.w * rasterScale));
+    const height = Math.max(1, Math.ceil(element.size.h * rasterScale));
+    assertExportSize(width, height, options);
+    if (typeof document === "undefined") {
+      options.onHtmlError?.({
+        elementId: element.id,
+        htmlType: element.htmlType,
+        reason: "encode"
+      });
+      continue;
+    }
+    const canvas = document.createElement("canvas");
+    canvas.width = width;
+    canvas.height = height;
+    const ctx = canvas.getContext("2d");
+    if (!ctx) {
+      options.onHtmlError?.({
+        elementId: element.id,
+        htmlType: element.htmlType,
+        reason: "encode"
+      });
+      continue;
+    }
+    try {
+      ctx.drawImage(source, 0, 0, width, height);
+      const dataUri = canvas.toDataURL();
+      if (dataUri.startsWith("data:")) {
+        encoded.set(element.id, dataUri);
+      } else {
+        options.onHtmlError?.({
+          elementId: element.id,
+          htmlType: element.htmlType,
+          reason: "encode"
+        });
+      }
+    } catch (cause) {
+      options.onHtmlError?.({
+        elementId: element.id,
+        htmlType: element.htmlType,
+        reason: "encode",
+        cause
+      });
+    }
+  }
+  return encoded;
+}
 function encodeImages(elements, imageCache, rasterScale, resourceOptions) {
   const out = /* @__PURE__ */ new Map();
   for (const el of elements) {
@@ -10902,7 +11047,7 @@ var LaserTool = class {
 };
 
 // src/index.ts
-var VERSION = "0.51.0";
+var VERSION = "0.52.0";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ArrowTool,