chore(deps) Update Tauri API Definitions (#4512)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Lucas Nogueira <lucas@tauri.studio>

.github/workflows/lint-js.yml

@@ -22,7 +22,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '12'
+          node-version: '14'
           cache: yarn
           cache-dependency-path: tooling/*/yarn.lock
       - name: install cli.js deps via yarn

core/tauri-utils/src/config.rs

@@ -409,7 +409,7 @@ pub struct WixConfig {
 
 /// Install modes for the Webview2 runtime.
 /// Note that for the updater bundle [`Self::DownloadBootstrapper`] is used.
-/// 
+///
 /// For more information see <https://tauri.app/v1/guides/building/windows>.
 #[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
 #[serde(tag = "type", rename_all = "camelCase", deny_unknown_fields)]

tooling/api/package.json

@@ -41,16 +41,16 @@
     "yarn": ">= 1.19.1"
   },
   "devDependencies": {
-    "@babel/core": "7.18.5",
+    "@babel/core": "7.18.6",
-    "@babel/preset-env": "7.18.2",
+    "@babel/preset-env": "7.18.6",
-    "@babel/preset-typescript": "7.17.12",
+    "@babel/preset-typescript": "7.18.6",
     "@rollup/plugin-babel": "5.3.1",
-    "@rollup/plugin-commonjs": "22.0.0",
+    "@rollup/plugin-commonjs": "22.0.1",
     "@rollup/plugin-node-resolve": "13.3.0",
     "@rollup/plugin-sucrase": "4.0.4",
     "@rollup/plugin-typescript": "8.3.3",
-    "@typescript-eslint/eslint-plugin": "5.29.0",
+    "@typescript-eslint/eslint-plugin": "5.30.0",
-    "@typescript-eslint/parser": "5.29.0",
+    "@typescript-eslint/parser": "5.30.0",
     "eslint": "8.18.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard-with-typescript": "21.0.1",
@@ -64,11 +64,11 @@
     "rollup": "2.75.7",
     "rollup-plugin-terser": "7.0.2",
     "tslib": "2.4.0",
-    "typedoc": "0.22.17",
+    "typedoc": "0.23.2",
-    "typedoc-plugin-markdown": "3.12.1",
+    "typedoc-plugin-markdown": "3.13.1",
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "type-fest": "2.13.1"
+    "type-fest": "2.14.0"
   }
 }

tooling/api/src/fs.ts

@@ -33,14 +33,14 @@
  *
  * This module prevents path traversal, not allowing absolute paths or parent dir components
  * (i.e. "/usr/path/to/file" or "../path/to/file" paths are not allowed).
- * Paths accessed with this API must be relative to one of the [[BaseDirectory | base directories]]
+ * Paths accessed with this API must be relative to one of the {@link BaseDirectory | base directories}
  * so if you need access to arbitrary filesystem paths, you must write such logic on the core layer instead.
  *
  * The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
  *
  * The scope configuration is an array of glob patterns describing folder paths that are allowed.
  * For instance, this scope configuration only allows accessing files on the
- * *databases* folder of the [[path.appDir | $APP directory]]:
+ * *databases* folder of the {@link path.appDir | $APP directory}:
  * ```json
  * {
  *   "tauri": {
@@ -53,14 +53,14 @@
  * }
  * ```
  *
- * Notice the use of the `$APP` variable. The value is injected at runtime, resolving to the [[path.appDir | app directory]].
+ * Notice the use of the `$APP` variable. The value is injected at runtime, resolving to the {@link path.appDir | app directory}.
  * The available variables are:
- * [[path.audioDir | `$AUDIO`]], [[path.cacheDir | `$CACHE`]], [[path.configDir | `$CONFIG`]], [[path.dataDir | `$DATA`]],
+ * {@link path.audioDir | `$AUDIO`}, {@link path.cacheDir | `$CACHE`}, {@link path.configDir | `$CONFIG`}, {@link path.dataDir | `$DATA`},
- * [[path.localDataDir | `$LOCALDATA`]], [[path.desktopDir | `$DESKTOP`]], [[path.documentDir | `$DOCUMENT`]],
+ * {@link path.localDataDir | `$LOCALDATA`}, {@link path.desktopDir | `$DESKTOP`}, {@link path.documentDir | `$DOCUMENT`},
- * [[path.downloadDir | `$DOWNLOAD`]], [[path.executableDir | `$EXE`]], [[path.fontDir | `$FONT`]], [[path.homeDir | `$HOME`]],
+ * {@link path.downloadDir | `$DOWNLOAD`}, {@link path.executableDir | `$EXE`}, {@link path.fontDir | `$FONT`}, {@link path.homeDir | `$HOME`},
- * [[path.pictureDir | `$PICTURE`]], [[path.publicDir | `$PUBLIC`]], [[path.runtimeDir | `$RUNTIME`]],
+ * {@link path.pictureDir | `$PICTURE`}, {@link path.publicDir | `$PUBLIC`}, {@link path.runtimeDir | `$RUNTIME`},
- * [[path.templateDir | `$TEMPLATE`]], [[path.videoDir | `$VIDEO`]], [[path.resourceDir | `$RESOURCE`]], [[path.appDir | `$APP`]],
+ * {@link path.templateDir | `$TEMPLATE`}, {@link path.videoDir | `$VIDEO`}, {@link path.resourceDir | `$RESOURCE`}, {@link path.appDir | `$APP`},
- * [[path.logDir | `$LOG`]], [[os.tempdir | `$TEMP`]].
+ * {@link path.logDir | `$LOG`}, {@link os.tempdir | `$TEMP`}.
  *
  * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.
  *

tooling/api/src/shell.ts

@@ -29,18 +29,18 @@
  *
  * This API has a scope configuration that forces you to restrict the programs and arguments that can be used.
  *
- * ### Restricting access to the [[open | `open`]] API
+ * ### Restricting access to the {@link open | `open`} API
  *
- * On the allowlist, `open: true` means that the [[open]] API can be used with any URL,
+ * On the allowlist, `open: true` means that the {@link open} API can be used with any URL,
  * as the argument is validated with the `^https?://` regex.
  * You can change that regex by changing the boolean value to a string, e.g. `open: ^https://github.com/`.
  *
- * ### Restricting access to the [[Command | `Command`]] APIs
+ * ### Restricting access to the {@link Command | `Command`} APIs
  *
  * The `shell` allowlist object has a `scope` field that defines an array of CLIs that can be used.
  * Each CLI is a configuration object `{ name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }`.
  *
- * - `name`: the unique identifier of the command, passed to the [[Command.constructor | Command constructor]].
+ * - `name`: the unique identifier of the command, passed to the {@link Command.constructor | Command constructor}.
  * If it's a sidecar, this must be the value defined on `tauri.conf.json > tauri > bundle > externalBin`.
  * - `cmd`: the program that is executed on this configuration. If it's a sidecar, this value is ignored.
  * - `sidecar`: whether the object configures a sidecar or a system program.