feat: add API example (tauri-apps#317)

enri90 · May 5, 2023 · 5015132 · 5015132
1 parent be1c775
commit 5015132
Show file tree

Hide file tree

Showing 98 changed files with 10,335 additions and 157 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
-members = ["plugins/*"]
-exclude = ["plugins/fs", "plugins/http"]
+members = ["plugins/*", "examples/*/src-tauri"]
+exclude = ["plugins/fs", "plugins/http", "examples/api/src-tauri"]
 resolver = "2"
 
 [workspace.dependencies]

diff --git a/examples/api/.gitignore b/examples/api/.gitignore
@@ -0,0 +1,4 @@
+/node_modules/
+/.vscode/
+.DS_Store
+.cargo
diff --git a/examples/api/.setup-cross.sh b/examples/api/.setup-cross.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+export ICONS_VOLUME="$(realpath icons)"
+export DIST_VOLUME="$(realpath dist)"
+export ISOLATION_VOLUME="$(realpath isolation-dist)"
diff --git a/examples/api/.taurignore b/examples/api/.taurignore
@@ -0,0 +1,3 @@
+src-tauri/locales/
+src-tauri/Cross.toml
+src-tauri/.gitignore
diff --git a/examples/api/README.md b/examples/api/README.md
@@ -0,0 +1,28 @@
+# API example
+
+This example demonstrates Tauri's API capabilities using the plugins from this repository. It's used as the main validation app, serving as the testbed of our development process.
+In the future, this app will be used on Tauri's integration tests.
+
+![App screenshot](./screenshot.png?raw=true)
+
+## Running the example
+
+- Install dependencies and build packages (Run inside of the repository root)
+
+```bash
+$ pnpm install
+$ pnpm build
+```
+
+- Run the app in development mode (Run inside of this folder `examples/api/`)
+
+```bash
+$ pnpm tauri dev
+```
+
+- Build an run the release app (Run inside of this folder `examples/api/`)
+
+```bash
+$ pnpm tauri build
+$ ./src-tauri/target/release/app
+```
diff --git a/examples/api/index.html b/examples/api/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en" theme="dark">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Svelte + Vite App</title>
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.js"></script>
+  </body>
+</html>
diff --git a/examples/api/isolation-dist/index.html b/examples/api/isolation-dist/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Isolation Secure Script</title>
+  </head>
+  <body>
+    <script src="index.js"></script>
+  </body>
+</html>
diff --git a/examples/api/isolation-dist/index.js b/examples/api/isolation-dist/index.js
@@ -0,0 +1,7 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+window.__TAURI_ISOLATION_HOOK__ = (payload) => {
+  return payload;
+};
diff --git a/examples/api/jsconfig.json b/examples/api/jsconfig.json
@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "target": "esnext",
+    "module": "esnext",
+    /**
+     * svelte-preprocess cannot figure out whether you have
+     * a value or a type, so tell TypeScript to enforce using
+     * `import type` instead of `import` for Types.
+     */
+    "importsNotUsedAsValues": "error",
+    "isolatedModules": true,
+    "resolveJsonModule": true,
+    /**
+     * To have warnings / errors of the Svelte compiler at the
+     * correct position, enable source maps by default.
+     */
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
+    /**
+     * Typecheck JS in `.svelte` and `.js` files by default.
+     * Disable this if you'd like to use dynamic types.
+     */
+    "checkJs": true
+  },
+  /**
+   * Use global.d.ts instead of compilerOptions.types
+   * to avoid limiting type declarations.
+   */
+  "include": ["src/**/*.d.ts", "src/**/*.js", "src/**/*.svelte"]
+}
diff --git a/examples/api/package.json b/examples/api/package.json
@@ -0,0 +1,32 @@
+{
+  "name": "svelte-app",
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite --clearScreen false",
+    "build": "vite build",
+    "serve": "vite preview"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "2.0.0-alpha.3",
+    "@tauri-apps/cli": "2.0.0-alpha.8",
+    "@zerodevx/svelte-json-view": "0.2.1",
+    "tauri-plugin-cli-api": "0.0.0",
+    "tauri-plugin-clipboard-api": "0.0.0",
+    "tauri-plugin-dialog-api": "0.0.0",
+    "tauri-plugin-fs-api": "0.0.0",
+    "tauri-plugin-global-shortcut-api": "0.0.0",
+    "tauri-plugin-http-api": "0.0.0",
+    "tauri-plugin-notification-api": "0.0.0",
+    "tauri-plugin-shell-api": "0.0.0"
+  },
+  "devDependencies": {
+    "@iconify-json/codicon": "^1.1.10",
+    "@iconify-json/ph": "^1.1.1",
+    "@sveltejs/vite-plugin-svelte": "^1.0.1",
+    "internal-ip": "^7.0.0",
+    "svelte": "^3.49.0",
+    "unocss": "^0.39.3",
+    "vite": "^3.0.9"
+  }
+}
diff --git a/examples/api/public/tauri_logo.png b/examples/api/public/tauri_logo.png
diff --git a/examples/api/screenshot.png b/examples/api/screenshot.png
diff --git a/examples/api/src-tauri/.gitignore b/examples/api/src-tauri/.gitignore
@@ -0,0 +1,6 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# cargo-mobile
+.cargo/
diff --git a/examples/api/src-tauri/.taurignore b/examples/api/src-tauri/.taurignore
@@ -0,0 +1 @@
+tauri-plugin-sample/