@disclosureos/schema 2.0.0-beta.2 → 2.0.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/CHANGELOG.md +101 -0
  2. package/README.md +95 -10
  3. package/dist/experimental/v2/index.d.ts +4431 -81
  4. package/dist/experimental/v2/index.js +8010 -322
  5. package/dist/experimental/v2/index.js.map +1 -1
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.js +1 -1
  8. package/dist/index.js.map +1 -1
  9. package/package.json +34 -6
  10. package/schema/enriched-observation.schema.json +16 -16
  11. package/schema/experimental/archival-case-presentation-0.1.0.schema.json +742 -0
  12. package/schema/experimental/case-presentation-0.1.0.schema.json +431 -0
  13. package/schema/experimental/context-case-presentation-0.1.0.schema.json +697 -0
  14. package/schema/experimental/lidar-point-cloud-profile-0.1.0.schema.json +416 -0
  15. package/schema/experimental/material-case-presentation-0.1.0.schema.json +802 -0
  16. package/schema/experimental/passive-sonar-profile-0.1.0.schema.json +238 -0
  17. package/schema/experimental/product-source-selection-0.1.0.schema.json +673 -0
  18. package/schema/experimental/radar-profile-0.1.0.schema.json +1232 -0
  19. package/schema/experimental/satellite-raster-profile-0.1.0.schema.json +406 -0
  20. package/schema/experimental/secondary-radar-profile-0.1.0.schema.json +154 -0
  21. package/schema/experimental/sonar-profile-0.1.0.schema.json +197 -0
  22. package/schema/experimental/steered-radar-profile-0.1.0.schema.json +214 -0
  23. package/schema/experimental/testimony-case-presentation-0.1.0.schema.json +682 -0
  24. package/schema/experimental/vocabulary-bindings-0.1.0.schema.json +167 -0
  25. package/schema/experimental/vocabulary-catalog-0.1.0.schema.json +155 -0
  26. package/schema/experimental/vocabulary-term-reference-0.1.0.schema.json +61 -0
@@ -0,0 +1,802 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "kind": {
6
+ "type": "string",
7
+ "const": "material_case_presentation"
8
+ },
9
+ "schemaVersion": {
10
+ "type": "string",
11
+ "const": "0.1.0"
12
+ },
13
+ "presentation": {
14
+ "type": "object",
15
+ "properties": {
16
+ "kind": {
17
+ "type": "string",
18
+ "const": "case_presentation"
19
+ },
20
+ "schemaVersion": {
21
+ "type": "string",
22
+ "const": "0.1.0"
23
+ },
24
+ "publicId": {
25
+ "$ref": "#/$defs/__schema0"
26
+ },
27
+ "caseRef": {
28
+ "type": "object",
29
+ "properties": {
30
+ "documentId": {
31
+ "$ref": "#/$defs/__schema0"
32
+ },
33
+ "schemaId": {
34
+ "type": "string",
35
+ "const": "urn:disclosureos:experimental:case-record:0.1.0"
36
+ },
37
+ "sha256": {
38
+ "$ref": "#/$defs/__schema1"
39
+ }
40
+ },
41
+ "required": [
42
+ "documentId",
43
+ "schemaId",
44
+ "sha256"
45
+ ],
46
+ "additionalProperties": false
47
+ },
48
+ "linksRef": {
49
+ "type": "object",
50
+ "properties": {
51
+ "documentId": {
52
+ "$ref": "#/$defs/__schema0"
53
+ },
54
+ "schemaId": {
55
+ "type": "string",
56
+ "const": "urn:disclosureos:experimental:case-links:0.1.0"
57
+ },
58
+ "sha256": {
59
+ "$ref": "#/$defs/__schema1"
60
+ }
61
+ },
62
+ "required": [
63
+ "documentId",
64
+ "schemaId",
65
+ "sha256"
66
+ ],
67
+ "additionalProperties": false
68
+ },
69
+ "title": {
70
+ "$ref": "#/$defs/__schema2"
71
+ },
72
+ "summary": {
73
+ "$ref": "#/$defs/__schema3"
74
+ },
75
+ "updatedAt": {
76
+ "type": "string",
77
+ "allOf": [
78
+ {
79
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
80
+ },
81
+ {
82
+ "pattern": "^(?!0000)"
83
+ },
84
+ {
85
+ "pattern": "T[0-9]{2}:[0-9]{2}:[0-9]{2}"
86
+ }
87
+ ]
88
+ },
89
+ "status": {
90
+ "type": "string",
91
+ "enum": [
92
+ "draft",
93
+ "published",
94
+ "archived",
95
+ "withdrawn"
96
+ ]
97
+ },
98
+ "citations": {
99
+ "type": "array",
100
+ "items": {
101
+ "type": "object",
102
+ "properties": {
103
+ "id": {
104
+ "$ref": "#/$defs/__schema0"
105
+ },
106
+ "label": {
107
+ "$ref": "#/$defs/__schema2"
108
+ },
109
+ "description": {
110
+ "$ref": "#/$defs/__schema3"
111
+ },
112
+ "target": {
113
+ "oneOf": [
114
+ {
115
+ "type": "object",
116
+ "properties": {
117
+ "kind": {
118
+ "type": "string",
119
+ "const": "case"
120
+ }
121
+ },
122
+ "required": [
123
+ "kind"
124
+ ],
125
+ "additionalProperties": false
126
+ },
127
+ {
128
+ "type": "object",
129
+ "properties": {
130
+ "kind": {
131
+ "type": "string",
132
+ "const": "artifact"
133
+ },
134
+ "observationId": {
135
+ "$ref": "#/$defs/__schema0"
136
+ },
137
+ "ref": {
138
+ "$ref": "#/$defs/__schema4"
139
+ }
140
+ },
141
+ "required": [
142
+ "kind",
143
+ "observationId",
144
+ "ref"
145
+ ],
146
+ "additionalProperties": false
147
+ },
148
+ {
149
+ "type": "object",
150
+ "properties": {
151
+ "kind": {
152
+ "type": "string",
153
+ "const": "supplement"
154
+ },
155
+ "linkId": {
156
+ "$ref": "#/$defs/__schema0"
157
+ }
158
+ },
159
+ "required": [
160
+ "kind",
161
+ "linkId"
162
+ ],
163
+ "additionalProperties": false
164
+ }
165
+ ]
166
+ }
167
+ },
168
+ "required": [
169
+ "id",
170
+ "label",
171
+ "target"
172
+ ],
173
+ "additionalProperties": false
174
+ }
175
+ },
176
+ "blocks": {
177
+ "type": "array",
178
+ "items": {
179
+ "type": "object",
180
+ "properties": {
181
+ "id": {
182
+ "$ref": "#/$defs/__schema0"
183
+ },
184
+ "heading": {
185
+ "$ref": "#/$defs/__schema2"
186
+ },
187
+ "text": {
188
+ "$ref": "#/$defs/__schema3"
189
+ },
190
+ "citationIds": {
191
+ "$ref": "#/$defs/__schema5"
192
+ }
193
+ },
194
+ "required": [
195
+ "id",
196
+ "text",
197
+ "citationIds"
198
+ ],
199
+ "additionalProperties": false
200
+ }
201
+ },
202
+ "findings": {
203
+ "type": "array",
204
+ "items": {
205
+ "type": "object",
206
+ "properties": {
207
+ "id": {
208
+ "$ref": "#/$defs/__schema0"
209
+ },
210
+ "historyRef": {
211
+ "type": "object",
212
+ "properties": {
213
+ "documentId": {
214
+ "$ref": "#/$defs/__schema0"
215
+ },
216
+ "schemaId": {
217
+ "type": "string",
218
+ "const": "urn:disclosureos:experimental:case-claim-history:0.1.0"
219
+ },
220
+ "sha256": {
221
+ "$ref": "#/$defs/__schema1"
222
+ }
223
+ },
224
+ "required": [
225
+ "documentId",
226
+ "schemaId",
227
+ "sha256"
228
+ ],
229
+ "additionalProperties": false
230
+ },
231
+ "claimId": {
232
+ "$ref": "#/$defs/__schema0"
233
+ },
234
+ "title": {
235
+ "$ref": "#/$defs/__schema2"
236
+ },
237
+ "summary": {
238
+ "$ref": "#/$defs/__schema3"
239
+ },
240
+ "reviewerLabel": {
241
+ "$ref": "#/$defs/__schema2"
242
+ },
243
+ "citationIds": {
244
+ "$ref": "#/$defs/__schema5"
245
+ }
246
+ },
247
+ "required": [
248
+ "id",
249
+ "historyRef",
250
+ "claimId",
251
+ "title",
252
+ "summary",
253
+ "reviewerLabel",
254
+ "citationIds"
255
+ ],
256
+ "additionalProperties": false
257
+ }
258
+ },
259
+ "attachments": {
260
+ "type": "array",
261
+ "items": {
262
+ "type": "object",
263
+ "properties": {
264
+ "id": {
265
+ "$ref": "#/$defs/__schema0"
266
+ },
267
+ "kind": {
268
+ "type": "string",
269
+ "enum": [
270
+ "image",
271
+ "video",
272
+ "audio",
273
+ "document",
274
+ "data"
275
+ ]
276
+ },
277
+ "role": {
278
+ "type": "string",
279
+ "enum": [
280
+ "primary",
281
+ "supporting",
282
+ "thumbnail"
283
+ ]
284
+ },
285
+ "observationId": {
286
+ "$ref": "#/$defs/__schema0"
287
+ },
288
+ "ref": {
289
+ "$ref": "#/$defs/__schema4"
290
+ },
291
+ "sha256": {
292
+ "$ref": "#/$defs/__schema1"
293
+ },
294
+ "caption": {
295
+ "$ref": "#/$defs/__schema3"
296
+ },
297
+ "credit": {
298
+ "$ref": "#/$defs/__schema2"
299
+ },
300
+ "rights": {
301
+ "$ref": "#/$defs/__schema3"
302
+ },
303
+ "alt": {
304
+ "$ref": "#/$defs/__schema2"
305
+ },
306
+ "dimensions": {
307
+ "type": "object",
308
+ "properties": {
309
+ "width": {
310
+ "type": "integer",
311
+ "exclusiveMinimum": 0,
312
+ "maximum": 9007199254740991
313
+ },
314
+ "height": {
315
+ "type": "integer",
316
+ "exclusiveMinimum": 0,
317
+ "maximum": 9007199254740991
318
+ }
319
+ },
320
+ "required": [
321
+ "width",
322
+ "height"
323
+ ],
324
+ "additionalProperties": false
325
+ },
326
+ "durationSeconds": {
327
+ "type": "number",
328
+ "minimum": 0
329
+ },
330
+ "citationIds": {
331
+ "$ref": "#/$defs/__schema5"
332
+ },
333
+ "mimeType": {
334
+ "$ref": "#/$defs/__schema2"
335
+ },
336
+ "fileSizeBytes": {
337
+ "type": "integer",
338
+ "minimum": 0,
339
+ "maximum": 9007199254740991
340
+ },
341
+ "thumbnailAttachmentId": {
342
+ "$ref": "#/$defs/__schema0"
343
+ }
344
+ },
345
+ "required": [
346
+ "id",
347
+ "kind",
348
+ "role",
349
+ "observationId",
350
+ "ref",
351
+ "sha256",
352
+ "caption",
353
+ "credit",
354
+ "rights",
355
+ "citationIds"
356
+ ],
357
+ "additionalProperties": false
358
+ }
359
+ },
360
+ "featuredAttachmentId": {
361
+ "$ref": "#/$defs/__schema0"
362
+ },
363
+ "notices": {
364
+ "type": "array",
365
+ "items": {
366
+ "type": "object",
367
+ "properties": {
368
+ "id": {
369
+ "$ref": "#/$defs/__schema0"
370
+ },
371
+ "kind": {
372
+ "type": "string",
373
+ "enum": [
374
+ "scope",
375
+ "correction",
376
+ "archive",
377
+ "withdrawal",
378
+ "rights"
379
+ ]
380
+ },
381
+ "text": {
382
+ "$ref": "#/$defs/__schema3"
383
+ }
384
+ },
385
+ "required": [
386
+ "id",
387
+ "kind",
388
+ "text"
389
+ ],
390
+ "additionalProperties": false
391
+ }
392
+ }
393
+ },
394
+ "required": [
395
+ "kind",
396
+ "schemaVersion",
397
+ "publicId",
398
+ "caseRef",
399
+ "title",
400
+ "summary",
401
+ "updatedAt",
402
+ "status",
403
+ "citations",
404
+ "blocks",
405
+ "findings",
406
+ "attachments",
407
+ "notices"
408
+ ],
409
+ "additionalProperties": false
410
+ },
411
+ "material": {
412
+ "type": "object",
413
+ "properties": {
414
+ "document": {
415
+ "type": "object",
416
+ "properties": {
417
+ "documentId": {
418
+ "$ref": "#/$defs/__schema6"
419
+ },
420
+ "schemaId": {
421
+ "type": "string",
422
+ "const": "urn:disclosureos:experimental:research-entities:0.4.0"
423
+ },
424
+ "sha256": {
425
+ "$ref": "#/$defs/__schema7"
426
+ }
427
+ },
428
+ "required": [
429
+ "documentId",
430
+ "schemaId",
431
+ "sha256"
432
+ ],
433
+ "additionalProperties": false
434
+ },
435
+ "history": {
436
+ "type": "object",
437
+ "properties": {
438
+ "documentId": {
439
+ "$ref": "#/$defs/__schema6"
440
+ },
441
+ "schemaId": {
442
+ "type": "string",
443
+ "const": "urn:disclosureos:experimental:claim-history:0.5.0"
444
+ },
445
+ "sha256": {
446
+ "$ref": "#/$defs/__schema7"
447
+ }
448
+ },
449
+ "required": [
450
+ "documentId",
451
+ "schemaId",
452
+ "sha256"
453
+ ],
454
+ "additionalProperties": false
455
+ },
456
+ "traces": {
457
+ "type": "array",
458
+ "items": {
459
+ "type": "object",
460
+ "properties": {
461
+ "id": {
462
+ "$ref": "#/$defs/__schema6"
463
+ },
464
+ "entityId": {
465
+ "$ref": "#/$defs/__schema6"
466
+ },
467
+ "label": {
468
+ "$ref": "#/$defs/__schema8"
469
+ },
470
+ "citationIds": {
471
+ "$ref": "#/$defs/__schema9"
472
+ },
473
+ "descriptionAssertionId": {
474
+ "$ref": "#/$defs/__schema6"
475
+ }
476
+ },
477
+ "required": [
478
+ "id",
479
+ "entityId",
480
+ "label",
481
+ "citationIds",
482
+ "descriptionAssertionId"
483
+ ],
484
+ "additionalProperties": false
485
+ }
486
+ },
487
+ "specimens": {
488
+ "minItems": 1,
489
+ "type": "array",
490
+ "items": {
491
+ "$ref": "#/$defs/__schema10"
492
+ }
493
+ },
494
+ "preparations": {
495
+ "type": "array",
496
+ "items": {
497
+ "type": "object",
498
+ "properties": {
499
+ "id": {
500
+ "$ref": "#/$defs/__schema6"
501
+ },
502
+ "entityId": {
503
+ "$ref": "#/$defs/__schema6"
504
+ },
505
+ "label": {
506
+ "$ref": "#/$defs/__schema8"
507
+ },
508
+ "citationIds": {
509
+ "$ref": "#/$defs/__schema9"
510
+ },
511
+ "methodAssertionId": {
512
+ "$ref": "#/$defs/__schema6"
513
+ },
514
+ "dateAssertionId": {
515
+ "$ref": "#/$defs/__schema6"
516
+ }
517
+ },
518
+ "required": [
519
+ "id",
520
+ "entityId",
521
+ "label",
522
+ "citationIds",
523
+ "methodAssertionId",
524
+ "dateAssertionId"
525
+ ],
526
+ "additionalProperties": false
527
+ }
528
+ },
529
+ "analyses": {
530
+ "minItems": 1,
531
+ "type": "array",
532
+ "items": {
533
+ "$ref": "#/$defs/__schema11"
534
+ }
535
+ },
536
+ "results": {
537
+ "minItems": 1,
538
+ "type": "array",
539
+ "items": {
540
+ "$ref": "#/$defs/__schema12"
541
+ }
542
+ },
543
+ "review": {
544
+ "type": "object",
545
+ "properties": {
546
+ "id": {
547
+ "$ref": "#/$defs/__schema6"
548
+ },
549
+ "claimId": {
550
+ "$ref": "#/$defs/__schema6"
551
+ },
552
+ "title": {
553
+ "$ref": "#/$defs/__schema8"
554
+ },
555
+ "summary": {
556
+ "$ref": "#/$defs/__schema8"
557
+ },
558
+ "reviewerLabel": {
559
+ "$ref": "#/$defs/__schema8"
560
+ },
561
+ "methodLabel": {
562
+ "$ref": "#/$defs/__schema8"
563
+ },
564
+ "citationIds": {
565
+ "$ref": "#/$defs/__schema9"
566
+ }
567
+ },
568
+ "required": [
569
+ "id",
570
+ "claimId",
571
+ "title",
572
+ "summary",
573
+ "reviewerLabel",
574
+ "methodLabel",
575
+ "citationIds"
576
+ ],
577
+ "additionalProperties": false
578
+ }
579
+ },
580
+ "required": [
581
+ "document",
582
+ "history",
583
+ "traces",
584
+ "specimens",
585
+ "preparations",
586
+ "analyses",
587
+ "results",
588
+ "review"
589
+ ],
590
+ "additionalProperties": false
591
+ }
592
+ },
593
+ "required": [
594
+ "kind",
595
+ "schemaVersion",
596
+ "presentation",
597
+ "material"
598
+ ],
599
+ "additionalProperties": false,
600
+ "$defs": {
601
+ "__schema0": {
602
+ "type": "string",
603
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
604
+ },
605
+ "__schema1": {
606
+ "type": "string",
607
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
608
+ },
609
+ "__schema2": {
610
+ "maxLength": 500,
611
+ "$ref": "#/$defs/__schema3"
612
+ },
613
+ "__schema3": {
614
+ "type": "string",
615
+ "minLength": 1,
616
+ "maxLength": 20000,
617
+ "pattern": "\\S"
618
+ },
619
+ "__schema4": {
620
+ "type": "string",
621
+ "pattern": "^(source|product):[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
622
+ },
623
+ "__schema5": {
624
+ "minItems": 1,
625
+ "type": "array",
626
+ "items": {
627
+ "$ref": "#/$defs/__schema0"
628
+ }
629
+ },
630
+ "__schema6": {
631
+ "type": "string",
632
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
633
+ },
634
+ "__schema7": {
635
+ "type": "string",
636
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
637
+ },
638
+ "__schema8": {
639
+ "type": "string",
640
+ "minLength": 1,
641
+ "maxLength": 20000,
642
+ "pattern": "\\S"
643
+ },
644
+ "__schema9": {
645
+ "minItems": 1,
646
+ "type": "array",
647
+ "items": {
648
+ "$ref": "#/$defs/__schema6"
649
+ }
650
+ },
651
+ "__schema10": {
652
+ "type": "object",
653
+ "properties": {
654
+ "id": {
655
+ "$ref": "#/$defs/__schema6"
656
+ },
657
+ "entityId": {
658
+ "$ref": "#/$defs/__schema6"
659
+ },
660
+ "label": {
661
+ "$ref": "#/$defs/__schema8"
662
+ },
663
+ "citationIds": {
664
+ "$ref": "#/$defs/__schema9"
665
+ },
666
+ "fields": {
667
+ "type": "array",
668
+ "items": {
669
+ "type": "object",
670
+ "properties": {
671
+ "field": {
672
+ "type": "string",
673
+ "enum": [
674
+ "type",
675
+ "description",
676
+ "collectionTime",
677
+ "reportedCustodyStatus"
678
+ ]
679
+ },
680
+ "assertionId": {
681
+ "$ref": "#/$defs/__schema6"
682
+ }
683
+ },
684
+ "required": [
685
+ "field",
686
+ "assertionId"
687
+ ],
688
+ "additionalProperties": false
689
+ }
690
+ },
691
+ "actions": {
692
+ "type": "array",
693
+ "items": {
694
+ "type": "object",
695
+ "properties": {
696
+ "id": {
697
+ "$ref": "#/$defs/__schema6"
698
+ },
699
+ "entityId": {
700
+ "$ref": "#/$defs/__schema6"
701
+ },
702
+ "actionAssertionId": {
703
+ "$ref": "#/$defs/__schema6"
704
+ },
705
+ "dateAssertionId": {
706
+ "$ref": "#/$defs/__schema6"
707
+ },
708
+ "citationIds": {
709
+ "$ref": "#/$defs/__schema9"
710
+ }
711
+ },
712
+ "required": [
713
+ "id",
714
+ "entityId",
715
+ "actionAssertionId",
716
+ "dateAssertionId",
717
+ "citationIds"
718
+ ],
719
+ "additionalProperties": false
720
+ }
721
+ }
722
+ },
723
+ "required": [
724
+ "id",
725
+ "entityId",
726
+ "label",
727
+ "citationIds",
728
+ "fields",
729
+ "actions"
730
+ ],
731
+ "additionalProperties": false
732
+ },
733
+ "__schema11": {
734
+ "type": "object",
735
+ "properties": {
736
+ "id": {
737
+ "$ref": "#/$defs/__schema6"
738
+ },
739
+ "entityId": {
740
+ "$ref": "#/$defs/__schema6"
741
+ },
742
+ "label": {
743
+ "$ref": "#/$defs/__schema8"
744
+ },
745
+ "citationIds": {
746
+ "$ref": "#/$defs/__schema9"
747
+ },
748
+ "methodAssertionId": {
749
+ "$ref": "#/$defs/__schema6"
750
+ },
751
+ "methodLabel": {
752
+ "$ref": "#/$defs/__schema8"
753
+ },
754
+ "dateAssertionId": {
755
+ "$ref": "#/$defs/__schema6"
756
+ }
757
+ },
758
+ "required": [
759
+ "id",
760
+ "entityId",
761
+ "label",
762
+ "citationIds",
763
+ "methodAssertionId",
764
+ "methodLabel",
765
+ "dateAssertionId"
766
+ ],
767
+ "additionalProperties": false
768
+ },
769
+ "__schema12": {
770
+ "type": "object",
771
+ "properties": {
772
+ "id": {
773
+ "$ref": "#/$defs/__schema6"
774
+ },
775
+ "entityId": {
776
+ "$ref": "#/$defs/__schema6"
777
+ },
778
+ "label": {
779
+ "$ref": "#/$defs/__schema8"
780
+ },
781
+ "citationIds": {
782
+ "$ref": "#/$defs/__schema9"
783
+ },
784
+ "resultAssertionId": {
785
+ "$ref": "#/$defs/__schema6"
786
+ },
787
+ "analyteAssertionId": {
788
+ "$ref": "#/$defs/__schema6"
789
+ }
790
+ },
791
+ "required": [
792
+ "id",
793
+ "entityId",
794
+ "label",
795
+ "citationIds",
796
+ "resultAssertionId"
797
+ ],
798
+ "additionalProperties": false
799
+ }
800
+ },
801
+ "$id": "urn:disclosureos:experimental:material-case-presentation:0.1.0"
802
+ }