emf-converter 4.18.2 → 4.20.0

package/dist/index.d.mts

@@ -114,11 +114,24 @@ interface EmfConvertOptions {
         y: number;
     };
     /**
-     * ANSI code page of the WMF playback device. Used for ANSI/DEFAULT
-     * charset text and LOGFONT face names. Defaults to 1252; supply the
-     * original Windows device's GetACP() value when known. Supported values:
-     * 874, 932, 936, 949, 950, 1250..1258, 54936 and 65001. Other values
-     * fall back to 1252. Explicit text charsets and EMF text are unchanged.
+     * ANSI code page of the playback device (Windows `GetACP()`), used for
+     * ANSI/DEFAULT charset text in EMF and WMF ANSI text records and for WMF
+     * LOGFONT face names, as Windows decodes them. Defaults to 1252.
+     * Supported values: 874, 932, 936, 949, 950, 1250..1258, 54936 and
+     * 65001. Other values fall back to 1252. Explicit text charsets keep
+     * their own code page.
+     */
+    ansiCodePage?: number;
+    /**
+     * OEM code page of the playback device (Windows `GetOEMCP()`), used for
+     * OEM_CHARSET text in EMF and WMF ANSI text records. Defaults to 437.
+     * Supported values: 437, 737, 775, 850, 852, 855, 858, 860, 861, 862,
+     * 863, 865, 866, 874, 932, 936, 949 and 950. Other values fall back to 437.
+     */
+    oemCodePage?: number;
+    /**
+     * ANSI code page of the WMF playback device only; overrides
+     * {@link ansiCodePage} for WMF input. Same values as `ansiCodePage`.
      */
     wmfAnsiCodePage?: number;
     /** Maximum output width in pixels. */
@@ -197,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
@@ -278,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
@@ -368,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

@@ -114,11 +114,24 @@ interface EmfConvertOptions {
         y: number;
     };
     /**
-     * ANSI code page of the WMF playback device. Used for ANSI/DEFAULT
-     * charset text and LOGFONT face names. Defaults to 1252; supply the
-     * original Windows device's GetACP() value when known. Supported values:
-     * 874, 932, 936, 949, 950, 1250..1258, 54936 and 65001. Other values
-     * fall back to 1252. Explicit text charsets and EMF text are unchanged.
+     * ANSI code page of the playback device (Windows `GetACP()`), used for
+     * ANSI/DEFAULT charset text in EMF and WMF ANSI text records and for WMF
+     * LOGFONT face names, as Windows decodes them. Defaults to 1252.
+     * Supported values: 874, 932, 936, 949, 950, 1250..1258, 54936 and
+     * 65001. Other values fall back to 1252. Explicit text charsets keep
+     * their own code page.
+     */
+    ansiCodePage?: number;
+    /**
+     * OEM code page of the playback device (Windows `GetOEMCP()`), used for
+     * OEM_CHARSET text in EMF and WMF ANSI text records. Defaults to 437.
+     * Supported values: 437, 737, 775, 850, 852, 855, 858, 860, 861, 862,
+     * 863, 865, 866, 874, 932, 936, 949 and 950. Other values fall back to 437.
+     */
+    oemCodePage?: number;
+    /**
+     * ANSI code page of the WMF playback device only; overrides
+     * {@link ansiCodePage} for WMF input. Same values as `ansiCodePage`.
      */
     wmfAnsiCodePage?: number;
     /** Maximum output width in pixels. */
@@ -197,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
@@ -278,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
@@ -368,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 };