Initial Commit

packages/media/image/compress-image/README.md

@@ -0,0 +1,65 @@
+# @suaveplan/compress-image - Runtime-agnostic image compression utilities: resize, quality reduction, format conversion, and metadata stripping via pluggable adapters
+
+Runtime-agnostic image compression utilities with pluggable adapters for Node.js (Sharp) and testing (MemoryAdapter). Supports resize, quality reduction, format conversion (JPEG, PNG, WebP, AVIF), and metadata stripping. The compressor core is pure TypeScript with zero runtime dependencies; only the Sharp adapter requires the native `sharp` library.
+
+<!-- begin:auto-docs -->
+## Documentation tree
+
+- [memory](./src/adapters/memory/memory.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [memory](./src/adapters/memory/memory.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+- [sharp](./src/adapters/sharp/sharp.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [sharp](./src/adapters/sharp/sharp.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+- [compressor](./src/core/compressor/compressor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [compressor](./src/core/compressor/compressor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+- [errors](./src/errors/compress-image-error.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [compress-image-error](./src/errors/compress-image-error.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+- [schemas](./src/schemas/compress-options.schema.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [compress-options.schema](./src/schemas/compress-options.schema.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+- [utils](./src/utils/image-utils.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+  - [image-utils](./src/utils/image-utils.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
+<!-- end:auto-docs -->
+
+## Installation
+
+```bash
+bun add @suaveplan/compress-image
+```
+
+## Quick Start
+
+```ts
+import { createCompressor } from "@suaveplan/compress-image/compressor";
+import { SharpAdapter } from "@suaveplan/compress-image/adapters/sharp";
+import sharp from "sharp";
+
+const compressor = createCompressor(new SharpAdapter(sharp));
+
+const result = await compressor.compress(imageBuffer, {
+    format: "webp",
+    quality: 75,
+    width: 1280,
+    height: 720,
+    resizeMode: "cover",
+    stripMetadata: true,
+});
+
+console.log(result.compressionRatio, result.compressedSize);
+```
+
+## Modules
+
+- [`src/core/compressor/compressor.md`](./src/core/compressor/compressor.md) — `ImageCompressor` core and `createCompressor`
+- [`src/adapters/memory/memory.md`](./src/adapters/memory/memory.md) — `MemoryAdapter` for testing without native deps
+- [`src/adapters/sharp/sharp.md`](./src/adapters/sharp/sharp.md) — `SharpAdapter` for Node.js production compression
+- [`src/errors/compress-image-error.md`](./src/errors/compress-image-error.md) — `CompressImageError` and error codes
+- [`src/schemas/compress-options.schema.md`](./src/schemas/compress-options.schema.md) — Zod schemas for compression options
+- [`src/types/compress-image.types.md`](./src/types/compress-image.types.md) — TypeScript interfaces for results and adapters
+- [`src/utils/image-utils.md`](./src/utils/image-utils.md) — Pure TypeScript image utilities
+
+## Subpath Exports
+
+- `.` — All public types, errors, utilities, adapters, and the compressor
+- `./compressor` — `ImageCompressor`, `createCompressor`
+- `./adapters/memory` — `MemoryAdapter`
+- `./adapters/sharp` — `SharpAdapter`, `SharpLike`, `SharpInstance`
+- `./errors` — `CompressImageError`, `COMPRESS_IMAGE_CODES`