deeplink2 typesafe path

apps/desktop/src/routeTree.gen.ts

@@ -11,6 +11,7 @@
 import { createFileRoute } from '@tanstack/react-router'
 
 import { Route as rootRouteImport } from './routes/__root'
+import { Route as NotificationRouteImport } from './routes/notification'
 import { Route as AppRouteRouteImport } from './routes/app/route'
 import { Route as AppDevtoolRouteImport } from './routes/app/devtool'
 import { Route as AppOnboardingIndexRouteImport } from './routes/app/onboarding/index'
@@ -22,6 +23,11 @@ import { Route as AppMainLayoutIndexRouteImport } from './routes/app/main/_layou
 const AppSettingsRouteImport = createFileRoute('/app/settings')()
 const AppMainRouteImport = createFileRoute('/app/main')()
 
+const NotificationRoute = NotificationRouteImport.update({
+  id: '/notification',
+  path: '/notification',
+  getParentRoute: () => rootRouteImport,
+} as any)
 const AppRouteRoute = AppRouteRouteImport.update({
   id: '/app',
   path: '/app',
@@ -68,6 +74,7 @@ const AppMainLayoutIndexRoute = AppMainLayoutIndexRouteImport.update({
 
 export interface FileRoutesByFullPath {
   '/app': typeof AppRouteRouteWithChildren
+  '/notification': typeof NotificationRoute
   '/app/devtool': typeof AppDevtoolRoute
   '/app/main': typeof AppMainLayoutRouteWithChildren
   '/app/settings': typeof AppSettingsLayoutRouteWithChildren
@@ -77,6 +84,7 @@ export interface FileRoutesByFullPath {
 }
 export interface FileRoutesByTo {
   '/app': typeof AppRouteRouteWithChildren
+  '/notification': typeof NotificationRoute
   '/app/devtool': typeof AppDevtoolRoute
   '/app/main': typeof AppMainLayoutIndexRoute
   '/app/settings': typeof AppSettingsLayoutIndexRoute
@@ -85,6 +93,7 @@ export interface FileRoutesByTo {
 export interface FileRoutesById {
   __root__: typeof rootRouteImport
   '/app': typeof AppRouteRouteWithChildren
+  '/notification': typeof NotificationRoute
   '/app/devtool': typeof AppDevtoolRoute
   '/app/main': typeof AppMainRouteWithChildren
   '/app/main/_layout': typeof AppMainLayoutRouteWithChildren
@@ -98,6 +107,7 @@ export interface FileRouteTypes {
   fileRoutesByFullPath: FileRoutesByFullPath
   fullPaths:
     | '/app'
+    | '/notification'
     | '/app/devtool'
     | '/app/main'
     | '/app/settings'
@@ -107,13 +117,15 @@ export interface FileRouteTypes {
   fileRoutesByTo: FileRoutesByTo
   to:
     | '/app'
+    | '/notification'
     | '/app/devtool'
     | '/app/main'
     | '/app/settings'
     | '/app/onboarding'
   id:
     | '__root__'
     | '/app'
+    | '/notification'
     | '/app/devtool'
     | '/app/main'
     | '/app/main/_layout'
@@ -126,10 +138,18 @@ export interface FileRouteTypes {
 }
 export interface RootRouteChildren {
   AppRouteRoute: typeof AppRouteRouteWithChildren
+  NotificationRoute: typeof NotificationRoute
 }
 
 declare module '@tanstack/react-router' {
   interface FileRoutesByPath {
+    '/notification': {
+      id: '/notification'
+      path: '/notification'
+      fullPath: '/notification'
+      preLoaderRoute: typeof NotificationRouteImport
+      parentRoute: typeof rootRouteImport
+    }
     '/app': {
       id: '/app'
       path: '/app'
@@ -262,6 +282,7 @@ const AppRouteRouteWithChildren = AppRouteRoute._addFileChildren(
 
 const rootRouteChildren: RootRouteChildren = {
   AppRouteRoute: AppRouteRouteWithChildren,
+  NotificationRoute: NotificationRoute,
 }
 export const routeTree = rootRouteImport
   ._addFileChildren(rootRouteChildren)

apps/desktop/src/routes/__root.tsx

@@ -1,18 +1,24 @@
 import {
   createRootRouteWithContext,
+  type LinkProps,
   Outlet,
   useNavigate,
 } from "@tanstack/react-router";
 import { getCurrentWebviewWindow } from "@tauri-apps/api/webviewWindow";
 import { lazy, useEffect } from "react";
 
+import type { DeepLink } from "@hypr/plugin-deeplink2";
 import { events as windowsEvents } from "@hypr/plugin-windows";
 
 import { AuthProvider } from "../auth";
 import { BillingProvider } from "../billing";
 import { ErrorComponent, NotFoundComponent } from "../components/control";
 import type { Context } from "../types";
 
+0 as DeepLink["to"] extends NonNullable<LinkProps["to"]>
+  ? 0
+  : "DeepLink['to'] must match a valid route";
+
 export const Route = createRootRouteWithContext<Partial<Context>>()({
   component: Component,
   errorComponent: ErrorComponent,

apps/desktop/src/routes/notification.tsx

@@ -0,0 +1,7 @@
+import { createFileRoute, redirect } from "@tanstack/react-router";
+
+export const Route = createFileRoute("/notification")({
+  beforeLoad: async () => {
+    throw redirect({ to: "/app/main" });
+  },
+});

plugins/deeplink2/build.rs

@@ -1,4 +1,4 @@
-const COMMANDS: &[&str] = &["ping", "get_available_deep_links"];
+const COMMANDS: &[&str] = &[];
 
 fn main() {
     tauri_plugin::Builder::new(COMMANDS).build();

plugins/deeplink2/js/bindings.gen.ts

@@ -7,22 +7,7 @@
 
 
 export const commands = {
-async ping() : Promise<Result<string, string>> {
-    try {
-    return { status: "ok", data: await TAURI_INVOKE("plugin:deeplink2|ping") };
-} catch (e) {
-    if(e instanceof Error) throw e;
-    else return { status: "error", error: e  as any };
-}
-},
-async getAvailableDeepLinks() : Promise<Result<DeepLinkInfo[], string>> {
-    try {
-    return { status: "ok", data: await TAURI_INVOKE("plugin:deeplink2|get_available_deep_links") };
-} catch (e) {
-    if(e instanceof Error) throw e;
-    else return { status: "error", error: e  as any };
-}
-}
+
 }
 
 /** user-defined events **/
@@ -40,10 +25,10 @@ deepLinkEvent: "plugin:deeplink2:deep-link-event"
 
 /** user-defined types **/
 
-export type AuthDeepLink = { action: "Callback"; access_token: string; refresh_token: string }
-export type DeepLink = { type: "Auth"; data: AuthDeepLink } | { type: "Unknown"; data: { url: string } }
+export type DeepLink = { to: "/app/onboarding"; search: OnboardingSearch }
 export type DeepLinkEvent = DeepLink
-export type DeepLinkInfo = { name: string; description: string; example: string }
+export type OnboardingSearch = { step: OnboardingStep; local?: boolean }
+export type OnboardingStep = "welcome" | "permissions"
 
 /** tauri-specta globals **/
 

plugins/deeplink2/src/error.rs

@@ -10,6 +10,8 @@ pub enum Error {
     UnknownPath(String),
     #[error("url parse error: {0}")]
     UrlParse(#[from] url::ParseError),
+    #[error("missing query parameter: {0}")]
+    MissingQueryParam(String),
 }
 
 impl Serialize for Error {

plugins/deeplink2/src/lib.rs

@@ -1,22 +1,16 @@
-mod commands;
 mod error;
-mod ext;
 mod types;
 
 pub use error::{Error, Result};
-pub use ext::*;
-pub use types::*;
 
 const PLUGIN_NAME: &str = "deeplink2";
 
 fn make_specta_builder<R: tauri::Runtime>() -> tauri_specta::Builder<R> {
     tauri_specta::Builder::<R>::new()
         .plugin_name(PLUGIN_NAME)
-        .commands(tauri_specta::collect_commands![
-            commands::ping::<tauri::Wry>,
-            commands::get_available_deep_links::<tauri::Wry>,
-        ])
-        .events(tauri_specta::collect_events![events::DeepLinkEvent])
+        .commands(tauri_specta::collect_commands![])
+        .events(tauri_specta::collect_events![types::DeepLinkEvent])
+        .typ::<types::DeepLink>()
         .error_handling(tauri_specta::ErrorHandlingMode::Result)
 }
 
@@ -29,11 +23,6 @@ pub fn init<R: tauri::Runtime>() -> tauri::plugin::TauriPlugin<R> {
         .build()
 }
 
-pub mod events {
-    #[derive(Debug, Clone, serde::Serialize, specta::Type, tauri_specta::Event)]
-    pub struct DeepLinkEvent(pub crate::DeepLink);
-}
-
 #[cfg(test)]
 mod test {
     use super::*;