emf-converter 4.19.0 → 4.20.0

package/dist/index.d.mts

@@ -210,6 +210,29 @@ interface EmfConvertOptions {
      */
     fontSmoothing?: 'cleartype' | 'gray' | 'mono';
 }
+/**
+ * Options for {@link convertMetafileToJpegDataUrl}: every
+ * {@link EmfConvertOptions} field plus the JPEG encoding settings.
+ */
+interface JpegConvertOptions extends EmfConvertOptions {
+    /**
+     * JPEG quality from 0 to 1, as for `canvas.toDataURL('image/jpeg', quality)`.
+     * Default 0.92.
+     */
+    quality?: number;
+    /**
+     * Colour the transparent background and translucent pixels are
+     * composited over, as `#rgb` or `#rrggbb` (JPEG has no alpha channel).
+     * Default `'#ffffff'`.
+     */
+    background?: string;
+    /**
+     * `true` averages colour over 2 x 2 pixels (4:2:0) for a smaller file.
+     * Default `false`: full-resolution colour (4:4:4), which keeps coloured
+     * lines and text free of colour fringes.
+     */
+    chromaSubsampling?: boolean;
+}
 /**
  * Options for the SVG outputs ({@link convertMetafileToSvg} and friends).
  * `maxWidth`/`maxHeight`/`dpiScale`/`maxCanvasDimension` set the SVG's
@@ -291,6 +314,21 @@ interface SvgConvertOptions extends EmfConvertOptions {
  * @returns A `data:image/png;base64,...` string, or `null` on failure.
  */
 declare function convertMetafileToDataUrl(buffer: ArrayBuffer, options?: EmfConvertOptions, recursionDepth?: number): Promise<string | null>;
+/**
+ * Converts an EMF or WMF buffer (format auto-detected) to a JPEG data URL.
+ *
+ * The drawing is rendered exactly as for {@link convertMetafileToDataUrl}
+ * (same options, same backends, same `null` cases) and encoded by the
+ * bundled baseline JPEG encoder, so the bytes do not depend on the canvas
+ * backend. JPEG has no transparency: the metafile's transparent background
+ * and any translucent pixels are composited over
+ * {@link JpegConvertOptions.background} (white by default).
+ *
+ * @param buffer  - The raw EMF or WMF file bytes.
+ * @param options - Optional {@link JpegConvertOptions}.
+ * @returns A `data:image/jpeg;base64,...` string, or `null` on failure.
+ */
+declare function convertMetafileToJpegDataUrl(buffer: ArrayBuffer, options?: JpegConvertOptions): Promise<string | null>;
 
 /**
  * Converts an EMF or WMF buffer (format auto-detected) into an SVG document
@@ -381,4 +419,4 @@ interface LoadSystemFontsOptions {
  */
 declare function loadSystemFonts(options?: LoadSystemFontsOptions): Promise<Uint8Array[]>;
 
-export { type CreateElement, DEFAULT_DPI_SCALE, type EmfConvertOptions, type LoadSystemFontsOptions, type SvgConvertOptions, type SvgJsxOptions, type SvgNode, convertMetafileToDataUrl, convertMetafileToSvg, convertMetafileToSvgDataUrl, convertMetafileToSvgTree, loadSystemFonts, svgTreeToDataUrl, svgTreeToJsx, svgTreeToReact, svgTreeToString };
+export { type CreateElement, DEFAULT_DPI_SCALE, type EmfConvertOptions, type JpegConvertOptions, type LoadSystemFontsOptions, type SvgConvertOptions, type SvgJsxOptions, type SvgNode, convertMetafileToDataUrl, convertMetafileToJpegDataUrl, convertMetafileToSvg, convertMetafileToSvgDataUrl, convertMetafileToSvgTree, loadSystemFonts, svgTreeToDataUrl, svgTreeToJsx, svgTreeToReact, svgTreeToString };

package/dist/index.d.ts

@@ -210,6 +210,29 @@ interface EmfConvertOptions {
      */
     fontSmoothing?: 'cleartype' | 'gray' | 'mono';
 }
+/**
+ * Options for {@link convertMetafileToJpegDataUrl}: every
+ * {@link EmfConvertOptions} field plus the JPEG encoding settings.
+ */
+interface JpegConvertOptions extends EmfConvertOptions {
+    /**
+     * JPEG quality from 0 to 1, as for `canvas.toDataURL('image/jpeg', quality)`.
+     * Default 0.92.
+     */
+    quality?: number;
+    /**
+     * Colour the transparent background and translucent pixels are
+     * composited over, as `#rgb` or `#rrggbb` (JPEG has no alpha channel).
+     * Default `'#ffffff'`.
+     */
+    background?: string;
+    /**
+     * `true` averages colour over 2 x 2 pixels (4:2:0) for a smaller file.
+     * Default `false`: full-resolution colour (4:4:4), which keeps coloured
+     * lines and text free of colour fringes.
+     */
+    chromaSubsampling?: boolean;
+}
 /**
  * Options for the SVG outputs ({@link convertMetafileToSvg} and friends).
  * `maxWidth`/`maxHeight`/`dpiScale`/`maxCanvasDimension` set the SVG's
@@ -291,6 +314,21 @@ interface SvgConvertOptions extends EmfConvertOptions {
  * @returns A `data:image/png;base64,...` string, or `null` on failure.
  */
 declare function convertMetafileToDataUrl(buffer: ArrayBuffer, options?: EmfConvertOptions, recursionDepth?: number): Promise<string | null>;
+/**
+ * Converts an EMF or WMF buffer (format auto-detected) to a JPEG data URL.
+ *
+ * The drawing is rendered exactly as for {@link convertMetafileToDataUrl}
+ * (same options, same backends, same `null` cases) and encoded by the
+ * bundled baseline JPEG encoder, so the bytes do not depend on the canvas
+ * backend. JPEG has no transparency: the metafile's transparent background
+ * and any translucent pixels are composited over
+ * {@link JpegConvertOptions.background} (white by default).
+ *
+ * @param buffer  - The raw EMF or WMF file bytes.
+ * @param options - Optional {@link JpegConvertOptions}.
+ * @returns A `data:image/jpeg;base64,...` string, or `null` on failure.
+ */
+declare function convertMetafileToJpegDataUrl(buffer: ArrayBuffer, options?: JpegConvertOptions): Promise<string | null>;
 
 /**
  * Converts an EMF or WMF buffer (format auto-detected) into an SVG document
@@ -381,4 +419,4 @@ interface LoadSystemFontsOptions {
  */
 declare function loadSystemFonts(options?: LoadSystemFontsOptions): Promise<Uint8Array[]>;
 
-export { type CreateElement, DEFAULT_DPI_SCALE, type EmfConvertOptions, type LoadSystemFontsOptions, type SvgConvertOptions, type SvgJsxOptions, type SvgNode, convertMetafileToDataUrl, convertMetafileToSvg, convertMetafileToSvgDataUrl, convertMetafileToSvgTree, loadSystemFonts, svgTreeToDataUrl, svgTreeToJsx, svgTreeToReact, svgTreeToString };
+export { type CreateElement, DEFAULT_DPI_SCALE, type EmfConvertOptions, type JpegConvertOptions, type LoadSystemFontsOptions, type SvgConvertOptions, type SvgJsxOptions, type SvgNode, convertMetafileToDataUrl, convertMetafileToJpegDataUrl, convertMetafileToSvg, convertMetafileToSvgDataUrl, convertMetafileToSvgTree, loadSystemFonts, svgTreeToDataUrl, svgTreeToJsx, svgTreeToReact, svgTreeToString };