document-svg 0.1.1

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "document-svg",
+  "version": "0.1.1",
+  "description": "Preview PDF and Office documents as page-by-page SVG from Node.js",
+  "keywords": [
+    "svg",
+    "preview",
+    "pdf",
+    "pptx",
+    "xlsx",
+    "docx",
+    "electron"
+  ],
+  "license": "MIT OR Apache-2.0",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.js",
+      "default": "./index.js"
+    },
+    "./preview-ui": {
+      "types": "./preview-ui.d.ts",
+      "require": "./preview-ui.js",
+      "default": "./preview-ui.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "preview-ui.js",
+    "preview-ui.d.ts",
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md",
+    "THIRD_PARTY_LICENSES.txt",
+    "docs",
+    "examples",
+    "LICENSE-MIT",
+    "LICENSE-APACHE"
+  ],
+  "napi": {
+    "binaryName": "document-svg",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "aarch64-pc-windows-msvc",
+      "x86_64-unknown-linux-gnu",
+      "aarch64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
+      "aarch64-unknown-linux-musl"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ryusui-hiro/document-svg.git",
+    "directory": "bindings/node"
+  },
+  "optionalDependencies": {
+    "document-svg-linux-x64-gnu": "0.1.1",
+    "document-svg-linux-arm64-gnu": "0.1.1",
+    "document-svg-linux-x64-musl": "0.1.1",
+    "document-svg-linux-arm64-musl": "0.1.1",
+    "document-svg-darwin-x64": "0.1.1",
+    "document-svg-darwin-arm64": "0.1.1",
+    "document-svg-win32-x64-msvc": "0.1.1",
+    "document-svg-win32-arm64-msvc": "0.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/preview-ui.d.ts

@@ -0,0 +1,21 @@
+/** Create an object URL suitable for an `<img>` src. */
+export declare function createSvgPreviewUrl(svg: string): string
+
+/** Create a validated self-contained data URL for cross-process previews. */
+export declare function createSvgPreviewDataUrl(svg: string): string
+
+/** Revoke an object URL previously returned by `createSvgPreviewUrl()`. */
+export declare function revokeSvgPreviewUrl(url: string): void
+
+/** Copy the exact SVG XML source as plain text. */
+export declare function copySvgSourceToClipboard(svg: string): Promise<void>
+
+/**
+ * Copy SVG as `image/svg+xml` when supported, with an exact-source text
+ * fallback. Call this from a user gesture such as a button click.
+ *
+ * The resolved value reports the MIME type that was actually copied.
+ */
+export declare function copySvgToClipboard(
+  svg: string,
+): Promise<'image/svg+xml' | 'text/plain'>

package/preview-ui.js

@@ -0,0 +1,164 @@
+'use strict'
+
+function assertSvg(svg, depth = 0) {
+  if (depth > 4 || (typeof svg === 'string' && svg.length > 64 * 1024 * 1024)) {
+    throw new TypeError('SVG preview size or nesting limit exceeded')
+  }
+  if (typeof svg !== 'string' || !/<svg(?:\s|>)/i.test(svg)) {
+    throw new TypeError('svg must be a complete SVG markup string')
+  }
+  if (
+    /<!DOCTYPE|<!ENTITY|<\s*(?:[\w.-]+:)?(?:script|foreignObject|iframe|object|embed|animate|animateMotion|animateTransform|set|discard)\b/i.test(svg) ||
+    /\son[a-z]+\s*=/i.test(svg) ||
+    /\b(?:href|xlink:href)\s*=\s*['"]\s*(?:https?:|javascript:|file:|blob:)/i.test(svg) ||
+    /@import\b|url\(\s*['"]?\s*(?:https?:|javascript:|file:|blob:)/i.test(svg)
+  ) {
+    throw new TypeError('svg must not contain executable or external content')
+  }
+  const allowedReference = (value) => {
+    if (/^\s*#[a-z0-9_.:-]+\s*$/i.test(value) ||
+      /^\s*data:image\/(?:png|jpeg|gif|webp);base64,[a-z0-9+/=\s]*$/i.test(value)) return true
+    if (/^\s*data:image\/svg\+xml;base64,[a-z0-9+/=\s]+$/i.test(value)) {
+      try {
+        const bytes = Uint8Array.from(atob(value.split(',')[1]), (c) => c.charCodeAt(0))
+        assertSvg(new TextDecoder('utf-8', { fatal: true }).decode(bytes), depth + 1)
+        return true
+      } catch { return false }
+    }
+    return false
+  }
+  for (const match of svg.matchAll(/\b(?:[\w.-]+:)?href\s*=\s*(['"])(.*?)\1/gis)) {
+    if (!allowedReference(match[2])) {
+      throw new TypeError('svg must not contain executable or external content')
+    }
+  }
+  for (const match of svg.matchAll(/url\s*\(\s*(['"]?)(.*?)\1\s*\)/gis)) {
+    if (!/^#[a-z0-9_.:-]+$/i.test(match[2].trim())) {
+      throw new TypeError('svg must not contain executable or external content')
+    }
+  }
+  if (/xml:base\s*=|<\?xml-stylesheet\b/i.test(svg)) {
+    throw new TypeError('svg must not contain executable or external content')
+  }
+  for (const match of svg.matchAll(/\bstyle\s*=\s*(['"])(.*?)\1|<style\b[^>]*>(.*?)<\/style\s*>/gis)) {
+    if (/[\\&@]|\/\*/.test(match[2] ?? match[3])) {
+      throw new TypeError('svg must not contain executable or external content')
+    }
+  }
+}
+
+function browserGlobal(name) {
+  const value = globalThis[name]
+  if (value == null) {
+    throw new Error(`${name} is not available in this environment`)
+  }
+  return value
+}
+
+/**
+ * Create an object URL suitable for an <img> src. Revoke it when the preview
+ * is replaced or unmounted.
+ */
+function createSvgPreviewUrl(svg) {
+  assertSvg(svg)
+  const BlobConstructor = browserGlobal('Blob')
+  const Url = browserGlobal('URL')
+  if (typeof Url.createObjectURL !== 'function') {
+    throw new Error('URL.createObjectURL is not available in this environment')
+  }
+  return Url.createObjectURL(
+    new BlobConstructor([svg], { type: 'image/svg+xml;charset=utf-8' }),
+  )
+}
+
+/**
+ * Create a self-contained data URL for renderers where blob URLs cannot cross
+ * process or Markdown boundaries. The SVG is validated before encoding.
+ */
+function createSvgPreviewDataUrl(svg) {
+  assertSvg(svg)
+  return `data:image/svg+xml;charset=utf-8,${encodeURIComponent(svg)}`
+}
+
+/** Revoke an object URL previously returned by createSvgPreviewUrl(). */
+function revokeSvgPreviewUrl(url) {
+  const Url = browserGlobal('URL')
+  if (typeof Url.revokeObjectURL !== 'function') {
+    throw new Error('URL.revokeObjectURL is not available in this environment')
+  }
+  Url.revokeObjectURL(url)
+}
+
+function legacyCopyText(text) {
+  const documentObject = browserGlobal('document')
+  const textarea = documentObject.createElement('textarea')
+  textarea.value = text
+  textarea.setAttribute('readonly', '')
+  textarea.style.position = 'fixed'
+  textarea.style.opacity = '0'
+  documentObject.body.appendChild(textarea)
+  textarea.select()
+  try {
+    if (!documentObject.execCommand('copy')) {
+      throw new Error('the browser rejected the clipboard copy command')
+    }
+  } finally {
+    textarea.remove()
+  }
+}
+
+/** Copy the exact SVG XML source as plain text. */
+async function copySvgSourceToClipboard(svg) {
+  assertSvg(svg)
+  const navigatorObject = globalThis.navigator
+  if (navigatorObject?.clipboard?.writeText) {
+    await navigatorObject.clipboard.writeText(svg)
+    return
+  }
+  legacyCopyText(svg)
+}
+
+/**
+ * Copy SVG using image/svg+xml when the Async Clipboard API explicitly
+ * supports it. Otherwise copy the exact SVG XML as text/plain.
+ *
+ * Must be called from a user gesture such as a button click.
+ */
+async function copySvgToClipboard(svg) {
+  assertSvg(svg)
+  const navigatorObject = globalThis.navigator
+  const ClipboardItemConstructor = globalThis.ClipboardItem
+  const supportsSvg =
+    typeof ClipboardItemConstructor === 'function' &&
+    typeof ClipboardItemConstructor.supports === 'function' &&
+    ClipboardItemConstructor.supports('image/svg+xml')
+
+  if (supportsSvg && navigatorObject?.clipboard?.write) {
+    const BlobConstructor = browserGlobal('Blob')
+    try {
+      await navigatorObject.clipboard.write([
+        new ClipboardItemConstructor({
+          'image/svg+xml': new BlobConstructor([svg], {
+            type: 'image/svg+xml',
+          }),
+        }),
+      ])
+      return 'image/svg+xml'
+    } catch (error) {
+      if (!navigatorObject.clipboard.writeText) {
+        throw error
+      }
+    }
+  }
+
+  await copySvgSourceToClipboard(svg)
+  return 'text/plain'
+}
+
+module.exports = {
+  copySvgSourceToClipboard,
+  copySvgToClipboard,
+  createSvgPreviewDataUrl,
+  createSvgPreviewUrl,
+  revokeSvgPreviewUrl,
+}