type-bridge-schema 2.2.1

Canonical schema resolution and projection engine for type-bridge
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
use type_bridge_contract::capability::{CapabilityId, CapabilitySet};
use type_bridge_contract::fingerprint::SemanticProfileId;
use type_bridge_contract::id::{AttributeId, FunctionId, RoleId, StructId, TypeId, TypeKind};
use type_bridge_contract::schema::{
    AnnotationKindId, CollectionMode, DocumentId, SchemaFactId, SubFactId,
};
use type_bridge_schema::{
    BUILTIN_SCHEMA_CAPABILITY_IDS, SchemaDocumentSet, normalize_documents, resolve,
    resolve_schema_with_capabilities,
};

fn declared(source: &str) -> type_bridge_contract::schema::DeclaredSchema {
    let documents = SchemaDocumentSet::parse([(
        DocumentId::new("schema.yaml").expect("document identifier is valid"),
        source,
    )])
    .expect("fixture YAML parses");
    normalize_documents(&documents).expect("fixture normalizes")
}

fn profile() -> SemanticProfileId {
    SemanticProfileId::new("typedb-3.12.1/v1").expect("profile is valid")
}

#[test]
fn ordered_collection_mode_and_distinct_survive_plain_inheritance() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  tag: { value: string }
entities:
  article:
    owns:
      tag: { ordered: true, distinct: true }
  review:
    sub: article
relations:
  collection:
    relates:
      member: { ordered: true, distinct: true }
  curated-collection:
    sub: collection
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("ordered schema resolves");
    let tag = AttributeId::new("tag").unwrap();
    let review = TypeId::new(TypeKind::Entity, "review").unwrap();
    let owns = &resolved.types()[&review].owns()[&tag];
    assert_eq!(owns.collection_mode(), CollectionMode::OrderedList);
    assert!(owns.is_distinct());
    assert!(!owns.origin().is_direct());

    let curated = TypeId::new(TypeKind::Relation, "curated-collection").unwrap();
    let member = RoleId::new("collection", "member").unwrap();
    let relates = &resolved.types()[&curated].relates()[&member];
    assert_eq!(relates.collection_mode(), CollectionMode::OrderedList);
    assert!(relates.is_distinct());
    assert!(!relates.origin().is_direct());
}

#[test]
fn inherited_owns_redeclaration_must_preserve_collection_mode() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  tag: { value: string }
entities:
  article:
    owns:
      tag: { ordered: true }
  review:
    sub: article
    owns: [tag]
"#,
    );
    let error = resolve(&schema, &profile()).expect_err("mode conflict rejects");
    let diagnostic = error.iter().next().expect("one diagnostic");
    assert_eq!(
        diagnostic.diagnostic().code().as_str(),
        "inherited_owns_collection_mode_conflict"
    );
    assert!(diagnostic.primary().is_some());
    assert_eq!(diagnostic.related().len(), 1);
}

#[test]
fn specialized_role_must_preserve_effective_parent_collection_mode() {
    let schema = declared(
        r#"format: typebridge.schema/v2
relations:
  collection:
    relates:
      member: { ordered: true }
  curated-collection:
    sub: collection
    relates:
      curated-member: { as: member }
"#,
    );
    let error = resolve(&schema, &profile()).expect_err("mode conflict rejects");
    let diagnostic = error.iter().next().expect("one diagnostic");
    assert_eq!(
        diagnostic.diagnostic().code().as_str(),
        "specialized_role_collection_mode_conflict"
    );
    assert!(diagnostic.primary().is_some());
    assert_eq!(diagnostic.related().len(), 1);
}

#[test]
fn direct_redeclarations_and_specializations_may_add_or_drop_distinct() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  tag: { value: string }
entities:
  base:
    owns:
      tag: { ordered: true, distinct: true }
  dropped:
    sub: base
    owns:
      tag: { ordered: true }
  added-base:
    owns:
      tag: { ordered: true }
  added:
    sub: added-base
    owns:
      tag: { ordered: true, distinct: true }
relations:
  distinct-roles:
    relates:
      member: { ordered: true, distinct: true }
  dropped-role:
    sub: distinct-roles
    relates:
      child: { as: member, ordered: true }
  plain-roles:
    relates:
      member: { ordered: true }
  added-role:
    sub: plain-roles
    relates:
      child: { as: member, ordered: true, distinct: true }
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("distinct transitions resolve");
    let tag = AttributeId::new("tag").unwrap();
    for (owner, distinct) in [("dropped", false), ("added", true)] {
        let id = TypeId::new(TypeKind::Entity, owner).unwrap();
        let owns = &resolved.types()[&id].owns()[&tag];
        assert_eq!(owns.collection_mode(), CollectionMode::OrderedList);
        assert_eq!(owns.is_distinct(), distinct);
    }
    for (relation, declaring_relation, distinct) in [
        ("dropped-role", "dropped-role", false),
        ("added-role", "added-role", true),
    ] {
        let id = TypeId::new(TypeKind::Relation, relation).unwrap();
        let role = RoleId::new(declaring_relation, "child").unwrap();
        let relates = &resolved.types()[&id].relates()[&role];
        assert_eq!(relates.collection_mode(), CollectionMode::OrderedList);
        assert_eq!(relates.is_distinct(), distinct);
    }
}

#[test]
fn ordered_collections_are_gated_to_the_3_12_1_semantic_profile() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  tag: { value: string }
entities:
  article:
    owns:
      tag: { ordered: true }
"#,
    );
    resolve(&schema, &profile()).expect("3.12.1 accepts ordered collections");

    let legacy = SemanticProfileId::new("typedb-3.11.5/v1").unwrap();
    let error = resolve(&schema, &legacy).expect_err("3.11.5 rejects ordered collections");
    let diagnostic = error.iter().next().expect("one diagnostic");
    assert_eq!(
        diagnostic.diagnostic().code().as_str(),
        "ordered_collection_profile_unsupported"
    );
    assert!(diagnostic.primary().is_some());

    let unordered = declared(
        r#"format: typebridge.schema/v2
attributes:
  tag: { value: string }
entities:
  article: { owns: [tag] }
"#,
    );
    resolve(&unordered, &legacy).expect("3.11.5 unordered behavior is preserved");
}

#[test]
fn resolves_inherited_value_owns_and_profile_cardinality() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  name: { value: string }
entities:
  party:
    owns: [name]
  person:
    sub: party
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let person = TypeId::new(TypeKind::Entity, "person").expect("type identifier is valid");
    let name = AttributeId::new("name").expect("attribute identifier is valid");
    let person = &resolved.types()[&person];
    let owns = &person.owns()[&name];
    assert!(!owns.origin().is_direct());
    assert_eq!(owns.cardinality().min(), 0);
    assert_eq!(owns.cardinality().max(), Some(1));

    let name_type = TypeId::new(TypeKind::Attribute, "name").expect("type identifier is valid");
    assert_eq!(
        resolved.types()[&name_type]
            .value_type()
            .expect("value type resolves")
            .value_type(),
        type_bridge_contract::value::ValueTypeTag::String
    );
}

#[test]
fn resolves_exact_direct_sub_origin_and_independent_edge_annotations() {
    let schema = declared(
        r#"format: typebridge.schema/v2
entities:
  actor: {}
  person:
    doc: "person type"
    sub:
      type: actor
      doc: "person edge"
      meta: { owner: "schema", stability: "stable" }
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let actor = TypeId::new(TypeKind::Entity, "actor").expect("type identifier is valid");
    let person = TypeId::new(TypeKind::Entity, "person").expect("type identifier is valid");
    let expected = SubFactId::new(person.clone(), actor).expect("sub identifier is valid");
    let person = &resolved.types()[&person];
    let direct_sub = person.direct_sub().expect("person retains its direct edge");

    assert_eq!(direct_sub.id(), &expected);
    assert_eq!(direct_sub.origin().declared(), &SchemaFactId::Sub(expected));
    assert!(direct_sub.origin().is_direct());
    assert_eq!(direct_sub.annotations().len(), 3);
    assert!(
        direct_sub
            .annotations()
            .contains_key(&AnnotationKindId::Doc)
    );
    assert!(
        direct_sub
            .annotations()
            .contains_key(&AnnotationKindId::Meta(
                type_bridge_contract::id::Label::new("owner").unwrap()
            ))
    );
    assert!(
        direct_sub
            .annotations()
            .contains_key(&AnnotationKindId::Meta(
                type_bridge_contract::id::Label::new("stability").unwrap()
            ))
    );
    assert_eq!(person.annotations().len(), 1);
}

#[test]
fn key_owns_materializes_exactly_one_and_unique_through_inheritance() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  identifier: { value: string }
entities:
  account:
    owns:
      identifier: { key: true }
  customer:
    sub: account
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("key schema resolves");
    let identifier = AttributeId::new("identifier").expect("attribute identifier is valid");

    for owner in ["account", "customer"] {
        let owner = TypeId::new(TypeKind::Entity, owner).expect("type identifier is valid");
        let owns = &resolved.types()[&owner].owns()[&identifier];
        assert_eq!(owns.cardinality().min(), 1);
        assert_eq!(owns.cardinality().max(), Some(1));
        assert!(owns.is_key());
        assert!(owns.is_unique());
    }
}

#[test]
fn role_specialization_replaces_the_parent_write_interface() {
    let schema = declared(
        r#"format: typebridge.schema/v2
relations:
  membership:
    relates: [member]
  employment:
    sub: membership
    relates:
      employee: { as: member }
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let employment =
        TypeId::new(TypeKind::Relation, "employment").expect("type identifier is valid");
    let relation = &resolved.types()[&employment];
    let member = RoleId::new("membership", "member").expect("role identifier is valid");
    let employee = RoleId::new("employment", "employee").expect("role identifier is valid");
    assert!(!relation.relates().contains_key(&member));
    assert!(
        relation.relates()[&employee]
            .replaced_roles()
            .contains(&member)
    );
}

#[test]
fn inherited_relates_rebinds_effective_relation_but_preserves_origin() {
    let schema = declared(
        r#"format: typebridge.schema/v2
relations:
  membership:
    relates: [member]
  employment:
    sub: membership
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let employment =
        TypeId::new(TypeKind::Relation, "employment").expect("type identifier is valid");
    let member = RoleId::new("membership", "member").expect("role identifier is valid");
    let relates = &resolved.types()[&employment].relates()[&member];
    assert_eq!(relates.id().relation(), &employment);
    assert!(!relates.origin().is_direct());
    assert_eq!(
        relates.origin().declared(),
        &type_bridge_contract::schema::SchemaFactId::Relates(
            type_bridge_contract::schema::RelatesFactId::new(
                TypeId::new(TypeKind::Relation, "membership").expect("type identifier is valid"),
                member,
            )
            .expect("relates identifier is valid"),
        )
    );
}

#[test]
fn inherited_abstract_role_is_playable_only_below_its_declaring_scope() {
    let schema = declared(
        r#"format: typebridge.schema/v2
entities:
  actor: {}
relations:
  base-event:
    relates:
      participant: { abstract: true, card: 1 }
  plain-event:
    sub: base-event
  specialized-event:
    sub: base-event
    relates:
      actor: { as: participant, card: 1 }
plays:
  actor:
    base-event: [participant]
    specialized-event: [actor]
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let base_event = TypeId::new(TypeKind::Relation, "base-event").unwrap();
    let plain_event = TypeId::new(TypeKind::Relation, "plain-event").unwrap();
    let specialized_event = TypeId::new(TypeKind::Relation, "specialized-event").unwrap();
    let participant = RoleId::new("base-event", "participant").unwrap();

    let declared_role = &resolved.types()[&base_event].relates()[&participant];
    assert!(declared_role.is_abstract());
    assert!(declared_role.origin().is_direct());
    assert!(!declared_role.accepts_players_at_effective_scope());
    assert!(!resolved.types()[&base_event].is_constructible());

    let inherited_role = &resolved.types()[&plain_event].relates()[&participant];
    assert!(inherited_role.is_abstract());
    assert!(!inherited_role.origin().is_direct());
    assert!(inherited_role.accepts_players_at_effective_scope());
    assert!(resolved.types()[&plain_event].is_constructible());
    assert!(resolved.types()[&specialized_event].is_constructible());
}

#[test]
fn specialized_roles_accept_only_explicit_effective_players() {
    let schema = declared(
        r#"format: typebridge.schema/v2
entities:
  parent-player: {}
  specialized-player: {}
relations:
  membership:
    relates: [member]
  employment:
    sub: membership
    relates:
      employee: { as: member }
plays:
  parent-player:
    membership: [member]
  specialized-player:
    employment: [employee]
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let member = RoleId::new("membership", "member").expect("role identifier is valid");
    let employee = RoleId::new("employment", "employee").expect("role identifier is valid");
    let parent_player =
        TypeId::new(TypeKind::Entity, "parent-player").expect("type identifier is valid");
    let specialized_player =
        TypeId::new(TypeKind::Entity, "specialized-player").expect("type identifier is valid");

    assert!(
        resolved.roles()[&member]
            .accepted_players()
            .contains(&parent_player)
    );
    assert!(
        !resolved.roles()[&employee]
            .accepted_players()
            .contains(&parent_player)
    );
    assert!(
        resolved.roles()[&employee]
            .accepted_players()
            .contains(&specialized_player)
    );
}

#[test]
fn relation_types_are_valid_concrete_role_players() {
    let schema = declared(
        r#"format: typebridge.schema/v2
relations:
  container:
    relates: [item]
  event: {}
plays:
  event:
    container: [item]
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let role = RoleId::new("container", "item").expect("role identifier is valid");
    let container = TypeId::new(TypeKind::Relation, "container").expect("type identifier is valid");
    let event = TypeId::new(TypeKind::Relation, "event").expect("type identifier is valid");
    assert!(resolved.roles()[&role].accepted_players().contains(&event));
    assert!(
        resolved
            .dependency_graph()
            .dependencies(&event)
            .expect("event has projection dependencies")
            .contains(&container)
    );
    assert!(
        resolved
            .dependency_graph()
            .dependencies(&container)
            .expect("container has projection dependencies")
            .contains(&event)
    );
    assert!(
        resolved
            .dependency_graph()
            .strongly_connected_components()
            .iter()
            .any(|component| {
                component.len() == 2 && component.contains(&container) && component.contains(&event)
            })
    );
}

#[test]
fn inheritance_cycles_fail_before_resolution_output() {
    let schema = declared(
        r#"format: typebridge.schema/v2
entities:
  cycle-alpha: { sub: cycle-beta }
  cycle-beta: { sub: cycle-alpha }
"#,
    );
    assert!(resolve(&schema, &profile()).is_err());
}

#[test]
fn resolution_is_deterministic_and_does_not_mutate_declared_identity() {
    let schema = declared(
        r#"format: typebridge.schema/v2
attributes:
  name: { value: string }
entities:
  person: { owns: [name] }
"#,
    );
    let before = schema.declared_identity_fingerprint().clone();
    let first = resolve(&schema, &profile()).expect("first resolution succeeds");
    let second = resolve(&schema, &profile()).expect("second resolution succeeds");
    assert_eq!(first, second);
    assert_eq!(&before, schema.declared_identity_fingerprint());
    assert_eq!(first.descriptor_index().iter().len(), schema.facts().len());
}

#[test]
fn resolves_structs_without_reordering_fields() {
    let schema = declared(
        r#"format: typebridge.schema/v2
structs:
  player-stats:
    fields:
      - name: wins
        type: integer
      - name: losses
        type: integer
      - name: nickname
        type: string
        optional: true
"#,
    );

    let before = schema.declared_identity_fingerprint().clone();
    let first = resolve(&schema, &profile()).expect("schema resolves");
    let second = resolve(&schema, &profile()).expect("schema resolves");
    let id = StructId::new("player-stats").expect("struct identifier is valid");
    let fields = first.structs()[&id].fields();

    assert_eq!(fields[0].name().as_str(), "wins");
    assert_eq!(fields[1].name().as_str(), "losses");
    assert_eq!(fields[2].name().as_str(), "nickname");
    assert!(fields[2].optional());
    assert_eq!(first, second);
    assert_eq!(&before, schema.declared_identity_fingerprint());
}

#[test]
fn resolves_functions_without_rewriting_signature_or_body() {
    let schema = declared(
        r#"format: typebridge.schema/v2
entities:
  person: {}
functions:
  people:
    parameters:
      - name: person
        type: person
    returns:
      stream: [person]
    body:
      typeql: |-
        match
          $person isa person;
        return { $person };
"#,
    );
    let resolved = resolve(&schema, &profile()).expect("schema resolves");
    let id = FunctionId::new("people").expect("function identifier is valid");
    let declaration = resolved.functions()[&id].declaration();

    assert_eq!(
        declaration.signature().parameters()[0].name().as_str(),
        "person"
    );
    assert_eq!(
        declaration.body().text(),
        "match\n  $person isa person;\nreturn { $person };"
    );
}

#[test]
fn injected_capabilities_accept_exact_requirements_and_reject_missing_ones() {
    let schema = declared(
        r#"format: typebridge.schema/v2
capabilities:
  required: [schema.roles]
relations:
  membership: { relates: [member] }
"#,
    );
    let available = CapabilitySet::from_iter([
        CapabilityId::new("schema.roles").expect("capability ID is valid")
    ]);
    resolve_schema_with_capabilities(&schema, &profile(), &available)
        .expect("advertised required capability resolves");

    let error = resolve_schema_with_capabilities(&schema, &profile(), &CapabilitySet::new())
        .expect_err("missing required capability rejects");
    assert_eq!(
        error.iter().next().unwrap().diagnostic().code().as_str(),
        "unsupported_required_capability",
    );
}

#[test]
fn compatibility_resolver_uses_a_closed_builtin_schema_capability_set() {
    assert_eq!(
        BUILTIN_SCHEMA_CAPABILITY_IDS,
        &["schema.annotations", "schema.doc-meta", "schema.roles"],
    );

    let supported = declared(
        r#"format: typebridge.schema/v2
capabilities:
  required: [schema.roles]
relations:
  membership: { relates: [member] }
"#,
    );
    resolve(&supported, &profile()).expect("built-in schema capability resolves");

    let future = declared(
        r#"format: typebridge.schema/v2
capabilities:
  required: [schema.future-feature]
"#,
    );
    let error = resolve(&future, &profile()).expect_err("unknown capability rejects");
    assert_eq!(
        error.iter().next().unwrap().diagnostic().code().as_str(),
        "unsupported_required_capability",
    );

    let explicitly_available =
        CapabilitySet::from_iter([
            CapabilityId::new("schema.future-feature").expect("capability ID is valid")
        ]);
    resolve_schema_with_capabilities(&future, &profile(), &explicitly_available)
        .expect("explicitly injected open capability resolves");
}