feat: Improve typings and shim

Author: MattCCC

README.md

@@ -182,9 +182,7 @@ export default {
 | navigatedFrom  | -                   | This event is tricky to control for developers. There is no exact mapping of it in the router. For store state cleanup use build-in meta dispatcher instead. For component state you could opt for using `beforeRouteLeave()`. |
 
 ## TypeScript Support
-If you need a TS support and it's not detected in your project for some reason, you can use [typings/shims.vue.d.ts](https://github.com/MattCCC/nativescript-vue-router-extended/blob/master/src/typings/shims-vue.d.ts) to bring proper support in .vue files.
-
-Assuming that your node_modules/ directory is on same level, you can specify following line in your `references.d.ts` file:
+If you need a TS support and it's not detected automatically in your project for some reason, you can use [typings/shims.vue.d.ts](https://github.com/MattCCC/nativescript-vue-router-extended/blob/master/src/typings/shims-vue.d.ts) to bring proper support in .vue files. You can specify it in your `shims.vue.d.ts` file (attention! Please ensure that path is relative to your node_modules directory):
 ```
 /// <reference path="./node_modules/nativescript-vue-router-extended/typings/shims-vue.d.ts" />
 ```

src/typings/router-service.d.ts

@@ -1,6 +1,9 @@
 import {
     RouterOptions,
 } from 'vue-router';
+import {
+    NavigationEntryVue,
+} from 'nativescript-vue';
 
 export type RouteChildren = Route;
 export type ErrorCallback = Error | ((...args: any[]) => void);
@@ -18,48 +21,23 @@ export interface NSVueRouterOptions extends RouterOptions {
     history?: string;
 }
 
-export interface Route extends RouteOptions {
-    path: string;
-    name?: string;
-    component?: Component;
-    children?: RouteChildren;
-
-    beforeRouteEnter?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
-    beforeRouteLeave?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
-}
-
-export interface RouteOptions {
+export interface RouteOptions extends NavigationEntryVue {
     /**
      * List of route meta information
      * Can contain a store object with action names as keys and payload as values.
      * These actions will be dispatched once a particular route is navigated to
      */
     meta?: Record<string, any>;
+}
 
-    /**
-     * Animation duration when switching a route
-     */
-    duration?: number;
-
-    /**
-     * Allows to pass props directly in $routeTo
-     */
-    props?: Record<string, any>;
-
-    /**
-     * Same as props, used internally for proper NS navigation support
-     */
-    context?: Record<string, any>;
-
-    /**
-     * Whether to clear previous records from the history
-     */
-    clearHistory?: boolean;
+export interface Route extends RouteOptions {
+    path: string;
+    name?: string;
+    component?: Component;
+    children?: RouteChildren;
 
-    /**
-     * NativeScript compatible transition object
-     */
-    transition?: Record<string, any>;
+    beforeRouteEnter?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
+    beforeRouteLeave?: (to: Route, from: Route, next?: (vm: any) => void) => boolean;
 }
 
 export interface RouterServiceOptions {

src/typings/shims-vue.d.ts

@@ -6,12 +6,9 @@ import type {
 } from "vue-router/dist/vue-router.d";
 import type { RouterService } from "nativescript-vue-router-extended/router-service";
 
-declare module "*.vue" {
-  export default Vue;
-}
-
 declare module "vue/types/vue" {
   interface Vue {
+    $route: Route;
     $router: RouterService;
     $routeTo(route: Route | string, options?: RouteOptions): void;
   }