tauri-plugin-outis-captcha 1.0.1

Tauri plugin for reading captchas.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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.