feat: add file association support, closes #3736 (#4320)

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
Co-authored-by: Raphii <iam@raphii.co>
Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
Co-authored-by: Lucas Nogueira <lucas@tauri.app>

Author: 5 people

.changes/file-associations-config.md

@@ -0,0 +1,5 @@
+---
+"tauri-utils": minor:feat
+---
+
+Add a configuration object for file associations under `BundleConfig`.

.changes/file-associations.md

@@ -0,0 +1,5 @@
+---
+"tauri": minor:feat
+---
+
+Added support to file associations.

.changes/runtime-opened-event.md

@@ -0,0 +1,6 @@
+---
+"tauri-runtime": minor:feat
+"tauri-runtime-wry": minor:feat
+---
+
+Added the `Opened` variant to `RunEvent`.

.github/workflows/covector-version-or-publish.yml

@@ -121,7 +121,7 @@ jobs:
           steps.covector.outputs.successfulPublish == 'true' &&
           contains(steps.covector.outputs.packagesPublished, '@tauri-apps/cli')
         run: |
-          echo '${{ steps.covector.outputs }}' > output.json
+          echo '${{ toJSON(steps.covector.outputs) }}' > output.json
           id=$(jq '.["-tauri-apps-cli-releaseId"]' < output.json)
           rm output.json
           echo "cliReleaseId=$id" >> "$GITHUB_OUTPUT"

Cargo.toml

@@ -20,6 +20,7 @@ exclude = [
   "examples/resources/src-tauri",
   "examples/sidecar/src-tauri",
   "examples/web/core",
+  "examples/file-associations/src-tauri",
   "examples/workspace",
 ]
 

core/tauri-config-schema/schema.json

@@ -925,6 +925,16 @@
             "null"
           ]
         },
+        "fileAssociations": {
+          "description": "File associations to application.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/FileAssociation"
+          }
+        },
         "shortDescription": {
           "description": "A short description of your application.",
           "type": [
@@ -1122,6 +1132,97 @@
         }
       ]
     },
+    "FileAssociation": {
+      "description": "File association",
+      "type": "object",
+      "required": [
+        "ext"
+      ],
+      "properties": {
+        "ext": {
+          "description": "File extensions to associate with this app. e.g. 'png'",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AssociationExt"
+          }
+        },
+        "name": {
+          "description": "The name. Maps to `CFBundleTypeName` on macOS. Default to ext[0]",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "description": {
+          "description": "The association description. Windows-only. It is displayed on the `Type` column on Windows Explorer.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "role": {
+          "description": "The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS.",
+          "default": "Editor",
+          "allOf": [
+            {
+              "$ref": "#/definitions/BundleTypeRole"
+            }
+          ]
+        },
+        "mimeType": {
+          "description": "The mime-type e.g. 'image/png' or 'text/plain'. Linux-only.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "AssociationExt": {
+      "description": "An extension for a [`FileAssociation`].\n\nA leading `.` is automatically stripped.",
+      "type": "string"
+    },
+    "BundleTypeRole": {
+      "description": "macOS-only. Corresponds to CFBundleTypeRole",
+      "oneOf": [
+        {
+          "description": "CFBundleTypeRole.Editor. Files can be read and edited.",
+          "type": "string",
+          "enum": [
+            "Editor"
+          ]
+        },
+        {
+          "description": "CFBundleTypeRole.Viewer. Files can be read.",
+          "type": "string",
+          "enum": [
+            "Viewer"
+          ]
+        },
+        {
+          "description": "CFBundleTypeRole.Shell",
+          "type": "string",
+          "enum": [
+            "Shell"
+          ]
+        },
+        {
+          "description": "CFBundleTypeRole.QLGenerator",
+          "type": "string",
+          "enum": [
+            "QLGenerator"
+          ]
+        },
+        {
+          "description": "CFBundleTypeRole.None",
+          "type": "string",
+          "enum": [
+            "None"
+          ]
+        }
+      ]
+    },
     "AppImageConfig": {
       "description": "Configuration for AppImage bundles.\n\nSee more: https://tauri.app/v1/api/config#appimageconfig",
       "type": "object",

core/tauri-runtime-wry/Cargo.toml

@@ -13,23 +13,23 @@ edition = { workspace = true }
 rust-version = { workspace = true }
 
 [dependencies]
-wry = { version = "0.28.3", default-features = false, features = [ "file-drop", "protocol" ] }
+wry = { version = "0.30", default-features = false, features = [ "file-drop", "protocol" ] }
 tauri-runtime = { version = "0.13.0-alpha.6", path = "../tauri-runtime" }
 tauri-utils = { version = "2.0.0-alpha.6", path = "../tauri-utils" }
 uuid = { version = "1", features = [ "v4" ] }
 rand = "0.8"
 raw-window-handle = "0.5"
 
 [target."cfg(windows)".dependencies]
-webview2-com = "0.22"
+webview2-com = "0.25"
 
   [target."cfg(windows)".dependencies.windows]
-  version = "0.44"
+  version = "0.48"
   features = [ "Win32_Foundation" ]
 
 [target."cfg(any(target_os = \"linux\", target_os = \"dragonfly\", target_os = \"freebsd\", target_os = \"openbsd\", target_os = \"netbsd\"))".dependencies]
 gtk = { version = "0.16", features = [ "v3_24" ] }
-webkit2gtk = { version = "0.19.1", features = [ "v2_38" ] }
+webkit2gtk = { version = "1.1", features = [ "v2_38" ] }
 percent-encoding = "2.1"
 
 [target."cfg(any(target_os = \"ios\", target_os = \"macos\"))".dependencies]
@@ -48,4 +48,4 @@ macos-private-api = [
   "tauri-runtime/macos-private-api"
 ]
 objc-exception = [ "wry/objc-exception" ]
-linux-headers = [ "wry/linux-headers", "webkit2gtk/v2_36" ]
+linux-headers = [ ]

core/tauri-runtime-wry/src/lib.rs

@@ -2952,6 +2952,10 @@ fn handle_event_loop<T: UserEvent>(
         );
       }
     },
+    #[cfg(target_os = "macos")]
+    Event::Opened { urls } => {
+      callback(RunEvent::Opened { urls });
+    }
     _ => (),
   }
 

core/tauri-runtime/Cargo.toml

@@ -35,7 +35,7 @@ rand = "0.8"
 url = { version = "2" }
 
 [target."cfg(windows)".dependencies.windows]
-version = "0.44"
+version = "0.48"
 features = [ "Win32_Foundation" ]
 
 [target."cfg(any(target_os = \"linux\", target_os = \"dragonfly\", target_os = \"freebsd\", target_os = \"openbsd\", target_os = \"netbsd\"))".dependencies]
@@ -44,6 +44,9 @@ gtk = { version = "0.16", features = [ "v3_24" ] }
 [target."cfg(target_os = \"android\")".dependencies]
 jni = "0.20"
 
+[target."cfg(target_os = \"macos\")".dependencies]
+url = "2"
+
 [features]
 devtools = [ ]
 system-tray = [ ]

core/tauri-runtime/src/lib.rs

@@ -290,6 +290,7 @@ pub trait UserEvent: Debug + Clone + Send + 'static {}
 impl<T: Debug + Clone + Send + 'static> UserEvent for T {}
 
 /// Event triggered on the event loop run.
+#[derive(Debug)]
 #[non_exhaustive]
 pub enum RunEvent<T: UserEvent> {
   /// Event loop is exiting.
@@ -313,6 +314,9 @@ pub enum RunEvent<T: UserEvent> {
   ///
   /// This event is useful as a place to put your code that should be run after all state-changing events have been handled and you want to do stuff (updating state, performing calculations, etc) that happens as the “main body” of your event loop.
   MainEventsCleared,
+  /// Emitted when the user wants to open the specified resource with the app.
+  #[cfg(target_os = "macos")]
+  Opened { urls: Vec<url::Url> },
   /// A custom event defined by the user.
   UserEvent(T),
 }