@boruto_vk7/stickengine 1.2.0 → 2.0.1

package/README.md

@@ -1,306 +1,173 @@
-# StickEngine
+# StickEngine - Lagos Solutions
 
-**Professional WhatsApp sticker engine for Node.js.**
+![Lagos Solutions](./logo_small.png)
 
-Build production-ready **static and animated** stickers with correct EXIF pack metadata, transparent framing (no black bars), and a one-line API.
+**Motor profissional de figurinhas para WhatsApp**
+Estático e animado, com EXIF, marca d'água com sua logo e suporte total ESM + CJS + TypeScript
 
-[![npm](https://img.shields.io/npm/v/@boruto_vk7/stickengine.svg)](https://www.npmjs.com/package/@boruto_vk7/stickengine)
-[![Node](https://img.shields.io/node/v/@boruto_vk7/stickengine.svg)](https://nodejs.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](./LICENSE)
+[![npm](https://img.shields.io/npm/v/@boruto_vk7/stickengine?style=flat-square&color=7c3aed)](https://www.npmjs.com/package/@boruto_vk7/stickengine)
+[![node](https://img.shields.io/node/v/@boruto_vk7/stickengine?style=flat-square&color=7c3aed)](https://nodejs.org)
+[![license](https://img.shields.io/badge/License-MIT-7c3aed?style=flat-square)](LICENSE)
+[![Lagos](https://img.shields.io/badge/Lagos-Solutions-7c3aed?style=flat-square)](https://www.npmjs.com/package/@boruto_vk7/stickengine)
 
-```bash
-npm install @boruto_vk7/stickengine
-```
+![Lagos Solutions Logo](./logo.png)
 
----
+> SOLUÇÕES INTELIGENTES. RESULTADOS REAIS.
 
-## Why StickEngine
+---
 
-Most sticker helpers break on the details that matter in real bots:
+## 🚀 Instalação
 
-| Problem in typical libs | StickEngine |
-|-------------------------|-------------|
-| Black bars on portrait/landscape media | **True transparent pad** (`format=rgba` → `pad=…:black@0`) |
-| Animated WebP EXIF crashes (`save` vs `muxAnim`) | **Compatible with node-webpmux v1 + v3** |
-| Oversized animated stickers rejected by WA | **Auto quality/FPS shrink under ~1MB** |
-| Awkward queue-only APIs | **`StickEngine.create()` → `{ buffer, path, base64 }`** |
-| ESM *or* CJS only | **Dual package (import + require)** |
+```bash
+npm install @boruto_vk7/stickengine
+```
 
-Built for Baileys, Evolution, Venom, whatsapp-web.js and any stack that sends a WebP buffer.
+FFmpeg já incluso via `@ffmpeg-installer/ffmpeg`. Não precisa instalar manualmente.
 
 ---
 
-## Requirements
-
-- **Node.js ≥ 18**
-- **ffmpeg** + **ffprobe** available in `PATH`  
-  (or install `@ffmpeg-installer/ffmpeg` + `@ffprobe-installer/ffprobe` and set paths via `fluent-ffmpeg`)
+## ✨ Funcionalidades
 
-```bash
-# Debian / Ubuntu
-sudo apt install ffmpeg
-
-# macOS
-brew install ffmpeg
-```
+- ✅ **Todos os tipos de entrada:** Buffer, caminho local, URL https, data URI base64, base64 puro
+- ✅ **Todos os tipos de figurinha:** JPG, PNG, WEBP estático, GIF animado, MP4, WEBM
+- ✅ **5 modos de enquadramento:** `natural` (padrão WA), `cover`, `contain`, `fill`, `none`
+- ✅ **EXIF com pack e autor:** Compatível com node-webpmux v1 e v3
+- ✅ **Auto shrink:** Figurinhas animadas sempre abaixo de 1MB
+- ✅ **Dirtemp custom:** `Dirtemp`, `tempDir`, `dirTemp` - qualquer alias funciona
+- ✅ **Marca d'água com LOGO:** `watermark: true` usa sua `logo.png` automaticamente
+- ✅ **Compatível:** ESM `import`, CJS `require()`, TypeScript `NodeNext` e `CommonJS`
+- ✅ **APIs antigas:** `sendImageAsSticker`, `imageToWebp`, `writeExifImg` ainda funcionam
 
 ---
 
-## Quick start
+## 📦 Uso Rápido
 
 ### ESM / TypeScript
-
-```ts
+```javascript
 import StickEngine from '@boruto_vk7/stickengine';
 
-const sticker = await StickEngine.create('./photo.jpg', {
+const sticker = await StickEngine.create('./foto.jpg', {
+  Dirtemp: './temp',
+  watermark: true,
   metadata: {
-    pack: 'StickEngine',
+    pack: 'Lagos Solutions',
     author: 'Borutovk7',
-    emojis: ['✨'],
-  },
+    emojis: ['🔥']
+  }
 });
 
-// WhatsApp-ready WebP
 await sock.sendMessage(jid, { sticker: sticker.buffer });
 ```
 
 ### CommonJS
-
-```js
-const StickEngine = require('@boruto_vk7/stickengine').default;
-
-const sticker = await StickEngine.create(buffer, {
-  metadata: { pack: 'My Pack', author: 'Bot' },
+```javascript
+const StickEngine = require('@boruto_vk7/stickengine');
+
+const buffer = await StickEngine.toBuffer('./video.mp4', {
+  Dirtemp: '/tmp/meus-stickers',
+  watermark: false,
+  fit: 'natural',
+  metadata: { pack: 'Meu Pack', author: 'Bot' }
 });
 ```
 
-### Even shorter
+### Com marca d'água LOGO
 
-```ts
-const buf = await StickEngine.toBuffer(media, {
-  metadata: { pack: 'Waguri', author: 'Evolution' },
+```javascript
+await StickEngine.create('./imagem.png', {
+  Dirtemp: './temp',
+  watermark: true,
+  metadata: { pack: 'Lagos', author: 'Solutions' }
 });
-```
-
-Accepts **file path**, **http(s) URL**, or **Buffer**.
-
----
-
-## Sticker framing (`fit`)
-
-By default StickEngine uses **`fit: 'natural'`** — the **real WhatsApp sticker look**:
 
-- keep the original aspect ratio  
-- longest side becomes **512px**  
-- no forced square, no center-crop, no black bars  
-
-Examples: `1080×1920` → `288×512` · `1920×1080` → `512×288`
-
-```ts
-await StickEngine.create(input, {
-  fit: 'natural',  // default — normal WA sticker geometry
-  // fit: 'cover',    // force 512×512 square (center-crop)
-  // fit: 'contain',  // square 512×512 + transparent margins
-  // fit: 'fill',     // stretch (distorts)
-  // fit: 'none',     // only shrink if larger than 512
+await StickEngine.create('./imagem.png', {
+  watermark: { image: './logo.png', position: 'center', size: 0.4, opacity: 0.6 },
+  metadata: { pack: 'Pack', author: 'Author' }
 });
-```
-
-| `fit` | Look |
-|-------|------|
-| `natural` (default) | Proportional sticker, max side 512 — **normal WA style** |
-| `cover` | Full square 512×512, crops edges |
-| `contain` | Full image in a square, transparent pad (never black) |
-| `fill` | Stretched to square |
-| `none` | Shrink-only if larger than 512 |
-
----
 
-## Result object
-
-```ts
-interface StickResult {
-  path: string;       // absolute path to .webp
-  buffer: Buffer;     // send this to WhatsApp
-  base64: string;     // raw base64 (no data: prefix)
-  animated: boolean;
-  width: number;
-  height: number;
-  size: number;       // bytes
-}
+await StickEngine.create('./imagem.png', {
+  watermark: false,
+  metadata: { pack: 'Sem marca', author: 'Bot' }
+});
 ```
 
 ---
 
-## Options
+## 🎨 Modos de Enquadramento
 
-```ts
-await StickEngine.create(input, {
-  metadata: {
-    pack: 'Pack name shown in WhatsApp',
-    author: 'Publisher name',
-    emojis: ['🔥', '✨'],
-    id: 'optional-stable-pack-id',
-  },
-
-  fit: 'natural',     // natural | cover | contain | fill | none
-  fps: 15,            // animated FPS
-  quality: 95,        // 1–100 (static default high; anim auto-shrinks)
-  maxDuration: 6,     // seconds (WA-friendly)
-
-  edit: {
-    // static images only
-    circle: true,
-    greyscale: false,
-    sepia: false,
-    blur: 0,
-    brightness: 0,    // -1 … 1
-    contrast: 0,      // -1 … 1
-    text: {
-      content: 'TOP',
-      color: 'WHITE',
-      stroke: true,   // outlined caption
-    },
-  },
-
-  // transparent: 'REMOVE_BG_API_KEY', // static only (remove.bg)
-  autoClean: false,
-  tempDir: './tmp_stickengine',
-});
+```javascript
+await StickEngine.create(input, { fit: 'natural' });
 ```
 
-| Option | Default | Description |
-|--------|---------|-------------|
-| `metadata.pack` | `StickEngine` | Sticker pack title |
-| `metadata.author` | `Borutovk7` | Pack publisher |
-| `fit` | `natural` | Sizing mode — `natural` = proportional WA sticker |
-| `fps` | `15` | Animated frame rate |
-| `quality` | `80` | WebP quality; auto-lowers for large animations |
-| `maxDuration` | `6` | Trim long videos/GIFs |
-| `edit` | `false` | Jimp filters (static only) |
-| `transparent` | `false` | remove.bg API key / key list |
-| `autoClean` | `false` | Set `true` only if you manage file lifetime yourself |
+| Fit | Resultado |
+|-----|-----------|
+| `natural` (padrão) | Mantém proporção, lado maior = 512px - visual real do WhatsApp |
+| `cover` | Força 512x512 quadrado com corte central |
+| `contain` | Encaixa dentro de 512x512 com fundo transparente |
+| `fill` | Estica para 512x512 |
+| `none` | Só diminui se maior que 512, nunca aumenta |
 
 ---
 
-## Animated stickers & EXIF
+## 📁 Dirtemp Personalizado
 
-WhatsApp animated stickers are **animated WebP** with EXIF pack metadata.
+Aceita qualquer alias:
 
-StickEngine:
+```javascript
+new StickEngine({ Dirtemp: './minha-pasta' })
+new StickEngine({ tempDir: './minha-pasta' })
+new StickEngine({ dirTemp: './minha-pasta' })
+```
 
-1. Detects GIF / MP4 / animated WebP  
-2. Encodes with `libwebp` (loop, alpha, duration cap)  
-3. Shrinks quality/FPS until size is under ~1MB  
-4. Writes EXIF using the correct **node-webpmux** path for your installed version  
-   - never crashes with `Using save for animations…`  
-   - falls back across v1 `muxAnim` and v3 `save({ frames })`
+Padrão: `os.tmpdir()/stickengine`
 
 ---
 
-## Baileys
+## 💧 Marca d'água LOGO
 
-```ts
-import StickEngine from '@boruto_vk7/stickengine';
+Sua logo `logo.png` é usada automaticamente:
 
-export async function sendSticker(sock: any, jid: string, media: Buffer) {
-  const { buffer } = await StickEngine.create(media, {
-    metadata: {
-      pack: 'Waguri Evolution',
-      author: 'Borutovk7',
-      emojis: ['💜'],
-    },
-    fit: 'natural',
-  });
-
-  await sock.sendMessage(jid, { sticker: buffer });
-}
+```javascript
+{ watermark: true }
+{ watermark: false }
+{ watermark: './caminho/para/outra-logo.png' }
+{ watermark: { image: './logo.png', position: 'bottom-right', size: 0.25 } }
+{ marcaDagua: true }
 ```
 
----
+Posições: `bottom-right`, `bottom-left`, `top-right`, `top-left`, `center`
 
-## More APIs
+---
 
-### Instance pipeline
+## 🔄 Compatibilidade com código antigo
 
-```ts
-const engine = new StickEngine({
-  metadata: { pack: 'Studio', author: 'You' },
-  fit: 'cover',
+```javascript
+const { sendImageAsSticker } = require('@boruto_vk7/stickengine');
+await sendImageAsSticker(conn, jid, './foto.jpg', quoted, {
+  packname: 'Meu Pack',
+  author: 'Bot',
+  categories: ['🔥']
 });
-
-const sticker = await engine.build('./clip.mp4');
-engine.clean(); // optional temp cleanup
-```
-
-### Batch queue
-
-```ts
-const engine = new StickEngine({ metadata: { pack: 'Batch', author: 'Bot' } });
-engine.add('./a.jpg', './b.gif', buffer);
-const results = await engine.start();
-// PromiseSettledResult<string>[] → value = path when fulfilled
-```
-
-### Text sticker
-
-```ts
-const engine = new StickEngine();
-const sticker = await engine.createTextSticker('ARISE', { color: 'WHITE' });
-```
-
-### Tray icon (96×96)
-
-```ts
-const trayPath = await engine.createTrayIcon('./logo.png');
-```
-
-### Events
-
-```ts
-engine.on('st.start', ({ index }) => {});
-engine.on('st.info', (info) => {});
-engine.on('st.data', ({ file, animated }) => {});
-engine.on('st.done', (result) => {});
-engine.on('st.error', ({ error }) => {});
 ```
 
 ---
 
-## API surface
+## 📊 Testado
 
-| Method | Description |
-|--------|-------------|
-| `StickEngine.create(input, opts?)` | One-shot → `StickResult` |
-| `StickEngine.toBuffer(input, opts?)` | One-shot → `Buffer` |
-| `StickEngine.toBase64String(input, opts?)` | One-shot → base64 |
-| `engine.build(input)` | Instance one-shot |
-| `engine.addFile` / `engine.add` / `engine.start` | Batch queue |
-| `engine.createTextSticker(text, opts?)` | Text → sticker |
-| `engine.createTrayIcon(input)` | Pack tray WebP |
-| `engine.clean()` | Delete tracked temps |
-| `getBuffer(url)` | Download helper |
+- ✅ PNG, JPG, WEBP transparente, GIF, MP4, WEBM
+- ✅ Buffer, Path local, URL https, Data URI base64, Base64 puro
+- ✅ Dirtemp custom
+- ✅ Watermark logo e texto
+- ✅ Fit natural, cover, contain, fill, none
+- ✅ ESM + CJS dual package
+- ✅ Foto real com logo Lagos Solutions no canto e no centro
 
 ---
 
-## Project standards
-
-- TypeScript source, dual **ESM + CJS** emit  
-- Strict typing for options and results  
-- Zero config for the happy path  
-- Designed for long-running bot processes  
+## 📄 Licença
 
----
-
-## Author
-
-**Borutovk7** — creator of StickEngine.
-
-If you ship stickers at scale, this is the engine you want under the hood.
-
----
+MIT - Lagos Solutions
 
-## License
+![Lagos Solutions](./logo_small.png)
 
-MIT © Borutovk7
+**SOLUÇÕES INTELIGENTES. RESULTADOS REAIS.**