feat: Add beforeEnter support in routes list acces

Author: MattCCC

src/router-guard-service.ts

@@ -1,10 +1,9 @@
 import {
   GuardReturnContext,
-  NavigationGuardCallback,
   NextContext,
 } from "./typings/router-guards-service";
 import { Route } from "./typings/router-service";
-import { NavigationHookAfter, RouteLocationNormalized } from "vue-router";
+import { NavigationGuard, NavigationHookAfter, RouteLocationNormalized } from "vue-router";
 
 /**
  * Single Guard Service
@@ -16,10 +15,10 @@ export class RouterGuardService {
    * List of Guard Callbacks
    *
    * @private
-   * @type {NavigationGuardCallback[]}
+   * @type {NavigationGuard[]}
    * @memberof RouterGuardService
    */
-  private guardCallbacks: NavigationGuardCallback[] = [];
+  private guardCallbacks: NavigationGuard[] = [];
 
   /**
    * Whether current navigation is cancelled from inside of guard
@@ -77,10 +76,10 @@ export class RouterGuardService {
   /**
    * Add a guard
    *
-   * @param {NavigationGuardCallback} callback The callback to be added to the guard
+   * @param {NavigationGuard} callback The callback to be added to the guard
    * @returns {void}
    */
-  public add(callback: NavigationGuardCallback): void {
+  public add(callback: NavigationGuard): void {
     this.guardCallbacks.push(callback);
   }
 

src/router-mixin.ts

@@ -1,5 +1,6 @@
 import Vue from "nativescript-vue";
 import { Page } from "@nativescript/core/ui/page";
+import { RouterService } from "./router-service";
 
 export default {
   nextCallbacks: [],
@@ -62,8 +63,8 @@ export default {
         return;
       }
 
-      const to = this.$router.getNewRoute();
-      const from = this.$router.getCurrentRoute();
+      const to = (this.$router as RouterService).getNewRoute();
+      const from = (this.$router as RouterService).getCurrentRoute();
 
       if (this.$options.beforeRouteLeave) {
         this.$options.beforeRouteLeave.call(
@@ -90,8 +91,8 @@ export default {
     },
 
     onNavigatingTo(data) {
-      const to = this.$router.getNewRoute();
-      const from = this.$router.getCurrentRoute();
+      const to = (this.$router as RouterService).getNewRoute();
+      const from = (this.$router as RouterService).getCurrentRoute();
 
       if (this.$options.beforeRouteUpdate && to && from && to.path === from.path) {
         this.$options.beforeRouteUpdate.call(
@@ -102,6 +103,28 @@ export default {
         );
       }
 
+      if (to.beforeEnter && typeof to.beforeEnter === "function") {
+        const next = (vmContext) => {
+          if (typeof vmContext === "undefined") {
+            return;
+          }
+
+          // Do not invoke callback immediately even though instance of new component is provided
+          // This is to keep cb invocation order in sync with Vue-Router
+          if (typeof vmContext === "function") {
+            this.$options.nextCallbacks.push(vmContext);
+          }
+        };
+
+        this.$options.beforeEnter.call(
+          this,
+          to,
+          from,
+          next,
+          data.object.navigationContext
+        );
+      }
+
       if (this.$options.beforeRouteEnter) {
         const next = (vmContext) => {
           if (typeof vmContext === "undefined") {

src/typings/router-guards-service.d.ts

@@ -20,8 +20,6 @@ export type BeforeRouteEnter = (to: Route, from?: Route, next?: NextContext) =>
 
 export type BeforeRouteLeave = (to: Route, from?: Route, next?: NextContext) => void;
 
-export type NavigationGuardCallback = NavigationGuard;
-
 export interface GuardsInitArgs {
     to: Route;
     from?: Route;

src/typings/router-service.d.ts

@@ -1,5 +1,6 @@
 import {
     RouterOptions,
+    NavigationGuardNext,
 } from 'vue-router';
 import {
     NavigationEntryVue,
@@ -36,8 +37,7 @@ export interface Route extends RouteOptions {
     component?: Component;
     children?: RouteChildren;
 
-    beforeRouteEnter?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
-    beforeRouteLeave?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
+    beforeEnter?: (to: Route, from: Route, next?: NavigationGuardNext) => void;
 }
 
 export interface RouterServiceOptions {