@tauri-apps/cli 2.2.7 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## \[2.3.0]
+
+### Enhancements
+
+- [`a2d36b8c3`](https://www.github.com/tauri-apps/tauri/commit/a2d36b8c34a8dcfc6736797ca5cd4665faf75e7e) ([#12181](https://www.github.com/tauri-apps/tauri/pull/12181) by [@bastiankistner](https://www.github.com/tauri-apps/tauri/../../bastiankistner)) Add an option to change the default background throttling policy (currently for WebKit only).
+
+### Dependencies
+
+- Upgraded to `tauri-cli@2.3.0`
+
 ## \[2.2.7]
 
 ### Bug Fixes

package/config.schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://schema.tauri.app/config/2.2.4",
+  "$id": "https://schema.tauri.app/config/2.3.0",
   "title": "Config",
-  "description": "The Tauri configuration object.\n It is read from a file where you can define your frontend assets,\n configure the bundler and define a tray icon.\n\n The configuration file is generated by the\n [`tauri init`](https://v2.tauri.app/reference/cli/#init) command that lives in\n your Tauri application source directory (src-tauri).\n\n Once generated, you may modify it at will to customize your Tauri application.\n\n ## File Formats\n\n By default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\n Tauri also supports JSON5 and TOML files via the `config-json5` and `config-toml` Cargo features, respectively.\n The JSON5 file name must be either `tauri.conf.json` or `tauri.conf.json5`.\n The TOML file name is `Tauri.toml`.\n\n ## Platform-Specific Configuration\n\n In addition to the default configuration file, Tauri can\n read a platform-specific configuration from `tauri.linux.conf.json`,\n `tauri.windows.conf.json`, `tauri.macos.conf.json`, `tauri.android.conf.json` and `tauri.ios.conf.json`\n (or `Tauri.linux.toml`, `Tauri.windows.toml`, `Tauri.macos.toml`, `Tauri.android.toml` and `Tauri.ios.toml` if the `Tauri.toml` format is used),\n which gets merged with the main configuration object.\n\n ## Configuration Structure\n\n The configuration is composed of the following objects:\n\n - [`app`](#appconfig): The Tauri configuration\n - [`build`](#buildconfig): The build configuration\n - [`bundle`](#bundleconfig): The bundle configurations\n - [`plugins`](#pluginconfig): The plugins configuration\n\n Example tauri.config.json file:\n\n ```json\n {\n   \"productName\": \"tauri-app\",\n   \"version\": \"0.1.0\",\n   \"build\": {\n     \"beforeBuildCommand\": \"\",\n     \"beforeDevCommand\": \"\",\n     \"devUrl\": \"../dist\",\n     \"frontendDist\": \"../dist\"\n   },\n   \"app\": {\n     \"security\": {\n       \"csp\": null\n     },\n     \"windows\": [\n       {\n         \"fullscreen\": false,\n         \"height\": 600,\n         \"resizable\": true,\n         \"title\": \"Tauri App\",\n         \"width\": 800\n       }\n     ]\n   },\n   \"bundle\": {},\n   \"plugins\": {}\n }\n ```",
+  "description": "The Tauri configuration object.\n It is read from a file where you can define your frontend assets,\n configure the bundler and define a tray icon.\n\n The configuration file is generated by the\n [`tauri init`](https://v2.tauri.app/reference/cli/#init) command that lives in\n your Tauri application source directory (src-tauri).\n\n Once generated, you may modify it at will to customize your Tauri application.\n\n ## File Formats\n\n By default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\n Tauri also supports JSON5 and TOML files via the `config-json5` and `config-toml` Cargo features, respectively.\n The JSON5 file name must be either `tauri.conf.json` or `tauri.conf.json5`.\n The TOML file name is `Tauri.toml`.\n\n ## Platform-Specific Configuration\n\n In addition to the default configuration file, Tauri can\n read a platform-specific configuration from `tauri.linux.conf.json`,\n `tauri.windows.conf.json`, `tauri.macos.conf.json`, `tauri.android.conf.json` and `tauri.ios.conf.json`\n (or `Tauri.linux.toml`, `Tauri.windows.toml`, `Tauri.macos.toml`, `Tauri.android.toml` and `Tauri.ios.toml` if the `Tauri.toml` format is used),\n which gets merged with the main configuration object.\n\n ## Configuration Structure\n\n The configuration is composed of the following objects:\n\n - [`app`](#appconfig): The Tauri configuration\n - [`build`](#buildconfig): The build configuration\n - [`bundle`](#bundleconfig): The bundle configurations\n - [`plugins`](#pluginconfig): The plugins configuration\n\n Example tauri.config.json file:\n\n ```json\n {\n   \"productName\": \"tauri-app\",\n   \"version\": \"0.1.0\",\n   \"build\": {\n     \"beforeBuildCommand\": \"\",\n     \"beforeDevCommand\": \"\",\n     \"devUrl\": \"http://localhost:3000\",\n     \"frontendDist\": \"../dist\"\n   },\n   \"app\": {\n     \"security\": {\n       \"csp\": null\n     },\n     \"windows\": [\n       {\n         \"fullscreen\": false,\n         \"height\": 600,\n         \"resizable\": true,\n         \"title\": \"Tauri App\",\n         \"width\": 800\n       }\n     ]\n   },\n   \"bundle\": {},\n   \"plugins\": {}\n }\n ```",
   "type": "object",
   "required": [
     "identifier"
@@ -516,6 +516,17 @@
               "type": "null"
             }
           ]
+        },
+        "backgroundThrottling": {
+          "description": "Change the default background throttling behaviour.\n\n By default, browsers use a suspend policy that will throttle timers and even unload\n the whole tab (view) to free resources after roughly 5 minutes when a view became\n minimized or hidden. This will pause all tasks until the documents visibility state\n changes back from hidden to visible by bringing the view back to the foreground.\n\n ## Platform-specific\n\n - **Linux / Windows / Android**: Unsupported. Workarounds like a pending WebLock transaction might suffice.\n - **iOS**: Supported since version 17.0+.\n - **macOS**: Supported since version 14.0+.\n\n see https://github.com/tauri-apps/tauri/issues/5250#issuecomment-2569380578",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/BackgroundThrottlingPolicy"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false
@@ -948,6 +959,32 @@
         }
       ]
     },
+    "BackgroundThrottlingPolicy": {
+      "description": "Background throttling policy.",
+      "oneOf": [
+        {
+          "description": "A policy where background throttling is disabled",
+          "type": "string",
+          "enum": [
+            "disabled"
+          ]
+        },
+        {
+          "description": "A policy where a web view that’s not in a window fully suspends tasks. This is usually the default behavior in case no policy is set.",
+          "type": "string",
+          "enum": [
+            "suspend"
+          ]
+        },
+        {
+          "description": "A policy where a web view that’s not in a window limits processing, but does not fully suspend tasks.",
+          "type": "string",
+          "enum": [
+            "throttle"
+          ]
+        }
+      ]
+    },
     "SecurityConfig": {
       "description": "Security configuration.\n\n See more: <https://v2.tauri.app/reference/config/#securityconfig>",
       "type": "object",
@@ -1663,7 +1700,7 @@
           ]
         },
         "devUrl": {
-          "description": "The URL to load in development.\n\n This is usually an URL to a dev server, which serves your application assets with hot-reload and HMR.\n Most modern JavaScript bundlers like [vite](https://vitejs.dev/guide/) provides a way to start a dev server by default.\n\n If you don't have a dev server or don't want to use one, ignore this option and use [`frontendDist`](BuildConfig::frontend_dist)\n and point to a web assets directory, and Tauri CLI will run its built-in dev server and provide a simple hot-reload experience.",
+          "description": "The URL to load in development.\n\n This is usually an URL to a dev server, which serves your application assets with hot-reload and HMR.\n Most modern JavaScript bundlers like [Vite](https://vite.dev/guide/) provides a way to start a dev server by default.\n\n If you don't have a dev server or don't want to use one, ignore this option and use [`frontendDist`](BuildConfig::frontend_dist)\n and point to a web assets directory, and Tauri CLI will run its built-in dev server and provide a simple hot-reload experience.",
           "type": [
             "string",
             "null"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/cli",
-  "version": "2.2.7",
+  "version": "2.3.0",
   "description": "Command line interface for building Tauri apps",
   "funding": {
     "type": "opencollective",
@@ -41,7 +41,7 @@
     "@napi-rs/cli": "2.18.4",
     "@types/node": "^22.10.1",
     "cross-env": "7.0.3",
-    "vitest": "^3.0.0"
+    "vitest": "^3.0.5"
   },
   "engines": {
     "node": ">= 10"
@@ -62,15 +62,15 @@
     "tauri": "node ./tauri.js"
   },
   "optionalDependencies": {
-    "@tauri-apps/cli-win32-x64-msvc": "2.2.7",
-    "@tauri-apps/cli-darwin-x64": "2.2.7",
-    "@tauri-apps/cli-linux-x64-gnu": "2.2.7",
-    "@tauri-apps/cli-darwin-arm64": "2.2.7",
-    "@tauri-apps/cli-linux-arm64-gnu": "2.2.7",
-    "@tauri-apps/cli-linux-arm64-musl": "2.2.7",
-    "@tauri-apps/cli-linux-arm-gnueabihf": "2.2.7",
-    "@tauri-apps/cli-linux-x64-musl": "2.2.7",
-    "@tauri-apps/cli-win32-ia32-msvc": "2.2.7",
-    "@tauri-apps/cli-win32-arm64-msvc": "2.2.7"
+    "@tauri-apps/cli-win32-x64-msvc": "2.3.0",
+    "@tauri-apps/cli-darwin-x64": "2.3.0",
+    "@tauri-apps/cli-linux-x64-gnu": "2.3.0",
+    "@tauri-apps/cli-darwin-arm64": "2.3.0",
+    "@tauri-apps/cli-linux-arm64-gnu": "2.3.0",
+    "@tauri-apps/cli-linux-arm64-musl": "2.3.0",
+    "@tauri-apps/cli-linux-arm-gnueabihf": "2.3.0",
+    "@tauri-apps/cli-linux-x64-musl": "2.3.0",
+    "@tauri-apps/cli-win32-ia32-msvc": "2.3.0",
+    "@tauri-apps/cli-win32-arm64-msvc": "2.3.0"
   }
 }