jmap-metadata-types 0.1.1

JMAP Object Metadata extension data types (draft-ietf-jmap-metadata-*)
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
//! Integration tests for jmap-metadata-types.
//!
//! All JSON fixtures are hand-written from draft-ietf-jmap-metadata-01 or
//! constructed directly from the spec field descriptions. No expected
//! value is derived from the code under test.
//!
//! Test name conventions:
//! - `*_draft_01_*` — pinned to draft-ietf-jmap-metadata-01 §N example so a
//!   future spec revision can revise or replace the test alongside the
//!   wire-format change. All current tests are pinned to -01.
//! - `*_preserves_vendor_extras` / `*_round_trip_*` — workspace
//!   extras-preservation policy round-trip coverage (bd JMAP-lbdy).
//!
//! Structs are constructed exclusively via serde_json deserialization
//! because all public structs carry `#[non_exhaustive]`, which prevents
//! struct-literal construction outside the defining crate.

use jmap_metadata_types::{
    Annotation, ImapMetadata, Metadata, MetadataCapability, MetadataFilterCondition,
    MetadataProperty, WebDavMetadata, JMAP_METADATA_URI,
};
use jmap_types::{GetObject, JmapObject, QueryObject, SetObject};

// ---------------------------------------------------------------------------
// Capability URI / capability object
// ---------------------------------------------------------------------------

#[test]
fn capability_uri_matches_draft_01() {
    // Oracle: draft-ietf-jmap-metadata-01 §1.2.1, IANA registration §9.1.
    assert_eq!(JMAP_METADATA_URI, "urn:ietf:params:jmap:metadata");
}

#[test]
fn metadata_capability_draft_01_round_trip() {
    // Oracle: hand-written from §1.2.1 property descriptions.
    // dataTypes=null → "all data types"; maxDepth=null → "no nesting limit";
    // metadataTypes lists explicit @type values; maySetPrivate=true.
    let json = r#"{
        "dataTypes": null,
        "metadataTypes": ["Annotation", "ImapMetadata", "WebDavMetadata"],
        "maxDepth": null,
        "maySetPrivate": true
    }"#;
    let cap: MetadataCapability = serde_json::from_str(json).unwrap();
    assert_eq!(cap.data_types, None);
    assert_eq!(
        cap.metadata_types,
        vec![
            "Annotation".to_owned(),
            "ImapMetadata".to_owned(),
            "WebDavMetadata".to_owned(),
        ]
    );
    assert_eq!(cap.max_depth, None);
    assert_eq!(cap.may_set_private, Some(true));

    // Round-trip: required-and-nullable fields stay present as null.
    let back = serde_json::to_value(&cap).unwrap();
    let map = back.as_object().unwrap();
    assert!(map.contains_key("dataTypes"));
    assert!(map["dataTypes"].is_null());
    assert!(map.contains_key("maxDepth"));
    assert!(map["maxDepth"].is_null());
}

#[test]
fn metadata_capability_draft_01_scoped_types() {
    // Oracle: hand-written from §1.2.1.
    // dataTypes restricted to specific JMAP types; maxDepth=3 limits nesting.
    let json = r#"{
        "dataTypes": ["Email", "Mailbox", "ContactCard"],
        "metadataTypes": ["Annotation"],
        "maxDepth": 3,
        "maySetPrivate": false
    }"#;
    let cap: MetadataCapability = serde_json::from_str(json).unwrap();
    assert_eq!(
        cap.data_types,
        Some(vec![
            "Email".to_owned(),
            "Mailbox".to_owned(),
            "ContactCard".to_owned(),
        ])
    );
    assert_eq!(cap.max_depth, Some(3));
    assert_eq!(cap.may_set_private, Some(false));
}

#[test]
fn metadata_capability_may_set_private_absent_is_none() {
    // Oracle: §1.2.1 says default is true when absent.
    // The Rust type preserves "absent" as None so callers can detect it.
    let json = r#"{
        "dataTypes": null,
        "metadataTypes": ["Annotation"],
        "maxDepth": null
    }"#;
    let cap: MetadataCapability = serde_json::from_str(json).unwrap();
    assert_eq!(cap.may_set_private, None);
}

// ---------------------------------------------------------------------------
// Annotation
// ---------------------------------------------------------------------------

#[test]
fn annotation_draft_01_section_7_1_create_with_vendor_props() {
    // Oracle: §7.1 example, "Creating a Mailbox with Annotation".
    // Wire-bytes copied verbatim from the draft (whitespace normalised).
    let json = r##"{
        "@type": "Annotation",
        "relatedType": "Mailbox",
        "relatedId": "#new-mailbox",
        "isPrivate": true,
        "acme.example.com:color": "blue",
        "acme.example.com:priority": "high",
        "acme.example.com:project": {
            "@type": "acme.example.com:ProjectInfo",
            "projectId": "ALPHA-2024",
            "deadline": "2024-12-31",
            "team": "Engineering"
        }
    }"##;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let ann = match &meta {
        Metadata::Annotation(a) => a,
        _ => panic!("expected Annotation variant; got {}", meta.type_name()),
    };
    assert_eq!(ann.id, None);
    assert_eq!(ann.related_type.as_deref(), Some("Mailbox"));
    // relatedId on create may carry a "#" creation reference; the wire
    // type is still Id (string), so the JMAP Id newtype accepts it.
    assert!(ann.related_id == *"#new-mailbox");
    assert_eq!(ann.is_private, Some(true));

    // Vendor-extension properties captured in `extra`.
    assert_eq!(
        ann.extra.get("acme.example.com:color"),
        Some(&serde_json::Value::String("blue".into())),
    );
    assert_eq!(
        ann.extra.get("acme.example.com:priority"),
        Some(&serde_json::Value::String("high".into())),
    );
    // Nested vendor object is preserved verbatim (the typed @type tag is
    // only consumed at the OUTER Metadata level; nested objects flow
    // through `extra` as-is).
    let project = ann.extra.get("acme.example.com:project").unwrap();
    assert_eq!(
        project["@type"],
        serde_json::Value::String("acme.example.com:ProjectInfo".into()),
    );
    assert_eq!(
        project["projectId"],
        serde_json::Value::String("ALPHA-2024".into()),
    );
}

#[test]
fn annotation_draft_01_section_7_2_partial_response_deserialises() {
    // Oracle: §7.2 example response demonstrates `metadataProperties`
    // filtering — the response omits `relatedType` because the request
    // did not list it. §4.1 lines 922-926 of the draft list only
    // `@type` and `relatedId` as always-included; `relatedType` is
    // omittable in the partial-response shape. The `Annotation` type
    // therefore models `relatedType` as `Option<String>` so the spec's
    // own §7.2 example deserialises losslessly.
    let json = r#"{
        "relatedId": "MB789",
        "@type": "Annotation",
        "acme.example.com:color": "blue",
        "acme.example.com:priority": "high"
    }"#;
    let meta: Metadata = serde_json::from_str(json)
        .expect("§7.2 partial response must deserialise into Metadata::Annotation");
    let ann = match meta {
        Metadata::Annotation(a) => a,
        _ => panic!("expected Annotation variant"),
    };
    assert_eq!(ann.related_type, None, "partial response omits relatedType");
    assert_eq!(ann.related_id.as_ref(), "MB789");
    assert_eq!(ann.id, None);
    assert_eq!(ann.is_private, None);
    assert_eq!(
        ann.extra.get("acme.example.com:color"),
        Some(&serde_json::Value::String("blue".into())),
    );
    assert_eq!(
        ann.extra.get("acme.example.com:priority"),
        Some(&serde_json::Value::String("high".into())),
    );

    // Round-trip: omitted `relatedType` stays omitted on serialise.
    let round_trip = serde_json::to_value(&Metadata::Annotation(ann)).unwrap();
    assert!(
        round_trip.get("relatedType").is_none(),
        "None relatedType must not serialise back as null or empty string"
    );
}

#[test]
fn annotation_draft_01_section_7_5_atomic_create_response() {
    // Oracle: §7.5 successful response, Metadata/set "created" entry.
    let json = r#"{
        "id": "MD789",
        "@type": "Annotation",
        "relatedType": "Email",
        "relatedId": "EM456"
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let ann = match meta {
        Metadata::Annotation(a) => a,
        _ => panic!("expected Annotation variant"),
    };
    assert_eq!(ann.id.as_ref().map(AsRef::as_ref), Some("MD789"));
    assert_eq!(ann.related_type.as_deref(), Some("Email"));
    assert!(ann.related_id == *"EM456");
    assert_eq!(ann.is_private, None);
    assert!(ann.extra.is_empty());
}

#[test]
fn annotation_round_trip_preserves_vendor_extras() {
    // Workspace extras-preservation policy: every public Deserialize
    // struct round-trips unknown fields losslessly.
    let original = r#"{
        "@type": "Annotation",
        "id": "MD42",
        "relatedType": "Email",
        "relatedId": "EM1",
        "isPrivate": false,
        "acme.example.com:workflowState": "approved",
        "acme.example.com:reviewer": "alice@example.com"
    }"#;

    let meta: Metadata = serde_json::from_str(original).unwrap();
    let round_tripped = serde_json::to_value(&meta).unwrap();
    let reparsed: Metadata = serde_json::from_value(round_tripped.clone()).unwrap();

    assert_eq!(meta, reparsed);

    // Independent oracle: the vendor keys survived as-is and the @type
    // tag is present at the outer level.
    let map = round_tripped.as_object().unwrap();
    assert_eq!(map["@type"], serde_json::Value::String("Annotation".into()));
    assert_eq!(
        map["acme.example.com:workflowState"],
        serde_json::Value::String("approved".into()),
    );
    assert_eq!(
        map["acme.example.com:reviewer"],
        serde_json::Value::String("alice@example.com".into()),
    );
}

#[test]
fn annotation_empty_extras_omitted_on_serialize() {
    // Workspace extras-preservation policy: empty Map serialises to
    // nothing (skip_serializing_if), keeping wire-bytes identical to
    // a spec example that has no vendor extras.
    let json = r#"{
        "@type": "Annotation",
        "id": "MD1",
        "relatedType": "Email",
        "relatedId": "EM1"
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let out = serde_json::to_value(&meta).unwrap();
    let map = out.as_object().unwrap();
    assert!(map.contains_key("@type"));
    assert!(map.contains_key("id"));
    assert!(map.contains_key("relatedType"));
    assert!(map.contains_key("relatedId"));
    // isPrivate was absent on input and is skip_serializing_if=is_none
    // on output.
    assert!(!map.contains_key("isPrivate"));
    // Map has exactly four keys: no stray "extra" object.
    assert_eq!(map.len(), 4);
}

// ---------------------------------------------------------------------------
// ImapMetadata
// ---------------------------------------------------------------------------

#[test]
fn imap_metadata_draft_01_section_2_2_2_private_namespace() {
    // Oracle: hand-written from §2.2.2.1 worked example.
    // isPrivate=true → keys map to /private/<key>.
    let json = r#"{
        "@type": "ImapMetadata",
        "id": "MD100",
        "relatedType": "Mailbox",
        "relatedId": "MB1",
        "isPrivate": true,
        "metadata": {
            "comment": "My notes",
            "vendor/acme.example/color": "blue"
        }
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let imap = match meta {
        Metadata::ImapMetadata(i) => i,
        _ => panic!("expected ImapMetadata variant"),
    };
    assert_eq!(imap.id.as_ref().map(AsRef::as_ref), Some("MD100"));
    assert_eq!(imap.related_type.as_deref(), Some("Mailbox"));
    assert_eq!(imap.is_private, Some(true));
    assert_eq!(imap.metadata.get("comment"), Some(&"My notes".to_owned()));
    assert_eq!(
        imap.metadata.get("vendor/acme.example/color"),
        Some(&"blue".to_owned()),
    );
}

#[test]
fn imap_metadata_draft_01_shared_namespace() {
    // Oracle: hand-written from §2.2.2.1 second bullet.
    // isPrivate=false (or omitted) → keys map to /shared/<key>.
    let json = r#"{
        "@type": "ImapMetadata",
        "id": "MD101",
        "relatedType": "Mailbox",
        "relatedId": "MB1",
        "isPrivate": false,
        "metadata": {
            "comment": "Team mailbox"
        }
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let imap = match meta {
        Metadata::ImapMetadata(i) => i,
        _ => panic!("expected ImapMetadata variant"),
    };
    assert_eq!(imap.is_private, Some(false));
    assert_eq!(
        imap.metadata.get("comment"),
        Some(&"Team mailbox".to_owned()),
    );
}

#[test]
fn imap_metadata_empty_string_value_round_trips() {
    // Oracle: §2.2.2.1 explicitly permits empty-string values
    // ("Empty string values are permitted and represent IMAP metadata
    // entries that exist but have no value").
    let json = r#"{
        "@type": "ImapMetadata",
        "id": "MD200",
        "relatedType": "Mailbox",
        "relatedId": "MB1",
        "isPrivate": false,
        "metadata": {
            "comment": ""
        }
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let imap = match &meta {
        Metadata::ImapMetadata(i) => i,
        _ => panic!("expected ImapMetadata"),
    };
    assert_eq!(imap.metadata.get("comment"), Some(&"".to_owned()));

    // Round-trip preserves the empty-string entry.
    let reser = serde_json::to_value(&meta).unwrap();
    assert_eq!(
        reser["metadata"]["comment"],
        serde_json::Value::String("".into())
    );
}

#[test]
fn imap_metadata_preserves_vendor_extras() {
    // Workspace extras-preservation policy.
    let json = r#"{
        "@type": "ImapMetadata",
        "id": "MD300",
        "relatedType": "Mailbox",
        "relatedId": "MB1",
        "isPrivate": false,
        "metadata": { "comment": "shared" },
        "x-vendor-custom": "preserved"
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let imap = match meta {
        Metadata::ImapMetadata(i) => i,
        _ => panic!("expected ImapMetadata"),
    };
    assert_eq!(
        imap.extra.get("x-vendor-custom"),
        Some(&serde_json::Value::String("preserved".into())),
    );
}

// ---------------------------------------------------------------------------
// WebDavMetadata
// ---------------------------------------------------------------------------

#[test]
fn webdav_metadata_draft_01_section_2_2_3_expanded_name_keys() {
    // Oracle: hand-written from §2.2.3.1 worked example.
    let json = r#"{
        "@type": "WebDavMetadata",
        "id": "MD500",
        "relatedType": "FileNode",
        "relatedId": "F1",
        "isPrivate": false,
        "metadata": {
            "{http://example.com/ns}priority": "high",
            "{http://example.com/ns}reviewedBy": "alice@example.com",
            "{DAV:}displayname": "Project Documents",
            "{http://example.com/ns}complexdata": "<item><name>Test</name><value>123</value></item>"
        }
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let webdav = match meta {
        Metadata::WebDavMetadata(w) => w,
        _ => panic!("expected WebDavMetadata variant"),
    };
    assert_eq!(webdav.related_type.as_deref(), Some("FileNode"));
    assert_eq!(
        webdav.metadata.get("{http://example.com/ns}priority"),
        Some(&"high".to_owned()),
    );
    assert_eq!(
        webdav.metadata.get("{DAV:}displayname"),
        Some(&"Project Documents".to_owned()),
    );
    // XML content survives verbatim.
    assert_eq!(
        webdav.metadata.get("{http://example.com/ns}complexdata"),
        Some(&"<item><name>Test</name><value>123</value></item>".to_owned()),
    );
}

#[test]
fn webdav_metadata_round_trip_preserves_keys_and_values() {
    let json = r#"{
        "@type": "WebDavMetadata",
        "id": "MD501",
        "relatedType": "Calendar",
        "relatedId": "CAL1",
        "isPrivate": false,
        "metadata": {
            "{DAV:}displayname": "Personal"
        }
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let reser: Metadata = serde_json::from_value(serde_json::to_value(&meta).unwrap()).unwrap();
    assert_eq!(meta, reser);
}

// ---------------------------------------------------------------------------
// Metadata enum dispatch
// ---------------------------------------------------------------------------

#[test]
fn metadata_tag_dispatches_on_at_type() {
    let cases: &[(&str, &str)] = &[
        (
            r#"{"@type":"Annotation","relatedType":"Email","relatedId":"EM1"}"#,
            "Annotation",
        ),
        (
            r#"{"@type":"ImapMetadata","relatedType":"Mailbox","relatedId":"MB1"}"#,
            "ImapMetadata",
        ),
        (
            r#"{"@type":"WebDavMetadata","relatedType":"FileNode","relatedId":"F1"}"#,
            "WebDavMetadata",
        ),
    ];
    for (json, expected) in cases {
        let meta: Metadata = serde_json::from_str(json).unwrap();
        assert_eq!(meta.type_name(), *expected, "failed for {json}");
    }
}

#[test]
fn metadata_unknown_tag_fails_to_deserialize() {
    // Future spec revisions may introduce new metadata @type values
    // (§2.1). Until this crate adds a new enum variant, an unknown
    // tag MUST fail to deserialize — silent-acceptance would lose the
    // tag string and prevent variant dispatch.
    let json = r#"{"@type":"FutureMetadataType","relatedType":"Email","relatedId":"EM1"}"#;
    let r: Result<Metadata, _> = serde_json::from_str(json);
    assert!(r.is_err(), "unknown @type tag must fail to deserialize");
}

#[test]
fn metadata_missing_tag_fails_to_deserialize() {
    // The @type discriminator is mandatory per §2.2.1.1.
    let json = r#"{"relatedType":"Email","relatedId":"EM1"}"#;
    let r: Result<Metadata, _> = serde_json::from_str(json);
    assert!(r.is_err(), "missing @type tag must fail to deserialize");
}

#[test]
fn metadata_common_accessors() {
    // Sanity-check the convenience accessors on the enum.
    let json = r#"{
        "@type": "Annotation",
        "id": "MDA",
        "relatedType": "Email",
        "relatedId": "EM1",
        "isPrivate": true
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    assert_eq!(meta.id().map(AsRef::as_ref), Some("MDA"));
    assert_eq!(meta.related_type(), Some("Email"));
    assert!(meta.related_id() == &Into::<jmap_types::Id>::into("EM1"));
    assert!(meta.is_private());

    // is_private default when omitted on the wire.
    let json2 = r#"{"@type":"Annotation","relatedType":"Email","relatedId":"EM1"}"#;
    let meta2: Metadata = serde_json::from_str(json2).unwrap();
    assert!(!meta2.is_private());
}

// ---------------------------------------------------------------------------
// MetadataFilterCondition
// ---------------------------------------------------------------------------

#[test]
fn metadata_filter_draft_01_section_3_4_1_all_fields() {
    // Oracle: hand-written from §3.4.1 field-by-field listing.
    let json = r#"{
        "@type": ["Annotation"],
        "relatedType": "Email",
        "relatedIds": ["EM1", "EM2", "EM3"],
        "isPrivate": true,
        "textMatch": "approved"
    }"#;
    let filter: MetadataFilterCondition = serde_json::from_str(json).unwrap();
    assert_eq!(filter.type_names, Some(vec!["Annotation".to_owned()]));
    assert_eq!(filter.related_type, Some("Email".to_owned()));
    let ids = filter.related_ids.as_ref().unwrap();
    assert_eq!(ids.len(), 3);
    assert!(ids[0] == *"EM1");
    assert_eq!(filter.is_private, Some(true));
    assert_eq!(filter.text_match, Some("approved".to_owned()));
}

#[test]
fn metadata_filter_at_type_wire_name() {
    // Independent oracle: the wire field name MUST be "@type" exactly
    // (§3.4.1). Round-trip the type_names field and inspect the JSON
    // key directly.
    let json = r#"{"@type":["Annotation","ImapMetadata"]}"#;
    let filter: MetadataFilterCondition = serde_json::from_str(json).unwrap();
    let serialised = serde_json::to_value(&filter).unwrap();
    let map = serialised.as_object().unwrap();
    assert!(map.contains_key("@type"));
    assert!(!map.contains_key("typeNames"));
}

#[test]
fn metadata_filter_empty_is_default() {
    let filter: MetadataFilterCondition = serde_json::from_str("{}").unwrap();
    assert_eq!(filter, MetadataFilterCondition::default());
    // Empty filter serialises to empty object.
    let out = serde_json::to_value(&filter).unwrap();
    assert_eq!(out, serde_json::json!({}));
}

#[test]
fn metadata_filter_no_extras_field() {
    // Filter-algebra exclusion: per workspace policy, filter conditions
    // do NOT carry an `extra` flatten field. Unknown fields on the wire
    // serde-deserialise into the typed fields if they collide, or
    // (since we don't deny_unknown_fields) are silently dropped.
    //
    // Independent oracle: if we round-trip a filter with an unknown
    // vendor field, that field MUST NOT appear in the re-serialised
    // output (no extras to preserve it).
    let json = r#"{"@type":["Annotation"],"vendor:custom":"ignored"}"#;
    let filter: MetadataFilterCondition = serde_json::from_str(json).unwrap();
    let out = serde_json::to_value(&filter).unwrap();
    let map = out.as_object().unwrap();
    assert!(!map.contains_key("vendor:custom"));
    assert!(!map.contains_key("extra"));
    assert_eq!(map["@type"], serde_json::json!(["Annotation"]));
}

// ---------------------------------------------------------------------------
// JmapObject trait wiring
// ---------------------------------------------------------------------------

#[test]
fn metadata_jmap_object_type_name() {
    // The TYPE_NAME constant feeds the server's error messages and
    // capability dispatch. Verify it matches the IANA-registered name
    // (§9.2 "Metadata").
    assert_eq!(Metadata::TYPE_NAME, "Metadata");
}

#[test]
fn metadata_trait_associated_types_compile() {
    // Compile-time check that the trait wiring is correct. The body
    // is intentionally a no-op assertion: success here means
    // Metadata satisfies the GetObject, SetObject, and QueryObject
    // marker bounds.
    fn _assert_marker_bounds<T>()
    where
        T: GetObject + SetObject + QueryObject,
    {
    }
    _assert_marker_bounds::<Metadata>();
}

#[test]
fn metadata_property_selector_round_trip() {
    // The selector is internal Rust API (not on the wire), so the test
    // is identity-only.
    let cases = &[
        MetadataProperty::TypeName,
        MetadataProperty::Id,
        MetadataProperty::RelatedType,
        MetadataProperty::RelatedId,
        MetadataProperty::IsPrivate,
        MetadataProperty::Metadata,
        MetadataProperty::VendorProperty("acme.example.com:color".into()),
    ];
    for c in cases {
        let cloned = c.clone();
        assert_eq!(c, &cloned);
    }
}

// ---------------------------------------------------------------------------
// ImapMetadata + WebDavMetadata struct construction sanity
// ---------------------------------------------------------------------------

#[test]
fn imap_metadata_struct_round_trips_via_metadata_enum() {
    // Build the wire JSON for an ImapMetadata via the Metadata enum,
    // then verify the inner ImapMetadata struct fields agree.
    let json = r#"{
        "@type": "ImapMetadata",
        "id": "MD-IMAP-1",
        "relatedType": "Mailbox",
        "relatedId": "MB-99",
        "metadata": {}
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let inner: ImapMetadata = match meta.clone() {
        Metadata::ImapMetadata(i) => i,
        _ => panic!("expected ImapMetadata variant"),
    };
    assert_eq!(inner.id.as_ref().map(AsRef::as_ref), Some("MD-IMAP-1"));
    assert_eq!(inner.related_type.as_deref(), Some("Mailbox"));
    assert!(inner.related_id == *"MB-99");
    assert!(inner.metadata.is_empty());

    let again = serde_json::to_value(&meta).unwrap();
    let map = again.as_object().unwrap();
    assert_eq!(
        map["@type"],
        serde_json::Value::String("ImapMetadata".into())
    );
}

#[test]
fn webdav_metadata_struct_round_trips_via_metadata_enum() {
    let json = r#"{
        "@type": "WebDavMetadata",
        "id": "MD-DAV-1",
        "relatedType": "FileNode",
        "relatedId": "F-99",
        "metadata": {}
    }"#;
    let meta: Metadata = serde_json::from_str(json).unwrap();
    let inner: WebDavMetadata = match meta.clone() {
        Metadata::WebDavMetadata(w) => w,
        _ => panic!("expected WebDavMetadata variant"),
    };
    assert_eq!(inner.id.as_ref().map(AsRef::as_ref), Some("MD-DAV-1"));
    assert_eq!(inner.related_type.as_deref(), Some("FileNode"));
    assert!(inner.metadata.is_empty());

    let again = serde_json::to_value(&meta).unwrap();
    let map = again.as_object().unwrap();
    assert_eq!(
        map["@type"],
        serde_json::Value::String("WebDavMetadata".into())
    );
}

#[test]
fn standalone_annotation_struct_does_not_carry_at_type() {
    // When constructing an Annotation directly (not via the Metadata
    // enum), the @type tag is NOT serialised — only the Metadata enum
    // emits the tag. This mirrors how, in the spec, @type is a
    // discriminator carried by the enclosing Metadata object.
    let json = r#"{
        "id": "MD1",
        "relatedType": "Email",
        "relatedId": "EM1"
    }"#;
    let ann: Annotation = serde_json::from_str(json).unwrap();
    let out = serde_json::to_value(&ann).unwrap();
    let map = out.as_object().unwrap();
    assert!(!map.contains_key("@type"));
    assert_eq!(
        map["relatedType"],
        serde_json::Value::String("Email".into())
    );
}