chef-socket

chef-socket

static files server designed for node written in typescript, with tests

with web-sockets micro-service manager, at the same port

• express for routing
• socket.io for websockets

Chat Demo

https://chef-socket.pietal.dev/

Chat using CLI

$ yarn add chef-socket
$ yarn chef-socket node_modules/chef-socket/demo --plugin node_modules/chef-socket/chat.js

Chat using node.js

const { cook, chat } = require("chef-socket");

cook({
  folder: "node_modules/chef-socket/demo",
  plugins: { chat },
}).then((server) => {
  console.log(server.config);
});

Serve folder CLI

$ npx chef-socket folder [--plugin node_modules/chef-socket/chat.js]

Serve folder node.js

const { cook } = require("chef-socket");

cook({ folder: "folder" }).then((server: Express.Application) => {
  // server api is get, post, any
  server.any("/*", (req: Express.Request, res: Express.Response) => {
    res.end("200 OK");
  });
});

• minimal configuration is zero configuration, all values have defaults
• if folder param is omitted default index.html is read from folder = '.'
• serves from http://localhost:3000 unless port specified

Configuration

For more information about config parameters read:

• The default configuration https://github.com/chef-js/core#configuration
• The parameters types https://chef-js.github.io/core/types/Config.html

Plugins

The plugins are a mighty thing, think of them like chat rooms,

after a client handshakes the chat room, his messages start being forwarded to that room,

and it is being handled there by the room's own plugin.

This means you can have for example: a chat server and other unrelated websocket services

at the same port as the files server too. One client may be in many rooms.

STEP 1: Before Connection

• client -> socket.io-client connects to location.origin.replace(/^http/, 'ws')
• server -> waits for any incoming config.join events

STEP 2: Connection

• client -> sends join event with room name (topic/plugin name)
• server -> if such plugin is configured joins client to that plugin

STEP 3: After Connection

• client -> does some actions (emits, receives)
• server -> plugin responds to websocket actions

STEP 4: Finish Connection

• client -> disconnects after some time
• server -> broadcasts to all plugins from room that client left (config.leave)

API

• a plugin is a function (ws, { id, event, data })
• it is called each time the frontend websocket emits to server
• you have to handle first join etc. yourself
• context (this) of each plugin is the server instance.
• plugins receive and send the events in the format of:

type Event = {
  id: string;      // socket gains unique id on connection
  event: string;   // event name to send in frontend/receive in backend
  data?: any;      // defaults to undefined, can be serializable primitive or JSON
}

License

MIT