kdu-router 3.4.0-beta.0 → 3.6.0

package/src/util/warn.js

@@ -1,14 +1,14 @@
-/* @flow */
-
-export function assert (condition: any, message: string) {
-  if (!condition) {
-    throw new Error(`[kdu-router] ${message}`)
-  }
-}
-
-export function warn (condition: any, message: string) {
-  if (process.env.NODE_ENV !== 'production' && !condition) {
-    typeof console !== 'undefined' && console.warn(`[kdu-router] ${message}`)
-  }
-}
-
+/* @flow */
+
+export function assert (condition: any, message: string) {
+  if (!condition) {
+    throw new Error(`[kdu-router] ${message}`)
+  }
+}
+
+export function warn (condition: any, message: string) {
+  if (!condition) {
+    typeof console !== 'undefined' && console.warn(`[kdu-router] ${message}`)
+  }
+}
+

package/types/composables.d.ts

@@ -0,0 +1,53 @@
+declare module 'kdu-router/composables' {
+  import type { ComputedRef, Ref } from 'kdu'
+  import type { Route, NavigationGuard, default as KduRouter } from 'kdu-router'
+
+  /**
+   * Returns the current route location. Equivalent to using `$route` inside templates.
+   */
+  export function useRoute(): Route
+
+  /**
+   * Returns the router instance. Equivalent to using `$router` inside templates.
+   */
+  export function useRouter(): KduRouter
+
+  /**
+   * Add a navigation guard that triggers whenever the current location is about to be updated. Similar to beforeRouteUpdate but can be used in any component. The guard is removed when the component is unmounted.
+   *
+   * @param updateGuard
+   */
+  export function onBeforeRouteUpdate(updateGuard: NavigationGuard): void
+
+  /**
+   * Add a navigation guard that triggers whenever the component for the current location is about to be left. Similar to beforeRouteLeave but can be used in any component. The guard is removed when the component is unmounted.
+   *
+   * @param leaveGuard
+   */
+  export function onBeforeRouteLeave(leaveGuard: NavigationGuard): void
+
+  export interface RouterLinkOptions {
+    /**
+     * Route Location the link should navigate to when clicked on.
+     */
+    to: Route | Ref<Route>
+    /**
+     * Calls `router.replace` instead of `router.push`.
+     */
+    replace?: boolean
+  }
+
+  /**
+   * Kdu Router 4 `useLink()` function. Note the active behavior is different from Kdu Router 3 as highlighted in the
+   * migration guide (https://kdujs-router.web.app/guide/migration/index.html#removal-of-the-exact-prop-in-router-link)
+   *
+   * @param props - object containing a `to` property with the location
+   */
+  export function useLink(props: RouterLinkOptions): {
+    route: ComputedRef<Route>,
+    isActive: ComputedRef<boolean>,
+    isExactActive: ComputedRef<boolean>,
+    href: ComputedRef<string>,
+    navigate: () => Promise<void>,
+  }
+}

package/types/index.d.ts

@@ -1,17 +1,25 @@
-import './kdu'
-import { KduRouter } from './router'
-
-export default KduRouter
-
-export {
-  RouterMode,
-  RawLocation,
-  RedirectOption,
-  RouterOptions,
-  RouteConfig,
-  RouteRecord,
-  Location,
-  Route,
-  NavigationGuard,
-  NavigationGuardNext
-} from './router'
+import './kdu'
+import { KduRouter, RouterLink, RouterView } from './router'
+
+export default KduRouter
+// TODO: does this really work with the new keyword?
+export { RouterView, RouterLink }
+
+export type {
+  RouterMode,
+  RouteMeta,
+  RawLocation,
+  RedirectOption,
+  RouterOptions,
+  RouteConfig,
+  RouteRecord,
+  RouteRecordPublic,
+  Location,
+  Route,
+  NavigationGuard,
+  NavigationGuardNext,
+  NavigationFailureType,
+  NavigationFailure
+} from './router'
+
+import './composables'

package/types/kdu.d.ts

@@ -1,22 +1,22 @@
-/**
- * Augment the typings of Kdu.js
- */
-
-import Kdu from 'kdu'
-import KduRouter, { Route, RawLocation, NavigationGuard } from './index'
-
-declare module 'kdu/types/kdu' {
-  interface Kdu {
-    $router: KduRouter
-    $route: Route
-  }
-}
-
-declare module 'kdu/types/options' {
-  interface ComponentOptions<V extends Kdu> {
-    router?: KduRouter
-    beforeRouteEnter?: NavigationGuard<V>
-    beforeRouteLeave?: NavigationGuard<V>
-    beforeRouteUpdate?: NavigationGuard<V>
-  }
-}
+/**
+ * Augment the typings of Kdu.js
+ */
+
+import Kdu from 'kdu'
+import KduRouter, { Route, NavigationGuard } from './index'
+
+declare module 'kdu/types/kdu' {
+  interface Kdu {
+    $router: KduRouter
+    $route: Route
+  }
+}
+
+declare module 'kdu/types/options' {
+  interface ComponentOptions<V extends Kdu> {
+    router?: KduRouter
+    beforeRouteEnter?: NavigationGuard<V>
+    beforeRouteLeave?: NavigationGuard<V>
+    beforeRouteUpdate?: NavigationGuard<V>
+  }
+}