custom plugin example

specta-rs · Sep 7, 2023 · 921363d · 921363d
1 parent c879faa
commit 921363d
Show file tree

Hide file tree

Showing 80 changed files with 1,702 additions and 63 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -18,15 +18,15 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 default = []
-javascript = []
+javascript = ["specta/typescript"]
 typescript = ["specta/typescript"]
 
 [dependencies]
 specta = { workspace = true, features = ["functions", "tauri"] }
 tauri-specta-macros = { path = "./macros" }
-serde = "1.0.152"
+serde = { workspace = true }
 serde_json = "1.0.93"
-tauri = "1.2.4"
+tauri = { workspace = true }
 thiserror = "1.0.38"
 heck = "0.4.1"
 indoc = "2.0.0"
@@ -36,11 +36,14 @@ doc-comment = "0.3.3"
 
 [workspace]
 members = [
-    "example/src-tauri",
+    "examples/app/src-tauri",
+    "examples/custom-plugin/app/src-tauri",
+    "examples/custom-plugin/plugin",
     "macros"
 ]
 
-
 [workspace.dependencies]
 # specta = { version = "=2.0.0-rc.1" }
+serde = "1.0.152"
 specta = { git = "https://github.com/oscartbeaumont/specta", rev = "5948d80f2551780eda2c7bf38450fc796c74cfbf" }
+tauri = "1.2.4"
diff --git a/example/index.html → examples/app/index.html b/example/index.html → examples/app/index.html
diff --git a/example/package.json → examples/app/package.json b/example/package.json → examples/app/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "example",
+  "name": "tauri-specta-app",
   "private": true,
   "version": "0.0.0",
   "type": "module",

diff --git a/example/pnpm-lock.yaml → examples/app/pnpm-lock.yaml b/example/pnpm-lock.yaml → examples/app/pnpm-lock.yaml
diff --git a/example/src-tauri/.gitignore → examples/app/src-tauri/.gitignore b/example/src-tauri/.gitignore → examples/app/src-tauri/.gitignore
diff --git a/example/src-tauri/Cargo.toml → examples/app/src-tauri/Cargo.toml b/example/src-tauri/Cargo.toml → examples/app/src-tauri/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "example"
+name = "tauri-specta-example-app"
 version = "0.0.0"
 description = "A Tauri App"
 authors = ["you"]
@@ -17,7 +17,7 @@ serde_json = "1.0"
 specta.workspace = true
 serde = { version = "1.0", features = ["derive"] }
 tauri = { version = "1.3.0", features = ["api-all"] }
-tauri-specta = { path = "../../", features = ["typescript", "javascript"] }
+tauri-specta = { path = "../../../", features = ["typescript", "javascript"] }
 
 [features]
 default = [ "custom-protocol" ]

diff --git a/example/src-tauri/build.rs → examples/app/src-tauri/build.rs b/example/src-tauri/build.rs → examples/app/src-tauri/build.rs
diff --git a/example/src-tauri/icons/128x128.png → examples/app/src-tauri/icons/128x128.png b/example/src-tauri/icons/128x128.png → examples/app/src-tauri/icons/128x128.png
diff --git a/example/src-tauri/icons/[email protected] → examples/app/src-tauri/icons/[email protected] b/example/src-tauri/icons/[email protected] → examples/app/src-tauri/icons/[email protected]
diff --git a/example/src-tauri/icons/32x32.png → examples/app/src-tauri/icons/32x32.png b/example/src-tauri/icons/32x32.png → examples/app/src-tauri/icons/32x32.png
diff --git a/...ple/src-tauri/icons/Square107x107Logo.png → ...app/src-tauri/icons/Square107x107Logo.png b/...ple/src-tauri/icons/Square107x107Logo.png → ...app/src-tauri/icons/Square107x107Logo.png
diff --git a/...ple/src-tauri/icons/Square142x142Logo.png → ...app/src-tauri/icons/Square142x142Logo.png b/...ple/src-tauri/icons/Square142x142Logo.png → ...app/src-tauri/icons/Square142x142Logo.png
diff --git a/...ple/src-tauri/icons/Square150x150Logo.png → ...app/src-tauri/icons/Square150x150Logo.png b/...ple/src-tauri/icons/Square150x150Logo.png → ...app/src-tauri/icons/Square150x150Logo.png
diff --git a/...ple/src-tauri/icons/Square284x284Logo.png → ...app/src-tauri/icons/Square284x284Logo.png b/...ple/src-tauri/icons/Square284x284Logo.png → ...app/src-tauri/icons/Square284x284Logo.png
diff --git a/example/src-tauri/icons/Square30x30Logo.png → ...s/app/src-tauri/icons/Square30x30Logo.png b/example/src-tauri/icons/Square30x30Logo.png → ...s/app/src-tauri/icons/Square30x30Logo.png
diff --git a/...ple/src-tauri/icons/Square310x310Logo.png → ...app/src-tauri/icons/Square310x310Logo.png b/...ple/src-tauri/icons/Square310x310Logo.png → ...app/src-tauri/icons/Square310x310Logo.png
diff --git a/example/src-tauri/icons/Square44x44Logo.png → ...s/app/src-tauri/icons/Square44x44Logo.png b/example/src-tauri/icons/Square44x44Logo.png → ...s/app/src-tauri/icons/Square44x44Logo.png
diff --git a/example/src-tauri/icons/Square71x71Logo.png → ...s/app/src-tauri/icons/Square71x71Logo.png b/example/src-tauri/icons/Square71x71Logo.png → ...s/app/src-tauri/icons/Square71x71Logo.png
diff --git a/example/src-tauri/icons/Square89x89Logo.png → ...s/app/src-tauri/icons/Square89x89Logo.png b/example/src-tauri/icons/Square89x89Logo.png → ...s/app/src-tauri/icons/Square89x89Logo.png
diff --git a/example/src-tauri/icons/StoreLogo.png → examples/app/src-tauri/icons/StoreLogo.png b/example/src-tauri/icons/StoreLogo.png → examples/app/src-tauri/icons/StoreLogo.png
diff --git a/example/src-tauri/icons/icon.icns → examples/app/src-tauri/icons/icon.icns b/example/src-tauri/icons/icon.icns → examples/app/src-tauri/icons/icon.icns
diff --git a/example/src-tauri/icons/icon.ico → examples/app/src-tauri/icons/icon.ico b/example/src-tauri/icons/icon.ico → examples/app/src-tauri/icons/icon.ico
diff --git a/example/src-tauri/icons/icon.png → examples/app/src-tauri/icons/icon.png b/example/src-tauri/icons/icon.png → examples/app/src-tauri/icons/icon.png
diff --git a/example/src-tauri/src/main.rs → examples/app/src-tauri/src/main.rs b/example/src-tauri/src/main.rs → examples/app/src-tauri/src/main.rs
diff --git a/example/src-tauri/tauri.conf.json → examples/app/src-tauri/tauri.conf.json b/example/src-tauri/tauri.conf.json → examples/app/src-tauri/tauri.conf.json
diff --git a/example/src/assets/tauri.svg → examples/app/src/assets/tauri.svg b/example/src/assets/tauri.svg → examples/app/src/assets/tauri.svg
diff --git a/example/src/assets/typescript.svg → examples/app/src/assets/typescript.svg b/example/src/assets/typescript.svg → examples/app/src/assets/typescript.svg
diff --git a/example/src/assets/vite.svg → examples/app/src/assets/vite.svg b/example/src/assets/vite.svg → examples/app/src/assets/vite.svg
diff --git a/example/src/bindings.ts → examples/app/src/bindings.ts b/example/src/bindings.ts → examples/app/src/bindings.ts
diff --git a/example/src/main.ts → examples/app/src/main.ts b/example/src/main.ts → examples/app/src/main.ts
diff --git a/example/src/style.css → examples/app/src/style.css b/example/src/style.css → examples/app/src/style.css
diff --git a/example/tsconfig.json → examples/app/tsconfig.json b/example/tsconfig.json → examples/app/tsconfig.json
diff --git a/example/vite.config.js → examples/app/vite.config.js b/example/vite.config.js → examples/app/vite.config.js
diff --git a/examples/custom-plugin/app/.gitignore b/examples/custom-plugin/app/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+dist
diff --git a/examples/custom-plugin/app/.vscode/extensions.json b/examples/custom-plugin/app/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["tauri-apps.tauri-vscode", "rust-lang.rust-analyzer"]
+}
diff --git a/examples/custom-plugin/app/README.md b/examples/custom-plugin/app/README.md
@@ -0,0 +1,7 @@
+# Tauri + Solid + Typescript
+
+This template should help get you started developing with Tauri, Solid and Typescript in Vite.
+
+## Recommended IDE Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
diff --git a/examples/custom-plugin/app/index.html b/examples/custom-plugin/app/index.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <link rel="icon" type="image/svg+xml" href="/src/assets/logo.svg" />
+    <title>Tauri + Solid + Typescript App</title>
+  </head>
+
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+
+    <script src="/src/index.tsx" type="module"></script>
+  </body>
+</html>
diff --git a/examples/custom-plugin/app/package.json b/examples/custom-plugin/app/package.json
@@ -0,0 +1,24 @@
+{
+  "name": "tauri-specta-example-custom-plugin-app",
+  "version": "0.0.0",
+  "description": "",
+  "scripts": {
+    "start": "vite",
+    "dev": "vite",
+    "build": "vite build",
+    "serve": "vite preview",
+    "tauri": "tauri"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "solid-js": "^1.7.8",
+    "@tauri-apps/api": "^1.4.0",
+    "tauri-specta-custom-plugin": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.2",
+    "vite": "^4.4.4",
+    "vite-plugin-solid": "^2.7.0",
+    "@tauri-apps/cli": "^1.4.0"
+  }
+}
diff --git a/examples/custom-plugin/app/public/tauri.svg b/examples/custom-plugin/app/public/tauri.svg
diff --git a/examples/custom-plugin/app/public/vite.svg b/examples/custom-plugin/app/public/vite.svg
diff --git a/examples/custom-plugin/app/src-tauri/.gitignore b/examples/custom-plugin/app/src-tauri/.gitignore
@@ -0,0 +1,4 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
diff --git a/examples/custom-plugin/app/src-tauri/Cargo.toml b/examples/custom-plugin/app/src-tauri/Cargo.toml
@@ -0,0 +1,24 @@
+[package]
+name = "tauri-specta-example-custom-plugin-app"
+version = "0.0.0"
+description = "A Tauri App"
+authors = ["you"]
+license = ""
+repository = ""
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[build-dependencies]
+tauri-build = { version = "1.4", features = [] }
+
+[dependencies]
+tauri = { version = "1.4", features = ["shell-open"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+tauri-specta-example-custom-plugin = { path = "../../plugin" }
+
+[features]
+# this feature is used for production builds or when `devPath` points to the filesystem
+# DO NOT REMOVE!!
+custom-protocol = ["tauri/custom-protocol"]
diff --git a/examples/custom-plugin/app/src-tauri/build.rs b/examples/custom-plugin/app/src-tauri/build.rs
@@ -0,0 +1,3 @@
+fn main() {
+  tauri_build::build()
+}
diff --git a/examples/custom-plugin/app/src-tauri/icons/128x128.png b/examples/custom-plugin/app/src-tauri/icons/128x128.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/[email protected] b/examples/custom-plugin/app/src-tauri/icons/[email protected]
diff --git a/examples/custom-plugin/app/src-tauri/icons/32x32.png b/examples/custom-plugin/app/src-tauri/icons/32x32.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square107x107Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square107x107Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square142x142Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square142x142Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square150x150Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square150x150Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square284x284Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square284x284Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square30x30Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square30x30Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square310x310Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square310x310Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square44x44Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square44x44Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square71x71Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square71x71Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/Square89x89Logo.png b/examples/custom-plugin/app/src-tauri/icons/Square89x89Logo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/StoreLogo.png b/examples/custom-plugin/app/src-tauri/icons/StoreLogo.png
diff --git a/examples/custom-plugin/app/src-tauri/icons/icon.icns b/examples/custom-plugin/app/src-tauri/icons/icon.icns
diff --git a/examples/custom-plugin/app/src-tauri/icons/icon.ico b/examples/custom-plugin/app/src-tauri/icons/icon.ico
diff --git a/examples/custom-plugin/app/src-tauri/icons/icon.png b/examples/custom-plugin/app/src-tauri/icons/icon.png
diff --git a/examples/custom-plugin/app/src-tauri/src/main.rs b/examples/custom-plugin/app/src-tauri/src/main.rs
@@ -0,0 +1,9 @@
+// Prevents additional console window on Windows in release, DO NOT REMOVE!!
+#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
+
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_specta_example_custom_plugin::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
diff --git a/examples/custom-plugin/app/src-tauri/tauri.conf.json b/examples/custom-plugin/app/src-tauri/tauri.conf.json
@@ -0,0 +1,46 @@
+{
+  "build": {
+    "beforeDevCommand": "pnpm dev",
+    "beforeBuildCommand": "pnpm build",
+    "devPath": "http://localhost:1420",
+    "distDir": "../dist",
+    "withGlobalTauri": false
+  },
+  "package": {
+    "productName": "app",
+    "version": "0.0.0"
+  },
+  "tauri": {
+    "allowlist": {
+      "all": false,
+      "shell": {
+        "all": false,
+        "open": true
+      }
+    },
+    "bundle": {
+      "active": true,
+      "targets": "all",
+      "identifier": "com.tauri.dev",
+      "icon": [
+        "icons/32x32.png",
+        "icons/128x128.png",
+        "icons/[email protected]",
+        "icons/icon.icns",
+        "icons/icon.ico"
+      ]
+    },
+    "security": {
+      "csp": null
+    },
+    "windows": [
+      {
+        "fullscreen": false,
+        "resizable": true,
+        "title": "app",
+        "width": 800,
+        "height": 600
+      }
+    ]
+  }
+}
diff --git a/examples/custom-plugin/app/src/App.tsx b/examples/custom-plugin/app/src/App.tsx
@@ -0,0 +1,50 @@
+import { Match, Switch, createSignal, onCleanup } from "solid-js";
+import { events, addNumbers } from "tauri-specta-custom-plugin";
+
+function App() {
+  const [latestNumber, setLatestNumber] = createSignal<number | null>(null);
+
+  const [generatedNumber, setGeneratedNumber] = createSignal<
+    { type: "loading" } | { type: "loaded"; value: number } | null
+  >(null);
+
+  events.randomNumber
+    .listen((e) => setLatestNumber(e.payload))
+    .then((unlisten) => onCleanup(unlisten));
+
+  return (
+    <div>
+      <p>Latest Random Number: {latestNumber()}</p>
+      <button
+        disabled={generatedNumber()?.type === "loading"}
+        onClick={() => {
+          setGeneratedNumber({ type: "loading" });
+
+          addNumbers(
+            Math.floor(Math.random() * 10),
+            Math.floor(Math.random() * 10)
+          )
+            .then((value) => setGeneratedNumber({ type: "loaded", value }))
+            .catch(() => setGeneratedNumber(null));
+        }}
+      >
+        Generate Random Number
+      </button>
+      <Switch fallback="Generate a number!">
+        <Match when={generatedNumber()?.type === "loading"}>
+          Loading number...
+        </Match>
+        <Match
+          when={(() => {
+            const n = generatedNumber();
+            return n?.type === "loaded" && n.value;
+          })()}
+        >
+          {(value) => value()}
+        </Match>
+      </Switch>
+    </div>
+  );
+}
+
+export default App;
diff --git a/examples/custom-plugin/app/src/index.tsx b/examples/custom-plugin/app/src/index.tsx
@@ -0,0 +1,6 @@
+/* @refresh reload */
+import { render } from "solid-js/web";
+
+import App from "./App";
+
+render(() => <App />, document.getElementById("root") as HTMLElement);
diff --git a/examples/custom-plugin/app/tsconfig.json b/examples/custom-plugin/app/tsconfig.json
@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+
+    "checkJs": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/custom-plugin/app/tsconfig.node.json b/examples/custom-plugin/app/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/custom-plugin/app/vite-env.d.ts b/examples/custom-plugin/app/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/examples/custom-plugin/app/vite.config.ts b/examples/custom-plugin/app/vite.config.ts
@@ -0,0 +1,20 @@
+import { defineConfig } from "vite";
+import solidPlugin from "vite-plugin-solid";
+
+// https://vitejs.dev/config/
+export default defineConfig(async () => ({
+  plugins: [solidPlugin()],
+
+  // Vite options tailored for Tauri development and only applied in `tauri dev` or `tauri build`
+  //
+  // 1. prevent vite from obscuring rust errors
+  clearScreen: false,
+  // 2. tauri expects a fixed port, fail if that port is not available
+  server: {
+    port: 1420,
+    strictPort: true,
+  },
+  // 3. to make use of `TAURI_DEBUG` and other env variables
+  // https://tauri.studio/v1/api/config#buildconfig.beforedevcommand
+  envPrefix: ["VITE_", "TAURI_"],
+}));