tauri-plugin-posthog 0.2.2

A Tauri v2 plugin for integrating PostHog analytics into your Tauri applications
Documentation 
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

# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Development Commands

### JavaScript/TypeScript (Guest JS API)
```bash
# Build the JavaScript/TypeScript API
pnpm build

# Install dependencies
pnpm install
```

### Rust (Plugin Core)
```bash
# Build the Rust plugin
cargo build

# Run tests
cargo test

# Check code
cargo check
```

### Example Application
```bash
# Navigate to example app
cd examples/tauri-app

# Run the example Tauri app in development
pnpm tauri dev

# Build the example app
pnpm tauri build
```

## Architecture Overview

This is a Tauri v2 plugin for integrating PostHog analytics. The plugin follows Tauri's standard plugin architecture:

### Core Components

1. **Rust Backend (`src/`)**:
   - `lib.rs`: Main plugin initialization and trait definitions
   - `commands.rs`: Tauri command handlers exposed to frontend
   - `models.rs`: Shared data structures (request/response types)
   - `desktop.rs`: Desktop-specific implementation
   - `mobile.rs`: Mobile-specific implementation (iOS/Android)
   - `error.rs`: Error handling

2. **JavaScript/TypeScript API (`guest-js/`)**:
   - `index.ts`: TypeScript API that wraps the plugin commands for frontend usage
   - Built with Rollup to produce both ESM and CommonJS modules

3. **Plugin Integration Pattern**:
   - Commands are registered in `lib.rs` via `tauri::generate_handler!`
   - Frontend calls go through the guest-js API which invokes Rust commands
   - Uses the `plugin:posthog|` namespace for command invocation

### Key Implementation Details

- The plugin uses conditional compilation for desktop vs mobile platforms
- State management via Tauri's `Manager` trait and app state
- Currently implements a basic `ping` command as a template
- Ready for PostHog SDK integration in the platform-specific modules

### Adding New Features

When implementing PostHog functionality:
1. Add data models in `src/models.rs`
2. Create command handlers in `src/commands.rs`
3. Implement platform-specific logic in `desktop.rs`/`mobile.rs`
4. Expose TypeScript API in `guest-js/index.ts`
5. Register new commands in `lib.rs` handler list