feat: Port path api to js (#1006)

Co-authored-by: Lucas Nogueira <lucas@tauri.studio>

.changes/path-api.md

@@ -0,0 +1,6 @@
+---
+"tauri.js": minor
+"tauri": minor
+---
+
+Adds a path resolution API (e.g. getting the download directory or resolving a path to the home directory).

cli/tauri.js/api-src/bundle.ts

@@ -3,10 +3,22 @@ import * as cli from './cli'
 import * as dialog from './dialog'
 import * as event from './event'
 import * as fs from './fs'
+import * as path from './path'
 import http from './http'
 import * as process from './process'
 import * as tauri from './tauri'
 import * as window from './window'
 import * as notification from './notification'
 
-export { cli, dialog, event, fs, http, process, tauri, window, notification }
+export {
+  cli,
+  dialog,
+  event,
+  fs,
+  path,
+  http,
+  process,
+  tauri,
+  window,
+  notification
+}

cli/tauri.js/api-src/path.ts

@@ -0,0 +1,274 @@
+import { promisified } from './tauri'
+import { BaseDirectory } from './fs'
+
+/**
+ * @name appDir
+ * @description Returns the path to the suggested directory for your app config files.
+ * @return {Promise<string>}
+ */
+async function appDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.App
+  })
+}
+
+/**
+ * @name audioDir
+ * @description Returns the path to the user's audio directory.
+ * @return {Promise<string>}
+ */
+async function audioDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Audio
+  })
+}
+
+/**
+ * @name cacheDir
+ * @description Returns the path to the user's cache directory.
+ * @return {Promise<string>}
+ */
+async function cacheDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Cache
+  })
+}
+
+/**
+ * @name configDir
+ * @description Returns the path to the user's config directory.
+ * @return {Promise<string>}
+ */
+async function configDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Config
+  })
+}
+
+/**
+ * @name dataDir
+ * @description Returns the path to the user's data directory.
+ * @return {Promise<string>}
+ */
+async function dataDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Data
+  })
+}
+
+/**
+ * @name desktopDir
+ * @description Returns the path to the user's desktop directory.
+ * @return {Promise<string>}
+ */
+async function desktopDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Desktop
+  })
+}
+
+/**
+ * @name documentDir
+ * @description Returns the path to the user's document directory.
+ * @return {Promise<string>}
+ */
+async function documentDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Document
+  })
+}
+
+/**
+ * @name downloadDir
+ * @description Returns the path to the user's download directory.
+ * @return {Promise<string>}
+ */
+async function downloadDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Download
+  })
+}
+
+/**
+ * @name executableDir
+ * @description Returns the path to the user's executable directory.
+ * @return {Promise<string>}
+ */
+async function executableDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Executable
+  })
+}
+
+/**
+ * @name fontDir
+ * @description Returns the path to the user's font directory.
+ * @return {Promise<string>}
+ */
+async function fontDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Font
+  })
+}
+
+/**
+ * @name homeDir
+ * @description Returns the path to the user's home directory.
+ * @return {Promise<string>}
+ */
+async function homeDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Home
+  })
+}
+
+/**
+ * @name localDataDir
+ * @description Returns the path to the user's local data directory.
+ * @return {Promise<string>}
+ */
+async function localDataDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.LocalData
+  })
+}
+
+/**
+ * @name pictureDir
+ * @description Returns the path to the user's picture directory.
+ * @return {Promise<string>}
+ */
+async function pictureDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Picture
+  })
+}
+
+/**
+ * @name publicDir
+ * @description Returns the path to the user's public directory.
+ * @return {Promise<string>}
+ */
+async function publicDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Public
+  })
+}
+
+/**
+ * @name resourceDir
+ * @description Returns the path to the user's resource directory.
+ * @return {Promise<string>}
+ */
+async function resourceDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Resource
+  })
+}
+
+/**
+ * @name runtimeDir
+ * @descriptionReturns Returns the path to the user's runtime directory.
+ * @return {Promise<string>}
+ */
+async function runtimeDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Runtime
+  })
+}
+
+/**
+ * @name templateDir
+ * @descriptionReturns Returns the path to the user's template directory.
+ * @return {Promise<string>}
+ */
+async function templateDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Template
+  })
+}
+
+/**
+ * @name videoDir
+ * @descriptionReturns Returns the path to the user's video dir.
+ * @return {Promise<string>}
+ */
+async function videoDir(): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path: '.',
+    directory: BaseDirectory.Video
+  })
+}
+
+/**
+ * @name resolvePath
+ * @descriptionReturns Resolves the path with the optional base directory.
+ * @return {Promise<string>}
+ */
+async function resolvePath(
+  path: string,
+  directory: BaseDirectory
+): Promise<string> {
+  return await promisified<string>({
+    cmd: 'resolvePath',
+    path,
+    directory
+  })
+}
+
+export {
+  appDir,
+  audioDir,
+  cacheDir,
+  configDir,
+  dataDir,
+  desktopDir,
+  documentDir,
+  downloadDir,
+  executableDir,
+  fontDir,
+  homeDir,
+  localDataDir,
+  pictureDir,
+  publicDir,
+  resourceDir,
+  runtimeDir,
+  templateDir,
+  videoDir,
+  resolvePath
+}

cli/tauri.js/rollup.config.js

@@ -11,6 +11,7 @@ export default [
   {
     input: {
       fs: './api-src/fs.ts',
+      path: './api-src/path.ts',
       dialog: './api-src/dialog.ts',
       event: './api-src/event.ts',
       http: './api-src/http.ts',

tauri/Cargo.toml

@@ -63,6 +63,7 @@ create-dir = [ ]
 remove-dir = [ ]
 remove-file = [ ]
 rename-file = [ ]
+path-api = [ ]
 set-title = [ ]
 execute = [ ]
 open = [ ]

tauri/build.rs

@@ -94,6 +94,7 @@ fn shared() {
   setup_env_aliases();
 }
 
+#[allow(clippy::cognitive_complexity)]
 fn setup_env_aliases() {
   cfg_aliases! {
     embedded_server: { feature = "embedded-server" },
@@ -115,6 +116,9 @@ fn setup_env_aliases() {
     remove_file: { any(all_api, feature = "remove-file") },
     rename_file: { any(all_api, feature = "rename-file") },
 
+    // js path api
+    path_api: { any(all_api, feature = "path-api") },
+
     // window
     set_title: { any(all_api, feature = "set-title") },
     open: { any(all_api, feature = "open") },

tauri/src/endpoints.rs

@@ -1,6 +1,7 @@
 mod cmd;
 #[allow(unused_imports)]
 mod file_system;
+mod path;
 mod salt;
 
 #[cfg(assets)]
@@ -138,6 +139,17 @@ pub(crate) fn handle(webview: &mut Webview<'_>, arg: &str) -> crate::Result<()>
           #[cfg(not(rename_file))]
           allowlist_error(webview, error, "renameFile");
         }
+        ResolvePath {
+          path,
+          directory,
+          callback,
+          error,
+        } => {
+          #[cfg(path_api)]
+          path::resolve_path(webview, path, directory, callback, error);
+          #[cfg(not(path_api))]
+          allowlist_error(webview, error, "pathApi");
+        }
         SetTitle { title } => {
           #[cfg(set_title)]
           webview.set_title(&title);

tauri/src/endpoints/cmd.rs

@@ -139,6 +139,13 @@ pub enum Cmd {
     callback: String,
     error: String,
   },
+  /// The resolve path API
+  ResolvePath {
+    path: String,
+    directory: Option<BaseDirectory>,
+    callback: String,
+    error: String,
+  },
   /// The set webview title API.
   SetTitle {
     title: String,

tauri/src/endpoints/path.rs

@@ -0,0 +1,19 @@
+#![cfg(path_api)]
+use tauri_api::path;
+use tauri_api::path::BaseDirectory;
+use webview_official::Webview;
+
+pub fn resolve_path(
+  webview: &mut Webview<'_>,
+  path: String,
+  directory: Option<BaseDirectory>,
+  callback: String,
+  error: String,
+) {
+  crate::execute_promise(
+    webview,
+    move || path::resolve_path(path, directory),
+    callback,
+    error,
+  )
+}