sockethub 5.0.0-alpha.0 → 5.0.0-alpha.3

package/bin/sockethub

@@ -1,30 +1,3 @@
 #!/usr/bin/env node
-const baseDir = process.env.DEV ? 'src' : 'dist';
-const Sockethub = require(`./../${baseDir}/sockethub`).default;
-const sockethub = new Sockethub();
-
-(async () => {
-  process.once('uncaughtException', function (err) {
-    console.log('UNCAUGHT EXCEPTION');
-    // eslint-disable-next-line security-node/detect-crlf
-    console.log(err.stack);
-    process.exit(1);
-  });
-
-  process.once('SIGTERM', function () {
-    console.log('Received TERM signal. Exiting.');
-    process.exit(0);
-  });
-
-  process.once('SIGINT', function () {
-    console.log('Received INT signal. Exiting.');
-    process.exit(0);
-  });
-
-  process.once('exit', async function () {
-    console.log('destroying all platform instances');
-    await sockethub.removeAllPlatformInstances();
-  });
-
-  sockethub.boot();
-})();
+const sockethubServer = require('@sockethub/server');
+sockethubServer();

package/build.js

@@ -0,0 +1,21 @@
+
+const fs = require('fs');
+const packageJSON = require('./package.json');
+const moduleList = Object.keys(packageJSON.dependencies);
+
+const rx = new RegExp('^@sockethub/platform-', 'i');
+const platforms = [];
+
+for (let moduleName of moduleList) {
+  if (rx.test(moduleName)) {
+    platforms.push(moduleName);
+  }
+}
+
+const data = fs.readFileSync(
+  'node_modules/@sockethub/server/sockethub.config.example.json', 'utf8');
+const config = JSON.parse(data);
+config.platforms = platforms;
+
+fs.writeFileSync(
+  './sockethub.config.json', data);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "sockethub",
   "description": "A polyglot messaging service",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.3",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "LGPL-3.0+",
-  "main": "./dist/sockethub.js",
-  "bin": "./bin/sockethub",
+  "main": "",
+  "bin": "bin/sockethub",
   "preferGlobal": true,
   "keywords": [
     "sockethub",
@@ -30,74 +30,24 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sockethub/sockethub.git",
-    "directory": "packages/sockethub"
+    "directory": "apps/sockethub"
   },
   "homepage": "https://sockethub.org",
   "dependencies": {
-    "activity-streams": "^4.4.0-alpha.0",
-    "body-parser": "^1.19.0",
-    "bull": "^4.0.0",
-    "debug": "^4.3.1",
-    "ejs": "^3.0.1",
-    "express": "^4.17.1",
-    "findup-sync": "^5.0.0",
-    "jquery": "^3.4.1",
-    "nconf": "^0.11.2",
-    "object-hash": "^3.0.0",
-    "secure-store-redis": "^1.4.7",
-    "socket.io": "^4.0.1",
-    "sockethub-platform-dummy": "^3.0.0-alpha.0",
-    "sockethub-platform-feeds": "^3.0.0-alpha.0",
-    "sockethub-platform-irc": "^4.0.0-alpha.0",
-    "sockethub-platform-xmpp": "^5.0.0-alpha.0",
-    "sockethub-schemas": "^3.0.0-alpha.0",
-    "urijs": "^1.19.2"
+    "@sockethub/platform-dummy": "^3.0.0-alpha.3",
+    "@sockethub/platform-feeds": "^3.0.0-alpha.3",
+    "@sockethub/platform-irc": "^4.0.0-alpha.3",
+    "@sockethub/platform-xmpp": "^5.0.0-alpha.3",
+    "@sockethub/server": "^5.0.0-alpha.3"
   },
   "scripts": {
-    "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 90 --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",
-    "clean": "find . -maxdepth 1 -name dist -exec rm -rv {} +",
-    "build": "yarn run clean && yarn run build:server && yarn run build:client",
-    "build:server": "tsc && cp ./src/defaults.json ./dist/defaults.json && cp src/bootstrap/platforms.js dist/bootstrap/",
-    "build:client": "webpack --config webpack.minified.config.js && webpack --config webpack.normal.config.js"
+    "build": "node build.js && test -f sockethub.config.json",
+    "clean:deps": "npx rimraf node_modules",
+    "dev": "DEBUG=sockethub* ./bin/sockethub --examples -c sockethub.config.json",
+    "start": "DEBUG=sockethub* ./bin/sockethub -c sockethub.config.json"
   },
   "engines": {
-    "node": ">= 12.0.0"
+    "node": ">= 12.4.0"
   },
-  "devDependencies": {
-    "@types/body-parser": "1.19.2",
-    "@types/chai": "4.3.0",
-    "@types/debug": "4.1.7",
-    "@types/ejs": "3.1.0",
-    "@types/eslint": "8.4.1",
-    "@types/express": "4.17.13",
-    "@types/jquery": "3.5.13",
-    "@types/mocha": "9.1.0",
-    "@types/nconf": "0.10.1",
-    "@types/node": "17.0.13",
-    "@types/object-hash": "2.2.1",
-    "@types/proxyquire": "1.3.28",
-    "@types/tv4": "1.2.31",
-    "@types/urijs": "1.19.18",
-    "@typescript-eslint/parser": "5.12.1",
-    "c8": "7.11.0",
-    "chai": "4.3.6",
-    "eslint": "8.9.0",
-    "eslint-cli": "1.1.1",
-    "eventemitter2": "6.4.5",
-    "jaribu": "2.2.3",
-    "mocha": "9.2.1",
-    "proxyquire": "2.1.3",
-    "sinon": "13.0.1",
-    "ts-node": "10.5.0",
-    "typescript": "4.5.5",
-    "webpack": "5.69.1",
-    "webpack-cli": "4.9.2"
-  },
-  "gitHead": "75337bd147d2d61a203a8f222551d3054fcedade"
+  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
 }

package/{dist/defaults.json → sockethub.config.json}

@@ -8,16 +8,18 @@
     "enabled": false,
     "secret": 1234567890
   },
-  "service": {
+  "sockethub": {
     "port": 10550,
     "host": "localhost",
     "path": "/sockethub"
   },
   "log_file": "",
-  "platforms": {
-    "whitelist": [],
-    "blacklist": []
-  },
+  "platforms": [
+    "@sockethub/platform-dummy",
+    "@sockethub/platform-feeds",
+    "@sockethub/platform-irc",
+    "@sockethub/platform-xmpp"
+  ],
   "public": {
     "protocol": "http",
     "host": "localhost",
@@ -27,6 +29,5 @@
   "redis": {
     "host": "127.0.0.1",
     "port": 6379
-  },
-  "workers": 1
+  }
 }

package/tsconfig.json

@@ -1,79 +1,17 @@
 {
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",
-    /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",
-    /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-     "lib": ["esnext"],                             /* Specify library files to be included in the compilation. */
     "allowJs": false,
-    /* Allow javascript files to be compiled. */
-    // "checkJs": true,                          /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,
-    /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
     "outDir": "dist",
-    /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    // "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": false,
-    /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    "noImplicitThis": false,
-    /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    //     "noUnusedLocals": true,                /* Report errors on unused locals. */
-    //     "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    //     "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    //     "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    "moduleResolution": "node",
-    /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    "types": ["mocha", "node"],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,
-    /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-     "sourceRoot": "/",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-     "mapRoot": "/",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-    "resolveJsonModule": true
+    "rootDir": "src",
+    "baseUrl": "/",
+    "sourceRoot": "/",
+    "mapRoot": "/",
   },
   "include": [
     "src"
   ],
   "exclude": [
-    "**/test", "**/node_modules", "**/dist", "**/*.test.ts"
+    "**/*.test.ts"
   ]
 }

package/README.md

@@ -1,98 +0,0 @@
-[![Sockethub](http://sockethub.org/res/img/sockethub-logo.svg)](http://sockethub.org)
-
-A protocol gateway for the web.
-
-## 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.
-
-## Features
-
-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'.
-
-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`.
-
-## Platforms
-
-* [Feeds](../sockethub-platform-feeds) *(RSS, Atom)*
-* [IRC](../sockethub-platform-irc) 
-* [XMPP](../sockethub-platform-xmpp) 
-
-## Install
-
-`$ npm install -g sockethub`
-
-## Running
-
-### Environment Variables
-
-* PORT
-Defaults to `10550`
-* HOST
-Defaults to `localhost`
-* DEBUG
-Specify the namespace to console log, ie. `sockethub*` will print all sockethub related debug statements, whereas `*` will also print any other modules debug statements that use the `debug` module.
-
-* REDIS_PORT
-Defaults to `6379`
-* REDIS_HOST
-Defaults to `localhost`
-
-***OR***
-
-* REDIS_URL
-Overrides `REDIS_HOST` and `REDIS_PORT`, can specify a full redis connect URL (eq. `redis://username:password@host:port`)
-
-### Command-line params
-
-```
-  --help       : this help screen
-  --info       : displays some basic runtime info
-
-  --examples   : enabled examples page and serves helper files like jquery
-
-  --host       : hostname to bind to
-  --port       : port to bind to
-```
-
-### Start
-
-Run with debug output and examples enabled:
-
-`$ DEBUG=sockethub* 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`
-
-## License
-
-Sockethub is licensed under the [LGPL](https://github.com/sockethub/sockethub/blob/master/LICENSE)
-
-## Credits
-
-Project created and maintained by [Nick Jennings](http://github.com/silverbucket)
-
-Logo design by [Jan-Christoph Borchardt](http://jancborchardt.net)
-
-Sponsored by [NLNET](http://nlnet.nl)
-
-[![NLNET Logo](http://sockethub.org/res/img/nlnet-logo.svg)](http://nlnet.nl)
-

package/config.json.example

@@ -1,32 +0,0 @@
-{
-  "activity-streams": {
-    "opts": {
-      "specialObjs": [ "credentials" ]
-    }
-  },
-  "examples": {
-    "enabled": false,
-    "secret": 1234567890
-  },
-  "service": {
-    "port": 10550,
-    "host": "localhost",
-    "path": "/sockethub"
-  },
-  "log_file": "",
-  "platforms": {
-    "whitelist": [],
-    "blacklist": []
-  },
-  "public": {
-    "protocol": "http",
-    "host": "localhost",
-    "port": 10550,
-    "path": "/"
-  },
-  "redis": {
-    "host": "redis",
-    "port": 6379
-  },
-  "workers": 1
-}