hodei-hrn 0.1.0

Hodei Resource Names (HRN) - Unique resource identification system for authorization
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

# hodei-authz-sdk-hrn

Core types for the Hodei authorization framework.

## Overview

`hodei-authz-sdk-hrn` provides fundamental types used across the Hodei framework, most notably the **HRN (Hodei Resource Name)** - a resource naming system inspired by AWS ARN.

## Features

- **HRN (Hodei Resource Name)**: Unique identifiers for resources
- **Builder Pattern**: Easy construction of HRNs
- **Serialization**: Full serde support
- **Parsing**: Parse HRNs from strings
- **Zero Dependencies**: No heavy dependencies (only serde and thiserror)

## Installation

```toml
[dependencies]
hodei-authz-sdk-hrn = "0.1"
```

## Usage

### Creating an HRN

```rust
use hodei_hrn::Hrn;

let hrn = Hrn::builder()
    .service("users-api")
    .tenant_id("tenant-123")
    .resource("user/alice")
    .unwrap()
    .build()
    .unwrap();

println!("{}", hrn);
// Output: hrn:hodei-authz-sdk:users-api:global:tenant-123:user/alice
```

### Parsing an HRN

```rust
use hodei_hrn::Hrn;

let hrn: Hrn = "hrn:hodei-authz-sdk:docs:global:tenant-1:document/doc-1"
    .parse()
    .unwrap();

assert_eq!(hrn.service, "docs");
assert_eq!(hrn.tenant_id, "tenant-1");
assert_eq!(hrn.resource_type, "document");
assert_eq!(hrn.resource_id, "doc-1");
```

### Serialization

```rust
use hodei_hrn::Hrn;
use serde_json;

let hrn = Hrn::builder()
    .service("api")
    .tenant_id("t1")
    .resource("user/1")
    .unwrap()
    .build()
    .unwrap();

let json = serde_json::to_string(&hrn).unwrap();
let deserialized: Hrn = serde_json::from_str(&json).unwrap();

assert_eq!(hrn, deserialized);
```

## HRN Format

```
hrn:hodei-authz-sdk:{service}:global:{tenant_id}:{resource_type}/{resource_id}
```

- **partition**: Always "hodei-authz-sdk"
- **service**: Service name (e.g., "users-api", "documents")
- **region**: Always "global" (reserved for future use)
- **tenant_id**: Tenant identifier for multi-tenancy
- **resource_type**: Type of resource (e.g., "user", "document")
- **resource_id**: Unique identifier within the resource type

## Features

### Optional Features

- `sqlx`: Enables PostgreSQL type support for HRN

```toml
[dependencies]
hodei-authz-sdk-hrn = { version = "0.1", features = ["sqlx"] }
```

## License

MIT OR Apache-2.0