Merge pull request #195 from curveball/prep-0.18-alpha0

Prep 0.18 alpha0 release.

changelog.md

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+0.18.0.alpha.0 (2022-04-09)
+---------------------------
+
+* The `Context` interface has been removed, and the `BaseContext` class is
+  renamed to `Context`. This is a BC break, but should only be an issue if
+  you used the `Context` interface directly. `BaseContext` is still
+  exported but simply aliased to `Context`. This alias will be removed from
+  a future version. This change should make ite asier to use interface
+  declaration merging to extend Context.
+* The `ws` dependency has been updated to version 8. There are some [breaking
+  changes][ws8] in this release. The most likely you'll hit is that incoming
+  messages are now of type `Buffer` instead of `string`. Check out the
+  [ws changelog][ws8] for more details.
+
+
 0.17.0 (2022-02-08)
 -------------------
 
@@ -333,3 +348,5 @@ Happy birthday Mom!
 ------------------
 
 * First published on npm.js to claim package name.
+
+[ws8]: https://github.com/websockets/ws/releases/tag/8.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curveball/core",
-  "version": "0.17.0",
+  "version": "0.18.0-alpha.0",
   "description": "Curveball is a framework writting in Typescript for Node.js",
   "main": "dist/index.js",
   "scripts": {

src/context.ts

@@ -194,3 +194,17 @@ export class Context<ReqT = any, ResT = any> {
 
 }
 
+/**
+ * WsContext always has a 'webSocket' property defined.
+ */
+export type WsContext = Context & {
+
+  /**
+   * 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;
+};

src/index.ts

@@ -1,5 +1,10 @@
 import { default as Application, invokeMiddlewares, Middleware, middlewareCall } from './application';
-export { Context } from './context';
+export {
+  Context,
+  // For backwards compatibility
+  Context as BaseContext,
+  WsContext
+} from './context';
 import Headers from './headers';
 import MemoryRequest from './memory-request';
 import MemoryResponse from './memory-response';