feat(template): add mobile projects, build script, fill initial src code (#305)

shared/template/src/commands.rs

@@ -0,0 +1,17 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri::{AppHandle, command, Runtime, State, Window};
+
+use crate::{MyState, Result};
+
+#[command]
+pub(crate) async fn execute<R: Runtime>(
+  _app: AppHandle<R>,
+  _window: Window<R>,
+  state: State<'_, MyState>,
+) -> Result<String> {
+  state.0.lock().unwrap().insert("key".into(), "value".into());
+  Ok("success".to_string())
+}

shared/template/src/desktop.rs

@@ -0,0 +1,26 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{plugin::PluginApi, AppHandle, Runtime};
+
+use crate::models::*;
+
+pub fn init<R: Runtime, C: DeserializeOwned>(
+  app: &AppHandle<R>,
+  _api: PluginApi<R, C>,
+) -> crate::Result<{{ plugin_name_pascal_case }}<R>> {
+  Ok({{ plugin_name_pascal_case }}(app.clone()))
+}
+
+/// Access to the {{ plugin_name }} APIs.
+pub struct {{ plugin_name_pascal_case }}<R: Runtime>(AppHandle<R>);
+
+impl<R: Runtime> {{ plugin_name_pascal_case }}<R> {
+  pub fn ping(&self, payload: PingRequest) -> crate::Result<PingResponse> {
+    Ok(PingResponse {
+      value: payload.value,
+    })
+  }
+}

shared/template/src/error.rs

@@ -0,0 +1,25 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::{ser::Serializer, Serialize};
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    #[error(transparent)]
+    Io(#[from] std::io::Error),
+    #[cfg(mobile)]
+    #[error(transparent)]
+    PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
+}
+
+impl Serialize for Error {
+    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(self.to_string().as_ref())
+    }
+}

shared/template/src/lib.rs

@@ -0,0 +1,60 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri::{
+  plugin::{Builder, TauriPlugin},
+  Manager, Runtime,
+};
+
+use std::{collections::HashMap, sync::Mutex};
+
+pub use models::*;
+
+#[cfg(desktop)]
+mod desktop;
+#[cfg(mobile)]
+mod mobile;
+
+mod commands;
+mod error;
+mod models;
+
+pub use error::{Error, Result};
+
+#[cfg(desktop)]
+use desktop::{{ plugin_name_pascal_case }};
+#[cfg(mobile)]
+use mobile::{{ plugin_name_pascal_case }};
+
+#[derive(Default)]
+struct MyState(Mutex<HashMap<String, String>>);
+
+/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the {{ plugin_name }} APIs.
+pub trait {{ plugin_name_pascal_case }}Ext<R: Runtime> {
+  fn {{ plugin_name_snake_case }}(&self) -> &{{ plugin_name_pascal_case }}<R>;
+}
+
+impl<R: Runtime, T: Manager<R>> crate::{{ plugin_name_pascal_case }}Ext<R> for T {
+  fn {{ plugin_name_snake_case }}(&self) -> &{{ plugin_name_pascal_case }}<R> {
+    self.state::<{{ plugin_name_pascal_case }}<R>>().inner()
+  }
+}
+
+/// Initializes the plugin.
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+  Builder::new("{{ plugin_name }}")
+    .invoke_handler(tauri::generate_handler![commands::execute])
+    .setup(|app, api| {
+      #[cfg(mobile)]
+      let {{ plugin_name_snake_case }} = mobile::init(app, api)?;
+      #[cfg(desktop)]
+      let {{ plugin_name_snake_case }} = desktop::init(app, api)?;
+      app.manage({{ plugin_name_snake_case }});
+
+      // manage state so it is accessible by the commands
+      app.manage(MyState::default());
+      Ok(())
+    })
+    .build()
+}

shared/template/src/mobile.rs

@@ -0,0 +1,41 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{
+  plugin::{PluginApi, PluginHandle},
+  AppHandle, Runtime,
+};
+
+use crate::models::*;
+
+#[cfg(target_os = "android")]
+const PLUGIN_IDENTIFIER: &str = "{{ android_package_id }}";
+
+#[cfg(target_os = "ios")]
+tauri::ios_plugin_binding!(init_plugin_{{ plugin_name }});
+
+// initializes the Kotlin or Swift plugin classes
+pub fn init<R: Runtime, C: DeserializeOwned>(
+  _app: &AppHandle<R>,
+  api: PluginApi<R, C>,
+) -> crate::Result<{{ plugin_name_pascal_case }}<R>> {
+  #[cfg(target_os = "android")]
+  let handle = api.register_android_plugin(PLUGIN_IDENTIFIER, "ExamplePlugin")?;
+  #[cfg(target_os = "ios")]
+  let handle = api.register_ios_plugin(init_plugin_{{ plugin_name }})?;
+  Ok({{ plugin_name_pascal_case }}(handle))
+}
+
+/// Access to the {{ plugin_name }} APIs.
+pub struct {{ plugin_name_pascal_case }}<R: Runtime>(PluginHandle<R>);
+
+impl<R: Runtime> {{ plugin_name_pascal_case }}<R> {
+  pub fn ping(&self, payload: PingRequest) -> crate::Result<PingResponse> {
+    self
+      .0
+      .run_mobile_plugin("ping", payload)
+      .map_err(Into::into)
+  }
+}

shared/template/src/models.rs

@@ -0,0 +1,17 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct PingRequest {
+    pub value: Option<String>,
+}
+
+#[derive(Debug, Clone, Default, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct PingResponse {
+    pub value: Option<String>,
+}