2.6 Routes - Baumgaer/Game GitHub Wiki

/**
 * constructs the base for the route on server and client side.
 */
export function BDOMyRouteFactory<TBase extends Constructor<BDORoute>>(ctor: TBase) {

    /**
     * Provides basic functionality for the "home page" of the website
     *
     * @export
     * @class GameLobby
     * @extends {BaseRoute}
     */
    abstract class BDOMyRoute extends ctor {

        /**
         * Defines which servers have to use this route.
         * "*" (default) means that all servers should use this route.
         * If only a specific number of server should use this route, define their
         * names in the array.
         */
        public static attachToServers: string[] = ["WebServer"];

        /**
         * this defines where to reach the route. In this case it is
         * www.example.com and by default it is www.example.com/<nameOfTheRoute>.
         */
        public routerNameSpace: string = '/';

        /**
         * This defines several routes which can be used after the
         * routerNameSpace. At the moment it uses
         * www.example.com/<routerNameSpace>/site/<aNumber>.
         * You can define more routes and must handle them in the
         * templateParams() method.
         */
        public routes: string[] = ['/site/:number'];

        /**
         * This has the same functionality like the templateString in a
         * component. In case a user comes the first time to this project. the
         * server will render the first page. After that the server should
         * receive a header named "X-Game-As-JSON" which forces the server to
         * send json only.
         */
        protected templateString: Template = require('~bdo/views/route.njk');

        /**
         * is called on HTTP GET and should return a dictionary with template
         * parameters.
         */
        protected async templateParams(_request: Request): Promise<IndexStructure> {
            return {
                someParam: 'some value'
            };
        }
    }

    return MyRoute;
}

import {BDOMyRouteFactory} from "~bdo/routes/BDOMyRoute";
import {ServerRoute} from "~server/lib/ServerRoute";

/**
 * Defines a route on server side. Please NOTE the default export!
 */
export default class GameLobby extends BDOMyRouteFactory(ServerRoute) {}