jsactions/core/EventRouter.js

  1. /** 
  2.  * @license
  3.  * Copyright (c) 2023 Gaurang Lade
  4.  * 
  5.  * MIT License
  6.  * 
  7.  * Permission is hereby granted, free of charge, to any person obtaining a copy
  8.  * of this software and associated documentation files (the "Software"), to deal
  9.  * in the Software without restriction, including without limitation the rights
  10.  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11.  * copies of the Software, and to permit persons to whom the Software is
  12.  * furnished to do so, subject to the following conditions:
  13.  *
  14.  * The above copyright notice and this permission notice shall be included in all
  15.  * copies or substantial portions of the Software.
  16.  *
  17.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18.  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19.  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20.  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21.  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22.  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23.  * SOFTWARE.
  24.  */
  27. /**
  28.  * EventRouter holds and manages array of event routes.
  29.  * Event Routes are used by ViewNavigator to find associated View and Viewstack
  30.  * 
  31.  * Viewnavigator find View and ViewStack based on Routes info set in EventRouter Object see Example
  32.  * 
  33.  */
  35.  class EventRouter {
  38.     /**
  39.      * @example Sample Event Router Object is in "SimpleNavigator" class (subclass of ViewNavigator) 
  40.      
  41.         initEventRoutes() {
  42.             let evtRoutes = [
  44.                { navEvent: " Login_NavEvent ", viewstackId: “LoginStack", viewId: “loginView", path: "/login" },
  45.                { navEvent: " Register_NavEvent ", viewstackId: “LoginStack", viewId: “registerView", path: "/login" },
  46.                { navEvent: " ForgotPwd_NavEvent", viewstackId: “LoginStack", viewId: “forgotpwdView", path: "/login" }
  48.             ]
  49.             this.eventRouter = new EventRouter(evtRoutes);
  50.         }
  52.         Here "navEvent" is Event Name, "viewstackId" is ViewStack Id, "viewId" is ViewId and "path" is routeID by which ViewNavigator associated.
  54.      * 
  55.      * @param {array} [_routes=[]] - Events routes array
  56.      * @memberof EventRouter
  57.      */
  58.     constructor(_routes = []) {
  59.         this.routes = _routes;
  60.     }
  63.     /**
  64.      *
  65.      * @description Adds new Event Route
  66.      * @param {string} _navEvent - Navigation Event Name
  67.      * @param {string} _viewstackId - ViewStack ID
  68.      * @param {string} _viewId -  View ID
  69.      * @param {string} _path -  Navigator Route path associted 
  70.      * @memberof EventRouter
  71.      */
  72.     addRoute(_navEvent, _viewstackId, _viewId, _path) {
  73.         let route = {};
  74.         route.navEvent = _navEvent;
  75.         route.viewstackId = _viewstackId;
  76.         route.viewId = _viewId;
  77.         route.path = _path;
  78.         this.routes.push(route);
  79.     }
  82.     /**
  83.      *
  84.      * @description find Event Route using Naviagtion EventName
  85.      * @param {string} _navEvent
  86.      * @returns {Object} Event Route Object
  87.      * @memberof EventRouter
  88.      */
  89.     findRoute(_navEvent) {
  90.         let tmpRoute = [];
  91.         for (let x = 0; x < this.routes.length; x++) {
  92.             if (this.routes[x].navEvent == _navEvent)
  93.                 tmpRoute[x] = this.routes[x];
  94.         }
  95.         return tmpRoute;
  96.     }
  99.     /**
  100.      *
  101.      * @description finds associated view by Navigation EventName and Path
  102.      * @param {string} _navEvent
  103.      * @param {string} _path
  104.      * @returns {string} - ViewID 
  105.      * @memberof EventRouter
  106.      */
  107.     findViewId(_navEvent, _path) {
  108.         let tmpViewId = [];
  109.         for (let i = 0; i < this.routes.length; i++) {
  110.             if ((this.routes[i].navEvent == _navEvent) && (this.routes[i].path == _path))
  111.                 tmpViewId = this.routes[i].viewId;
  112.         }
  113.         return tmpViewId;
  114.     }
  117.     /**
  118.      *
  119.      * @description finds associated viewstack by Navigation EventName and Path
  120.      * @param {string} _navEvent
  121.      * @param {string} _path
  122.      * @returns {string} - ViewStackID
  123.      * @memberof EventRouter
  124.      */
  125.     findViewStackId(_navEvent, _path) {
  126.         let tmpViewStackId = null;
  127.         for (let j = 0; j < this.routes.length; j++) {
  128.             if ((this.routes[j].navEvent == _navEvent) && (this.routes[j].path == _path))
  129.                 tmpViewStackId = this.routes[j].viewstackId;
  130.         }
  131.         return tmpViewStackId;
  132.     }
  135.     /**
  136.      *
  137.      * @description Remove and Resets existing event routes
  138.      * @memberof EventRouter
  139.      */
  140.     reset() {
  141.         this.routes = [];
  142.     }
  145.     /**
  146.      *
  147.      * @description prints Event Routes
  148.      * @memberof EventRouter
  149.      */
  150.     printRoutes() {
  151.         if (this.routes.length > 0) {
  152.             for (let i = 0; i < this.routes.length; i++) {
  153.                 console.log("navEvent:" + this.routes[i].navEvent + " viewstackId:" + this.routes[i].viewstackId + " viewId:" + this.routes[i].viewId);
  154.             }
  155.         } else {
  156.             console.log("No Routes Found");
  157.         }
  158.     }
  160. }
  162. export default EventRouter;