@boruto_vk7/stickengine 0.0.1-alpha → 0.0.2-alpha

package/README.md

@@ -1,131 +1,135 @@
-# StickEngine: Gerador de Stickers para WhatsApp
+# StickEngine
 
-Bem-vindo ao **StickEngine**, um módulo Node.js robusto e flexível para a criação de stickers personalizados para WhatsApp. Desenvolvido para ser eficiente e compatível com diversos ambientes, o StickEngine permite transformar imagens e vídeos em stickers WebP com metadados personalizados, além de oferecer funcionalidades como remoção de fundo.
+[![npm](https://img.shields.io/npm/v/@boruto_vk7/stickengine)](https://www.npmjs.com/package/@boruto_vk7/stickengine)
+[![license](https://img.shields.io/npm/l/@boruto_vk7/stickengine)](https://github.com/Borutovk7/StickEngine/blob/main/LICENSE)
 
-## Funcionalidades Principais
+Módulo Node.js para criação de stickers para WhatsApp — feito pra funcionar em qualquer lugar, do **Termux no seu celular** até um servidor dedicado. Sem dependências nativas complicadas, sem dor de cabeça na instalação.
 
--   **Geração de Stickers WebP**: Converte imagens (JPG, PNG, GIF) e vídeos (MP4, WebM) para o formato WebP, otimizado para stickers do WhatsApp.
--   **Metadados Personalizados (EXIF)**: Adiciona informações como nome do pacote, autor e emojis diretamente no sticker.
--   **Suporte a URLs, Buffers e Caminhos Locais**: Flexibilidade na entrada de dados para a criação dos stickers.
--   **Remoção de Fundo (Opcional)**: Integração com a API `remove.bg` para remover o fundo de imagens, ideal para criar stickers transparentes.
--   **Compatibilidade CJS e ESM**: O módulo pode ser utilizado tanto em projetos CommonJS (`require`) quanto em módulos ES (`import`).
+> Sabe aquele sofrimento de tentar rodar um módulo de sticker no Termux e quebrar tudo por causa do `sharp` ou de alguma lib nativa? O StickEngine foi criado exatamente pra resolver isso. Aqui funciona.
 
-## Instalação
+## Por que o StickEngine?
+
+- ✅ **Funciona no Termux** — sem `sharp`, sem compilação nativa, sem erro de permissão
+- ✅ **Funciona em VPS, Replit, Railway, servidor dedicado** — em qualquer ambiente
+- ✅ **Zero configuração extra** — instala e já usa
+- ✅ **Suporte a ESM e CJS** — compatível com qualquer projeto
+- ✅ **Entrada flexível** — URL, Buffer ou caminho local, tanto faz
+
+## Requisitos
 
-Para utilizar o StickEngine, você precisará ter o Node.js e o `ffmpeg` instalados em seu sistema. O `ffmpeg` é essencial para a conversão de mídia.
+- Node.js 16+
+- [ffmpeg](https://ffmpeg.org/) instalado no sistema
 
 ```bash
-# Instale as dependências do Node.js
-pnpm install axios fluent-ffmpeg node-webpmux file-type jimp remove.bg node-fetch
+# Termux
+pkg install ffmpeg
 
-# Certifique-se de ter o ffmpeg instalado e acessível no PATH do seu sistema.
-# Para sistemas baseados em Debian/Ubuntu:
-sudo apt update && sudo apt install ffmpeg
-# Para outras plataformas, consulte a documentação oficial do ffmpeg.
+# Debian/Ubuntu/VPS
+sudo apt install ffmpeg
 ```
 
-## Uso
+## Instalação
+
+```bash
+npm install @boruto_vk7/stickengine
+```
 
-O StickEngine é projetado para ser fácil de usar, com uma API baseada em classes e eventos para feedback de progresso.
+## Uso
 
-### Exemplo de Uso (ESM - `index.js`)
+### ESM
 
 ```javascript
-import StickEngine from './index.js';
+import StickEngine from '@boruto_vk7/stickengine';
 
 const engine = new StickEngine({
   metadata: {
     pack: 'Meu Pack de Stickers',
-    author: 'Borutovk7 & Eduh Dev',
-    emojis: ['✨', '🚀'] // Emojis opcionais
+    author: 'Borutovk7',
+    emojis: ['✨', '🚀']
   },
-  // Para remover o fundo, forneça uma ou mais chaves de API do remove.bg
-  // transparent: ['SUA_API_KEY_REMOVEBG_1', 'SUA_API_KEY_REMOVEBG_2']
+  // Opcional: chaves da API remove.bg para remoção de fundo
+  // transparent: ['SUA_API_KEY']
 });
 
-// Eventos para acompanhar o progresso
-engine.on('st.start', (data) => console.log(`[START] Processando arquivo ${data.index}:`, data.input));
-engine.on('st.info', (data) => console.log(`[INFO] Metadados do arquivo ${data.index}:`, data));
-engine.on('st.data', (data) => console.log(`[DATA] Sticker ${data.index} gerado em:`, data.file));
-engine.on('st.error', (data) => console.error(`[ERROR] Falha no arquivo ${data.index}:`, data.error));
+engine.on('st.start', (data) => console.log(`Processando:`, data.input));
+engine.on('st.data',  (data) => console.log(`Sticker gerado:`, data.file));
+engine.on('st.error', (data) => console.error(`Erro:`, data.error));
 
-// Adicione arquivos à fila (pode ser URL, Buffer ou caminho local)
-engine.addFile('https://picsum.photos/512') // Exemplo de URL de imagem
-      .addFile('caminho/para/seu/video.mp4') // Exemplo de caminho local para vídeo
-      .addFile(Buffer.from('...')) // Exemplo de Buffer
-  .start()
-  .then(results => {
-    console.log('Processamento concluído. Resultados:', results);
-  })
-  .catch(err => {
-    console.error('Ocorreu um erro geral no processamento:', err);
-  });
+const results = await engine
+  .addFile('https://picsum.photos/512') // URL
+  .addFile('caminho/para/video.mp4')    // caminho local
+  .addFile(buffer)                      // Buffer
+  .start();
+
+console.log(results);
 ```
 
-### Exemplo de Uso (CommonJS - `index.cjs`)
+### CJS
 
 ```javascript
-const StickEngine = require('./index.cjs');
+const StickEngine = require('@boruto_vk7/stickengine');
 
 const engine = new StickEngine({
   metadata: {
-    pack: 'Meu Pack CJS',
-    author: 'Borutovk7 & Eduh Dev',
+    pack: 'Meu Pack',
+    author: 'Borutovk7',
     emojis: ['🎉']
   }
 });
 
-// Os eventos e a forma de adicionar arquivos são os mesmos do exemplo ESM.
-engine.on('st.start', (data) => console.log(`[START CJS] Processando arquivo ${data.index}:`, data.input));
-// ... (outros eventos)
+engine.on('st.start', (data) => console.log(`Processando:`, data.input));
+engine.on('st.data',  (data) => console.log(`Sticker gerado:`, data.file));
+engine.on('st.error', (data) => console.error(`Erro:`, data.error));
 
 engine.addFile('https://picsum.photos/200')
   .start()
-  .then(results => {
-    console.log('Processamento CJS concluído. Resultados:', results);
-  })
-  .catch(err => {
-    console.error('Ocorreu um erro geral no processamento CJS:', err);
-  });
+  .then(results => console.log(results))
+  .catch(err => console.error(err));
 ```
 
-### Função `getBuffer`
+## Eventos
 
-A função `getBuffer` fornecida pelo usuário foi integrada ao módulo para lidar com o download de URLs de forma robusta. Ela pode ser importada e utilizada separadamente, se necessário:
+| Evento | Descrição |
+|--------|-----------|
+| `st.start` | Disparado ao iniciar o processamento de um arquivo |
+| `st.info` | Metadados do arquivo sendo processado |
+| `st.data` | Sticker gerado com sucesso |
+| `st.error` | Erro ao processar um arquivo |
 
-```javascript
-// ESM
-import { getBuffer } from './index.js';
-
-// CJS
-const { getBuffer } = require('./index.cjs');
-
-async function downloadAndProcess() {
-  try {
-    const buffer = await getBuffer('https://example.com/image.png');
-    console.log('Buffer obtido com sucesso:', buffer.length, 'bytes');
-    // Faça algo com o buffer
-  } catch (error) {
-    console.error('Erro ao obter buffer:', error);
-  }
-}
-downloadAndProcess();
-```
+## API
+
+### `new StickEngine(options)`
+
+| Opção | Tipo | Descrição |
+|-------|------|-----------|
+| `metadata.pack` | `string` | Nome do pacote de stickers |
+| `metadata.author` | `string` | Nome do autor |
+| `metadata.emojis` | `string[]` | Emojis associados ao sticker |
+| `transparent` | `string[]` | Chaves da API remove.bg para remoção de fundo |
+
+### `.addFile(input)`
+
+Adiciona um arquivo à fila. Aceita URL, Buffer ou caminho local. Retorna a instância para encadeamento.
 
-## Notas Importantes
+### `.start()`
 
-*   **Diretrizes `async`**: Lembre-se de que as operações do StickEngine são assíncronas. Certifique-se de usar `async/await` ou `.then().catch()` para lidar com as Promises retornadas, garantindo um código funcional e sem bloqueios.
-*   **`extractMetadata` (EXIF) sem `sharp`**: A implementação da manipulação de metadados (EXIF) foi cuidadosamente desenvolvida para **não depender da biblioteca `sharp`**. Esta decisão foi tomada para garantir a máxima compatibilidade e leveza do módulo, especialmente para usuários que executam o código em ambientes com recursos limitados, como o Termux, ou em hosts que não suportam a compilação de dependências nativas como o `sharp`. Agradecemos a compreensão, caro usuário! 👊🏻
-*   **Verificação de Atualizações**: Caso encontre algum erro na execução ou comportamento inesperado, verifique se os módulos e dependências foram atualizados. Em alguns casos, pode ser necessário obter a versão mais recente do arquivo.
+Inicia o processamento da fila. Retorna uma Promise com os resultados.
+
+### `getBuffer(url)`
+
+Utilitário para baixar uma URL como Buffer.
+
+```javascript
+import { getBuffer } from '@boruto_vk7/stickengine';
+
+const buffer = await getBuffer('https://example.com/image.png');
+```
 
 ## Créditos
 
-Este módulo foi desenvolvido com base nas contribuições e inspiração de:
+- [Eduh dev](https://github.com/Borutovk7)
 
--   **Borutovk7** (GitHub: [Borutovk7](https://github.com/Borutovk7))
--   **Eduh Dev**
--   **Manus AI** (Adaptação e refatoração)
 
 ## Licença
 
-Este projeto está licenciado sob a licença ISC. Veja o arquivo `LICENSE` para mais detalhes.
+ISC

package/README.md.bak

@@ -0,0 +1,131 @@
+# StickEngine: Gerador de Stickers para WhatsApp
+
+Bem-vindo ao **StickEngine**, um módulo Node.js robusto e flexível para a criação de stickers personalizados para WhatsApp. Desenvolvido para ser eficiente e compatível com diversos ambientes, o StickEngine permite transformar imagens e vídeos em stickers WebP com metadados personalizados, além de oferecer funcionalidades como remoção de fundo.
+
+## Funcionalidades Principais
+
+-   **Geração de Stickers WebP**: Converte imagens (JPG, PNG, GIF) e vídeos (MP4, WebM) para o formato WebP, otimizado para stickers do WhatsApp.
+-   **Metadados Personalizados (EXIF)**: Adiciona informações como nome do pacote, autor e emojis diretamente no sticker.
+-   **Suporte a URLs, Buffers e Caminhos Locais**: Flexibilidade na entrada de dados para a criação dos stickers.
+-   **Remoção de Fundo (Opcional)**: Integração com a API `remove.bg` para remover o fundo de imagens, ideal para criar stickers transparentes.
+-   **Compatibilidade CJS e ESM**: O módulo pode ser utilizado tanto em projetos CommonJS (`require`) quanto em módulos ES (`import`).
+
+## Instalação
+
+Para utilizar o StickEngine, você precisará ter o Node.js e o `ffmpeg` instalados em seu sistema. O `ffmpeg` é essencial para a conversão de mídia.
+
+```bash
+# Instale as dependências do Node.js
+pnpm install axios fluent-ffmpeg node-webpmux file-type jimp remove.bg node-fetch
+
+# Certifique-se de ter o ffmpeg instalado e acessível no PATH do seu sistema.
+# Para sistemas baseados em Debian/Ubuntu:
+sudo apt update && sudo apt install ffmpeg
+# Para outras plataformas, consulte a documentação oficial do ffmpeg.
+```
+
+## Uso
+
+O StickEngine é projetado para ser fácil de usar, com uma API baseada em classes e eventos para feedback de progresso.
+
+### Exemplo de Uso (ESM - `index.js`)
+
+```javascript
+import StickEngine from './index.js';
+
+const engine = new StickEngine({
+  metadata: {
+    pack: 'Meu Pack de Stickers',
+    author: 'Borutovk7 & Eduh Dev',
+    emojis: ['✨', '🚀'] // Emojis opcionais
+  },
+  // Para remover o fundo, forneça uma ou mais chaves de API do remove.bg
+  // transparent: ['SUA_API_KEY_REMOVEBG_1', 'SUA_API_KEY_REMOVEBG_2']
+});
+
+// Eventos para acompanhar o progresso
+engine.on('st.start', (data) => console.log(`[START] Processando arquivo ${data.index}:`, data.input));
+engine.on('st.info', (data) => console.log(`[INFO] Metadados do arquivo ${data.index}:`, data));
+engine.on('st.data', (data) => console.log(`[DATA] Sticker ${data.index} gerado em:`, data.file));
+engine.on('st.error', (data) => console.error(`[ERROR] Falha no arquivo ${data.index}:`, data.error));
+
+// Adicione arquivos à fila (pode ser URL, Buffer ou caminho local)
+engine.addFile('https://picsum.photos/512') // Exemplo de URL de imagem
+      .addFile('caminho/para/seu/video.mp4') // Exemplo de caminho local para vídeo
+      .addFile(Buffer.from('...')) // Exemplo de Buffer
+  .start()
+  .then(results => {
+    console.log('Processamento concluído. Resultados:', results);
+  })
+  .catch(err => {
+    console.error('Ocorreu um erro geral no processamento:', err);
+  });
+```
+
+### Exemplo de Uso (CommonJS - `index.cjs`)
+
+```javascript
+const StickEngine = require('./index.cjs');
+
+const engine = new StickEngine({
+  metadata: {
+    pack: 'Meu Pack CJS',
+    author: 'Borutovk7 & Eduh Dev',
+    emojis: ['🎉']
+  }
+});
+
+// Os eventos e a forma de adicionar arquivos são os mesmos do exemplo ESM.
+engine.on('st.start', (data) => console.log(`[START CJS] Processando arquivo ${data.index}:`, data.input));
+// ... (outros eventos)
+
+engine.addFile('https://picsum.photos/200')
+  .start()
+  .then(results => {
+    console.log('Processamento CJS concluído. Resultados:', results);
+  })
+  .catch(err => {
+    console.error('Ocorreu um erro geral no processamento CJS:', err);
+  });
+```
+
+### Função `getBuffer`
+
+A função `getBuffer` fornecida pelo usuário foi integrada ao módulo para lidar com o download de URLs de forma robusta. Ela pode ser importada e utilizada separadamente, se necessário:
+
+```javascript
+// ESM
+import { getBuffer } from './index.js';
+
+// CJS
+const { getBuffer } = require('./index.cjs');
+
+async function downloadAndProcess() {
+  try {
+    const buffer = await getBuffer('https://example.com/image.png');
+    console.log('Buffer obtido com sucesso:', buffer.length, 'bytes');
+    // Faça algo com o buffer
+  } catch (error) {
+    console.error('Erro ao obter buffer:', error);
+  }
+}
+downloadAndProcess();
+```
+
+## Notas Importantes
+
+*   **Diretrizes `async`**: Lembre-se de que as operações do StickEngine são assíncronas. Certifique-se de usar `async/await` ou `.then().catch()` para lidar com as Promises retornadas, garantindo um código funcional e sem bloqueios.
+*   **`extractMetadata` (EXIF) sem `sharp`**: A implementação da manipulação de metadados (EXIF) foi cuidadosamente desenvolvida para **não depender da biblioteca `sharp`**. Esta decisão foi tomada para garantir a máxima compatibilidade e leveza do módulo, especialmente para usuários que executam o código em ambientes com recursos limitados, como o Termux, ou em hosts que não suportam a compilação de dependências nativas como o `sharp`. Agradecemos a compreensão, caro usuário! 👊🏻
+*   **Verificação de Atualizações**: Caso encontre algum erro na execução ou comportamento inesperado, verifique se os módulos e dependências foram atualizados. Em alguns casos, pode ser necessário obter a versão mais recente do arquivo.
+
+## Créditos
+
+Este módulo foi desenvolvido com base nas contribuições e inspiração de:
+
+-   **Borutovk7** (GitHub: [Borutovk7](https://github.com/Borutovk7))
+-   **Eduh Dev**
+-   **Manus AI** (Adaptação e refatoração)
+
+## Licença
+
+Este projeto está licenciado sob a licença ISC. Veja o arquivo `LICENSE` para mais detalhes.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boruto_vk7/stickengine",
-  "version": "0.0.1-alpha",
+  "version": "0.0.2-alpha",
   "description": "StickEngine module for creating WhatsApp stickers",
   "type": "module",
   "main": "dist/StickEngine.js",
@@ -17,9 +17,16 @@
     "build": "tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": ["sticker", "whatsapp", "stickengine"],
+  "keywords": [
+    "sticker",
+    "whatsapp",
+    "stickengine"
+  ],
   "author": "Borutovk7 <https://github.com/Borutovk7>",
-  "contributors": ["Eduh Dev", "Manus AI"],
+  "contributors": [
+    "Eduh Dev",
+    "Manus AI"
+  ],
   "license": "ISC",
   "repository": {
     "type": "git",
@@ -40,4 +47,4 @@
     "@types/node-fetch": "2.6.1",
     "typescript": "^6.0.3"
   }
-}
+}