@skalfa/skalfa-printer 1.0.0

package/src-rust/Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+name = "tauri-plugin-skalfa-printer"
+version = "0.1.0"
+edition = "2021"
+description = "Tauri 2 plugin for thermal/raw printing via Windows Print Spooler API"
+authors = ["Skalfa"]
+license = "MIT"
+links = "tauri-plugin-skalfa-printer"
+
+[lib]
+name = "tauri_plugin_skalfa_printer"
+crate-type = ["lib"]
+
+[build-dependencies]
+tauri-plugin = { version = "2", features = ["build"] }
+
+[dependencies]
+tauri = { version = "2", features = [] }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+thiserror = "2"
+log = "0.4"
+
+[target.'cfg(windows)'.dependencies]
+windows = { version = "0.58", features = [
+  "Win32_Graphics_Printing",
+  "Win32_Graphics_Gdi",
+  "Win32_Foundation",
+  "Win32_Security",
+] }

package/src-rust/build.rs

@@ -0,0 +1,5 @@
+const COMMANDS: &[&str] = &["list_printers", "print_raw", "get_printer_status"];
+
+fn main() {
+    tauri_plugin::Builder::new(COMMANDS).build();
+}

package/src-rust/permissions/autogenerated/commands/get_printer_status.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-get-printer-status"
+description = "Enables the get_printer_status command without any pre-configured scope."
+commands.allow = ["get_printer_status"]
+
+[[permission]]
+identifier = "deny-get-printer-status"
+description = "Denies the get_printer_status command without any pre-configured scope."
+commands.deny = ["get_printer_status"]

package/src-rust/permissions/autogenerated/commands/list_printers.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-list-printers"
+description = "Enables the list_printers command without any pre-configured scope."
+commands.allow = ["list_printers"]
+
+[[permission]]
+identifier = "deny-list-printers"
+description = "Denies the list_printers command without any pre-configured scope."
+commands.deny = ["list_printers"]

package/src-rust/permissions/autogenerated/commands/print_raw.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-print-raw"
+description = "Enables the print_raw command without any pre-configured scope."
+commands.allow = ["print_raw"]
+
+[[permission]]
+identifier = "deny-print-raw"
+description = "Denies the print_raw command without any pre-configured scope."
+commands.deny = ["print_raw"]

package/src-rust/permissions/autogenerated/reference.md

@@ -0,0 +1,97 @@
+## Default Permission
+
+Default permissions for the skalfa-printer plugin
+
+#### This default permission set includes the following:
+
+- `allow-list-printers`
+- `allow-print-raw`
+- `allow-get-printer-status`
+
+## Permission Table
+
+<table>
+<tr>
+<th>Identifier</th>
+<th>Description</th>
+</tr>
+
+
+<tr>
+<td>
+
+`skalfa-printer:allow-get-printer-status`
+
+</td>
+<td>
+
+Enables the get_printer_status command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`skalfa-printer:deny-get-printer-status`
+
+</td>
+<td>
+
+Denies the get_printer_status command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`skalfa-printer:allow-list-printers`
+
+</td>
+<td>
+
+Enables the list_printers command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`skalfa-printer:deny-list-printers`
+
+</td>
+<td>
+
+Denies the list_printers command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`skalfa-printer:allow-print-raw`
+
+</td>
+<td>
+
+Enables the print_raw command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`skalfa-printer:deny-print-raw`
+
+</td>
+<td>
+
+Denies the print_raw command without any pre-configured scope.
+
+</td>
+</tr>
+</table>

package/src-rust/permissions/default.toml

@@ -0,0 +1,3 @@
+[default]
+description = "Default permissions for the skalfa-printer plugin"
+permissions = ["allow-list-printers", "allow-print-raw", "allow-get-printer-status"]

package/src-rust/permissions/schemas/schema.json

@@ -0,0 +1,342 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PermissionFile",
+  "description": "Permission file that can define a default permission, a set of permissions or a list of inlined permissions.",
+  "type": "object",
+  "properties": {
+    "default": {
+      "description": "The default permission set for the plugin",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/DefaultPermission"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "set": {
+      "description": "A list of permissions sets defined",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/PermissionSet"
+      }
+    },
+    "permission": {
+      "description": "A list of inlined permissions",
+      "default": [],
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Permission"
+      }
+    }
+  },
+  "definitions": {
+    "DefaultPermission": {
+      "description": "The default permission set of the plugin.\n\nWorks similarly to a permission with the \"default\" identifier.",
+      "type": "object",
+      "required": [
+        "permissions"
+      ],
+      "properties": {
+        "version": {
+          "description": "The version of the permission.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "format": "uint64",
+          "minimum": 1.0
+        },
+        "description": {
+          "description": "Human-readable description of what the permission does. Tauri convention is to use `<h4>` headings in markdown content for Tauri documentation generation purposes.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "permissions": {
+          "description": "All permissions this set contains.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "PermissionSet": {
+      "description": "A set of direct permissions grouped together under a new name.",
+      "type": "object",
+      "required": [
+        "description",
+        "identifier",
+        "permissions"
+      ],
+      "properties": {
+        "identifier": {
+          "description": "A unique identifier for the permission.",
+          "type": "string"
+        },
+        "description": {
+          "description": "Human-readable description of what the permission does.",
+          "type": "string"
+        },
+        "permissions": {
+          "description": "All permissions this set contains.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PermissionKind"
+          }
+        }
+      }
+    },
+    "Permission": {
+      "description": "Descriptions of explicit privileges of commands.\n\nIt can enable commands to be accessible in the frontend of the application.\n\nIf the scope is defined it can be used to fine grain control the access of individual or multiple commands.",
+      "type": "object",
+      "required": [
+        "identifier"
+      ],
+      "properties": {
+        "version": {
+          "description": "The version of the permission.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "format": "uint64",
+          "minimum": 1.0
+        },
+        "identifier": {
+          "description": "A unique identifier for the permission.",
+          "type": "string"
+        },
+        "description": {
+          "description": "Human-readable description of what the permission does. Tauri internal convention is to use `<h4>` headings in markdown content for Tauri documentation generation purposes.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "commands": {
+          "description": "Allowed or denied commands when using this permission.",
+          "default": {
+            "allow": [],
+            "deny": []
+          },
+          "allOf": [
+            {
+              "$ref": "#/definitions/Commands"
+            }
+          ]
+        },
+        "scope": {
+          "description": "Allowed or denied scoped when using this permission.",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Scopes"
+            }
+          ]
+        },
+        "platforms": {
+          "description": "Target platforms this permission applies. By default all platforms are affected by this permission.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/Target"
+          }
+        }
+      }
+    },
+    "Commands": {
+      "description": "Allowed and denied commands inside a permission.\n\nIf two commands clash inside of `allow` and `deny`, it should be denied by default.",
+      "type": "object",
+      "properties": {
+        "allow": {
+          "description": "Allowed command.",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "deny": {
+          "description": "Denied command, which takes priority.",
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Scopes": {
+      "description": "An argument for fine grained behavior control of Tauri commands.\n\nIt can be of any serde serializable type and is used to allow or prevent certain actions inside a Tauri command. The configured scope is passed to the command and will be enforced by the command implementation.\n\n## Example\n\n```json { \"allow\": [{ \"path\": \"$HOME/**\" }], \"deny\": [{ \"path\": \"$HOME/secret.txt\" }] } ```",
+      "type": "object",
+      "properties": {
+        "allow": {
+          "description": "Data that defines what is allowed by the scope.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/Value"
+          }
+        },
+        "deny": {
+          "description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/Value"
+          }
+        }
+      }
+    },
+    "Value": {
+      "description": "All supported ACL values.",
+      "anyOf": [
+        {
+          "description": "Represents a null JSON value.",
+          "type": "null"
+        },
+        {
+          "description": "Represents a [`bool`].",
+          "type": "boolean"
+        },
+        {
+          "description": "Represents a valid ACL [`Number`].",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Number"
+            }
+          ]
+        },
+        {
+          "description": "Represents a [`String`].",
+          "type": "string"
+        },
+        {
+          "description": "Represents a list of other [`Value`]s.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Value"
+          }
+        },
+        {
+          "description": "Represents a map of [`String`] keys to [`Value`]s.",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/Value"
+          }
+        }
+      ]
+    },
+    "Number": {
+      "description": "A valid ACL number.",
+      "anyOf": [
+        {
+          "description": "Represents an [`i64`].",
+          "type": "integer",
+          "format": "int64"
+        },
+        {
+          "description": "Represents a [`f64`].",
+          "type": "number",
+          "format": "double"
+        }
+      ]
+    },
+    "Target": {
+      "description": "Platform target.",
+      "oneOf": [
+        {
+          "description": "MacOS.",
+          "type": "string",
+          "enum": [
+            "macOS"
+          ]
+        },
+        {
+          "description": "Windows.",
+          "type": "string",
+          "enum": [
+            "windows"
+          ]
+        },
+        {
+          "description": "Linux.",
+          "type": "string",
+          "enum": [
+            "linux"
+          ]
+        },
+        {
+          "description": "Android.",
+          "type": "string",
+          "enum": [
+            "android"
+          ]
+        },
+        {
+          "description": "iOS.",
+          "type": "string",
+          "enum": [
+            "iOS"
+          ]
+        }
+      ]
+    },
+    "PermissionKind": {
+      "type": "string",
+      "oneOf": [
+        {
+          "description": "Enables the get_printer_status command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-get-printer-status",
+          "markdownDescription": "Enables the get_printer_status command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the get_printer_status command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-get-printer-status",
+          "markdownDescription": "Denies the get_printer_status command without any pre-configured scope."
+        },
+        {
+          "description": "Enables the list_printers command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-list-printers",
+          "markdownDescription": "Enables the list_printers command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the list_printers command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-list-printers",
+          "markdownDescription": "Denies the list_printers command without any pre-configured scope."
+        },
+        {
+          "description": "Enables the print_raw command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-print-raw",
+          "markdownDescription": "Enables the print_raw command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the print_raw command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-print-raw",
+          "markdownDescription": "Denies the print_raw command without any pre-configured scope."
+        },
+        {
+          "description": "Default permissions for the skalfa-printer plugin\n#### This default permission set includes:\n\n- `allow-list-printers`\n- `allow-print-raw`\n- `allow-get-printer-status`",
+          "type": "string",
+          "const": "default",
+          "markdownDescription": "Default permissions for the skalfa-printer plugin\n#### This default permission set includes:\n\n- `allow-list-printers`\n- `allow-print-raw`\n- `allow-get-printer-status`"
+        }
+      ]
+    }
+  }
+}

package/src-rust/src/commands.rs

@@ -0,0 +1,62 @@
+use crate::error::Error;
+
+#[cfg(windows)]
+use crate::printer_windows;
+
+#[cfg(windows)]
+use crate::printer_windows::PrinterInfo;
+
+#[cfg(not(windows))]
+use serde::Serialize;
+
+#[cfg(not(windows))]
+#[derive(Debug, Clone, Serialize)]
+pub struct PrinterInfo {
+    pub name: String,
+    pub port: String,
+    pub driver: String,
+    pub is_default: bool,
+    pub status: u32,
+    pub status_text: String,
+}
+
+#[tauri::command]
+pub fn list_printers() -> Result<Vec<PrinterInfo>, Error> {
+    #[cfg(windows)]
+    {
+        printer_windows::enum_printers()
+    }
+
+    #[cfg(not(windows))]
+    {
+        Err(Error::UnsupportedPlatform)
+    }
+}
+
+#[tauri::command]
+pub fn print_raw(printer: String, content: String) -> Result<(), Error> {
+    #[cfg(windows)]
+    {
+        printer_windows::print_raw(&printer, &content)
+    }
+
+    #[cfg(not(windows))]
+    {
+        let _ = (printer, content);
+        Err(Error::UnsupportedPlatform)
+    }
+}
+
+#[tauri::command]
+pub fn get_printer_status(printer: String) -> Result<PrinterInfo, Error> {
+    #[cfg(windows)]
+    {
+        printer_windows::get_printer_status(&printer)
+    }
+
+    #[cfg(not(windows))]
+    {
+        let _ = printer;
+        Err(Error::UnsupportedPlatform)
+    }
+}

package/src-rust/src/error.rs

@@ -0,0 +1,34 @@
+use serde::Serialize;
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    #[error("Failed to enumerate printers: {0}")]
+    EnumPrinters(String),
+
+    #[error("Failed to open printer '{0}': {1}")]
+    OpenPrinter(String, String),
+
+    #[error("Failed to start print job: {0}")]
+    StartDoc(String),
+
+    #[error("Failed to write to printer: {0}")]
+    WritePrinter(String),
+
+    #[error("Printer not found: {0}")]
+    PrinterNotFound(String),
+
+    #[error("Platform not supported")]
+    UnsupportedPlatform,
+
+    #[error("{0}")]
+    Other(String),
+}
+
+impl Serialize for Error {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        serializer.serialize_str(&self.to_string())
+    }
+}

package/src-rust/src/lib.rs

@@ -0,0 +1,20 @@
+mod commands;
+mod error;
+
+#[cfg(windows)]
+mod printer_windows;
+
+use tauri::{
+    plugin::{Builder, TauriPlugin},
+    Runtime,
+};
+
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+    Builder::new("skalfa-printer")
+        .invoke_handler(tauri::generate_handler![
+            commands::list_printers,
+            commands::print_raw,
+            commands::get_printer_status,
+        ])
+        .build()
+}