tauri-plugin-outis-captcha-api 1.0.1

package/README.md

@@ -0,0 +1,77 @@
+# Tauri Plugin: Outis Captcha
+
+A drop-in Tauri plugin for local, offline captcha solving.
+Powered by `outis-captcha-core` with a custom-trained ONNX model.
+
+## Features
+
+- **Zero Runtime Config**: No model paths, no downloads, no network requests at runtime.
+- **Offline Ready**: The model is downloaded at *build time* and embedded directly into the application binary.
+- **Fast**: ~50ms inference time on CPU.
+
+## Installation
+
+1.  **Add dependency**:
+
+    Full feature set (recommended):
+    ```toml
+    [dependencies]
+    tauri-plugin-outis-captcha = { git = "https://github.com/milangress/outis", branch = "main" }
+    ```
+
+2.  **Register the plugin** in `src-tauri/src/lib.rs`:
+
+    ```rust
+    #[cfg_attr(mobile, tauri::mobile_entry_point)]
+    pub fn run() {
+        tauri::Builder::default()
+            .plugin(tauri_plugin_outis_captcha::init())
+            .run(tauri::generate_context!())
+            .expect("error running app");
+    }
+    ```
+
+3.  **Allow permissions** in `src-tauri/capabilities/default.json` (or similar):
+
+    ```json
+    {
+      "permissions": [
+        "outis-captcha:default"
+      ]
+    }
+    ```
+
+## Usage (Frontend)
+
+```typescript
+import { invoke } from '@tauri-apps/api/core';
+
+// 1. Initialize (Optional)
+// Pre-loads the model into memory. If you skip this, it auto-loads on first use.
+// Doing this at app startup makes the first user interaction feel instant.
+await invoke('plugin:outis-captcha|init_model');
+
+// 2. Break a Captcha
+try {
+    const result = await invoke<string>('plugin:outis-captcha|read_captcha', {
+        // You can pass:
+        // - A URL (http://...) -> Plugin will download it
+        // - A Data URI (data:image/png;base64,...)
+        // - A local file path (/Users/...)
+        imagePath: 'https://example.com/captcha.png'
+    });
+
+    console.log('Captcha Result:', result);
+} catch (error) {
+    console.error('Failed to break captcha:', error);
+}
+```
+
+## How it Works (Model Downloading)
+
+You might wonder where the model comes from if you don't provide it.
+
+1.  **Build Time**: When you run `cargo build`, the `outis-captcha-core` build script checks for the model file (`assets/outis-model.rten`).
+2.  **Auto-Download**: If the file is missing (e.g., in a CI environment or fresh clone), it automatically downloads the latest version from HuggingFace (`Milang/outis`) to Rust's `OUT_DIR`.
+3.  **Embedding**: The model bytes (~19MB) are then compiled **into the binary** itself.
+4.  **Runtime**: When your app runs, the plugin loads the model directly from memory. This guarantees the model is always available and version-matched to the code.

package/dist-js/index.cjs

@@ -0,0 +1,32 @@
+'use strict';
+
+var core = require('@tauri-apps/api/core');
+
+/**
+ * Reads a captcha from a local file path or a remote URL.
+ *
+ * @param imagePath Local path or HTTP/HTTPS URL of the captcha image.
+ * @returns The decoded captcha text.
+ */
+async function readCaptcha(imagePath) {
+    return await core.invoke('plugin:outis|read_captcha', {
+        imagePath,
+    });
+}
+/**
+ * Ensures the model is downloaded and loaded into memory.
+ * This can be called pre-emptively to avoid lag on the first captcha break.
+ */
+async function initModel() {
+    return await core.invoke('plugin:outis|init_model');
+}
+/**
+ * Deletes the model from disk and from memory.
+ */
+async function deleteModel() {
+    return await core.invoke('plugin:outis|delete_model');
+}
+
+exports.deleteModel = deleteModel;
+exports.initModel = initModel;
+exports.readCaptcha = readCaptcha;

package/dist-js/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Reads a captcha from a local file path or a remote URL.
+ *
+ * @param imagePath Local path or HTTP/HTTPS URL of the captcha image.
+ * @returns The decoded captcha text.
+ */
+export declare function readCaptcha(imagePath: string): Promise<string>;
+/**
+ * Ensures the model is downloaded and loaded into memory.
+ * This can be called pre-emptively to avoid lag on the first captcha break.
+ */
+export declare function initModel(): Promise<void>;
+/**
+ * Deletes the model from disk and from memory.
+ */
+export declare function deleteModel(): Promise<void>;

package/dist-js/index.js

@@ -0,0 +1,28 @@
+import { invoke } from '@tauri-apps/api/core';
+
+/**
+ * Reads a captcha from a local file path or a remote URL.
+ *
+ * @param imagePath Local path or HTTP/HTTPS URL of the captcha image.
+ * @returns The decoded captcha text.
+ */
+async function readCaptcha(imagePath) {
+    return await invoke('plugin:outis|read_captcha', {
+        imagePath,
+    });
+}
+/**
+ * Ensures the model is downloaded and loaded into memory.
+ * This can be called pre-emptively to avoid lag on the first captcha break.
+ */
+async function initModel() {
+    return await invoke('plugin:outis|init_model');
+}
+/**
+ * Deletes the model from disk and from memory.
+ */
+async function deleteModel() {
+    return await invoke('plugin:outis|delete_model');
+}
+
+export { deleteModel, initModel, readCaptcha };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "tauri-plugin-outis-captcha-api",
+  "version": "1.0.1",
+  "author": "Milan Gress",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/milangress/outis-captcha.git",
+    "directory": "plugins/tauri-plugin-outis-captcha"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Tauri plugin for reading captchas.",
+  "type": "module",
+  "types": "./dist-js/index.d.ts",
+  "main": "./dist-js/index.cjs",
+  "module": "./dist-js/index.js",
+  "exports": {
+    "types": "./dist-js/index.d.ts",
+    "import": "./dist-js/index.js",
+    "require": "./dist-js/index.cjs"
+  },
+  "files": [
+    "dist-js",
+    "README.md"
+  ],
+  "dependencies": {
+    "@tauri-apps/api": "^2.10.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.3.0",
+    "rollup": "^4.57.1",
+    "typescript": "^5.9.3",
+    "tslib": "^2.8.1"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "pretest": "pnpm build"
+  }
+}