@dharmax/state-router 2.0.0 → 2.0.1

package/dist/state-manager.d.ts

@@ -7,14 +7,17 @@ export type ApplicationState = {
     route: RegExp;
     mode?: string | string[];
 };
+export type ChangeAuthority = (state: ApplicationState) => Promise<boolean>;
 export declare class StateManager {
     private allStates;
     private appState;
     private previousState;
     private stateContext;
-    static dispatcher: import("@dharmax/pubsub").Pubsub;
+    static dispatcher: import("@dharmax/pubsub").PubSub;
+    private changeAuthorities;
     constructor(mode?: RoutingMode);
     onChange(handler: (event: PubSubEvent, data: any) => void): IPubSubHandle;
+    registerChangeAuthority(authorityCallback: (targetState: ApplicationState) => Promise<boolean>): void;
     getState(): ApplicationState;
     get previous(): ApplicationState;
     get context(): ApplicationState;
@@ -23,14 +26,14 @@ export declare class StateManager {
      * @param state can be either just a state or a state and context (which can be sub-state, or anything else)
      */
     set state(state: ApplicationStateName | [ApplicationStateName, any]);
-    /** attempts to restore state from current url */
+    /** attempts to restore state from current url. Currently, works only in hash mode */
     restoreState(defaultState: ApplicationStateName): void;
     /**
      *
      * @param stateName state
      * @param context extra context (e.g. sub-state)
      */
-    setState(stateName: ApplicationStateName, context?: any): boolean;
+    setState(stateName: ApplicationStateName, context?: any): Promise<boolean>;
     /**
      * Define an application state
      * @param name

package/dist/state-manager.js

@@ -6,6 +6,7 @@ export class StateManager {
     previousState;
     stateContext;
     static dispatcher = dispatcher;
+    changeAuthorities = [];
     constructor(mode = 'hash') {
         router.mode = mode;
         router.listen();
@@ -13,6 +14,14 @@ export class StateManager {
     onChange(handler) {
         return StateManager.dispatcher.on('state:changed', handler);
     }
+    /*
+    Add a hook which enable conditional approval of state change. It can be more than one; when a state
+    change is requested, all the registered authorities must return true (asynchronously) otherwise the change
+    requested doesn't happen.
+    **/
+    registerChangeAuthority(authorityCallback) {
+        this.changeAuthorities.push(authorityCallback);
+    }
     getState() {
         return this.appState || {};
     }
@@ -32,7 +41,7 @@ export class StateManager {
         else
             this.setState(state);
     }
-    /** attempts to restore state from current url */
+    /** attempts to restore state from current url. Currently, works only in hash mode */
     restoreState(defaultState) {
         let dest = window.location.hash;
         if (dest == '#login' || dest == '')
@@ -44,12 +53,17 @@ export class StateManager {
      * @param stateName state
      * @param context extra context (e.g. sub-state)
      */
-    setState(stateName, context) {
+    async setState(stateName, context) {
         const newState = this.allStates[stateName];
         if (!newState) {
             alert(`Undefined app state ${stateName}`);
             return false;
         }
+        // check if the state change was declined by any change authority and if so - don't do it and return false
+        const changeConfirmations = await Promise.all(this.changeAuthorities.map(authority => authority(newState)));
+        if (changeConfirmations.includes(false))
+            return false;
+        // perform the change
         this.previousState = this.appState;
         this.stateContext = context;
         this.appState = newState;
@@ -79,8 +93,8 @@ export class StateManager {
     }
     registerStateByState(state) {
         this.allStates[state.name] = state;
-        router.add(state.route, (context) => {
-            if (this.setState(state.name, context)) {
+        router.add(state.route, async (context) => {
+            if (await this.setState(state.name, context)) {
                 // @ts-ignore
                 if (window.ga) {
                     // @ts-ignore

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@dharmax/state-router",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A cute and tight router and application state controller",
-  "main": "dist/router.js",
-  "types": "dist/router.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "npx tsc",
@@ -27,6 +28,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@dharmax/pubsub": "^1.0.1"
+    "@dharmax/pubsub": "^1.1.0"
   }
 }