@huh-david/bmp-js 0.4.1 → 0.6.0

package/README.md

@@ -1,5 +1,8 @@
 # @huh-david/bmp-js
 
+[![npm version](https://img.shields.io/npm/v/%40huh-david%2Fbmp-js)](https://www.npmjs.com/package/@huh-david/bmp-js)
+[![Documentation](https://img.shields.io/badge/docs-github%20pages-1d4ed8)](https://huh-david.github.io/bmp-js/)
+
 A pure TypeScript BMP encoder/decoder for Node.js.
 
 ## Maintenance
@@ -7,14 +10,15 @@ A pure TypeScript BMP encoder/decoder for Node.js.
 This fork is actively maintained and tracks unresolved upstream `shaozilee/bmp-js` issues and PRs.
 
 - Repository: https://github.com/Huh-David/bmp-js
-- Latest release: https://github.com/Huh-David/bmp-js/releases/tag/v0.4.0
+- Releases: https://github.com/Huh-David/bmp-js/releases
+- Documentation: https://huh-david.github.io/bmp-js/
 
 ## Features
 
 - Decoding for BMP bit depths: 1, 4, 8, 15, 16, 24, 32
 - Decoding support for RLE-4 and RLE-8 compressed BMPs
 - Robust DIB handling for CORE/INFO/V4/V5 headers
-- Encoding output as 24-bit BMP with configurable orientation
+- Encoding output bit depths: 1, 4, 8, 16, 24, 32
 - Dual package output: ESM + CommonJS
 - First-class TypeScript types
 
@@ -57,7 +61,9 @@ const encoded = encode(
   },
   {
     orientation: "bottom-up", // default: "top-down"
-    bitPP: 24, // only 24 is currently supported
+    bitPP: 32, // supported: 1, 4, 8, 16, 24, 32
+    // palette is required for 4/8-bit and optional for 1-bit
+    // palette: [{ red: 0, green: 0, blue: 0, quad: 0 }, ...],
   },
 );
 ```
@@ -96,6 +102,44 @@ If `toRGBA: true` is provided to `decode`, output is returned in `RGBA`.
 
 Input/output binary types use `Uint8Array` (Node `Buffer` is fully compatible because it extends `Uint8Array`).
 
+## Sharp adapter (optional subexport)
+
+The package ships an optional Sharp adapter at `@huh-david/bmp-js/sharp`.
+Core usage does not require `sharp`.
+
+Install Sharp only when using the adapter:
+
+```bash
+pnpm add sharp
+```
+
+### BMP -> Sharp -> PNG
+
+```ts
+import sharp from "sharp";
+import { sharpFromBmp } from "@huh-david/bmp-js/sharp";
+
+const png = await sharpFromBmp(bmpBytes, sharp).resize(800).png().toBuffer();
+```
+
+### Sharp raw -> BMP
+
+```ts
+import sharp from "sharp";
+import { encodeFromSharp } from "@huh-david/bmp-js/sharp";
+
+const { data, info } = await sharp(input).ensureAlpha().raw().toBuffer({ resolveWithObject: true });
+
+const bmp = encodeFromSharp({ data, info }, { bitDepth: 32 });
+```
+
+Adapter behavior:
+
+- `decodeForSharp` and `sharpFromBmp` require BMP input and throw on non-BMP bytes.
+- Sharp-bound decode output is normalized to `RGBA` + `{ raw: { width, height, channels: 4 } }`.
+- `encodeFromSharp` supports `channels` 3 and 4 only; other values throw.
+- Default encode depth is data-preserving: RGB -> 24-bit, RGBA -> 32-bit.
+
 ## Development
 
 ```bash