@capgo/capacitor-file-compressor 7.0.0

package/dist/docs.json

@@ -0,0 +1,316 @@
+{
+  "api": {
+    "name": "FileCompressorPlugin",
+    "slug": "filecompressorplugin",
+    "docs": "Capacitor File Compressor Plugin interface for image compression.",
+    "tags": [
+      {
+        "text": "7.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "compressImage",
+        "signature": "(options: CompressImageOptions) => Promise<CompressImageResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Configuration options for image compression",
+            "type": "CompressImageOptions"
+          }
+        ],
+        "returns": "Promise<CompressImageResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Configuration options for image compression"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the compressed image path or blob"
+          },
+          {
+            "name": "throws",
+            "text": "Error if compression fails, invalid parameters, or unsupported format"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Web - Compress from file input\nconst fileInput = document.getElementById('file') as HTMLInputElement;\nconst file = fileInput.files[0];\nconst result = await FileCompressor.compressImage({\n  blob: file,\n  quality: 0.8,\n  width: 1200,\n  mimeType: 'image/jpeg'\n});\nconst url = URL.createObjectURL(result.blob);\n```"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// iOS - Compress image from file path\nconst result = await FileCompressor.compressImage({\n  path: 'file:///var/mobile/Containers/Data/image.jpg',\n  quality: 0.7,\n  width: 1000,\n  mimeType: 'image/jpeg' // Only JPEG supported on iOS\n});\nconsole.log('Compressed to:', result.path);\n```"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Android - Compress with WebP format\nconst result = await FileCompressor.compressImage({\n  path: 'content://downloads/document/123',\n  quality: 0.6,\n  width: 800,\n  height: 600,\n  mimeType: 'image/webp'\n});\nconsole.log('Compressed to:', result.path);\n```"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Maintain aspect ratio - only specify width\nconst result = await FileCompressor.compressImage({\n  path: imagePath,\n  quality: 0.75,\n  width: 1920, // Height calculated automatically\n  mimeType: 'image/jpeg'\n});\n```"
+          }
+        ],
+        "docs": "Compresses an image file with specified dimensions and quality settings.\n\nThis method compresses images to reduce file size while maintaining acceptable quality.\nIt supports resizing and format conversion (JPEG/WebP depending on platform).\n\n**Important Notes:**\n- EXIF metadata is removed during compression on all platforms\n- Aspect ratio is automatically maintained if only one dimension is provided\n- Compressed files are saved to temporary directories on native platforms",
+        "complexTypes": [
+          "CompressImageResult",
+          "CompressImageOptions"
+        ],
+        "slug": "compressimage"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version string"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await FileCompressor.getPluginVersion();\nconsole.log('Plugin version:', version); // \"7.0.0\"\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.\n\nReturns the version of the native plugin implementation.\nUseful for debugging and ensuring compatibility.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "CompressImageResult",
+      "slug": "compressimageresult",
+      "docs": "The result of compressing an image.\n\nContains either a file path (native platforms) or a Blob (web platform)\ndepending on where the compression was performed.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "\"/var/mobile/Containers/Data/tmp/compressed_abc123.jpg\" // iOS",
+              "name": "example"
+            },
+            {
+              "text": "\"/data/user/0/com.app/cache/compressed_xyz789.jpg\" // Android",
+              "name": "example"
+            }
+          ],
+          "docs": "The file path of the compressed image.\n\n**Platform:** Android, iOS only (undefined on Web)\n\nPoints to a temporary file containing the compressed image.\nOn iOS, typically in `NSTemporaryDirectory()`.\nOn Android, typically in app cache directory.\n\n**Important:** These files may be cleaned up by the OS.\nCopy to permanent storage if needed for long-term use.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "blob",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "```typescript\n// Create preview URL\nconst url = URL.createObjectURL(result.blob);\nimageElement.src = url;\n```",
+              "name": "example"
+            },
+            {
+              "text": "```typescript\n// Upload to server\nconst formData = new FormData();\nformData.append('image', result.blob, 'compressed.jpg');\nawait fetch('/upload', { method: 'POST', body: formData });\n```",
+              "name": "example"
+            }
+          ],
+          "docs": "The blob of the compressed image.\n\n**Platform:** Web only (undefined on iOS/Android)\n\nA Blob object containing the compressed image data.\nCan be used to:\n- Create object URLs for preview: `URL.createObjectURL(blob)`\n- Upload to server via FormData\n- Save to IndexedDB or other storage\n- Convert to base64 with FileReader",
+          "complexTypes": [
+            "Blob"
+          ],
+          "type": "Blob"
+        }
+      ]
+    },
+    {
+      "name": "CompressImageOptions",
+      "slug": "compressimageoptions",
+      "docs": "Options for compressing an image.\n\nConfigure the compression behavior including quality, dimensions, and output format.\nPlatform-specific options are available for path (native) and blob (web).",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "\"file:///var/mobile/Containers/Data/Application/image.jpg\" // iOS",
+              "name": "example"
+            },
+            {
+              "text": "\"content://com.android.providers.downloads.documents/document/msf%3A1000000485\" // Android",
+              "name": "example"
+            },
+            {
+              "text": "\"/storage/emulated/0/Download/photo.png\" // Android absolute path",
+              "name": "example"
+            }
+          ],
+          "docs": "The file path of the image to compress.\n\n**Platform:** Android, iOS only (not supported on Web)\n\nAccepts various path formats:\n- iOS: `file://` URLs or absolute paths\n- Android: `content://` URIs, `file://` URLs, or absolute paths",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "blob",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "```typescript\n// From file input\nconst fileInput = document.getElementById('file') as HTMLInputElement;\nconst blob = fileInput.files[0];\n```",
+              "name": "example"
+            },
+            {
+              "text": "```typescript\n// From fetch\nconst response = await fetch('https://example.com/image.jpg');\nconst blob = await response.blob();\n```",
+              "name": "example"
+            }
+          ],
+          "docs": "The file blob of the image to compress.\n\n**Platform:** Web only (not supported on iOS/Android)\n\nUse this when compressing images from file inputs, fetch responses,\nor any other Blob source in web applications.",
+          "complexTypes": [
+            "Blob"
+          ],
+          "type": "Blob"
+        },
+        {
+          "name": "quality",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "0.6",
+              "name": "default"
+            },
+            {
+              "text": "0.8 // High quality",
+              "name": "example"
+            },
+            {
+              "text": "0.5 // Medium quality, smaller file",
+              "name": "example"
+            },
+            {
+              "text": "0.3 // Low quality, very small file",
+              "name": "example"
+            }
+          ],
+          "docs": "The quality of the compressed image.\n\n**Range:** 0.0 to 1.0\n- `0.0` = Maximum compression (lowest quality, smallest file)\n- `1.0` = Minimum compression (highest quality, largest file)\n- `0.6` = Default balanced compression\n\n**Platform:** All platforms\n\nHigher quality values result in larger files but better visual quality.\nThe actual compression ratio depends on the image content and format.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "width",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "1920 // Full HD width",
+              "name": "example"
+            },
+            {
+              "text": "1200 // Common web image width",
+              "name": "example"
+            },
+            {
+              "text": "800  // Mobile-optimized width",
+              "name": "example"
+            }
+          ],
+          "docs": "The width of the compressed image in pixels.\n\n**Platform:** All platforms\n\nIf only width is specified, height is calculated automatically\nto maintain the original aspect ratio.\n\nIf both width and height are specified, the image is resized\nto exact dimensions (may distort if ratio differs).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "height",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "1080 // Full HD height",
+              "name": "example"
+            },
+            {
+              "text": "800  // Common web image height",
+              "name": "example"
+            },
+            {
+              "text": "600  // Mobile-optimized height",
+              "name": "example"
+            }
+          ],
+          "docs": "The height of the compressed image in pixels.\n\n**Platform:** All platforms\n\nIf only height is specified, width is calculated automatically\nto maintain the original aspect ratio.\n\nIf both width and height are specified, the image is resized\nto exact dimensions (may distort if ratio differs).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "mimeType",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "\"image/jpeg\"",
+              "name": "default"
+            },
+            {
+              "text": "\"image/jpeg\" // JPEG format (all platforms)",
+              "name": "example"
+            },
+            {
+              "text": "\"image/webp\" // WebP format (Android/Web only)",
+              "name": "example"
+            }
+          ],
+          "docs": "The MIME type of the compressed output image.\n\n**Platform Support:**\n- **iOS:** `image/jpeg` only\n- **Android:** `image/jpeg`, `image/webp`\n- **Web:** `image/jpeg`, `image/webp`\n\n**Format Characteristics:**\n- **JPEG:** Universal support, good for photos, no transparency\n- **WebP:** Better compression, supports transparency, not on iOS",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,263 @@
+/**
+ * Capacitor File Compressor Plugin interface for image compression.
+ *
+ * @since 7.0.0
+ */
+export interface FileCompressorPlugin {
+    /**
+     * Compresses an image file with specified dimensions and quality settings.
+     *
+     * This method compresses images to reduce file size while maintaining acceptable quality.
+     * It supports resizing and format conversion (JPEG/WebP depending on platform).
+     *
+     * **Important Notes:**
+     * - EXIF metadata is removed during compression on all platforms
+     * - Aspect ratio is automatically maintained if only one dimension is provided
+     * - Compressed files are saved to temporary directories on native platforms
+     *
+     * @param options - Configuration options for image compression
+     * @returns Promise that resolves with the compressed image path or blob
+     * @throws Error if compression fails, invalid parameters, or unsupported format
+     * @since 7.0.0
+     * @example
+     * ```typescript
+     * // Web - Compress from file input
+     * const fileInput = document.getElementById('file') as HTMLInputElement;
+     * const file = fileInput.files[0];
+     * const result = await FileCompressor.compressImage({
+     *   blob: file,
+     *   quality: 0.8,
+     *   width: 1200,
+     *   mimeType: 'image/jpeg'
+     * });
+     * const url = URL.createObjectURL(result.blob);
+     * ```
+     * @example
+     * ```typescript
+     * // iOS - Compress image from file path
+     * const result = await FileCompressor.compressImage({
+     *   path: 'file:///var/mobile/Containers/Data/image.jpg',
+     *   quality: 0.7,
+     *   width: 1000,
+     *   mimeType: 'image/jpeg' // Only JPEG supported on iOS
+     * });
+     * console.log('Compressed to:', result.path);
+     * ```
+     * @example
+     * ```typescript
+     * // Android - Compress with WebP format
+     * const result = await FileCompressor.compressImage({
+     *   path: 'content://downloads/document/123',
+     *   quality: 0.6,
+     *   width: 800,
+     *   height: 600,
+     *   mimeType: 'image/webp'
+     * });
+     * console.log('Compressed to:', result.path);
+     * ```
+     * @example
+     * ```typescript
+     * // Maintain aspect ratio - only specify width
+     * const result = await FileCompressor.compressImage({
+     *   path: imagePath,
+     *   quality: 0.75,
+     *   width: 1920, // Height calculated automatically
+     *   mimeType: 'image/jpeg'
+     * });
+     * ```
+     */
+    compressImage(options: CompressImageOptions): Promise<CompressImageResult>;
+    /**
+     * Get the native Capacitor plugin version.
+     *
+     * Returns the version of the native plugin implementation.
+     * Useful for debugging and ensuring compatibility.
+     *
+     * @returns Promise that resolves with the plugin version string
+     * @throws Error if getting the version fails
+     * @since 7.0.0
+     * @example
+     * ```typescript
+     * const { version } = await FileCompressor.getPluginVersion();
+     * console.log('Plugin version:', version); // "7.0.0"
+     * ```
+     */
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
+}
+/**
+ * Options for compressing an image.
+ *
+ * Configure the compression behavior including quality, dimensions, and output format.
+ * Platform-specific options are available for path (native) and blob (web).
+ *
+ * @since 7.0.0
+ */
+export interface CompressImageOptions {
+    /**
+     * The file path of the image to compress.
+     *
+     * **Platform:** Android, iOS only (not supported on Web)
+     *
+     * Accepts various path formats:
+     * - iOS: `file://` URLs or absolute paths
+     * - Android: `content://` URIs, `file://` URLs, or absolute paths
+     *
+     * @since 7.0.0
+     * @example "file:///var/mobile/Containers/Data/Application/image.jpg" // iOS
+     * @example "content://com.android.providers.downloads.documents/document/msf%3A1000000485" // Android
+     * @example "/storage/emulated/0/Download/photo.png" // Android absolute path
+     */
+    path?: string;
+    /**
+     * The file blob of the image to compress.
+     *
+     * **Platform:** Web only (not supported on iOS/Android)
+     *
+     * Use this when compressing images from file inputs, fetch responses,
+     * or any other Blob source in web applications.
+     *
+     * @since 7.0.0
+     * @example
+     * ```typescript
+     * // From file input
+     * const fileInput = document.getElementById('file') as HTMLInputElement;
+     * const blob = fileInput.files[0];
+     * ```
+     * @example
+     * ```typescript
+     * // From fetch
+     * const response = await fetch('https://example.com/image.jpg');
+     * const blob = await response.blob();
+     * ```
+     */
+    blob?: Blob;
+    /**
+     * The quality of the compressed image.
+     *
+     * **Range:** 0.0 to 1.0
+     * - `0.0` = Maximum compression (lowest quality, smallest file)
+     * - `1.0` = Minimum compression (highest quality, largest file)
+     * - `0.6` = Default balanced compression
+     *
+     * **Platform:** All platforms
+     *
+     * Higher quality values result in larger files but better visual quality.
+     * The actual compression ratio depends on the image content and format.
+     *
+     * @since 7.0.0
+     * @default 0.6
+     * @example 0.8 // High quality
+     * @example 0.5 // Medium quality, smaller file
+     * @example 0.3 // Low quality, very small file
+     */
+    quality?: number;
+    /**
+     * The width of the compressed image in pixels.
+     *
+     * **Platform:** All platforms
+     *
+     * If only width is specified, height is calculated automatically
+     * to maintain the original aspect ratio.
+     *
+     * If both width and height are specified, the image is resized
+     * to exact dimensions (may distort if ratio differs).
+     *
+     * @since 7.0.0
+     * @example 1920 // Full HD width
+     * @example 1200 // Common web image width
+     * @example 800  // Mobile-optimized width
+     */
+    width?: number;
+    /**
+     * The height of the compressed image in pixels.
+     *
+     * **Platform:** All platforms
+     *
+     * If only height is specified, width is calculated automatically
+     * to maintain the original aspect ratio.
+     *
+     * If both width and height are specified, the image is resized
+     * to exact dimensions (may distort if ratio differs).
+     *
+     * @since 7.0.0
+     * @example 1080 // Full HD height
+     * @example 800  // Common web image height
+     * @example 600  // Mobile-optimized height
+     */
+    height?: number;
+    /**
+     * The MIME type of the compressed output image.
+     *
+     * **Platform Support:**
+     * - **iOS:** `image/jpeg` only
+     * - **Android:** `image/jpeg`, `image/webp`
+     * - **Web:** `image/jpeg`, `image/webp`
+     *
+     * **Format Characteristics:**
+     * - **JPEG:** Universal support, good for photos, no transparency
+     * - **WebP:** Better compression, supports transparency, not on iOS
+     *
+     * @since 7.0.0
+     * @default "image/jpeg"
+     * @example "image/jpeg" // JPEG format (all platforms)
+     * @example "image/webp" // WebP format (Android/Web only)
+     */
+    mimeType?: string;
+}
+/**
+ * The result of compressing an image.
+ *
+ * Contains either a file path (native platforms) or a Blob (web platform)
+ * depending on where the compression was performed.
+ *
+ * @since 7.0.0
+ */
+export interface CompressImageResult {
+    /**
+     * The file path of the compressed image.
+     *
+     * **Platform:** Android, iOS only (undefined on Web)
+     *
+     * Points to a temporary file containing the compressed image.
+     * On iOS, typically in `NSTemporaryDirectory()`.
+     * On Android, typically in app cache directory.
+     *
+     * **Important:** These files may be cleaned up by the OS.
+     * Copy to permanent storage if needed for long-term use.
+     *
+     * @since 7.0.0
+     * @example "/var/mobile/Containers/Data/tmp/compressed_abc123.jpg" // iOS
+     * @example "/data/user/0/com.app/cache/compressed_xyz789.jpg" // Android
+     */
+    path?: string;
+    /**
+     * The blob of the compressed image.
+     *
+     * **Platform:** Web only (undefined on iOS/Android)
+     *
+     * A Blob object containing the compressed image data.
+     * Can be used to:
+     * - Create object URLs for preview: `URL.createObjectURL(blob)`
+     * - Upload to server via FormData
+     * - Save to IndexedDB or other storage
+     * - Convert to base64 with FileReader
+     *
+     * @since 7.0.0
+     * @example
+     * ```typescript
+     * // Create preview URL
+     * const url = URL.createObjectURL(result.blob);
+     * imageElement.src = url;
+     * ```
+     * @example
+     * ```typescript
+     * // Upload to server
+     * const formData = new FormData();
+     * formData.append('image', result.blob, 'compressed.jpg');
+     * await fetch('/upload', { method: 'POST', body: formData });
+     * ```
+     */
+    blob?: Blob;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Capacitor File Compressor Plugin interface for image compression.\n *\n * @since 7.0.0\n */\nexport interface FileCompressorPlugin {\n  /**\n   * Compresses an image file with specified dimensions and quality settings.\n   *\n   * This method compresses images to reduce file size while maintaining acceptable quality.\n   * It supports resizing and format conversion (JPEG/WebP depending on platform).\n   *\n   * **Important Notes:**\n   * - EXIF metadata is removed during compression on all platforms\n   * - Aspect ratio is automatically maintained if only one dimension is provided\n   * - Compressed files are saved to temporary directories on native platforms\n   *\n   * @param options - Configuration options for image compression\n   * @returns Promise that resolves with the compressed image path or blob\n   * @throws Error if compression fails, invalid parameters, or unsupported format\n   * @since 7.0.0\n   * @example\n   * ```typescript\n   * // Web - Compress from file input\n   * const fileInput = document.getElementById('file') as HTMLInputElement;\n   * const file = fileInput.files[0];\n   * const result = await FileCompressor.compressImage({\n   *   blob: file,\n   *   quality: 0.8,\n   *   width: 1200,\n   *   mimeType: 'image/jpeg'\n   * });\n   * const url = URL.createObjectURL(result.blob);\n   * ```\n   * @example\n   * ```typescript\n   * // iOS - Compress image from file path\n   * const result = await FileCompressor.compressImage({\n   *   path: 'file:///var/mobile/Containers/Data/image.jpg',\n   *   quality: 0.7,\n   *   width: 1000,\n   *   mimeType: 'image/jpeg' // Only JPEG supported on iOS\n   * });\n   * console.log('Compressed to:', result.path);\n   * ```\n   * @example\n   * ```typescript\n   * // Android - Compress with WebP format\n   * const result = await FileCompressor.compressImage({\n   *   path: 'content://downloads/document/123',\n   *   quality: 0.6,\n   *   width: 800,\n   *   height: 600,\n   *   mimeType: 'image/webp'\n   * });\n   * console.log('Compressed to:', result.path);\n   * ```\n   * @example\n   * ```typescript\n   * // Maintain aspect ratio - only specify width\n   * const result = await FileCompressor.compressImage({\n   *   path: imagePath,\n   *   quality: 0.75,\n   *   width: 1920, // Height calculated automatically\n   *   mimeType: 'image/jpeg'\n   * });\n   * ```\n   */\n  compressImage(options: CompressImageOptions): Promise<CompressImageResult>;\n\n  /**\n   * Get the native Capacitor plugin version.\n   *\n   * Returns the version of the native plugin implementation.\n   * Useful for debugging and ensuring compatibility.\n   *\n   * @returns Promise that resolves with the plugin version string\n   * @throws Error if getting the version fails\n   * @since 7.0.0\n   * @example\n   * ```typescript\n   * const { version } = await FileCompressor.getPluginVersion();\n   * console.log('Plugin version:', version); // \"7.0.0\"\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n\n/**\n * Options for compressing an image.\n *\n * Configure the compression behavior including quality, dimensions, and output format.\n * Platform-specific options are available for path (native) and blob (web).\n *\n * @since 7.0.0\n */\nexport interface CompressImageOptions {\n  /**\n   * The file path of the image to compress.\n   *\n   * **Platform:** Android, iOS only (not supported on Web)\n   *\n   * Accepts various path formats:\n   * - iOS: `file://` URLs or absolute paths\n   * - Android: `content://` URIs, `file://` URLs, or absolute paths\n   *\n   * @since 7.0.0\n   * @example \"file:///var/mobile/Containers/Data/Application/image.jpg\" // iOS\n   * @example \"content://com.android.providers.downloads.documents/document/msf%3A1000000485\" // Android\n   * @example \"/storage/emulated/0/Download/photo.png\" // Android absolute path\n   */\n  path?: string;\n\n  /**\n   * The file blob of the image to compress.\n   *\n   * **Platform:** Web only (not supported on iOS/Android)\n   *\n   * Use this when compressing images from file inputs, fetch responses,\n   * or any other Blob source in web applications.\n   *\n   * @since 7.0.0\n   * @example\n   * ```typescript\n   * // From file input\n   * const fileInput = document.getElementById('file') as HTMLInputElement;\n   * const blob = fileInput.files[0];\n   * ```\n   * @example\n   * ```typescript\n   * // From fetch\n   * const response = await fetch('https://example.com/image.jpg');\n   * const blob = await response.blob();\n   * ```\n   */\n  blob?: Blob;\n\n  /**\n   * The quality of the compressed image.\n   *\n   * **Range:** 0.0 to 1.0\n   * - `0.0` = Maximum compression (lowest quality, smallest file)\n   * - `1.0` = Minimum compression (highest quality, largest file)\n   * - `0.6` = Default balanced compression\n   *\n   * **Platform:** All platforms\n   *\n   * Higher quality values result in larger files but better visual quality.\n   * The actual compression ratio depends on the image content and format.\n   *\n   * @since 7.0.0\n   * @default 0.6\n   * @example 0.8 // High quality\n   * @example 0.5 // Medium quality, smaller file\n   * @example 0.3 // Low quality, very small file\n   */\n  quality?: number;\n\n  /**\n   * The width of the compressed image in pixels.\n   *\n   * **Platform:** All platforms\n   *\n   * If only width is specified, height is calculated automatically\n   * to maintain the original aspect ratio.\n   *\n   * If both width and height are specified, the image is resized\n   * to exact dimensions (may distort if ratio differs).\n   *\n   * @since 7.0.0\n   * @example 1920 // Full HD width\n   * @example 1200 // Common web image width\n   * @example 800  // Mobile-optimized width\n   */\n  width?: number;\n\n  /**\n   * The height of the compressed image in pixels.\n   *\n   * **Platform:** All platforms\n   *\n   * If only height is specified, width is calculated automatically\n   * to maintain the original aspect ratio.\n   *\n   * If both width and height are specified, the image is resized\n   * to exact dimensions (may distort if ratio differs).\n   *\n   * @since 7.0.0\n   * @example 1080 // Full HD height\n   * @example 800  // Common web image height\n   * @example 600  // Mobile-optimized height\n   */\n  height?: number;\n\n  /**\n   * The MIME type of the compressed output image.\n   *\n   * **Platform Support:**\n   * - **iOS:** `image/jpeg` only\n   * - **Android:** `image/jpeg`, `image/webp`\n   * - **Web:** `image/jpeg`, `image/webp`\n   *\n   * **Format Characteristics:**\n   * - **JPEG:** Universal support, good for photos, no transparency\n   * - **WebP:** Better compression, supports transparency, not on iOS\n   *\n   * @since 7.0.0\n   * @default \"image/jpeg\"\n   * @example \"image/jpeg\" // JPEG format (all platforms)\n   * @example \"image/webp\" // WebP format (Android/Web only)\n   */\n  mimeType?: string;\n}\n\n/**\n * The result of compressing an image.\n *\n * Contains either a file path (native platforms) or a Blob (web platform)\n * depending on where the compression was performed.\n *\n * @since 7.0.0\n */\nexport interface CompressImageResult {\n  /**\n   * The file path of the compressed image.\n   *\n   * **Platform:** Android, iOS only (undefined on Web)\n   *\n   * Points to a temporary file containing the compressed image.\n   * On iOS, typically in `NSTemporaryDirectory()`.\n   * On Android, typically in app cache directory.\n   *\n   * **Important:** These files may be cleaned up by the OS.\n   * Copy to permanent storage if needed for long-term use.\n   *\n   * @since 7.0.0\n   * @example \"/var/mobile/Containers/Data/tmp/compressed_abc123.jpg\" // iOS\n   * @example \"/data/user/0/com.app/cache/compressed_xyz789.jpg\" // Android\n   */\n  path?: string;\n\n  /**\n   * The blob of the compressed image.\n   *\n   * **Platform:** Web only (undefined on iOS/Android)\n   *\n   * A Blob object containing the compressed image data.\n   * Can be used to:\n   * - Create object URLs for preview: `URL.createObjectURL(blob)`\n   * - Upload to server via FormData\n   * - Save to IndexedDB or other storage\n   * - Convert to base64 with FileReader\n   *\n   * @since 7.0.0\n   * @example\n   * ```typescript\n   * // Create preview URL\n   * const url = URL.createObjectURL(result.blob);\n   * imageElement.src = url;\n   * ```\n   * @example\n   * ```typescript\n   * // Upload to server\n   * const formData = new FormData();\n   * formData.append('image', result.blob, 'compressed.jpg');\n   * await fetch('/upload', { method: 'POST', body: formData });\n   * ```\n   */\n  blob?: Blob;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { FileCompressorPlugin } from './definitions';
+declare const FileCompressor: FileCompressorPlugin;
+export * from './definitions';
+export { FileCompressor };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const FileCompressor = registerPlugin('FileCompressor', {
+    web: () => import('./web').then((m) => new m.FileCompressorWeb()),
+});
+export * from './definitions';
+export { FileCompressor };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,cAAc,GAAG,cAAc,CAAuB,gBAAgB,EAAE;IAC5E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;CAClE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { FileCompressorPlugin } from './definitions';\n\nconst FileCompressor = registerPlugin<FileCompressorPlugin>('FileCompressor', {\n  web: () => import('./web').then((m) => new m.FileCompressorWeb()),\n});\n\nexport * from './definitions';\nexport { FileCompressor };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,9 @@
+import { WebPlugin } from '@capacitor/core';
+import type { CompressImageOptions, CompressImageResult, FileCompressorPlugin } from './definitions';
+export declare class FileCompressorWeb extends WebPlugin implements FileCompressorPlugin {
+    compressImage(options: CompressImageOptions): Promise<CompressImageResult>;
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
+    private createImageFromBlob;
+}