@sockethub/server 5.0.0-alpha.4 → 5.0.0-alpha.6

package/README.md

@@ -1,100 +1,94 @@
-[![Sockethub](http://sockethub.org/res/img/sockethub-logo.svg)](http://sockethub.org)
-
-# Sockethub
-
-A protocol gateway for the web.
+# @sockethub/server
 
 ## About
 
-Sockethub is a translation layer for web applications to communicate with
-other protocols and services that are traditionally either inaccessible or
-impractical to use from in-browser JavaScript.
-
-Using [ActivityStream](http://activitystrea.ms/) (AS) objects to pass messages
-to and from the web app, Sockethub acts as a smart proxy server/agent, which
-can maintain state, and connect to sockets, endpoints and networks that would
-otherwise be restricted from an application running in the browser.
-
-Originally inspired as a sister project to
-[RemoteStorage](https://remotestorage.io), and assisting in the development of
-[unhosted](http://unhosted.org) and [noBackend](http://nobackend.org)
-applications, Sockethub's functionality can also fit into a more traditional
-development stack, removing the need for custom code to handle various protocol
-specifics at the application layer.
-
-Example uses of Sockethub are:
-
-* Writing and receiving messages (SMTP, IMAP, Facebook, Twitter, ...)
-
-* Instant messaging (XMPP, IRC, MSN, FB Messenger, Hangouts, ...)
-
-* Discovery (WebFinger, RDF(a), ...)
-
-The architecture of Sockethub is extensible and supports easy implementation
-of additional 'platforms' to carry out tasks.
-
-## Docs
-
-See the [Sockethub wiki](https://github.com/sockethub/sockethub/wiki) for
-documentation.
+The core Sockethub server package that handles client connections, manages platform
+instances, and orchestrates message routing between web clients and protocol platforms.
 
-## Features
+This package can be used independently if you want to build a custom Sockethub
+deployment or integrate server functionality into your own application. For a complete
+setup with all platforms and dependencies, use the main `sockethub` package instead.
 
-We use ActivityStreams to map the various actions of a platform to a set of AS
-'@type's which identify the underlying action. For example, using the XMPP
-platform, a friend request/accept cycle would use the activity stream types
-'request-friend', 'remove-friend', 'make-friend'.
+## Architecture
 
-Below is a list of platform contexts we're currently working on and their types,
-both the completed and not yet implemented ones. They are all implemented in
-Sockethub platforms (each in their own repository) and can be enabled/disabled
-in the `config.json`.
+The server implements:
 
-## Platforms
+- **Socket.IO Connection Management**: Handles web client connections and real-time communication
+- **Platform Instance Management**: Spawns and manages child processes for each protocol platform
+- **Job Queue Integration**: Uses Redis and BullMQ for reliable message queuing
+- **Middleware Pipeline**: Extensible request processing including validation and credential storage
+- **Session Management**: Per-connection credential isolation and state management
+- **Error Reporting**: Optional Sentry integration for production error monitoring and debugging
 
-* [Feeds](../platform-feeds) *(RSS, Atom)*
+## Documentation
 
-* [IRC](../platform-irc)
-
-* [XMPP](../platform-xmpp)
+For complete Sockethub documentation, see the [main repository README](../../README.md)
+and [Sockethub wiki](https://github.com/sockethub/sockethub/wiki).
 
 ## Install
 
-`$ npm install -g @sockethub/server`
+`$ bun install -g @sockethub/server`
 
 ## Running
 
+`$ DEBUG=sockethub* bunx @sockethub/server`
+
 ### Environment Variables
 
-* PORT
+- PORT
 
 Default: `10550`
 
-* HOST
+- HOST
 
 Default: `localhost`
 
-* DEBUG
+- DEBUG
 
-Specify the namespace to console log, ie. `sockethub*` will print all sockethub
+Specify the namespace to console log, e.g. `sockethub*` will print all sockethub
 related debug statements, whereas `*` will also print any other modules debug
 statements that use the `debug` module.
 
-* REDIS_PORT
+- REDIS_PORT
 
 Default: `6379`
 
-* REDIS_HOST
+- REDIS_HOST
 
 Default: `localhost`
 
 ***OR***
 
-* REDIS_URL
+- REDIS_URL
 
 Overrides `REDIS_HOST` and `REDIS_PORT`, can specify a full redis connect URL
 (eq. `redis://username:password@host:port`)
 
+#### Sentry Configuration
+
+Sentry error reporting can be configured via environment variable or config file:
+
+**Environment Variable:**
+
+- SENTRY_DSN - Set this to enable basic Sentry error reporting
+
+**Config File:**
+For more advanced Sentry configuration, add a `sentry` section to your
+`sockethub.config.json`:
+
+```json
+{
+  "sentry": {
+    "dsn": "https://your-dsn@sentry.io/project-id",
+    "environment": "production",
+    "traceSampleRate": 1.0
+  }
+}
+```
+
+When configured, the server automatically reports errors to Sentry for monitoring and
+debugging in production environments.
+
 ### Command-line params
 
 ```
@@ -111,14 +105,14 @@ Overrides `REDIS_HOST` and `REDIS_PORT`, can specify a full redis connect URL
 
 Run with debug output and examples enabled:
 
-`$ DEBUG=sockethub* sockethub --examples`
+`$ DEBUG=sockethub* bin/sockethub --examples`
 
 You should then be able to browse to `http://localhost:10550/examples` and try
 out the examples.
 
 For production, with examples disabled.
 
-`$ DEBUG=sockethub* sockethub`
+`$ DEBUG=sockethub* bin/sockethub`
 
 ## License
 

package/bin/sockethub

@@ -1,3 +1,4 @@
-#!/usr/bin/env node
-const sockethubServer = require(`./../dist/index`);
-sockethubServer();
+#!/usr/bin/env bun
+import("@sockethub/server").then((sockethub) => {
+    sockethub.server();
+});

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@sockethub/server",
   "description": "A polyglot messaging service, server libraries",
-  "version": "5.0.0-alpha.4",
+  "version": "5.0.0-alpha.6",
+  "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "LGPL-3.0+",
-  "main": "dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "src/index.ts",
   "bin": "bin/sockethub",
   "preferGlobal": true,
+  "engines": {
+    "bun": ">=1.2.4"
+  },
   "keywords": [
     "sockethub",
     "messaging",
@@ -34,64 +41,45 @@
   },
   "homepage": "https://sockethub.org",
   "dependencies": {
-    "@sockethub/activity-streams": "^4.4.0-alpha.4",
-    "@sockethub/client": "^5.0.0-alpha.4",
-    "@sockethub/crypto": "^1.0.0-alpha.4",
-    "@sockethub/data-layer": "^1.0.0-alpha.4",
-    "@sockethub/schemas": "^3.0.0-alpha.4",
-    "body-parser": "^1.19.0",
-    "debug": "^4.3.1",
-    "ejs": "^3.0.1",
-    "express": "^4.17.1",
-    "jquery": "^3.4.1",
-    "nconf": "^0.12.0",
-    "npm": "8.19.2",
-    "socket.io": "^4.0.1"
+    "@sentry/bun": "^10.15.0",
+    "@sockethub/activity-streams": "^4.4.0-alpha.6",
+    "@sockethub/client": "^5.0.0-alpha.6",
+    "@sockethub/crypto": "^1.0.0-alpha.6",
+    "@sockethub/data-layer": "^1.0.0-alpha.6",
+    "@sockethub/schemas": "^3.0.0-alpha.6",
+    "body-parser": "1.20.3",
+    "chalk": "^5.3.0",
+    "debug": "4.3.4",
+    "ejs": "3.1.10",
+    "express": "4.20.0",
+    "express-rate-limit": "^8.2.1",
+    "jquery": "3.7.1",
+    "nconf": "0.12.1",
+    "socket.io": "4.7.5"
   },
   "scripts": {
-    "clean": "npx rimraf dist coverage",
-    "clean:deps": "npx rimraf node_modules",
-    "compliance": "yarn run lint && yarn run test && yarn run coverage",
-    "test": "c8 -x src/bootstrap -x \"src/**/*.test.*\" mocha -r ts-node/register src/*.test.ts src/**/*.test.ts",
-    "coverage": "c8 check-coverage --statements 90 --branches 80 --functions 82 --lines 90",
-    "start": "DEBUG=sockethub* ./bin/sockethub",
-    "dev": "yarn run build && DEBUG=sockethub* ./bin/sockethub --examples",
-    "lint": "eslint \"**/*.ts\" ./bin/sockethub",
-    "lint:fix": "eslint --fix \"**/*.ts\" ./bin/sockethub",
-    "build": "npx rimraf dist && tsc && cp ./src/defaults.json ./dist/defaults.json && cp src/bootstrap/platforms.js dist/bootstrap/"
-  },
-  "engines": {
-    "node": ">= 14"
+    "dev": "DEBUG=sockethub* bun run --hot ./bin/sockethub --examples",
+    "start": "DEBUG=sockethub* bun run ./bin/sockethub"
   },
   "devDependencies": {
-    "@types/body-parser": "1.19.2",
-    "@types/chai": "4.3.3",
-    "@types/debug": "4.1.7",
-    "@types/eslint": "8.4.6",
-    "@types/express": "4.17.14",
-    "@types/jquery": "3.5.14",
-    "@types/mocha": "9.1.1",
-    "@types/nconf": "0.10.3",
-    "@types/node": "17.0.13",
-    "@types/proxyquire": "1.3.28",
-    "@types/sinon": "10.0.13",
-    "@typescript-eslint/parser": "5.37.0",
-    "c8": "7.12.0",
-    "chai": "4.3.6",
-    "eslint": "8.23.1",
-    "eslint-cli": "1.1.1",
+    "@types/body-parser": "1.19.5",
+    "@types/bun": "latest",
+    "@types/debug": "4.1.12",
+    "@types/express": "4.17.21",
+    "@types/jquery": "3.5.29",
+    "@types/nconf": "0.10.6",
+    "@types/sinon": "17.0.2",
     "jaribu": "2.2.3",
-    "mocha": "10.0.0",
-    "proxyquire": "2.1.3",
-    "sinon": "14.0.0",
-    "ts-node": "10.9.1",
-    "typescript": "4.8.3"
+    "sinon": "17.0.1",
+    "web-streams-polyfill": "^3.3.3"
   },
   "optionalDependencies": {
-    "@sockethub/platform-dummy": "^3.0.0-alpha.4",
-    "@sockethub/platform-feeds": "^3.0.0-alpha.4",
-    "@sockethub/platform-irc": "^4.0.0-alpha.4",
-    "@sockethub/platform-xmpp": "^5.0.0-alpha.4"
+    "@sockethub/examples": "^1.0.0-alpha.6",
+    "@sockethub/platform-dummy": "3.0.0-alpha.6",
+    "@sockethub/platform-feeds": "4.0.0-alpha.6",
+    "@sockethub/platform-irc": "4.0.0-alpha.6",
+    "@sockethub/platform-metadata": "1.0.1-alpha.1",
+    "@sockethub/platform-xmpp": "5.0.0-alpha.6"
   },
-  "gitHead": "c6d34ff44d2be479e4ea42c46da649612342a680"
+  "gitHead": "f8a937e071e7a209f94b94f63e68faa27784e00e"
 }