feat: rewrite crate public API to be significantly easier to use

Author: nekename

.gitignore

@@ -1,2 +1,2 @@
-/target
+target/
 Cargo.lock

Cargo.toml

@@ -1,25 +1,27 @@
 [package]
 name = "openaction"
-description = "A crate for creating plugins for the OpenAction API."
+description = "A crate for creating plugins for the OpenAction API"
 categories = [
 	"api-bindings",
 	"asynchronous",
 	"data-structures",
 	"web-programming::websocket",
 ]
-authors = ["ninjadev64"]
-version = "1.1.5"
+authors = ["nekename"]
+version = "2.0.0"
 edition = "2024"
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/OpenActionAPI/rust"
 homepage = "https://openaction.amankhanna.me"
 
 [dependencies]
-anyhow = "1.0"
+thiserror = "1.0"
+async-trait = "0.1"
+dashmap = "6.1"
 futures-util = "0.3"
 log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-tokio = { version = "1.42", features = ["rt", "net", "sync"] }
-tokio-tungstenite = "0.26"
+tokio = { version = "1.47", features = ["rt", "net", "sync"] }
+tokio-tungstenite = "0.28"

README.md

@@ -1,6 +1,52 @@
 # openaction-rs
 
-A Rust crate for creating plugins for the [OpenAction API](https://openaction.amankhanna.me) (compatible with the Stream Deck SDK).
+A Rust crate for creating plugins for the [OpenAction API](https://openaction.amankhanna.me) (backwards-compatible with the Stream Deck SDK)
 
-My [Linux Media plugin](https://github.com/nekename/oampris) serves as a minimal example of using this crate.
-The [OpenDeck Starter Pack plugin](https://github.com/nekename/OpenDeck/tree/main/plugins/com.amansprojects.starterpack.sdPlugin) is also made with this crate.
+```rust
+use openaction::*;
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Default, Clone)]
+#[serde(default)]
+struct CounterSettings {
+	value: u32,
+}
+
+struct CounterAction;
+#[async_trait]
+impl Action for CounterAction {
+	const UUID: ActionUuid = "com.example.counter.counter";
+	type Settings = CounterSettings;
+
+	async fn key_up(
+		&self,
+		instance: &Instance,
+		settings: &Self::Settings,
+	) -> OpenActionResult<()> {
+		let mut clone = settings.clone();
+		clone.value = settings.value + 1;
+		instance.set_settings(&clone).await?;
+		instance.set_title(clone.value.to_string()).await
+	}
+}
+
+#[tokio::main]
+async fn main() -> OpenActionResult<()> {
+	{
+		use simplelog::*;
+		if let Err(error) = TermLogger::init(
+			LevelFilter::Debug,
+			Config::default(),
+			TerminalMode::Stdout,
+			ColorChoice::Never,
+		) {
+			eprintln!("Logger initialization failed: {}", error);
+		}
+	}
+
+	register_action(CounterAction).await;
+
+	run(std::env::args().collect()).await
+}
+```

src/inbound/encoder.rs

@@ -1,12 +1,11 @@
-use crate::SettingsValue;
-
-use super::Coordinates;
+use super::{Coordinates, SettingsValue};
 
 use serde::Deserialize;
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct DialRotatePayload {
 	pub settings: SettingsValue,
+	#[allow(dead_code)]
 	pub coordinates: Coordinates,
 	pub ticks: i16,
 	pub pressed: bool,
@@ -16,21 +15,25 @@ pub struct DialRotatePayload {
 pub struct DialRotateEvent {
 	pub action: String,
 	pub context: String,
+	#[allow(dead_code)]
 	pub device: String,
 	pub payload: DialRotatePayload,
 }
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct DialPressPayload {
+	#[allow(dead_code)]
 	pub controller: String,
 	pub settings: SettingsValue,
+	#[allow(dead_code)]
 	pub coordinates: Coordinates,
 }
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct DialPressEvent {
 	pub action: String,
 	pub context: String,
+	#[allow(dead_code)]
 	pub device: String,
 	pub payload: DialPressPayload,
 }

src/inbound/keypad.rs

@@ -6,6 +6,7 @@ use serde::Deserialize;
 pub struct KeyEvent {
 	pub action: String,
 	pub context: String,
+	#[allow(dead_code)]
 	pub device: String,
 	pub payload: GenericInstancePayload,
 }