https://github.com/waithawoo/hermesockserve

Modular Websocket Server using socket.io
https://github.com/waithawoo/hermesockserve

broadcast nodejs socket socket-io websocket websocket-server

Last synced: 13 days ago
JSON representation

Modular Websocket Server using socket.io

• Host: GitHub
• URL: https://github.com/waithawoo/hermesockserve
• Owner: waithawoo
• Created: 2024-10-17T02:54:57.000Z (29 days ago)
• Default Branch: main
• Last Pushed: 2024-10-31T04:55:13.000Z (15 days ago)
• Last Synced: 2024-10-31T05:17:05.301Z (15 days ago)
• Topics: broadcast, nodejs, socket, socket-io, websocket, websocket-server
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Hermesockserve

A Modular Websocket Server and HTTP API for real-time notifications using socket.io.

HermesWS is a WebSocket server with an HTTP API for sending real-time notifications. This package combines both WebSocket and HTTP servers into one and can be used in any backend or frontend setup.

## Installation

Install it via npm:

```bash

npm install hermesockserve

```

## Usage

```js

// Import the required functions

import { startHermesWS, setHermesConfig, generateJWTToken, generateSecretKey } from 'hermesockserve';

// First, Setup the required configuration values for middlewares

// Recommend load from .env for all config values for security concerns

setHermesConfig('jwtSecret', 'JWT_SECRET')

setHermesConfig('customHeader', 'HEADER_NAME:HEADER_VALUE') // ':' must be used for delimiter

setHermesConfig('validApiKeys', ['apikey1','apikey2']) // Must be array type

// ---- Server Setup

// Setup WebSocket and HTTP servers with necessary configurations

const { expressApp, hermesWS } = await startHermesWS({

  httpPort: 3000, // This port will serve for Http and Websocket servers

  httpOptions: {

    auth_middleware_types: ['jwt', 'custom-header'] // Can use 3 types : 'api-key', 'jwt' and 'custom-header'

  },

  wsOptions: {

    auth_middleware_types: ['jwt', 'custom-header'] // Can use 3 types : 'api-key', 'jwt' and 'custom-header'

  },

  dbConfig: { dbFile: './mydb.sqlite' } // set 'null' in case of that Database is not needed

});

// Set onConnect and onDisconnect handlers 

async function onConnect (socket){

    console.log('Custom handler: New client connected with ID:', socket.id)

    this.broadcastMessage('message', 'HI I am Server1')

};

async function onDisconnect(socket, reason){

    console.log(`Custom handler: Client with ID-${socket.id} disconnected. Reason:`, reason);

};

hermesWS.setOnConnect(onConnect)

hermesWS.setOnDisconnect(onDisconnect)

// Start the main Hermes Server

hermesWS.start()

// ---- Databases

// Create create tables as needed

await hermesWS.DB().createTable('notifications', [

    'id INTEGER PRIMARY KEY AUTOINCREMENT',

    'sender_id TEXT',

    'receiver_id TEXT',

    'data TEXT',

]);

await hermesWS.DB().insert(tableName, data) // tableName : string, data : json

await hermesWS.DB().query(tableName, conditions) // tableName : string, condidtion : json

// ---- Websocket - Custom Events handlers and Channels

// You can also add Custom Event Handlers for custom channels as follows. 

// ---- Define event handlers

function onMessageChannelHandler(socket, message){

    console.log(`Received message in onMessageChannelHandler from ${socket.id}: ${message}`);

};

async function onAnnouncementChannelHandler(socket, message) {

    console.log(`Received message in onAnnouncementChannelHandler from ${socket.id}: ${message}`);

};

// ---- Register custom event handlers

hermesWS.addEventHandler('message', onMessageChannelHandler);

hermesWS.addEventHandler('announcement', onAnnouncementChannelHandler);

// Can use the hermesWS instance as 'this' in event handler functions

function onMessageChannelHandler(socket, message){

    console.log(`Received message in onMessageChannelHandler from ${socket.id}: ${message}`);

    this.broadcastMessage('announcement', 'I am Server')

};

// ---- Http - Custom API endpoints

// Add custom http routes if needed

expressApp.get('/custom-endpoint-1', (req, res) => {

  res.send('Hello from custom endpoint 1!');

});

```