inflow 0.1.0

Matrix push notification gateway types and pusher registration, with support for domestic Chinese Android OEM providers (JPush, Huawei, Xiaomi, OPPO, vivo, HONOR) via the Bugle push gateway.
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# inflow

> **Warning:** This project is in a very early stage and is not functional yet. APIs will change without notice.

Matrix push notification gateway types, preferences, and pusher registration library.

**inflow** provides the shared data types and logic used by Matrix chat clients to configure and register push notification gateways with a Matrix homeserver. It is designed for use by multiple front-end projects (e.g. [Synpad](https://github.com/nickkuk/synpad), [Robrix](https://github.com/nickkuk/robrix)) that need a common push notification layer.

## Gateway Support

| Gateway    | Description |
|------------|-------------|
| **Sygnal** | Standard Matrix push gateway using FCM (Android) and APNs (iOS). Works globally. |
| **Bugle**  | Push gateway with domestic Chinese Android OEM provider support. Routes through JPush `third_party_channel` to Huawei Push Kit, Xiaomi Mi Push, OPPO Push, vivo Push, HONOR Push, and HarmonyOS. Ideal for mainland China where Google FCM is unavailable. |
| **Custom** | User-provided gateway URL for self-hosted or third-party gateways. |

## Features

| Feature  | Description |
|----------|-------------|
| _(default)_ | Core types (`PushGatewayType`, `PushPreferences`) and JSON serialization helpers. No network dependencies. |
| `matrix` | Adds `register_pusher()` and `unregister_pusher()` functions that use `matrix_sdk::Client` to register/unregister HTTP pushers with a Matrix homeserver. |

## Quick Start

Add to your `Cargo.toml`:

```toml
[dependencies]
inflow = { path = "../inflow" }
# or with pusher registration:
# inflow = { path = "../inflow", features = ["matrix"] }
```

### Core types (no network)

```rust
use inflow::{PushGatewayType, PushPreferences};

// Create preferences with Bugle gateway for China users
let mut prefs = PushPreferences {
    enabled: true,
    gateway_type: PushGatewayType::Bugle,
    ..Default::default()
};
prefs.apply_gateway_type_defaults();

// Resolve the correct app ID for the gateway
let app_id = prefs.android_app_id("app.example.android", "app.example.android.cn");
assert_eq!(app_id, "app.example.android.cn");

// Serialize to JSON for persistence
let json = inflow::to_json(&prefs).unwrap();
let loaded = inflow::from_json(&json);
assert_eq!(loaded.gateway_type, PushGatewayType::Bugle);
```

### Pusher registration (requires `matrix` feature)

```rust,ignore
use inflow::{PushPreferences, PusherConfig, register_pusher};

let config = PusherConfig {
    token: "fcm-or-apns-device-token",
    platform: "android",
    android_app_id: "app.example.android",
    domestic_android_app_id: "app.example.android.cn",
    ios_app_id: "app.example.ios",
    app_display_name: "MyApp",
    device_display_name: "MyApp Mobile",
};

let prefs = PushPreferences::default();
register_pusher(&matrix_client, &config, &prefs).await?;
```

## Architecture

```
Matrix Client (Synpad / Robrix / ...)
        |
        v
   ┌─────────┐     PushPreferences
   │  inflow  │───> PushGatewayType { Sygnal, Bugle, Custom }
   └────┬─────┘     register_pusher() / unregister_pusher()
        |
        v
  Matrix Homeserver
        |
        v
  Push Gateway (Sygnal or Bugle)
        |
        ├── FCM ──> Android (global)
        ├── APNs ─> iOS
        └── Bugle domestic providers:
            ├── JPush (aggregation layer)
            ├── Huawei Push Kit / HarmonyOS
            ├── Xiaomi Mi Push
            ├── OPPO / OnePlus Push
            ├── vivo Push
            └── HONOR Push
```

## License

Licensed under Apache 2.0. See [LICENSE](LICENSE).