chat-bridge

Chat Bridge

Chat Bridge is an npm package that simplifies the integration of Facebook Messenger webhook handling into your Node.js applications. It offers a convenient way to interact with the Messenger Platform, handling incoming messages, postbacks, quick replies, and more. 🚀

Table of Contents

• Table of Contents
• Features
• Installation
• Usage
• Documentation
• Contributing
• Acknowledgments
• License

Features

• Easy Integration: Simplifies the integration of Facebook Messenger webhook handling into your Node.js applications.
• Incoming Events Handling: Provides a convenient way to handle incoming events from users.
• Customizable: Offers flexibility for customization according to specific application needs.
• Event Driven: Built on an event-driven architecture, making it easy to listen for and respond to various events.
• Simple API: Provides a straightforward API for sending messages and interacting with users.
• Scalable: Designed to scale with your application, handling high volumes of incoming messages efficiently.
• Open Source: Licensed under the MIT License, Chat Bridge is open source and free to use.

Installation

Ready to get started? Install Chat Bridge using npm:

npm install chat-bridge

⚠️ Warning: Chat Bridge is currently in alpha, and is not yet ready for production use. We recommend that you do not use it in production until it reaches a stable release.

Usage

// Import the Client class
const { Client } = require('chat-bridge');

// Create a new client instance
const client = new Client({
    accessToken: 'YOUR_ACCESS_TOKEN',
    verifyToken: 'YOUR_VERIFY_TOKEN'
});

// Listen for incoming messages events
client.on('message', (event) => {
    const { sender, message } = event;

    // Send a text message back to the sender
    client.sendTextMessage(sender.id, `You wrote: ${message.text}`);
});

// Start the client
client.start(async () => {
    console.log(`Listening on ${client.page.name} (${client.page.id})`);
});

Documentation

You can read additional documents at Chat Bridge

Contributing

We welcome contributions!

Fixing a bug, adding a new feature, or improving the documentation — we're always happy to see your work.

Read up on our contributing guidelines and then check out one of our issues.

Acknowledgments

• fastify — Fast and low overhead web framework, for Node.js
• undici — HTTP/1.1 client, written from scratch for Node.js

License

Chat Bridge is licensed under the MIT License unless otherwise specified.

---

Changelog

2.0.1

Patch Changes

Chat Bridge v2.0.1 introduces documentation enhancements and workflow refinements to streamline development processes and improve project organization. Dive into the details of this incremental update:

Documentation Improvements:

• API Documentation:
  • Adds comprehensive documentation for templates, providing clear guidelines on their usage and integration within the Chat Bridge ecosystem.

Package Updates:

• Dependency Upgrades:
  • Updates package versions to leverage the latest features and improvements, ensuring compatibility and stability across the project.
  • Includes updates to various dependencies, such as fastify and undici.

Project Refactoring:

• File and Directory Restructuring:
  • Refactors project files and directories for improved organization and maintainability.
  • Ensures a more coherent structure to facilitate easier navigation and development.

Workflow Enhancements:

• GitHub Actions Workflow Updates:
  • Enhances GitHub Package workflow for authentication, ensuring secure and seamless package management.
  • Updates GitHub Actions workflows to optimize CI/CD processes and improve overall project efficiency.

Upgrading Instructions:

Upgrade to Chat Bridge v2.0.1 to benefit from enhanced documentation and streamlined workflows. Follow the updated documentation to explore the newly added templates and leverage the improved project structure for a more efficient development experience.

As always, we appreciate your feedback and contributions to making Chat Bridge a robust and reliable communication solution. Happy coding with Chat Bridge v2.0.1!