simple-ws-chat v1.1.3

TL;DR

simple-ws-chat is intended to be a simple, easily customizable, and complete SockJS chat server.

It supports many different ways of customizing what it does, while still being fully functional without using any of them, if you please.

Usage

const {createServer} = require('simple-ws-chat');

createServer(opts);

Here are all the options you can use to create a server.

// do note both the DefaultUser and DefaultRoom class are also directly exported.
export interface ServerSettings {
    /** Customized User class extending the Server.DefaultUser class. */
    User?: typeof User;
    /** Customized chatroom class extending the Server.DefaultRoom class. */
    Room?: typeof Room;
    /** Number of cluster workers to spawn.*/
    socketsProcesses?: number;
    /** Titles for HTML pages. */
    pageTitle?: string;
    /** Port to listen on.*/
    port?: number;
    socketsPrefix?: string;
    /** If you want the server to serve webpages, pass this an absolute path with the 
     * directory of pages you want 
     * (with an index.js file containing a Map, which should map each req url to a handler that returns the page html)
    */
    pageDirectory?: string;
    /** Your backend for choosing how to save / load rooms. */
    rooms?: {
        load: () => Room[] | Promise<Room[]>;
        save: () => void | Promise<void>;
        /** Use this if you want to do other stuff when creating a room. Otherwise, just use Room above.
         * Note the existence of this function takes precedence over Room being set.
        */
        create?: (name: string, server: Server, data?: any) => Promise<Room>;
    };
    /**
     * For user registration, you can either subclass Server.DefaultUser 
     * and override User#validateLogin and User#registerName,
     * or pass a function here that takes a username and password and returns a promise that resolves to a boolean.
     * You also need to pass a registration function if you're using this.
     */
    passwords?: {
        register: (this: User, name: string, pass: string) => Promise<boolean> | boolean;
        login: (this: User, name: string, pass: string) => Promise<boolean> | boolean;
    }
    /* you can use this to send authentication, ie a browser fingerprint packet. Return false 
     * if the authentication is invalid and you want to reject the socket.
     */
    validateFirstPacket?: (socketid: number, message: string) => boolean | Promise<boolean>;
}

API

Most things are either self-contained or can be accessed via customized subclasses / functions, but the Server class also exports a general listener API that can be used for various events. Here are the builtins and their params:

chat: user: User, message: string, room: Room

connect: user: User

disconnect: user: User

roomjoin: user: User, room: Room

roomleave: user: User, room: Room

roomcreate: room: Room

You can add more as you like with subclasses and so forth. In addition, the server also exposes an easy API for adding chat commands: Server#addCommands(commandTable: {[k: string]: CommandHandler}).