npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fiction-chat-server

v1.0.6

Published

A chat plugin for Node.js/Nest.js projects using WebSockets

Downloads

323

Readme

Fiction Chat Server

Fiction Chat Server is an npm package designed to integrate real-time chat capabilities into your backend server. It manages WebSocket connections and handles chat requests, forming the backend of the Fiction Chat system. To work correctly, this package requires the fiction-chat-client package for the frontend.

Note: This package is intended to be used with fiction-chat-client, which provides the frontend chat functionality for a complete chat solution.

Installation

Install the package using npm:

bash

Copy code

  • npm install fiction-chat-server

    Configuration

To use Fiction Chat Server, create a route on your server that sets up and configures the Fiction Chat instance as shown in the example below.

Example Setup

javascript


 import { FictionChat } from 'fiction-chat-server';
   
 const fictionChatConfig = {
     dbUrl: process.env.DATABASE_URL,
     websocketPort: parseInt(process.env.WEBSOCKET_PORT || '8080'),
     userTableConfig: {
         tableName: 'User',
         idColumn: 'id',
         fullNameColumn: 'name',
         profilePictureColumn: 'avatar'
     },
     jwtSecret: process.env.JWT_SECRET,
     jwtUserIdColumn: 'id'
 };
   
 const fictionChat = new FictionChat(fictionChatConfig);
   
 // Wait for initialization before accepting requests
 await new Promise((resolve) => {
     const checkInit = () => {
         if (fictionChat.initialized) {
             resolve();
         } else {
             setTimeout(checkInit, 100);
         }
     };
     checkInit();
 });
   
 export default async function handler(req, res) {
     if (req.method === 'OPTIONS') {
         return res.status(200).end();
     }
   
     const queryparammethod = req.query.method;
     const newReq = {
         ...req,
         url: `/${queryparammethod}`,
         method: queryparammethod,
         headers: req.headers
     };
   
     if (!fictionChat.initialized) {
         return res.status(400).json({ error: 'FictionChat is not initialized' });
     }
   
     return fictionChat.handleRequest(newReq, res);
 }

Environment Variables

The following environment variables are required:

  • DATABASE_URL: URL of your database.

  • WEBSOCKET_PORT: Port number for the WebSocket server (default is 8080).

  • JWT_SECRET: Secret key for JWT authentication.

    Database Configuration

Fiction Chat Server requires a table to store user information. In the configuration object (userTableConfig), specify the following fields:

  • tableName: The name of the table in your database.

  • idColumn: The unique identifier column for users.

  • fullNameColumn: The column storing users' full names.

  • profilePictureColumn: The column storing users' profile pictures (optional).

    Example Implementation

For a full implementation of Fiction Chat Server and Client in a Next.js application, refer to the fiction-chat-example repository.

  • Backend Implementation: Check out the route.js file for the backend setup of the chat server here.

    Support

For any questions or issues, contact us: