feat(deep-link): Add deep link support for desktop

.github/workflows/test-rust.yml

@@ -56,6 +56,9 @@ jobs:
             tauri-plugin-clipboard-manager:
               - .github/workflows/test-rust.yml
               - plugins/clipboard-manager/**
+            tauri-plugin-deep-link:
+              - .github/workflows/test-rust.yml
+              - plugins/deep-link/**
             tauri-plugin-dialog:
               - .github/workflows/test-rust.yml
               - plugins/dialog/**

Cargo.toml

@@ -13,6 +13,7 @@ log = "0.4"
 tauri = "2.0.0-beta.17"
 tauri-build = "2.0.0-beta.13"
 tauri-plugin = "2.0.0-beta.13"
+tauri-utils = "2.0.0-beta.13"
 serde_json = "1"
 thiserror = "1"
 url = "2"

plugins/deep-link/Cargo.toml

@@ -17,12 +17,22 @@ targets = [ "x86_64-linux-android" ]
 [build-dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }
+tauri-utils = { workspace = true }
 tauri-plugin = { workspace = true, features = [ "build" ] }
 
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }
 tauri = { workspace = true }
+tauri-utils = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
 url = { workspace = true }
+
+[target."cfg(windows)".dependencies]
+dunce = "1"
+windows-registry = "0.1"
+windows-result = "0.1"
+
+[target.'cfg(target_os = "linux")'.dependencies]
+rust-ini = "0.21"

plugins/deep-link/README.md

@@ -93,16 +93,19 @@ See [supporting associated domains](https://developer.apple.com/documentation/xc
 
 ## Configuration
 
-Under `tauri.conf.json > plugins > deep-link`, configure the domains you want to associate with your application:
+Under `tauri.conf.json > plugins > deep-link`, configure the domains (mobile) and schemes (desktop) you want to associate with your application:
 
 ```json
 {
   "plugins": {
     "deep-link": {
-      "domains": [
+      "mobile": [
         { "host": "your.website.com", "pathPrefix": ["/open"] },
         { "host": "another.site.br" }
-      ]
+      ],
+      "desktop": {
+        "schemes": ["something", "my-tauri-app"]
+      }
     }
   }
 }
@@ -128,10 +131,12 @@ Afterwards all the plugin's APIs are available through the JavaScript guest bind
 ```javascript
 import { onOpenUrl } from "@tauri-apps/plugin-deep-link";
 await onOpenUrl((urls) => {
-  console.log('deep link:', urls);
+  console.log("deep link:", urls);
 });
 ```
 
+Note that the Plugin will only emit events on macOS, iOS and Android. On Windows and Linux the OS will spawn a new instance of your app with the URL as a CLI argument. If you want your app to behave on Windows & Linux similar to the other platforms you can use the [single-instance](../single-instance/) plugin.
+
 ## Contributing
 
 PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

plugins/deep-link/build.rs

@@ -6,7 +6,7 @@
 mod config;
 use config::{AssociatedDomain, Config};
 
-const COMMANDS: &[&str] = &["get_current"];
+const COMMANDS: &[&str] = &["get_current", "register", "unregister", "is_registered"];
 
 // TODO: Consider using activity-alias in case users may have multiple activities in their app.
 // TODO: Do we want to support the other path* configs too?
@@ -48,7 +48,7 @@ fn main() {
             "DEEP LINK PLUGIN",
             "activity",
             config
-                .domains
+                .mobile
                 .iter()
                 .map(intent_filter)
                 .collect::<Vec<_>>()
@@ -62,7 +62,7 @@ fn main() {
                 entitlements.insert(
                     "com.apple.developer.associated-domains".into(),
                     config
-                        .domains
+                        .mobile
                         .into_iter()
                         .map(|d| format!("applinks:{}", d.host).into())
                         .collect::<Vec<_>>()

plugins/deep-link/examples/app/src-tauri/tauri.conf.json

@@ -28,15 +28,13 @@
       "hello": "world"
     },
     "deep-link": {
-      "domains": [
-        {
-          "host": "fabianlars.de",
-          "pathPrefix": ["/intent"]
-        },
-        {
-          "host": "tauri.app"
-        }
-      ]
+      "mobile": [
+        { "host": "fabianlars.de", "pathPrefix": ["/intent"] },
+        { "host": "tauri.app" }
+      ],
+      "desktop": {
+        "schemes": ["fabianlars", "my-tauri-app"]
+      }
     }
   },
   "bundle": {

plugins/deep-link/examples/app/tsconfig.json

@@ -3,7 +3,7 @@
     "target": "ESNext",
     "module": "ESNext",
     "lib": ["ESNext", "DOM"],
-    "moduleResolution": "Node",
+    "moduleResolution": "bundler",
     "strict": true,
     "sourceMap": true,
     "resolveJsonModule": true,

plugins/deep-link/guest-js/index.ts

@@ -5,12 +5,95 @@
 import { invoke } from "@tauri-apps/api/core";
 import { type UnlistenFn, listen } from "@tauri-apps/api/event";
 
+/**
+ * Get the current URLs that triggered the deep link. Use this on app load to check whether your app was started via a deep link.
+ *
+ * @example
+ * ```typescript
+ * import { getCurrent } from '@tauri-apps/plugin-deep-link';
+ * const urls = await getCurrent();
+ * ```
+ *
+ * #### - **Windows / Linux**: Unsupported.
+ *
+ * @since 2.0.0
+ */
 export async function getCurrent(): Promise<string[] | null> {
-  return await invoke<string[] | null>("plugin:deep-link|get_current");
+  return await invoke("plugin:deep-link|get_current");
+}
+
+/**
+ * Register the app as the default handler for the specified protocol.
+ *
+ * @param protocol The name of the protocol without `://`. For example, if you want your app to handle `tauri://` links, call this method with `tauri` as the protocol.
+ *
+ * @example
+ * ```typescript
+ * import { register } from '@tauri-apps/plugin-deep-link';
+ * await register("my-scheme");
+ * ```
+ *
+ * #### - **macOS / Android / iOS**: Unsupported.
+ *
+ * @since 2.0.0
+ */
+export async function register(protocol: string): Promise<null> {
+  return await invoke("plugin:deep-link|register", { protocol });
+}
+
+/**
+ * Unregister the app as the default handler for the specified protocol.
+ *
+ * @param protocol The name of the protocol without `://`.
+ *
+ * @example
+ * ```typescript
+ * import { unregister } from '@tauri-apps/plugin-deep-link';
+ * await unregister("my-scheme");
+ * ```
+ *
+ * #### - **macOS / Linux / Android / iOS**: Unsupported.
+ *
+ * @since 2.0.0
+ */
+export async function unregister(protocol: string): Promise<null> {
+  return await invoke("plugin:deep-link|unregister", { protocol });
+}
 
-  // return await invoke("plugin:deep-link|get_current");
+/**
+ * Check whether the app is the default handler for the specified protocol.
+ *
+ * @param protocol The name of the protocol without `://`.
+ *
+ * @example
+ * ```typescript
+ * import { isRegistered } from '@tauri-apps/plugin-deep-link';
+ * await isRegistered("my-scheme");
+ * ```
+ *
+ * #### - **macOS / Android / iOS**: Unsupported, always returns `true`.
+ *
+ * @since 2.0.0
+ */
+export async function isRegistered(protocol: string): Promise<boolean> {
+  return await invoke("plugin:deep-link|i_registered", { protocol });
 }
 
+/**
+ * Helper function for the `deep-link://new-url` event to run a function each time the protocol is triggered while the app is running. Use `getCurrent` on app load to check whether your app was started via a deep link.
+ *
+ * @param protocol The name of the protocol without `://`.
+ *
+ * @example
+ * ```typescript
+ * import { onOpenUrl } from '@tauri-apps/plugin-deep-link';
+ * await onOpenUrl((urls) => { console.log(urls) });
+ * ```
+ *
+ * #### - **Windows / Linux**: Unsupported, the OS will spawn a new app instance passing the URL as a CLI argument.
+ *
+ * @since 2.0.0
+ */
 export async function onOpenUrl(
   handler: (urls: string[]) => void,
 ): Promise<UnlistenFn> {