AIOChatWC

AIOChatWC or in other words All in one chat web component is a highly configurable chat solution that includes a web component for embedding chat functionality into your frontend and a backend service for managing chat logic, authentication, and database interactions.

Features

• Web Component: Easily embed a chat widget into your application.
• Backend Service: Manage chat logic, authentication, and database interactions.
• Authentication: Supports multiple authentication methods, including JWT, Proxy, and Custom.
• Database Support: Works with SQLite, MySQL, and PostgreSQL.
• Customizability: Override default behavior for both the web component and backend service.

---

Documentation

The documentation is divided into two main sections:

1. Web Component: Learn how to set up and configure the AIOChatWC web component.
2. Service: Understand the backend service, its configuration, and customization options.

---

Quick Start

Installation

Install the package:

npm install aio-chat-wc

Also, ensure Vue.js is installed in your project:

npm install vue

Web Component

The AIOChatWC web component allows you to embed a chat widget into your application. It supports two ways to initialize:

1. Using the <chat-widget> HTML Element:

   <chat-widget user_id="123" service_url="https://your-backend.com"></chat-widget>

2. Using the initChatWidget Function:

   import { initChatWidget } from 'aio-chat-wc';
   
   initChatWidget({
     user_id: 123,
     service_url: 'https://your-backend.com',
     container: document.querySelector('#chat-container')
   });

For more details, refer to the Web Component Documentation.

---

Service

The AIOChatWC service provides the backend functionality required for chat, including database management, authentication, and chat logic.

Key Features

• Authentication: Supports Direct, Auth Endpoint, JWT, Proxy, and Custom authentication methods.
• Database: Works with SQLite, MySQL, and PostgreSQL. Includes migration utilities.
• Customizability: Override default chat logic and user filtering.

Setup

1. Create a file to start the service (e.g., chat_service.js).

2. Import and start the service:

   import { startService } from 'aio-chat-wc/service';
   
   startService(config)
     .then(() => console.log("Chat service started successfully."))
     .catch((err) => console.error("Failed to start chat service:", err));

3. Add a start command to your package.json:

   "scripts": {
     "start:service": "node path/to/chat_service.js"
   }

For more details, refer to the Service Documentation.

---

Configuration

Both the web component and service are highly configurable. Key configuration options include:

• Web Component:

  • service_url: The base URL of the chat service.
  • user_id: The ID of the authenticated user.
  • token: The JWT token used for authentication.

• Service:

  • DB_TYPE: Type of database (sqlite, mysql, or postgres).
  • AUTH_MODE: Authentication mode (direct, auth-endpoint, jwt, proxy, or custom).
  • user_mapping: Map user fields to your database schema.

For a full list of configuration options, refer to the Configuration Documentation.

---

Authentication

AIOChatWC supports multiple authentication methods:

1. Direct: Quick prototyping with minimal setup.
2. Auth Endpoint: Verifies users through a backend endpoint.
3. JWT: Uses existing JWT authentication systems.
4. Proxy: Routes all chat requests through an authenticated backend.
5. Custom: Implements custom authentication logic.

For detailed instructions, refer to the Authentication Documentation.

---

Database

AIOChatWC supports SQLite, MySQL, and PostgreSQL. It includes migration utilities to set up and manage the database schema.

• SQLite: Ideal for quick setups or local development.
• MySQL/PostgreSQL: Recommended for production environments.

For more details, refer to the Database Documentation.

---

Customization

AIOChatWC is designed to be highly customizable:

• Web Component: Customize the widget's behavior. In the future change modes and appearance.
• Service: Override default chat logic, user filtering, authentication and connect it to your existing database.

For advanced use cases, refer to the Chat Service Documentation.

---

Best Practices

1. Change Default Authentication Method: Avoid using the default authentication method (direct) in production. Choose an authentication method that best fits your application's needs, such as jwt, proxy, or custom.
2. Update Authentication Defaults: Replace default authentication values like TOKEN_SECRET and PROXY_SECRET with secure, unique values to enhance security.
3. Migrations: Before running migrations on existing database make sure to check documentation on User Entity customization

---

Troubleshooting

Common Issues

• Authentication Errors: Ensure secrets and token names match between your app and the chat service.
• CORS Issues: Configure CORS on both your proxy endpoint and the chat service.
• Database Errors: Verify your database configuration and run migrations.

For more help, check the GitHub repository or create a new issue.

---

License

This project is licensed under the MIT License.