@zumer/snapdom-plugins 3.0.0-beta.0 → 4.0.0

package/vector.d.ts

@@ -0,0 +1,28 @@
+import type { SnapdomPlugin } from '@zumer/snapdom';
+
+/** A CSS selector, or a predicate that returns true for an element to leave out. */
+export type Exclusion = string | ((element: Element) => boolean);
+
+export interface VectorOptions {
+  /** Elements to leave out of the vector output. On a call it wins over the vector() default. */
+  exclude?: Exclusion | Exclusion[];
+}
+
+/** Create the plugin. A capture it runs on gains toVector() and toFigma(). */
+export declare function vector(options?: VectorOptions): SnapdomPlugin;
+export default vector;
+
+declare module '@zumer/snapdom' {
+  interface CaptureResult {
+    /**
+     * The capture as a standalone SVG string: real shapes, editable text, no
+     * foreignObject. Requires vector() on this capture and a connected source element.
+     */
+    toVector(options?: VectorOptions): Promise<string>;
+    /**
+     * Copy the capture to the clipboard in Figma's paste format, then paste it into
+     * a Figma file. Needs the async clipboard API: https or localhost, from a user action.
+     */
+    toFigma(options?: VectorOptions): Promise<void>;
+  }
+}

package/vector.js

@@ -0,0 +1 @@
+export { default, vector } from './vector/src/public.js';

package/video-export.d.ts

@@ -26,3 +26,9 @@ export interface VideoExportOptions {
 /** Adds `result.toMp4()`: records through MediaRecorder, with WebM fallback when needed. */
 export declare function videoExport(options?: VideoExportOptions): SnapdomPlugin;
 export default videoExport;
+
+declare module '@zumer/snapdom' {
+  interface CaptureResult {
+    toMp4(options?: VideoExportOptions & { download?: boolean | string }): Promise<Blob>;
+  }
+}

package/video-export.js

@@ -47,13 +47,13 @@ export function videoExport(options = {}) {
       return {
         mp4: async (ctx, opts = {}) => {
           if (typeof MediaRecorder === 'undefined') {
-            throw new Error('[snapdom] video-export: MediaRecorder is not available in this environment');
+            throw new Error('[SnapDOM] video-export: MediaRecorder is not available in this environment');
           }
           if (typeof HTMLCanvasElement.prototype.captureStream !== 'function') {
-            throw new Error('[snapdom] video-export: canvas.captureStream is not available in this environment');
+            throw new Error('[SnapDOM] video-export: canvas.captureStream is not available in this environment');
           }
           const el = ctx.element;
-          if (!el) throw new Error('[snapdom] video-export: no source element on context');
+          if (!el) throw new Error('[SnapDOM] video-export: there is no element to record.');
 
           const recording = frameOptions(ctx, opts, { fps, duration, frames: frameOpt, scale, background }, 'video-export');
           const { fps: _fps, count: _count, background: _bg } = recording;
@@ -70,7 +70,7 @@ export function videoExport(options = {}) {
             typeof MediaRecorder.isTypeSupported === 'function' && MediaRecorder.isTypeSupported(t)
           ) || '';
           if (mimeType && !mimeType.startsWith('video/mp4')) {
-            console.warn(`[snapdom] video-export: MP4 not supported by this browser's MediaRecorder; falling back to ${mimeType}`);
+            console.warn(`[SnapDOM] video-export: MP4 not supported by this browser's MediaRecorder; falling back to ${mimeType}`);
           }
 
           // 3) Request each painted frame where supported. MediaRecorder uses a real-time
@@ -91,20 +91,20 @@ export function videoExport(options = {}) {
           try {
             stream = stage.captureStream(0);
             let track = stream.getVideoTracks()[0];
-            if (!track) throw new Error('[snapdom] video-export: captureStream produced no video track');
+            if (!track) throw new Error('[SnapDOM] video-export: captureStream produced no video track');
             if (typeof track.requestFrame !== 'function') {
               // A zero-rate track without requestFrame never receives later paintings.
               for (const t of stream.getTracks()) t.stop();
               stream = stage.captureStream(_fps);
               track = stream.getVideoTracks()[0];
-              if (!track) throw new Error('[snapdom] video-export: captureStream produced no video track');
+              if (!track) throw new Error('[SnapDOM] video-export: captureStream produced no video track');
             }
             const pushFrame = () => track.requestFrame?.();
             rec = new MediaRecorder(stream, recOpts);
             rec.ondataavailable = e => { if (e.data && e.data.size) chunks.push(e.data); };
             const stopped = new Promise(resolve => { rec.onstop = resolve; });
             const failed = new Promise((_, reject) => {
-              rec.onerror = event => reject(event.error || new Error('[snapdom] video-export: MediaRecorder failed'));
+              rec.onerror = event => reject(event.error || new Error('[SnapDOM] video-export: MediaRecorder failed'));
             });
             // An error can arrive between awaited frame operations. Mark it handled now;
             // every wait below still observes the original rejection and exits the recorder.

package/pdf-image.d.ts

@@ -1,18 +0,0 @@
-/**
- * Type declarations for `@zumer/snapdom-plugins/pdf-image`.
- *
- * The plugin instance type comes from the core package: one definition of what a plugin IS,
- * so a plugin that stops matching the host's contract fails to typecheck instead of failing
- * at capture time.
- */
-import type { SnapdomPlugin } from '@zumer/snapdom';
-
-export interface PdfImageOptions {
-  orientation?: 'portrait' | 'landscape';
-  /** JPEG quality, 0-1. */
-  quality?: number;
-  filename?: string;
-}
-
-/** Adds `result.toPdfImage()`: the capture as a JPEG embedded in a downloadable PDF. */
-export declare function pdfImage(options?: PdfImageOptions): SnapdomPlugin;

package/pdf-image.js

@@ -1,114 +0,0 @@
-/**
- * pdfImage - Official SnapDOM Plugin
- * Exports the capture as a JPEG embedded in a downloadable PDF.
- * Pinned by __tests__/plugins.imageExports.v3.test.js.
- * @module plugins/pdf-image
- *
- * @param {Object} [options]
- * @param {string} [options.orientation='portrait'] - 'portrait' | 'landscape'
- * @param {number} [options.quality=0.92] - JPEG quality (0-1)
- * @param {string} [options.filename='capture.pdf'] - Download filename
- * @returns {Object} SnapDOM plugin
- */
-export function pdfImage(options = {}) {
-  const {
-    orientation = 'portrait',
-    quality = 0.92,
-    filename = 'capture.pdf',
-  } = options;
-
-  return {
-    name: 'pdf-image',
-
-    defineExports({ exports }) {
-      return {
-        pdfImage: async (_ctx, opts) => {
-          // Core owns sizing, captured originals and Safari's image/font paint workarounds.
-          const canvas = await exports.canvas({
-            ...opts, canvas: null,
-            backgroundColor: !opts.backgroundColor || opts.backgroundColor === 'transparent' ? '#ffffff' : opts.backgroundColor,
-          });
-
-          const isLandscape = orientation === 'landscape';
-          const pageW = isLandscape ? 841.89 : 595.28; // A4 in points
-          const pageH = isLandscape ? 595.28 : 841.89;
-          const margin = 40;
-          const maxW = pageW - margin * 2;
-          const maxH = pageH - margin * 2;
-          const scale = Math.min(maxW / canvas.width, maxH / canvas.height, 1);
-          const w = canvas.width * scale;
-          const h = canvas.height * scale;
-          const x = (pageW - w) / 2;
-          const y = (pageH - h) / 2;
-
-          // Get image as JPEG data
-          const jpegDataUrl = canvas.toDataURL('image/jpeg', quality);
-          const jpegBase64 = jpegDataUrl.split(',')[1];
-          const jpegBytes = atob(jpegBase64);
-          const jpegLen = jpegBytes.length;
-
-          const enc = new TextEncoder();
-          const realOffsets = [];
-
-          // Obj 1-3
-          let textPart = '%PDF-1.4\n';
-          realOffsets.push(textPart.length);
-          textPart += '1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n';
-          realOffsets.push(textPart.length);
-          textPart += '2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n';
-          realOffsets.push(textPart.length);
-          textPart += `3 0 obj\n<< /Type /Page /Parent 2 0 R /MediaBox [0 0 ${pageW} ${pageH}] /Contents 5 0 R /Resources << /XObject << /Img 4 0 R >> >> >>\nendobj\n`;
-
-          // Obj 4 — image with binary JPEG stream
-          realOffsets.push(textPart.length);
-          const imgHeader = `4 0 obj\n<< /Type /XObject /Subtype /Image /Width ${canvas.width} /Height ${canvas.height} /ColorSpace /DeviceRGB /BitsPerComponent 8 /Filter /DCTDecode /Length ${jpegLen} >>\nstream\n`;
-
-          const imgHeaderBytes = enc.encode(imgHeader);
-          const preImgBytes = enc.encode(textPart);
-
-          const jpegBuf = new Uint8Array(jpegLen);
-          for (let i = 0; i < jpegLen; i++) jpegBuf[i] = jpegBytes.charCodeAt(i);
-
-          const afterImg = '\nendstream\nendobj\n';
-          const afterImgBytes = enc.encode(afterImg);
-
-          // Obj 5 — content stream
-          const contentStr = `q ${w.toFixed(2)} 0 0 ${h.toFixed(2)} ${x.toFixed(2)} ${y.toFixed(2)} cm /Img Do Q`;
-          const obj5 = `5 0 obj\n<< /Length ${contentStr.length} >>\nstream\n${contentStr}\nendstream\nendobj\n`;
-          const obj5Bytes = enc.encode(obj5);
-
-          realOffsets.push(preImgBytes.length + imgHeaderBytes.length + jpegLen + afterImgBytes.length);
-
-          // xref table
-          const xrefOffset = preImgBytes.length + imgHeaderBytes.length + jpegLen + afterImgBytes.length + obj5Bytes.length;
-          let xref = 'xref\n0 6\n0000000000 65535 f \n';
-          for (let i = 0; i < 5; i++) {
-            xref += `${String(realOffsets[i]).padStart(10, '0')} 00000 n \n`;
-          }
-          xref += `trailer\n<< /Size 6 /Root 1 0 R >>\nstartxref\n${xrefOffset}\n%%EOF`;
-          const xrefBytes = enc.encode(xref);
-
-          // Combine all parts
-          const totalLen = preImgBytes.length + imgHeaderBytes.length + jpegLen + afterImgBytes.length + obj5Bytes.length + xrefBytes.length;
-          const pdfBuf = new Uint8Array(totalLen);
-          let pos = 0;
-          pdfBuf.set(preImgBytes, pos); pos += preImgBytes.length;
-          pdfBuf.set(imgHeaderBytes, pos); pos += imgHeaderBytes.length;
-          pdfBuf.set(jpegBuf, pos); pos += jpegLen;
-          pdfBuf.set(afterImgBytes, pos); pos += afterImgBytes.length;
-          pdfBuf.set(obj5Bytes, pos); pos += obj5Bytes.length;
-          pdfBuf.set(xrefBytes, pos);
-
-          const blob = new Blob([pdfBuf], { type: 'application/pdf' });
-          const url = URL.createObjectURL(blob);
-          const a = document.createElement('a');
-          a.href = url;
-          a.download = filename;
-          a.click();
-          setTimeout(() => URL.revokeObjectURL(url), 5000);
-          return url;
-        }
-      };
-    }
-  };
-}