omni-compress 2.3.0

package/dist/compressor-BVD2z3r0.d.cts

@@ -0,0 +1,232 @@
+interface CompressorOptions$1 {
+    type: 'image' | 'audio' | 'video';
+    format: 'webp' | 'avif' | 'jpeg' | 'png' | 'opus' | 'mp3' | 'flac' | 'wav' | 'auto' | 'mp4' | 'webm' | string;
+    maxSizeMB?: number;
+    quality?: number;
+    onProgress?: (percent: number) => void;
+    originalFileName?: string;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     */
+    useWorker?: boolean;
+    /**
+     * If the compressed file is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    maxWidth?: number;
+    maxHeight?: number;
+    preserveMetadata?: boolean;
+    bitrate?: string;
+    channels?: 1 | 2;
+    sampleRate?: number;
+    videoBitrate?: string;
+    fps?: number;
+}
+/**
+ * The result of a v2.0 compression call.
+ * Replaces the raw `Blob` return from v1.x.
+ */
+interface CompressResult {
+    /** The compressed output blob, ready to save or upload. */
+    blob: Blob;
+    /** Size of the input file in bytes. */
+    originalSize: number;
+    /** Size of the output blob in bytes. */
+    compressedSize: number;
+    /** compressedSize / originalSize — values below 1.0 indicate actual compression. */
+    ratio: number;
+    /** The target format that was used (e.g. 'webp', 'opus'). */
+    format: string;
+}
+/** Options for compressImage(). */
+interface ImageOptions {
+    /** Target output format. Default: 'auto' (converts PNG/JPEG to WebP). */
+    format?: 'webp' | 'avif' | 'jpeg' | 'png' | 'auto';
+    /** Encoder quality from 0.0 (worst) to 1.0 (best). Default: 0.8. */
+    quality?: number;
+    /** Resize output width to at most this many pixels (maintains aspect ratio). */
+    maxWidth?: number;
+    /** Resize output height to at most this many pixels (maintains aspect ratio). */
+    maxHeight?: number;
+    /** When true, EXIF/metadata is preserved in the output. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed image is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during heavy-path (FFmpeg) operations. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Options for compressAudio(). */
+interface AudioOptions {
+    /** Target output format. Default: 'auto' (converts WAV/FLAC to MP3). */
+    format?: 'opus' | 'mp3' | 'flac' | 'wav' | 'aac' | 'auto';
+    /** Target bitrate, e.g. '128k', '192k'. Encoder default if omitted. */
+    bitrate?: string;
+    /** Output channel count. Defaults to input channel count. */
+    channels?: 1 | 2;
+    /** Output sample rate in Hz. Defaults to input sample rate. */
+    sampleRate?: number;
+    /** When true, audio tags/metadata is preserved. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed audio is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during FFmpeg operations. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Options for compressVideo(). */
+interface VideoOptions {
+    /** Target output format. Default: 'mp4'. */
+    format?: 'mp4' | 'webm';
+    /** Target video bitrate, e.g. '1M', '2M'. Default: '1M'. */
+    bitrate?: string;
+    /** Resize output width to at most this many pixels (maintains aspect ratio). */
+    maxWidth?: number;
+    /** Resize output height to at most this many pixels (maintains aspect ratio). */
+    maxHeight?: number;
+    /** Output frames per second. Default: input FPS. */
+    fps?: number;
+    /** When true, metadata is preserved. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed video is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during processing. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** A single file entry for the archive() / archiveStream() functions. */
+interface ArchiveEntry {
+    /** Path/name of the file inside the ZIP (e.g. 'images/photo.webp'). */
+    name: string;
+    /** File contents. File and Blob are read via .arrayBuffer(). */
+    data: File | Blob | Uint8Array;
+}
+/** Options for archive() and archiveStream(). */
+interface ArchiveOptions {
+    /** Archive format. Currently only 'zip'. Default: 'zip'. */
+    format?: 'zip';
+    /**
+     * fflate deflate compression level (0 = store, 1 = fastest, 9 = best compression).
+     * Default: 6.
+     */
+    level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    /**
+     * When true, image and audio files are automatically compressed to optimized
+     * formats (WebP/MP3) before being added to the archive.
+     * Default: false.
+     */
+    smartOptimize?: boolean;
+    /** Called with progress 0–100 as entries are processed. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Result of archive(). */
+interface ArchiveResult {
+    /** The compressed ZIP blob. */
+    blob: Blob;
+    /** Total uncompressed size of all entries in bytes. */
+    originalSize: number;
+    /** Size of the ZIP output in bytes. */
+    compressedSize: number;
+    /** compressedSize / originalSize. */
+    ratio: number;
+    /** Always 'zip' for now. */
+    format: 'zip';
+}
+type Environment = 'browser' | 'node';
+interface RouteContext {
+    env: Environment;
+    isFastPath: boolean;
+    /**
+     * If true, the task should be dispatched to a Web Worker.
+     * If false, the task can run on the main thread for lower latency (small files).
+     */
+    shouldUseWorker: boolean;
+}
+declare class Router {
+    static getEnvironment(): Environment;
+    static isFastPathSupported(options: CompressorOptions$1): boolean;
+    static evaluate(options: CompressorOptions$1, fileSize: number): RouteContext;
+}
+
+interface CompressorOptions extends Omit<ImageOptions, 'format'> {
+    /**
+     * Output mime type (e.g., 'image/webp', 'image/jpeg')
+     * @default 'image/jpeg'
+     */
+    mimeType?: string;
+    /**
+     * Success callback (called with compressed Blob or File)
+     */
+    success?: (result: Blob | File) => void;
+    /**
+     * Error callback (called with Error object)
+     */
+    error?: (err: Error) => void;
+    /**
+     * If the compressed image is larger than the original, output the original.
+     * @default true
+     */
+    strict?: boolean;
+    /**
+     * Files larger than this (in bytes) will be converted to JPEGs.
+     * @default 5,000,000 (5 MB)
+     */
+    convertSize?: number;
+}
+/**
+ * Compatibility shim for `compressorjs`.
+ *
+ * Provides an API identical to the `Compressor` class from the `compressorjs` package,
+ * but uses `omni-compress` under the hood to support AVIF and faster Web Workers.
+ *
+ * @example
+ * ```ts
+ * import Compressor from 'omni-compress/compat';
+ *
+ * new Compressor(file, {
+ *   quality: 0.6,
+ *   success(result) {
+ *     // 'result' is the compressed Blob/File
+ *   },
+ *   error(err) {
+ *     console.error(err.message);
+ *   },
+ * });
+ * ```
+ */
+declare class Compressor {
+    constructor(file: File | Blob, options?: CompressorOptions);
+    private compress;
+}
+
+export { type ArchiveEntry as A, type CompressorOptions$1 as C, type Environment as E, type ImageOptions as I, type RouteContext as R, type VideoOptions as V, type ArchiveOptions as a, type ArchiveResult as b, type AudioOptions as c, type CompressResult as d, Compressor as e, Router as f, type CompressorOptions as g };

package/dist/compressor-BVD2z3r0.d.ts

@@ -0,0 +1,232 @@
+interface CompressorOptions$1 {
+    type: 'image' | 'audio' | 'video';
+    format: 'webp' | 'avif' | 'jpeg' | 'png' | 'opus' | 'mp3' | 'flac' | 'wav' | 'auto' | 'mp4' | 'webm' | string;
+    maxSizeMB?: number;
+    quality?: number;
+    onProgress?: (percent: number) => void;
+    originalFileName?: string;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     */
+    useWorker?: boolean;
+    /**
+     * If the compressed file is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    maxWidth?: number;
+    maxHeight?: number;
+    preserveMetadata?: boolean;
+    bitrate?: string;
+    channels?: 1 | 2;
+    sampleRate?: number;
+    videoBitrate?: string;
+    fps?: number;
+}
+/**
+ * The result of a v2.0 compression call.
+ * Replaces the raw `Blob` return from v1.x.
+ */
+interface CompressResult {
+    /** The compressed output blob, ready to save or upload. */
+    blob: Blob;
+    /** Size of the input file in bytes. */
+    originalSize: number;
+    /** Size of the output blob in bytes. */
+    compressedSize: number;
+    /** compressedSize / originalSize — values below 1.0 indicate actual compression. */
+    ratio: number;
+    /** The target format that was used (e.g. 'webp', 'opus'). */
+    format: string;
+}
+/** Options for compressImage(). */
+interface ImageOptions {
+    /** Target output format. Default: 'auto' (converts PNG/JPEG to WebP). */
+    format?: 'webp' | 'avif' | 'jpeg' | 'png' | 'auto';
+    /** Encoder quality from 0.0 (worst) to 1.0 (best). Default: 0.8. */
+    quality?: number;
+    /** Resize output width to at most this many pixels (maintains aspect ratio). */
+    maxWidth?: number;
+    /** Resize output height to at most this many pixels (maintains aspect ratio). */
+    maxHeight?: number;
+    /** When true, EXIF/metadata is preserved in the output. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed image is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during heavy-path (FFmpeg) operations. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Options for compressAudio(). */
+interface AudioOptions {
+    /** Target output format. Default: 'auto' (converts WAV/FLAC to MP3). */
+    format?: 'opus' | 'mp3' | 'flac' | 'wav' | 'aac' | 'auto';
+    /** Target bitrate, e.g. '128k', '192k'. Encoder default if omitted. */
+    bitrate?: string;
+    /** Output channel count. Defaults to input channel count. */
+    channels?: 1 | 2;
+    /** Output sample rate in Hz. Defaults to input sample rate. */
+    sampleRate?: number;
+    /** When true, audio tags/metadata is preserved. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed audio is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during FFmpeg operations. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Options for compressVideo(). */
+interface VideoOptions {
+    /** Target output format. Default: 'mp4'. */
+    format?: 'mp4' | 'webm';
+    /** Target video bitrate, e.g. '1M', '2M'. Default: '1M'. */
+    bitrate?: string;
+    /** Resize output width to at most this many pixels (maintains aspect ratio). */
+    maxWidth?: number;
+    /** Resize output height to at most this many pixels (maintains aspect ratio). */
+    maxHeight?: number;
+    /** Output frames per second. Default: input FPS. */
+    fps?: number;
+    /** When true, metadata is preserved. Default: false (stripped). */
+    preserveMetadata?: boolean;
+    /**
+     * If the compressed video is larger than the original, return the original.
+     * Default: false.
+     */
+    strict?: boolean;
+    /**
+     * Explicitly force Web Worker usage (true) or Main Thread usage (false).
+     * If omitted, the library chooses based on file size and operation type.
+     */
+    useWorker?: boolean;
+    /** Called with progress 0–100 during processing. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** A single file entry for the archive() / archiveStream() functions. */
+interface ArchiveEntry {
+    /** Path/name of the file inside the ZIP (e.g. 'images/photo.webp'). */
+    name: string;
+    /** File contents. File and Blob are read via .arrayBuffer(). */
+    data: File | Blob | Uint8Array;
+}
+/** Options for archive() and archiveStream(). */
+interface ArchiveOptions {
+    /** Archive format. Currently only 'zip'. Default: 'zip'. */
+    format?: 'zip';
+    /**
+     * fflate deflate compression level (0 = store, 1 = fastest, 9 = best compression).
+     * Default: 6.
+     */
+    level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    /**
+     * When true, image and audio files are automatically compressed to optimized
+     * formats (WebP/MP3) before being added to the archive.
+     * Default: false.
+     */
+    smartOptimize?: boolean;
+    /** Called with progress 0–100 as entries are processed. */
+    onProgress?: (percent: number) => void;
+    /** Cancel the operation. Throws AbortError when signalled. */
+    signal?: AbortSignal;
+}
+/** Result of archive(). */
+interface ArchiveResult {
+    /** The compressed ZIP blob. */
+    blob: Blob;
+    /** Total uncompressed size of all entries in bytes. */
+    originalSize: number;
+    /** Size of the ZIP output in bytes. */
+    compressedSize: number;
+    /** compressedSize / originalSize. */
+    ratio: number;
+    /** Always 'zip' for now. */
+    format: 'zip';
+}
+type Environment = 'browser' | 'node';
+interface RouteContext {
+    env: Environment;
+    isFastPath: boolean;
+    /**
+     * If true, the task should be dispatched to a Web Worker.
+     * If false, the task can run on the main thread for lower latency (small files).
+     */
+    shouldUseWorker: boolean;
+}
+declare class Router {
+    static getEnvironment(): Environment;
+    static isFastPathSupported(options: CompressorOptions$1): boolean;
+    static evaluate(options: CompressorOptions$1, fileSize: number): RouteContext;
+}
+
+interface CompressorOptions extends Omit<ImageOptions, 'format'> {
+    /**
+     * Output mime type (e.g., 'image/webp', 'image/jpeg')
+     * @default 'image/jpeg'
+     */
+    mimeType?: string;
+    /**
+     * Success callback (called with compressed Blob or File)
+     */
+    success?: (result: Blob | File) => void;
+    /**
+     * Error callback (called with Error object)
+     */
+    error?: (err: Error) => void;
+    /**
+     * If the compressed image is larger than the original, output the original.
+     * @default true
+     */
+    strict?: boolean;
+    /**
+     * Files larger than this (in bytes) will be converted to JPEGs.
+     * @default 5,000,000 (5 MB)
+     */
+    convertSize?: number;
+}
+/**
+ * Compatibility shim for `compressorjs`.
+ *
+ * Provides an API identical to the `Compressor` class from the `compressorjs` package,
+ * but uses `omni-compress` under the hood to support AVIF and faster Web Workers.
+ *
+ * @example
+ * ```ts
+ * import Compressor from 'omni-compress/compat';
+ *
+ * new Compressor(file, {
+ *   quality: 0.6,
+ *   success(result) {
+ *     // 'result' is the compressed Blob/File
+ *   },
+ *   error(err) {
+ *     console.error(err.message);
+ *   },
+ * });
+ * ```
+ */
+declare class Compressor {
+    constructor(file: File | Blob, options?: CompressorOptions);
+    private compress;
+}
+
+export { type ArchiveEntry as A, type CompressorOptions$1 as C, type Environment as E, type ImageOptions as I, type RouteContext as R, type VideoOptions as V, type ArchiveOptions as a, type ArchiveResult as b, type AudioOptions as c, type CompressResult as d, Compressor as e, Router as f, type CompressorOptions as g };

package/dist/index.cjs

@@ -0,0 +1 @@
+'use strict';var chunk4VVOIQUC_cjs=require('./chunk-4VVOIQUC.cjs'),chunkMGMH7JY3_cjs=require('./chunk-MGMH7JY3.cjs');Object.defineProperty(exports,"Compressor",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.f}});Object.defineProperty(exports,"MT_SUPPORTED",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.c}});Object.defineProperty(exports,"OmniCompressor",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.j}});Object.defineProperty(exports,"Router",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.b}});Object.defineProperty(exports,"WorkerConfig",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.a}});Object.defineProperty(exports,"archive",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.d}});Object.defineProperty(exports,"archiveStream",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.e}});Object.defineProperty(exports,"compressAudio",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.h}});Object.defineProperty(exports,"compressImage",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.g}});Object.defineProperty(exports,"compressVideo",{enumerable:true,get:function(){return chunk4VVOIQUC_cjs.i}});Object.defineProperty(exports,"AbortError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.h}});Object.defineProperty(exports,"EncoderError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.i}});Object.defineProperty(exports,"FileTooLargeError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.e}});Object.defineProperty(exports,"FormatNotSupportedError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.f}});Object.defineProperty(exports,"InvalidOptionsError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.g}});Object.defineProperty(exports,"OmniCompressError",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.d}});Object.defineProperty(exports,"SAFE_SIZE_LIMITS",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.m}});Object.defineProperty(exports,"arrayBufferToBlob",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.k}});Object.defineProperty(exports,"assertFileSizeWithinLimit",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.n}});Object.defineProperty(exports,"detectFormat",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.r}});Object.defineProperty(exports,"fileToArrayBuffer",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.j}});Object.defineProperty(exports,"getMimeType",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.l}});Object.defineProperty(exports,"isAudioFile",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.p}});Object.defineProperty(exports,"isImageFile",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.o}});Object.defineProperty(exports,"isVideoFile",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.q}});Object.defineProperty(exports,"logger",{enumerable:true,get:function(){return chunkMGMH7JY3_cjs.s}});