refactor(dialog): reuse message command for confirm (#3287)

* chore(dialog): reuse `message` command for confirm

* Add change file

* Remove ask and confirm from default permissions

* Format

* Remove extra `toString`

* Point `allow-confirm` to `allow-message`

Author: Legend-Master

.changes/re-use-message-dialog-command.md

@@ -0,0 +1,6 @@
+---
+"dialog": minor
+"dialog-js": minor
+---
+
+Re-use `message` command in Rust side for `ask` and `confirm` commands, `allow-ask` and `allow-confirm` permissions are now aliases to `allow-message`

examples/api/src-tauri/capabilities/base.json

@@ -23,11 +23,7 @@
     "core:window:allow-start-dragging",
     "notification:default",
     "os:allow-platform",
-    "dialog:allow-open",
-    "dialog:allow-ask",
-    "dialog:allow-save",
-    "dialog:allow-confirm",
-    "dialog:allow-message",
+    "dialog:default",
     {
       "identifier": "shell:allow-spawn",
       "allow": [

plugins/dialog/api-iife.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-const COMMANDS: &[&str] = &["open", "save", "message", "ask", "confirm"];
+const COMMANDS: &[&str] = &["open", "save", "message"];
 
 fn main() {
     let result = tauri_plugin::Builder::new(COMMANDS)

plugins/dialog/build.rs

@@ -405,6 +405,16 @@ async function save(options: SaveDialogOptions = {}): Promise<string | null> {
  */
 export type MessageDialogResult = 'Yes' | 'No' | 'Ok' | 'Cancel' | (string & {})
 
+async function messageCommand(message: string, options?: MessageDialogOptions) {
+  return await invoke<MessageDialogResult>('plugin:dialog|message', {
+    message,
+    title: options?.title,
+    kind: options?.kind,
+    okButtonLabel: options?.okLabel,
+    buttons: buttonsToRust(options?.buttons)
+  })
+}
+
 /**
  * Shows a message dialog with an `Ok` button.
  * @example
@@ -427,18 +437,14 @@ async function message(
   options?: string | MessageDialogOptions
 ): Promise<MessageDialogResult> {
   const opts = typeof options === 'string' ? { title: options } : options
-
-  return invoke<MessageDialogResult>('plugin:dialog|message', {
-    message: message.toString(),
-    title: opts?.title?.toString(),
-    kind: opts?.kind,
-    okButtonLabel: opts?.okLabel?.toString(),
-    buttons: buttonsToRust(opts?.buttons)
-  })
+  return messageCommand(message, opts)
 }
 
 /**
  * Shows a question dialog with `Yes` and `No` buttons.
+ *
+ * Convenient wrapper for `await message('msg', { buttons: 'YesNo' }) === 'Yes'`
+ *
  * @example
  * ```typescript
  * import { ask } from '@tauri-apps/plugin-dialog';
@@ -458,17 +464,24 @@ async function ask(
   options?: string | ConfirmDialogOptions
 ): Promise<boolean> {
   const opts = typeof options === 'string' ? { title: options } : options
-  return await invoke('plugin:dialog|ask', {
-    message: message.toString(),
-    title: opts?.title?.toString(),
-    kind: opts?.kind,
-    yesButtonLabel: opts?.okLabel?.toString(),
-    noButtonLabel: opts?.cancelLabel?.toString()
-  })
+  const customButtons = opts?.okLabel || opts?.cancelLabel
+  const okLabel = opts?.okLabel ?? 'Yes'
+  return (
+    (await messageCommand(message, {
+      title: opts?.title,
+      kind: opts?.kind,
+      buttons: customButtons
+        ? { ok: okLabel, cancel: opts.cancelLabel ?? 'No' }
+        : 'YesNo'
+    })) === okLabel
+  )
 }
 
 /**
  * Shows a question dialog with `Ok` and `Cancel` buttons.
+ *
+ * Convenient wrapper for `await message('msg', { buttons: 'OkCancel' }) === 'Ok'`
+ *
  * @example
  * ```typescript
  * import { confirm } from '@tauri-apps/plugin-dialog';
@@ -488,13 +501,17 @@ async function confirm(
   options?: string | ConfirmDialogOptions
 ): Promise<boolean> {
   const opts = typeof options === 'string' ? { title: options } : options
-  return await invoke('plugin:dialog|confirm', {
-    message: message.toString(),
-    title: opts?.title?.toString(),
-    kind: opts?.kind,
-    okButtonLabel: opts?.okLabel?.toString(),
-    cancelButtonLabel: opts?.cancelLabel?.toString()
-  })
+  const customButtons = opts?.okLabel || opts?.cancelLabel
+  const okLabel = opts?.okLabel ?? 'Ok'
+  return (
+    (await messageCommand(message, {
+      title: opts?.title,
+      kind: opts?.kind,
+      buttons: customButtons
+        ? { ok: okLabel, cancel: opts.cancelLabel ?? 'Cancel' }
+        : 'OkCancel'
+    })) === okLabel
+  )
 }
 
 export type {

plugins/dialog/guest-js/index.ts

@@ -0,0 +1,11 @@
+"$schema" = "schemas/schema.json"
+
+[[permission]]
+identifier = "allow-ask"
+description = "Enables the ask command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `allow-message` and will be removed in v3)"
+commands.allow = ["message"]
+
+[[permission]]
+identifier = "deny-ask"
+description = "Denies the ask command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `deny-message` and will be removed in v3)"
+commands.deny = ["message"]

plugins/dialog/permissions/ask.toml

@@ -9,8 +9,6 @@ All dialog types are enabled.
 
 #### This default permission set includes the following:
 
-- `allow-ask`
-- `allow-confirm`
 - `allow-message`
 - `allow-save`
 - `allow-open`
@@ -32,7 +30,7 @@ All dialog types are enabled.
 </td>
 <td>
 
-Enables the ask command without any pre-configured scope.
+Enables the ask command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `allow-message` and will be removed in v3)
 
 </td>
 </tr>
@@ -45,111 +43,111 @@ Enables the ask command without any pre-configured scope.
 </td>
 <td>
 
-Denies the ask command without any pre-configured scope.
+Denies the ask command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `deny-message` and will be removed in v3)
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:allow-confirm`
+`dialog:allow-message`
 
 </td>
 <td>
 
-Enables the confirm command without any pre-configured scope.
+Enables the message command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:deny-confirm`
+`dialog:deny-message`
 
 </td>
 <td>
 
-Denies the confirm command without any pre-configured scope.
+Denies the message command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:allow-message`
+`dialog:allow-open`
 
 </td>
 <td>
 
-Enables the message command without any pre-configured scope.
+Enables the open command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:deny-message`
+`dialog:deny-open`
 
 </td>
 <td>
 
-Denies the message command without any pre-configured scope.
+Denies the open command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:allow-open`
+`dialog:allow-save`
 
 </td>
 <td>
 
-Enables the open command without any pre-configured scope.
+Enables the save command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:deny-open`
+`dialog:deny-save`
 
 </td>
 <td>
 
-Denies the open command without any pre-configured scope.
+Denies the save command without any pre-configured scope.
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:allow-save`
+`dialog:allow-confirm`
 
 </td>
 <td>
 
-Enables the save command without any pre-configured scope.
+Enables the confirm command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `allow-message` and will be removed in v3)
 
 </td>
 </tr>
 
 <tr>
 <td>
 
-`dialog:deny-save`
+`dialog:deny-confirm`
 
 </td>
 <td>
 
-Denies the save command without any pre-configured scope.
+Denies the confirm command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `deny-message` and will be removed in v3)
 
 </td>
 </tr>

plugins/dialog/permissions/autogenerated/commands/ask.toml

@@ -0,0 +1,11 @@
+"$schema" = "schemas/schema.json"
+
+[[permission]]
+identifier = "allow-confirm"
+description = "Enables the confirm command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `allow-message` and will be removed in v3)"
+commands.allow = ["message"]
+
+[[permission]]
+identifier = "deny-confirm"
+description = "Denies the confirm command without any pre-configured scope. (**DEPRECATED**: This is now an alias to `deny-message` and will be removed in v3)"
+commands.deny = ["message"]