update template plugin to support custom template

Author: yujonglee

crates/template/src/lib.rs

@@ -170,6 +170,15 @@ pub fn render(
     }
 }
 
+pub fn render_custom(
+    template_content: &str,
+    ctx: &serde_json::Map<String, serde_json::Value>,
+) -> Result<String, crate::Error> {
+    let env = get_environment();
+    let tpl = env.template_from_str(template_content)?;
+    tpl.render(ctx).map_err(Into::into)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

plugins/template/build.rs

@@ -1,4 +1,4 @@
-const COMMANDS: &[&str] = &["render"];
+const COMMANDS: &[&str] = &["render", "render_custom"];
 
 fn main() {
     tauri_plugin::Builder::new(COMMANDS).build();

plugins/template/js/bindings.gen.ts

@@ -14,6 +14,14 @@ async render(name: Template, ctx: Partial<{ [key in string]: JsonValue }>) : Pro
     if(e instanceof Error) throw e;
     else return { status: "error", error: e  as any };
 }
+},
+async renderCustom(templateContent: string, ctx: Partial<{ [key in string]: JsonValue }>) : Promise<Result<string, string>> {
+    try {
+    return { status: "ok", data: await TAURI_INVOKE("plugin:template|render_custom", { templateContent, ctx }) };
+} catch (e) {
+    if(e instanceof Error) throw e;
+    else return { status: "error", error: e  as any };
+}
 }
 }
 

plugins/template/permissions/autogenerated/commands/render_custom.toml

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

plugins/template/permissions/autogenerated/reference.md

@@ -5,6 +5,7 @@ Default permissions for the plugin
 #### This default permission set includes the following:
 
 - `allow-render`
+- `allow-render-custom`
 
 ## Permission Table
 
@@ -38,6 +39,32 @@ Enables the render command without any pre-configured scope.
 
 Denies the render command without any pre-configured scope.
 
+</td>
+</tr>
+
+<tr>
+<td>
+
+`template:allow-render-custom`
+
+</td>
+<td>
+
+Enables the render_custom command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`template:deny-render-custom`
+
+</td>
+<td>
+
+Denies the render_custom command without any pre-configured scope.
+
 </td>
 </tr>
 </table>

plugins/template/permissions/default.toml

@@ -1,3 +1,3 @@
 [default]
 description = "Default permissions for the plugin"
-permissions = ["allow-render"]
+permissions = ["allow-render", "allow-render-custom"]

plugins/template/permissions/schemas/schema.json

@@ -307,10 +307,22 @@
           "markdownDescription": "Denies the render command without any pre-configured scope."
         },
         {
-          "description": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-render`",
+          "description": "Enables the render_custom command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-render-custom",
+          "markdownDescription": "Enables the render_custom command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the render_custom command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-render-custom",
+          "markdownDescription": "Denies the render_custom command without any pre-configured scope."
+        },
+        {
+          "description": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-render`\n- `allow-render-custom`",
           "type": "string",
           "const": "default",
-          "markdownDescription": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-render`"
+          "markdownDescription": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-render`\n- `allow-render-custom`"
         }
       ]
     }

plugins/template/src/commands.rs

@@ -9,3 +9,13 @@ pub async fn render<R: tauri::Runtime>(
 ) -> Result<String, String> {
     app.render(name, ctx)
 }
+
+#[tauri::command]
+#[specta::specta]
+pub async fn render_custom<R: tauri::Runtime>(
+    app: tauri::AppHandle<R>,
+    template_content: String,
+    ctx: serde_json::Map<String, serde_json::Value>,
+) -> Result<String, String> {
+    app.render_custom(&template_content, ctx)
+}

plugins/template/src/ext.rs

@@ -4,6 +4,12 @@ pub trait TemplatePluginExt<R: tauri::Runtime> {
         name: hypr_template::Template,
         ctx: serde_json::Map<String, serde_json::Value>,
     ) -> Result<String, String>;
+
+    fn render_custom(
+        &self,
+        template_content: &str,
+        ctx: serde_json::Map<String, serde_json::Value>,
+    ) -> Result<String, String>;
 }
 
 impl<R: tauri::Runtime, T: tauri::Manager<R>> TemplatePluginExt<R> for T {
@@ -17,4 +23,15 @@ impl<R: tauri::Runtime, T: tauri::Manager<R>> TemplatePluginExt<R> for T {
             .map(|s| s.trim().to_string())
             .map_err(|e| e.to_string())
     }
+
+    #[tracing::instrument(skip_all)]
+    fn render_custom(
+        &self,
+        template_content: &str,
+        ctx: serde_json::Map<String, serde_json::Value>,
+    ) -> Result<String, String> {
+        hypr_template::render_custom(template_content, &ctx)
+            .map(|s| s.trim().to_string())
+            .map_err(|e| e.to_string())
+    }
 }

plugins/template/src/lib.rs

@@ -11,7 +11,10 @@ const PLUGIN_NAME: &str = "template";
 fn make_specta_builder<R: tauri::Runtime>() -> tauri_specta::Builder<R> {
     tauri_specta::Builder::<R>::new()
         .plugin_name(PLUGIN_NAME)
-        .commands(tauri_specta::collect_commands![commands::render::<Wry>,])
+        .commands(tauri_specta::collect_commands![
+            commands::render::<Wry>,
+            commands::render_custom::<Wry>,
+        ])
         .typ::<hypr_gbnf::Grammar>()
         .error_handling(tauri_specta::ErrorHandlingMode::Result)
 }