paramdef 0.2.0

Type-safe parameter definition system
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# paramdef - Version Roadmap


Structured roadmap organized by semantic versions with clear deliverables.

---

## v0.2.0 - Foundation (Current)


**Status:** ✅ Released

Core types and basic parameter system.

### Completed Features


- **Core Infrastructure**
  - Key, Metadata, Flags, StateFlags
  - Value enum with all primitive types
  - Error types with thiserror

- **Schema Layer**
  - Schema builder and container
  - Immutable parameter definitions via Arc

- **Runtime Layer**
  - RuntimeNode with type erasure
  - State management (dirty, touched, valid)
  - Context for parameter instances

- **Type System (24 types)**
  - Group: Group, Panel
  - Leaf: Text, Number, Boolean, Vector, Select, File
  - Container: Object, List, Mode, Matrix, Routing, Expirable, Reference
  - Decoration: Notice, Separator, Link, Code, Image, Html, Video, Progress

- **Subtype System**
  - TextSubtype: 45+ variants (Email, URL, Password, JSON, Markdown, etc.)
  - NumberSubtype: 30+ variants (Port, Percentage, Temperature, etc.)
  - VectorSubtype: 20+ variants (Position3D, ColorRgba, Quaternion, etc.)
  - FileSubtype: 17 variants (Image, PDF, Audio, Video, etc.)
  - NumberUnit: 17 categories with conversions

- **Container Features**
  - Object: extensible mode (additionalProperties)
  - List: rankable mode for priority ordering
  - Matrix: table-based data entry (rows × columns)

---

## v0.3.0 - Visibility & Expressions


**Status:** 🔜 Next

Conditional visibility and expression system.

### Planned Features


- **Visibility Expression (Expr)**
  ```rust
  pub enum Expr {
      Eq(Key, Value),        // key == value
      Ne(Key, Value),        // key != value
      Lt(Key, f64),          // key < value
      Gt(Key, f64),          // key > value
      IsSet(Key),            // key is not null
      IsEmpty(Key),          // "", [], {}
      IsTrue(Key),           // key == true
      OneOf(Key, Vec<Value>), // key in [...]
      And(Vec<Expr>),        // all must be true
      Or(Vec<Expr>),         // any must be true
      Not(Box<Expr>),        // invert
  }
  ```

- **Expression Evaluation**
  - `Expr::eval(&self, ctx: &Context) -> bool`
  - `Expr::dependencies() -> Vec<Key>`
  - Lazy compilation and caching

- **Visibility Integration**
  - Add `visibility: Option<Expr>` to all parameter types
  - Runtime visibility state in Context

### Feature Flag

```toml
[features]
visibility = []
```

---

## v0.4.0 - Event System


**Status:** 📋 Planned

Reactive event system with observers.

### Planned Features


- **Parameter Events**
  ```rust
  pub enum ParameterEvent {
      ValueChanging { key: Key, old: Value, new: Value },
      ValueChanged { key: Key, old: Value, new: Value },
      Validated { key: Key, is_valid: bool, errors: Vec<Error> },
      VisibilityChanged { key: Key, visible: bool },
      BatchBegin { description: String },
      BatchEnd { description: String },
  }
  ```

- **Event Bus**
  - Based on `tokio::broadcast`
  - Multiple subscribers support
  - Batch mode for grouping related changes

- **Built-in Observers**
  - LoggerObserver - debug logging
  - ValidationObserver - auto-validate on change
  - VisibilityObserver - reactive visibility updates

### Feature Flag

```toml
[features]
events = ["dep:tokio"]
```

---

## v0.5.0 - Computed & Triggers


**Status:** 📋 Planned

Computed values and trigger system.

### Planned Features


- **Computed Expressions**
  ```rust
  Text::builder("full_name")
      .computed("{first_name} + ' ' + {last_name}")
      .build()

  Number::builder("total")
      .computed("{price} * {quantity}")
      .build()
  ```

- **Trigger System**
  ```rust
  Trigger::set_value()
      .when(Expr::Eq("country", "US"))
      .set("currency", "USD")

  Trigger::copy_value()
      .when(Expr::IsTrue("same_address"))
      .from("billing_address")
      .to("shipping_address")

  Trigger::clear_value()
      .when(Expr::Ne("type", "custom"))
      .clear("custom_value")
  ```

- **Dependency Graph**
  - Automatic dependency tracking
  - Cycle detection
  - Topological sort for evaluation order

### Dependencies

- Requires: v0.3.0 (Visibility), v0.4.0 (Events)

---

## v0.6.0 - Validation System


**Status:** 📋 Planned

Comprehensive validation with built-in validators.

### Planned Features


- **Validator Trait**
  ```rust
  pub trait Validator: Send + Sync {
      fn validate(&self, value: &Value) -> Result<(), ValidationError>;
      fn name(&self) -> &'static str;
  }
  ```

- **Built-in Validators**
  - RequiredValidator
  - MinLengthValidator, MaxLengthValidator
  - RangeValidator (min, max)
  - PatternValidator (regex)
  - EmailValidator, UrlValidator
  - CustomValidator (closure-based)

- **Validation Modes**
  - Immediate: validate on every change
  - OnBlur: validate when field loses focus
  - OnSubmit: validate only on form submit
  - Manual: validate only when explicitly called

- **Cross-Field Validation**
  ```rust
  Validator::cross_field()
      .fields(["password", "confirm_password"])
      .rule(|values| values[0] == values[1])
      .message("Passwords must match")
  ```

### Feature Flag

```toml
[features]
validation = []
```

---

## v0.7.0 - Transformers


**Status:** 📋 Planned

Value transformation pipeline.

### Planned Features


- **Transformer Trait**
  ```rust
  pub trait Transformer: Send + Sync {
      fn transform(&self, value: Value) -> Value;
      fn name(&self) -> &'static str;
  }
  ```

- **Built-in Transformers**
  - TrimTransformer
  - LowercaseTransformer, UppercaseTransformer
  - StripWhitespaceTransformer
  - NormalizeUnicodeTransformer
  - SanitizeHtmlTransformer
  - NumberFormatTransformer

- **Transform Pipeline**
  ```rust
  Text::builder("username")
      .transform(TrimTransformer)
      .transform(LowercaseTransformer)
      .build()
  ```

---

## v0.8.0 - History & Undo/Redo


**Status:** 📋 Planned

Command-based history system.

### Planned Features


- **Command Pattern**
  ```rust
  pub trait Command: Send + Sync {
      fn execute(&mut self, ctx: &mut Context) -> Result<()>;
      fn undo(&mut self, ctx: &mut Context) -> Result<()>;
      fn redo(&mut self, ctx: &mut Context) -> Result<()>;
      fn merge(&mut self, other: &dyn Command) -> bool;
      fn description(&self) -> &str;
  }
  ```

- **Built-in Commands**
  - SetValueCommand
  - ClearValueCommand
  - BatchCommand (transactions)

- **History Manager**
  ```rust
  pub struct HistoryManager {
      undo_stack: VecDeque<Box<dyn Command>>,
      redo_stack: VecDeque<Box<dyn Command>>,
      max_history: usize,
  }
  ```

- **Transaction Support**
  ```rust
  ctx.begin_transaction("Update user");
  ctx.set_value("name", "John");
  ctx.set_value("email", "john@example.com");
  ctx.commit_transaction(); // Single undo step
  ```

### Dependencies

- Requires: v0.4.0 (Events)

---

## v0.9.0 - Serialization


**Status:** 📋 Planned

Full serialization support.

### Planned Features


- **Schema Serialization**
  - Serialize/Deserialize for all schema types
  - JSON Schema export
  - TypeScript type generation

- **Value Serialization**
  - Custom date/time formats
  - Binary encoding options
  - Streaming support for large schemas

- **Import/Export**
  ```rust
  // Export to JSON Schema
  let json_schema = schema.to_json_schema()?;

  // Export to TypeScript
  let ts_types = schema.to_typescript()?;

  // Import from JSON
  let schema = Schema::from_json(json)?;
  ```

### Feature Flag

```toml
[features]
serde = ["dep:serde", "dep:serde_json"]
```

---

## v1.0.0 - Production Ready


**Status:** 📋 Planned

Stable API with full documentation.

### Requirements


- All features complete and tested
- 90%+ test coverage
- Complete API documentation
- Performance benchmarks
- Migration guide from v0.x
- Examples for common use cases

### Stability Guarantees


- Semantic versioning
- Deprecation warnings before removal
- MSRV policy (minimum 1.85)

---

## v1.1.0 - I18n Support


**Status:** 📋 Future

Internationalization with Fluent.

### Planned Features


- **Fluent Integration**
  ```rust
  Text::builder("name")
      .label_fluent("field-name-label")
      .description_fluent("field-name-description")
      .build()
  ```

- **User-Managed Translations**
  - Library provides Fluent keys
  - Users provide translation files
  - No embedded translations (zero bloat)

### Feature Flag

```toml
[features]
i18n = ["dep:fluent"]
```

---

## v1.2.0 - Async Validation


**Status:** 📋 Future

Async validators for remote validation.

### Planned Features


- **Async Validator Trait**
  ```rust
  #[async_trait]
  pub trait AsyncValidator: Send + Sync {
      async fn validate(&self, value: &Value) -> Result<(), ValidationError>;
  }
  ```

- **Use Cases**
  - Username availability check
  - Email verification
  - Remote API validation
  - Database lookups

---

## v1.3.0 - Convenience Containers


**Status:** 📋 Future

DX-friendly container helpers for common patterns.

### Planned Features


- **WithComment<T: Leaf>** - Field with optional comment
  ```rust
  let satisfaction = WithComment::new(
      Select::single("satisfaction")
          .options(["Good", "Bad", "Other"])
          .build()
  )
  .placeholder("Explain your choice...")
  .show_when(["Other", "Bad"])  // auto-generates visibility
  .build();

  // Produces: { "satisfaction": "Bad", "satisfaction_comment": "..." }
  ```

- **WithOther<Select>** - Select with "Other" text field
  ```rust
  let country = WithOther::new(
      Select::single("country")
          .options(["USA", "UK", "Other"])
          .build()
  )
  .other_value("Other")
  .other_placeholder("Enter country name")
  .build();

  // Produces: { "country": "Other", "country_other": "Canada" }
  ```

- **Nullable<T: Leaf>** - Enable checkbox + field
  ```rust
  let discount = Nullable::new(
      Number::builder("discount")
          .subtype(Percentage)
          .build()
  )
  .checkbox_label("Apply discount")
  .build();

  // Produces: { "discount_enabled": true, "discount": 15 }
  ```

- **Confirmed<T: Leaf>** - Field with confirmation (e.g., password)
  ```rust
  let password = Confirmed::new(
      Text::builder("password")
          .subtype(Password)
          .build()
  )
  .confirm_label("Confirm password")
  .build();

  // Auto-validates: password == password_confirm
  ```

### Design Philosophy


These are **pure DX sugar** - convenient builders that generate appropriate structures (Object, Group, or other compositions) with visibility expressions. The underlying structure is an implementation detail; users get a clean, ergonomic API. Users can always build equivalent structures manually if needed.

### Dependencies

- Requires: v0.3.0 (Visibility), v0.6.0 (Validation for Confirmed)

---

## v2.0.0 - Next Generation


**Status:** 🔮 Future

Major improvements and breaking changes.

### Potential Features


- WebAssembly support
- Plugin system for custom types
- Visual schema editor export
- GraphQL schema generation
- React/Vue component generation

---

## Version Dependencies


```
v0.2.0 (Foundation)
    ├── v0.3.0 (Visibility)
    │       │
    │       └── v0.5.0 (Computed/Triggers)
    ├── v0.4.0 (Events)
    │       │
    │       ├── v0.5.0 (Computed/Triggers)
    │       │
    │       └── v0.8.0 (History)
    ├── v0.6.0 (Validation)
    ├── v0.7.0 (Transformers)
    └── v0.9.0 (Serialization)
            └── v1.0.0 (Production Ready)
                    ├── v1.1.0 (I18n)
                    └── v1.2.0 (Async Validation)
```

---

## Contributing


See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

Each version has a corresponding GitHub milestone for tracking issues and PRs.