1.0.0 release

Author: MasterOdin

.eslintrc.js

@@ -1,16 +1,19 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  /*parserOptions: {
+  parserOptions: {
     project:'./tsconfig.json'
-  },*/
+  },
   plugins: ['@typescript-eslint'],
-  extends: ['plugin:@typescript-eslint/recommended'],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
   rules: {
     "indent": "off",
-    "semi": "error",
+    "@typescript-eslint/brace-style": ["error", "stroustrup"],
     "@typescript-eslint/camelcase": "off",
     "@typescript-eslint/indent": ["error", 2],
-    "@typescript-eslint/no-explicit-any": "off"
-    // not yet released - "@typescript-eslint/semi": ["error"]
+    "@typescript-eslint/semi": ["error"]
   }
-}
+}

CHANGELOG.md

@@ -1,27 +1,4 @@
 # Changelog
 
-## v1.3.3
-* Add missing cookie-parser dependency
-
-## v1.3.1
-* Add back in `app.expressListen`
-* Make `app.listen` to be equivalent to v1.2.1 `app.listen` functionality
-* Remove `app.cogListen` as it's equivalent to `app.listen`
-* Use `utf-8` instead of `ascii` when reading the cog.json file
-
-## v1.3.0
-* Rewrite module to use TypeScript
-* Added `app.cogListen` function which incorporates the old overriden `app.listen` functionality.
-* Remove `app.express` and `app.express_listen`. Simply import `express` or use `app.listen` instead.
-
-## v1.2.1
-* Fix undefined reference to logger.log (should be logger.info) when using @cisl/logger
-
-## v1.2.0
-* Use @cisl/logger if installed over console
-
-## v1.1.0
-* Added [ejs](https://ejs.co/) as the view engine
-
 ## v1.0.0
-* Initial Release
+* Initial Release (as @cisl/express)

LICENSE.md

@@ -1,9 +1,9 @@
 MIT License
 
-Copyright (c) 2019 CISL
+Copyright (c) 2019 Cognitive and Immersive Systems Lab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,7 +1,7 @@
 # @cisl/express
 
-An opinionated wrapper around the popular [express](https://expressjs.com/) library as
-well as [socket.io](https://socket.io/).
+An opinionated wrapper around the popular [express](https://expressjs.com/) and [websockets/ws](https://github.com/websockets/ws) libraries. It assumes that you are running
+an application with a `cog.json` file.
 
 The library assumes that you want to use `cookie-parser`, `body-parser` (namely JSON),
 `json spaces` set to 2, and use `ejs` as the view engine. Finally, the port is
@@ -12,50 +12,71 @@ used from the `cog.json` file.
 npm install @cisl/express
 ```
 ## Usage
+In straight JS:
 ```js
 const express = require('@cisl/express');
-// or typescript
-import app from '@cisl/express';
+const app = express();
+app.listen();
+```
 
+or in TypeScript:
+```typescript
+// or typescript
+import express from '@cisl/express';
 const app = express();
+
 app.listen();
 ```
+The `listen` method above does not accept any parameters, and will automatically use the
+port specified in the `cog.json` file that should exist in current working directory when
+running the above.
 
-and then it can be used the same as a regular express object:
+After creating the object, it can be used as a regular express app:
 ```js
 app.get('/', (req, res) => {
     res.json({'msg': 'Hello World'});
 });
 ```
 
-as well as accessing the attached socket.io instance:
+as well as accessing the attached WebSocket server:
 ```js
-app.socketio.on('connection', (socket) => {
+app.wsServer.on('connection', (socket) => {
     console.log('a user connected');
+    socket.on('message', data => {
+        console.log(`Received: ${data}`);
+        socket.send('pong');
+    });
 });
 ```
 
-If you want to disable the socket.io instance, pass in `{socketio: false}` to the `express`
-function.
+The available objects off the original (in addition to the normal express stuff) is:
+* `expressListen` - original express listen method, should largely not be necessary/used over `listen()`
+* `httpServer` - the underlying `HttpServer` instance
+* `wsServer` - the underlying `WebSocket.Server` instance
 
-If you need the original listen method, it can be accessed through `app.expressListen`.
-Socket.io is expressed through `app.socketio`.
 
-Additionally, the package will automatically add a `/test` GET route that returns
+Finally, the package will automatically add a `/test` GET route that returns
 a JSON object with the following definition:
 ```json
 {
     "response": "AOK",
     "error": null
 }
 ```
-which can be used as a small healthcheck for these applications.
+which can be used as a small healthcheck for apps running `@cisl/express`.
 
 ## Configuration
 Using this package assumes you have a `cog.json` file with at least the following
 in it:
 ```typescript
 {
-    "port": string | number
+    "port": number
 }
 ```
+
+## Output
+`@cisl/express` will only output a single line when you run the
+`listen()` command with the following message `@cisl/express listening on port <PORT>`.
+This will be output as a standard `console.log`, or if you have `@cisl/logger` installed,
+using `logger.info`. You can silence the output, by sending `{quiet: True}` to the
+`express()` method above.