@lzif/zaileys 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 zaadevofc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/QWEN.md

@@ -0,0 +1,135 @@
+# Zaileys - WhatsApp Node.js TypeScript/JavaScript API
+
+## Project Overview
+
+Zaileys is a powerful, type-safe wrapper around Baileys, designed to simplify the development of WhatsApp bots. It provides a robust architecture with built-in state management, middleware support, and easy-to-use event handlers, making it perfect for building scalable and maintainable WhatsApp applications.
+
+This library targets Node.js and TypeScript developers, providing an opinionated API that handles the complexity of managing raw WhatsApp socket connections. It includes essential features like rate limiting, session management, and input validation out of the box.
+
+### Key Features
+- ✅ **Auto-Cleanup** - Automatically delete old messages to keep database light
+- ✅ **Intelligent Health Manager** - Auto-recovery and connection monitoring
+- ✅ **History Filtering** - Smart filtering of old history sync messages
+- ✅ **Type-Safe** - Full TypeScript + Zod validation with autocomplete
+- ✅ **Middleware** - Intercept and process events globally
+- ✅ **Plugin System** - Drop-in file-based plugins
+- ✅ **State Management** - Built-in `JetDB` for data persistence with **auto chunking**
+- ✅ **Event-Driven** - Clean listeners for `connection`, `messages`, `calls`
+- ✅ **Rate Limiting** - Anti-spam protection out of the box
+- ✅ **Auto-Everything** - Auto-read, auto-reject calls, auto-mentions
+- ✅ **Multi-Device** - QR code or Pairing Code authentication
+- ✅ **Built-in FFmpeg** - No external dependencies for media processing
+- ✅ **Interactive Buttons** - Simple buttons, URL, copy code, call buttons, and lists
+
+## Architecture
+
+### Core Concepts
+- **Client** - Your bot's brain. Manages connections, events, and the entire lifecycle.
+- **Context** - Rich event objects with all the data and helpers you need.
+- **Middleware** - Pre-process events for logging, auth, spam filtering, or custom logic.
+- **Plugins** - Drop files in `plugins/` directory. Auto-loaded, zero config.
+- **Store** - JSON database (`JetDB`) that auto-syncs chats, contacts, and messages.
+
+### Project Structure
+```
+src/
+├── Auth/          # Authentication related modules
+├── Classes/       # Core class implementations (Client, Middleware, etc.)
+├── Config/        # Configuration modules
+├── Listener/      # Event listeners
+├── Modules/       # Core functionality modules (store, limiter, zod)
+├── Signal/        # Signal handling for different features (groups, privacy, etc.)
+├── Types/         # Type definitions
+└── Utils/         # Utility functions
+```
+
+## Building and Running
+
+### Prerequisites
+- Node.js v20+ 
+- TypeScript (for best experience)
+
+### Installation
+```bash
+npm install zaileys
+```
+
+### Build Commands
+From the `package.json`:
+- `npm run build` - Build the project using tsup
+- `npm run test` - Run tests with tsx
+- `npm run r:patch` - Build and publish a patch version
+- `npm run r:minor` - Build and publish a minor version
+- `npm run r:major` - Build and publish a major version
+
+### Quick Start Example
+```typescript
+import { Client } from 'zaileys';
+
+const wa = new Client({
+  // dynamic session you can change
+  session: 'zaileys', // default
+
+  // qr code
+  authType: 'qr',
+
+  // pairing code
+  authType: 'pairing',
+  phoneNumber: 6280000000,
+
+  // if you want to disable built-in ffmpeg
+  // disableFFmpeg: true,
+
+  sticker: {
+    authorName: 'your name',
+    packageName: 'package name',
+    quality: 80,
+    shape: 'circle', // output sticker must be circle
+  },
+});
+
+wa.on('messages', async (ctx) => {
+  if (ctx.text == 'ping') {
+    await wa.send(ctx.roomId, 'Pong! 🏓');
+  }
+});
+```
+
+## Development Conventions
+
+### TypeScript Configuration
+- Target: ES2022
+- Module: ESNext
+- Strict mode: disabled (for compatibility)
+- Module resolution: bundler
+
+### Dependencies
+- **Core**: `baileys` (WhatsApp Web API), `jetdb` (JSON database)
+- **Validation**: `zod` (type validation)
+- **Media**: `@ffmpeg-installer/ffmpeg`, `@ffprobe-installer/ffprobe`, `sharp`
+- **Utilities**: `lodash`, `pino` (logger), `nanospinner`, `rate-limiter-flexible`
+
+### Architecture Patterns
+- Event-driven architecture with EventEmitter
+- Proxy-based class injection for modular functionality
+- Plugin system with auto-loading capabilities
+- Middleware pattern for request processing
+- Health management with auto-recovery
+
+### Code Structure
+- Main client class combines functionality through interface merging
+- Signal classes handle specific WhatsApp features (groups, privacy, etc.)
+- Store module manages data persistence and caching
+- Utility functions provide common operations
+- Type definitions ensure type safety throughout the codebase
+
+## Testing
+The project uses a test script that can be run with `npm run test`, which executes examples/test.ts with tsx in watch mode.
+
+## Contributing
+Based on the README, contributions are welcome following the standard GitHub workflow:
+1. Fork the repository
+2. Create a new branch for your feature
+3. Commit your changes
+4. Push to your branch
+5. Open a Pull Request