@poof-bg/js 1.2.0 → 1.3.0

package/README.md

@@ -116,7 +116,7 @@ fs.writeFileSync('output.png', Buffer.from(result.data));
 
 ### Video
 
-Videos go through the same `removeBackground()` call. Because a clip takes a while to process, the call returns a `Job` instead of bytes: wait for it with `waitForJob()` (or pass `wait: true`), then download `resultUrl`. Output is a transparent VP9 WebM by default; `format` can also be `mov` (ProRes 4444 with alpha) or `mp4` (H.264, composited on `bgColor`, default white). Audio is kept. Each started second of video costs 5 credits (10 above 30 fps), charged when the job is accepted and refunded if it fails.
+Videos go through the same `removeBackground()` call. Because a clip takes a while to process, the call returns a `Job` instead of bytes: wait for it with `waitForJob()` (or pass `wait: true`), then download `resultUrl`. Output is a transparent VP9 WebM by default; `format` can also be `mov` (ProRes 4444 with alpha), `mp4` (H.264, composited on `bgColor`, default white) or `gif` (looping GIF with 1-bit transparency and no audio, capped at 720p, for stickers and chat; pass `size: 'preview'` for sticker-sized output). Audio is kept except for `gif`. An animated GIF is accepted as input too. Each started second of video costs 5 credits (10 above 30 fps), charged when the job is accepted and refunded if it fails.
 
 ```typescript
 import { Poof } from '@poof-bg/js';
@@ -142,10 +142,10 @@ Shorter: `wait: true` submits and waits in one call.
 
 ```typescript
 const done = await poof.removeBackground('./clip.mp4', {
-  format: 'mp4',        // 'webm' (transparent) | 'mov' (transparent ProRes) | 'mp4' (opaque)
+  format: 'mp4',        // 'webm' (transparent) | 'mov' (transparent ProRes) | 'mp4' (opaque) | 'gif' (1-bit transparent)
   channels: 'rgba',     // 'rgba' | 'rgb' | 'alpha' (grayscale matte video, no audio)
   bgColor: '#00ff00',   // Background for opaque output (mp4 or channels 'rgb'); default white
-  size: 'hd',           // Longest side cap; video output never exceeds 1080p
+  size: 'hd',           // Longest side cap: 640 / 1280 / 1920 (hd); 'full' keeps the source up to 4K
   wait: { pollIntervalMs: 5000, timeoutMs: 15 * 60 * 1000 },
 });
 ```
@@ -258,7 +258,7 @@ const poof = new Poof({
 | File path (string) | ❌ | ✅   |
 | `{ url: string }` (public https URL) | ✅ | ✅ |
 
-Images: PNG, JPEG, WebP, GIF (first frame), up to 20 MB. Videos: MP4, MOV, WebM, MKV, up to 100 MB uploaded or 500 MB by URL, up to 5 minutes.
+Images: PNG, JPEG, WebP, single-frame GIF, up to 20 MB. Videos: MP4, MOV, WebM, MKV, animated GIF, up to 100 MB uploaded or 500 MB by URL, up to 5 minutes.
 
 ## TypeScript
 

package/dist/index.d.cts

@@ -13,10 +13,14 @@ interface PoofOptions {
 /** Output image format */
 type ImageFormat = 'png' | 'jpg' | 'webp';
 /** Output video format: VP9 WebM (alpha or opaque), ProRes MOV (alpha or opaque) or H.264 MP4 (opaque) */
-type VideoFormat = 'webm' | 'mov' | 'mp4';
+type VideoFormat = 'webm' | 'mov' | 'mp4' | 'gif';
 /** Output color channels */
 type Channels = 'rgba' | 'rgb' | 'alpha';
-/** Output image size preset */
+/**
+ * Output size preset. Images: megapixel cap. Videos: longest side capped at
+ * 640 (preview), 1280 (medium) or 1920 (hd); 'full' keeps the source
+ * resolution up to 4096 px (4K).
+ */
 type ImageSize = 'full' | 'preview' | 'medium' | 'hd';
 /**
  * How the image is fitted into a fixed width/height (never stretched):

package/dist/index.d.ts

@@ -13,10 +13,14 @@ interface PoofOptions {
 /** Output image format */
 type ImageFormat = 'png' | 'jpg' | 'webp';
 /** Output video format: VP9 WebM (alpha or opaque), ProRes MOV (alpha or opaque) or H.264 MP4 (opaque) */
-type VideoFormat = 'webm' | 'mov' | 'mp4';
+type VideoFormat = 'webm' | 'mov' | 'mp4' | 'gif';
 /** Output color channels */
 type Channels = 'rgba' | 'rgb' | 'alpha';
-/** Output image size preset */
+/**
+ * Output size preset. Images: megapixel cap. Videos: longest side capped at
+ * 640 (preview), 1280 (medium) or 1920 (hd); 'full' keeps the source
+ * resolution up to 4096 px (4K).
+ */
 type ImageSize = 'full' | 'preview' | 'medium' | 'hd';
 /**
  * How the image is fitted into a fixed width/height (never stretched):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poof-bg/js",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Official Poof SDK for image and video background removal",
   "author": "Poof <support@poof.bg>",
   "license": "MIT",