@curveball/core - npm Package Compare versions

Comparing version 0.13.0 to 0.14.0

changelog.md

 Changelog
 =========
 
-0.13.0 (2020-06-16) (ALPHA)
----------------------------
+0.14.0 (2020-07-13)
+-------------------
 
+* Native Websocket support. If enabled, `ctx` will now have a `webSocket`
+  property.
+
+
+0.13.0 (2020-06-16)
+-------------------
+
 * Removed `Request` and `Response` interfaces again. They actually made it more
@@ -8,0 +15,0 @@ difficult to extend.

dist/application.d.ts

 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import http from 'http';
-import Context from './context';
+import { Context } from './context';
 import { HeadersInterface, HeadersObject } from './headers';
@@ -9,2 +9,4 @@ import { HttpCallback, NodeHttpRequest, NodeHttpResponse } from './node/http-utils';
 import Response from './response';
+import WebSocket from 'ws';
+import * as net from 'net';
 /**
@@ -29,2 +31,3 @@ * The middleware-call Symbol is a special symbol that might exist as a
     middlewares: Middleware[];
+    private wss;
     /**
@@ -44,2 +47,3 @@ * Add a middleware to the application.
     listen(port: number): http.Server;
+    listenWs(port: number): WebSocket.Server;
     /**
@@ -51,2 +55,8 @@ * This function is a callback that can be used for Node's http.Server,
     /**
+     * This callback can be used to tie to the Node.js Http(s/2) server 'upgrade' event'.
+     *
+     * It's used to facilitate incoming Websocket requests
+     */
+    upgradeCallback(request: http.IncomingMessage, socket: net.Socket, head: Buffer): void;
+    /**
      * Does a sub-request based on a Request object, and returns a Response
@@ -53,0 +63,0 @@ * object.

dist/application.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeMiddlewares = exports.middlewareCall = void 0;
 const http_errors_1 = require("@curveball/http-errors");
@@ -17,2 +18,3 @@ const events_1 = require("events");
 const response_1 = __importDefault(require("./node/response"));
+const ws_1 = __importDefault(require("ws"));
 const pkg = require('../package.json');
@@ -74,4 +76,18 @@ /**
         const server = http_1.default.createServer(this.callback());
+        server.on('upgrade', this.upgradeCallback.bind(this));
         return server.listen(port);
     }
+    listenWs(port) {
+        const wss = new ws_1.default.Server({
+            port
+        });
+        wss.on('connection', async (ws, req) => {
+            const request = new request_1.default(req);
+            const response = new memory_response_1.default();
+            const context = new base_context_1.default(request, response);
+            context.webSocket = ws;
+            await this.handle(context);
+        });
+        return wss;
+    }
     /**
@@ -109,2 +125,16 @@ * This function is a callback that can be used for Node's http.Server,
     }
+    /**
+     * This callback can be used to tie to the Node.js Http(s/2) server 'upgrade' event'.
+     *
+     * It's used to facilitate incoming Websocket requests
+     */
+    upgradeCallback(request, socket, head) {
+        if (!this.wss) {
+            // We don't have an existing Websocket server. Lets make one.
+            this.wss = new ws_1.default.Server({ noServer: true });
+        }
+        this.wss.handleUpgrade(request, socket, head, (ws) => {
+            this.wss.emit('connection', ws, request);
+        });
+    }
     async subRequest(arg1, path, headers, body = '') {
@@ -111,0 +141,0 @@ let request;

dist/base-context.d.ts

 import { Middleware } from './application';
-import Context from './context';
+import { Context } from './context';
 import { HeadersInterface, HeadersObject } from './headers';
 import Request from './request';
 import Response from './response';
+import WebSocket from 'ws';
 /**
@@ -106,2 +107,10 @@ * The Context object encapsulates a single HTTP request.
     redirect(status: number, address: string): void;
+    /**
+     * WebSocket object.
+     *
+     * If the current request is a websocket request, this proprerty will be set
+     *
+     * @see https://github.com/websockets/ws#simple-server
+     */
+    webSocket?: WebSocket;
 }

dist/conditional.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.conditionalCheck = void 0;
 /**
@@ -4,0 +5,0 @@ * This method will check the following request headers:

dist/context.d.ts

@@ -5,3 +5,4 @@ import { Middleware } from './application';
 import Response from './response';
-export default interface Context<ReqT = any, ResT = any> {
+import WebSocket from 'ws';
+export interface Context<ReqT = any, ResT = any> {
     /**
@@ -94,2 +95,24 @@ * HTTP Request
     redirect(status: number, address: string): void;
+    /**
+     * WebSocket object.
+     *
+     * If the current request is a websocket request, this proprerty will be set
+     *
+     * @see https://github.com/websockets/ws#simple-server
+     */
+    webSocket?: WebSocket;
 }
+/**
+ * WebSocket Context
+ *
+ * This is the Context that will be passed in case a WebSocket request was
+ * initiated.
+ */
+export interface WsContext extends Context<any, any> {
+    /**
+     * WebSocket object.
+     *
+     * @see https://github.com/websockets/ws#simple-server
+     */
+    webSocket: WebSocket;
+}

dist/header-helpers.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitHeader = exports.parsePrefer = exports.is = void 0;
 /**
@@ -4,0 +5,0 @@ * This method will return true or false if a Request or Response has a

dist/headers.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
 class Headers {
@@ -4,0 +5,0 @@ constructor(headersObj = {}) {

dist/index.d.ts

 import { default as Application, invokeMiddlewares, Middleware, middlewareCall } from './application';
 import BaseContext from './base-context';
-import Context from './context';
+export { Context, WsContext } from './context';
 import Headers from './headers';
@@ -11,2 +11,2 @@ import MemoryRequest from './memory-request';
 export default Application;
-export { Application, BaseContext, Context, conditionalCheck, Headers, invokeMiddlewares, middlewareCall, Middleware, Request, Response, MemoryRequest, MemoryResponse, };
+export { Application, BaseContext, conditionalCheck, Headers, invokeMiddlewares, middlewareCall, Middleware, Request, Response, MemoryRequest, MemoryResponse, };

dist/index.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
@@ -13,6 +25,7 @@ };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryResponse = exports.MemoryRequest = exports.Response = exports.Request = exports.middlewareCall = exports.invokeMiddlewares = exports.Headers = exports.conditionalCheck = exports.BaseContext = exports.Application = void 0;
 const application_1 = __importStar(require("./application"));
-exports.Application = application_1.default;
-exports.invokeMiddlewares = application_1.invokeMiddlewares;
-exports.middlewareCall = application_1.middlewareCall;
+Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.default; } });
+Object.defineProperty(exports, "invokeMiddlewares", { enumerable: true, get: function () { return application_1.invokeMiddlewares; } });
+Object.defineProperty(exports, "middlewareCall", { enumerable: true, get: function () { return application_1.middlewareCall; } });
 const base_context_1 = __importDefault(require("./base-context"));
@@ -31,4 +44,4 @@ exports.BaseContext = base_context_1.default;
 const conditional_1 = require("./conditional");
-exports.conditionalCheck = conditional_1.conditionalCheck;
+Object.defineProperty(exports, "conditionalCheck", { enumerable: true, get: function () { return conditional_1.conditionalCheck; } });
 exports.default = application_1.default;
 //# sourceMappingURL=index.js.map

dist/memory-request.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryRequest = void 0;
 const stream_1 = require("stream");
@@ -8,0 +9,0 @@ const headers_1 = require("./headers");

dist/memory-response.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryResponse = void 0;
 const headers_1 = require("./headers");
@@ -8,0 +9,0 @@ const response_1 = __importDefault(require("./response"));

dist/middleware/not-found.d.ts

@@ -1,2 +0,2 @@
-import Context from '../context';
+import { Context } from '../context';
 export default function mw(ctx: Context): void;

dist/node/http-utils.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendBody = exports.isHttp2Response = void 0;
 const stream_1 = __importDefault(require("stream"));
@@ -8,0 +9,0 @@ /**

dist/node/push.d.ts

 /// <reference types="node" />
 import http2 from 'http2';
-import Context from '../context';
+import { Context } from '../context';
 /**
@@ -5,0 +5,0 @@ * This is a utility for helping with HTTP/2 Push for node servers.

dist/node/request.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeRequest = void 0;
 const raw_body_1 = __importDefault(require("raw-body"));
@@ -8,0 +9,0 @@ const headers_1 = require("../headers");

dist/node/response.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeResponse = void 0;
 const http_1 = __importDefault(require("http"));
@@ -8,0 +9,0 @@ const util_1 = require("util");

dist/request.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Request = void 0;
 const accepts_1 = __importDefault(require("accepts"));
@@ -8,0 +9,0 @@ const url_1 = __importDefault(require("url"));

dist/response.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = void 0;
 const header_helpers_1 = require("./header-helpers");
@@ -4,0 +5,0 @@ const headers_1 = require("./headers");

package.json

 {
   "name": "@curveball/core",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Curveball is a framework writting in Typescript for Node.js",
@@ -19,3 +19,4 @@ "main": "dist/index.js",
     "dist",
-    "LICENSE"
+    "LICENSE",
+    "src"
   ],
@@ -38,15 +39,16 @@ "keywords": [
     "@types/chai": "^4.2.11",
-    "@types/co-body": "0.0.3",
-    "@types/mocha": "^7.0.2",
-    "@types/node": "^10.17.17",
-    "@types/node-fetch": "^2.5.5",
-    "@types/sinon": "^7.5.2",
+    "@types/co-body": "^5.1.0",
+    "@types/mocha": "^8.0.0",
+    "@types/node": "^10.17.27",
+    "@types/node-fetch": "^2.5.7",
+    "@types/sinon": "^9.0.4",
+    "@types/ws": "^7.2.6",
     "chai": "^4.2.0",
-    "mocha": "^7.1.1",
+    "mocha": "^8.0.1",
     "node-fetch": "^2.6.0",
-    "nyc": "^15.0.0",
-    "sinon": "^9.0.1",
-    "ts-node": "^8.8.1",
-    "tslint": "^6.1.0",
-    "typescript": "^3.8.3"
+    "nyc": "^15.1.0",
+    "sinon": "^9.0.2",
+    "ts-node": "^8.10.2",
+    "tslint": "^6.1.2",
+    "typescript": "^3.9.6"
   },
@@ -62,3 +64,4 @@ "types": "dist/",
     "accepts": "^1.3.7",
-    "raw-body": "^2.4.1"
+    "raw-body": "^2.4.1",
+    "ws": "^7.3.1"
   },
@@ -65,0 +68,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

185444

42.33%

Number of package files

79

27.42%

Lines of code

4274

69.27%

Worsened metrics

Dependency count

4

33.33%

Dev dependency count

16

6.67%

Dependency changes

• + Added

  ws@^7.3.1

• + Added

  ws@7.5.10
  (transitive)