backendium 0.0.4 → 0.0.6

package/dist/router.d.ts

@@ -52,7 +52,7 @@ export declare class BackendiumRouter<GlobalAuthType = undefined> {
     unlock<BodyType = Buffer, ParamsType = {}, QueryType = {}, AuthType = GlobalAuthType, HeadersType = {}>(...args: BackendiumMethodArgsType<BodyType, ParamsType, QueryType, AuthType, HeadersType, GlobalAuthType>): void;
     link<BodyType = Buffer, ParamsType = {}, QueryType = {}, AuthType = GlobalAuthType, HeadersType = {}>(...args: BackendiumMethodArgsType<BodyType, ParamsType, QueryType, AuthType, HeadersType, GlobalAuthType>): void;
     unlink<BodyType = Buffer, ParamsType = {}, QueryType = {}, AuthType = GlobalAuthType, HeadersType = {}>(...args: BackendiumMethodArgsType<BodyType, ParamsType, QueryType, AuthType, HeadersType, GlobalAuthType>): void;
-    ws<InitDataType>(route: string, constructor: WebSocketRouteConstructor<InitDataType>): void;
+    ws<InitDataType>(route: string): WebSocketRouteConstructor<InitDataType>;
     protected static addPrefix([method, route, handler]: [MethodType, string | undefined, Array<(app: Backendium) => RequestHandler>], prefix: string): [MethodType, string, Array<(app: Backendium) => RequestHandler>];
     protected static addPrefix([method, route, handler]: ["ws", string, Array<(app: Backendium) => WSRequestHandler>], prefix: string): ["ws", string, Array<(app: Backendium) => WSRequestHandler>];
     router<AuthType>(router: BackendiumRouter<AuthType>, routePrefix?: string): void;

package/dist/router.js

@@ -1,4 +1,5 @@
 import backendiumHandler from "./handler.js";
+import { WebSocketRouteConstructor } from "./ws.js";
 export class BackendiumRouter {
     constructor() {
         this._handlers = [];
@@ -114,10 +115,12 @@ export class BackendiumRouter {
     unlink(...args) {
         this.addHandler("unlink", ...args);
     }
-    ws(route, constructor) {
+    ws(route) {
+        let constructor = new WebSocketRouteConstructor;
         this._handlers.push(["ws", route, [(app) => (request, response, next) => {
                     constructor._handle(request, response, next, app);
                 }]]);
+        return constructor;
     }
     static addPrefix([method, route, handler], prefix) {
         return [method, route || !(route === null || route === void 0 ? void 0 : route.startsWith("/")) ? prefix + (route !== null && route !== void 0 ? route : "") : prefix + (route !== null && route !== void 0 ? route : ""), handler];

package/dist/ws.d.ts

@@ -98,5 +98,4 @@ export declare class WebSocketRouteConstructor<InitDataType> {
     off<E extends EventKey<BackendiumWebSocketEvents<InitDataType>>>(event: E, subscriber: (...args: BackendiumWebSocketEvents<InitDataType>[E]) => void): WebSocketRouteConstructor<InitDataType>;
     requireInit<Type>(callback: (connection: WebSocket & WebSocketExtension, data: Type, app: Backendium) => null | InitDataType | Promise<null | InitDataType>, validator: Validator<Type>): WebSocketRouteConstructor<InitDataType>;
 }
-export declare function websocketConstructor<InitDataType = undefined>(): WebSocketRouteConstructor<InitDataType>;
 export {};

package/dist/ws.js

@@ -336,7 +336,4 @@ export class WebSocketRouteConstructor {
         return this;
     }
 }
-export function websocketConstructor() {
-    return new WebSocketRouteConstructor;
-}
 // @TODO error handling +termination logging

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backendium",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Express-based javascript backend framework with websocket support and type-safe checkeasy validators",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -4,6 +4,10 @@
 > 1. [Installation](#installation)
 > 2. [Basics](#basics)
 > 3. [Routing](#routing)
+> 4. [Request validation](#request-validation-checkeasy)
+> 5. [Authorization](#authorization)
+> 6. [Dynamic routing](#dynamic-routing)
+> 7. [Websocket](#websocket)
 # Installation
 ```bash
 npm i backendium checkeasy
@@ -43,7 +47,7 @@ app.start();
 ```
 ```typescript
 // handlers.ts
-import {BackendiumRouter} from "backendium/dist/router";
+import {BackendiumRouter} from "backendium";
 
 const router = new BackendiumRouter;
 
@@ -214,7 +218,7 @@ websocketRequest()
 ```
 ## Init
 ```typescript
-router.ws<string>("/ws/init")
+router.ws<string>("/ws-init")
     .event("test", (data, socket) => {
         socket.send(socket.initData);
     })
@@ -228,7 +232,7 @@ websocketRequest<number>()
     .on("message", data => {
         console.log(data.toString());
     })
-    .send("ws://localhost:8080/ws/init", 54)
+    .send("ws://localhost:8080/ws-init", 54)
     .then(socket => {
         socket.emit("test");
     });

package/src/router.ts

@@ -200,10 +200,12 @@ export class BackendiumRouter<GlobalAuthType = undefined> {
         this.addHandler("unlink", ...args);
     }
 
-    ws<InitDataType>(route: string, constructor: WebSocketRouteConstructor<InitDataType>) {
+    ws<InitDataType>(route: string) {
+        let constructor = new WebSocketRouteConstructor<InitDataType>;
         this._handlers.push(["ws", route, [(app: Backendium) => (request: Request, response: WSResponse, next: NextFunction) => {
             constructor._handle(request, response, next, app);
         }]]);
+        return constructor;
     }
 
     protected static addPrefix([method, route, handler]: [MethodType, string | undefined, Array<(app: Backendium) => RequestHandler>], prefix: string): [MethodType, string, Array<(app: Backendium) => RequestHandler>];

package/src/ws.ts

@@ -369,8 +369,4 @@ export class WebSocketRouteConstructor<InitDataType> {
     }
 }
 
-export function websocketConstructor<InitDataType = undefined>() {
-    return new WebSocketRouteConstructor<InitDataType>;
-}
-
 // @TODO error handling +termination logging