v0.1.0

wa-sticker-toolkit v0.1.0 – Custom Path Support 🎉 (#10)

This minor update introduces a flexible config system, giving you full control over your ffmpeg and ffprobe paths. Whether you're working in custom environments or bundling the toolkit into larger projects, this update ensures smoother integration and fewer path-related issues.

✨ What's New

• Config System Added: You can now set custom paths for ffmpeg and ffprobe using setConfig().
  Great for advanced setups or non-standard installs!

🔧 Example

const { config } = require('wa-sticker-toolkit');

config.setConfig({
  ffmpegPath: '/custom/bin/ffmpeg',
  ffprobePath: '/custom/bin/ffprobe'
});

Full Changelog:
v0.0.4...v0.1.0

v0.0.4 patch

wa-sticker-toolkit v0.0.4 – Patch Update (#6)

What's Fixes:

Quality Option for Animated Stickers: Resolved an issue where the quality option had no effect on animated stickers. Previously, adjusting the quality setting did not alter the output for animated stickers, whereas static stickers functioned correctly. This fix ensures that the quality setting now appropriately influences the file size, resolution, and compression of animated stickers.

##Upgrade Instructions:

To update to version 0.0.4, run:

npm update wa-sticker-toolkit

What's Changed

• 6 quality option not working on animated sticker by @DannyAkintunde in #7
• 6 quality option not working on animated stickers by @DannyAkintunde in #8
• Delete package-lock.json by @DannyAkintunde in #9

Full Changelog: v0.0.3...v0.0.4

v0.0.3 patch

wa-sticker-toolkit v0.0.3 – Patch Update (#2)

What's Fixed

Black Artifacts in Circle Stickers – Fixed an issue where black artifacts appeared when generating circular stickers. The processing logic was updated to ensure a clean and smooth circular crop.

Upgrade Instructions

Update to the latest version using:

npm update wa-sticker-toolkit

What's Changed

• 4 fix more artifacts on non square images by @DannyAkintunde in #5

Full Changelog: v0.0.2...v0.0.3

v0.0.2 patch

wa-sticker-toolkit v0.0.2 – Patch Update (#1)

What's Fixed

Border Artifacts on Non-Square Images – Fixed an issue where applying borders to non-square images caused unwanted lines at the top and bottom.

Upgrade Instructions

Update to the latest version using:

npm update wa-sticker-toolkit

What's Changed

• #1 fix black artifacts issue by @DannyAkintunde in #2
• Update README.md (docs) by @DannyAkintunde in #3

Full Changelog: v0.0.1...v0.0.2

v0.0.1

wa-sticker-toolkit v0.0.1 Release Notes

Release Date: 26-02-2025

We are excited to announce the initial release of wa-sticker-toolkit v0.0.1 – a versatile library for creating WhatsApp stickers from a variety of image sources.

Key Features

Sticker Creation

• Multiple Input Formats: Create stickers using Buffers, URLs, SVG strings, Base64-encoded images, or file paths.

• Animated Stickers: Convert GIFs and videos into animated WebP stickers seamlessly.

• Output Quality Control: Adjust output quality (1-100) to fine-tune your sticker results.

Customization Options

• Metadata Support: Easily embed metadata such as pack name, author, sticker ID, and categories into your stickers.

• Flexible Appearance: Choose from multiple sticker types (default, crop, fill, circle) and customize backgrounds using either a hex color or a Sharp color object.

• Text Overlays: Add text overlays with customizable content, color, font, font size, and position (top, center, bottom).

Developer-Friendly Integration

• Chained Methods: Enjoy a fluent API that allows chaining of methods for setting various properties.

• Direct Usage: Easily convert stickers to buffers, save them as files, or send them directly using popular messaging libraries like Baileys-MD.

• Backward Compatibility: Seamlessly migrate from wa-sticker-formatter or @shibam/sticker-maker with minimal changes.

Getting Started

Install via npm:

npm i wa-sticker-toolkit

Usage Example

Using the Sticker Constructor:

const { Sticker, StickerTypes } = require("wa-sticker-toolkit");

const sticker = new Sticker(image, {
  metadata: {
    pack: "My Pack",
    author: "Me",
    id: "12345",
    categories: ["😘", "😍"]
  },
  type: StickerTypes.FILL,
  quality: 50,
  background: "#000000"
});

// Convert to buffer, save to file, or send using Baileys-MD
const buffer = await sticker.toBuffer();
await sticker.toFile("sticker.webp");

Alternatively, use the helper function:

const { createSticker } = require("wa-sticker-toolkit");

const buffer = await createSticker(image, {
  metadata: { pack: "My Pack", author: "Me" },
  type: "fill",
  quality: 80,
  background: "#FFFFFF"
});

Additional Information

• Sticker Types: Four sticker types are available:

  • default

  • crop

  • fill

  • circle

• Text Overlay Options: Customize the position of text (top, center, bottom) for a personalized touch.

• WhatsApp Metadata: Stickers are embedded with Exif metadata for pack name, author, and categories to enhance discoverability on WhatsApp.

Future Enhancements

This initial release lays the groundwork for a robust sticker creation toolkit. In future updates, expect enhancements such as:

• Expanded input and output format support

• Improved performance optimizations

• Additional customization options for more dynamic sticker creation

Thank you for trying out wa-sticker-toolkit v0.0.1. We welcome feedback and contributions to help improve the toolkit!