@disclosureos/schema 2.0.0-beta.3 → 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 +87 -0
  2. package/README.md +78 -7
  3. package/dist/experimental/v2/index.d.ts +4425 -81
  4. package/dist/experimental/v2/index.js +7952 -334
  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,742 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "kind": {
6
+ "type": "string",
7
+ "const": "archival_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
+ "archival": {
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.2.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.4.0"
444
+ },
445
+ "sha256": {
446
+ "$ref": "#/$defs/__schema7"
447
+ }
448
+ },
449
+ "required": [
450
+ "documentId",
451
+ "schemaId",
452
+ "sha256"
453
+ ],
454
+ "additionalProperties": false
455
+ },
456
+ "editions": {
457
+ "minItems": 1,
458
+ "type": "array",
459
+ "items": {
460
+ "$ref": "#/$defs/__schema8"
461
+ }
462
+ },
463
+ "passages": {
464
+ "type": "array",
465
+ "items": {
466
+ "type": "object",
467
+ "properties": {
468
+ "id": {
469
+ "$ref": "#/$defs/__schema6"
470
+ },
471
+ "claimId": {
472
+ "$ref": "#/$defs/__schema6"
473
+ },
474
+ "attributionLabel": {
475
+ "$ref": "#/$defs/__schema9"
476
+ },
477
+ "citationIds": {
478
+ "$ref": "#/$defs/__schema10"
479
+ }
480
+ },
481
+ "required": [
482
+ "id",
483
+ "claimId",
484
+ "attributionLabel",
485
+ "citationIds"
486
+ ],
487
+ "additionalProperties": false
488
+ }
489
+ },
490
+ "review": {
491
+ "type": "object",
492
+ "properties": {
493
+ "id": {
494
+ "$ref": "#/$defs/__schema6"
495
+ },
496
+ "claimId": {
497
+ "$ref": "#/$defs/__schema6"
498
+ },
499
+ "title": {
500
+ "$ref": "#/$defs/__schema9"
501
+ },
502
+ "summary": {
503
+ "$ref": "#/$defs/__schema9"
504
+ },
505
+ "reviewerLabel": {
506
+ "$ref": "#/$defs/__schema9"
507
+ },
508
+ "methodLabel": {
509
+ "$ref": "#/$defs/__schema9"
510
+ },
511
+ "citationIds": {
512
+ "$ref": "#/$defs/__schema10"
513
+ }
514
+ },
515
+ "required": [
516
+ "id",
517
+ "claimId",
518
+ "title",
519
+ "summary",
520
+ "reviewerLabel",
521
+ "methodLabel",
522
+ "citationIds"
523
+ ],
524
+ "additionalProperties": false
525
+ }
526
+ },
527
+ "required": [
528
+ "document",
529
+ "history",
530
+ "editions",
531
+ "passages",
532
+ "review"
533
+ ],
534
+ "additionalProperties": false
535
+ }
536
+ },
537
+ "required": [
538
+ "kind",
539
+ "schemaVersion",
540
+ "presentation",
541
+ "archival"
542
+ ],
543
+ "additionalProperties": false,
544
+ "$defs": {
545
+ "__schema0": {
546
+ "type": "string",
547
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
548
+ },
549
+ "__schema1": {
550
+ "type": "string",
551
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
552
+ },
553
+ "__schema2": {
554
+ "maxLength": 500,
555
+ "$ref": "#/$defs/__schema3"
556
+ },
557
+ "__schema3": {
558
+ "type": "string",
559
+ "minLength": 1,
560
+ "maxLength": 20000,
561
+ "pattern": "\\S"
562
+ },
563
+ "__schema4": {
564
+ "type": "string",
565
+ "pattern": "^(source|product):[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
566
+ },
567
+ "__schema5": {
568
+ "minItems": 1,
569
+ "type": "array",
570
+ "items": {
571
+ "$ref": "#/$defs/__schema0"
572
+ }
573
+ },
574
+ "__schema6": {
575
+ "type": "string",
576
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
577
+ },
578
+ "__schema7": {
579
+ "type": "string",
580
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
581
+ },
582
+ "__schema8": {
583
+ "type": "object",
584
+ "properties": {
585
+ "id": {
586
+ "$ref": "#/$defs/__schema6"
587
+ },
588
+ "label": {
589
+ "$ref": "#/$defs/__schema9"
590
+ },
591
+ "entityId": {
592
+ "$ref": "#/$defs/__schema6"
593
+ },
594
+ "titleAssertionId": {
595
+ "$ref": "#/$defs/__schema6"
596
+ },
597
+ "pageCountAssertionId": {
598
+ "$ref": "#/$defs/__schema6"
599
+ },
600
+ "attachmentId": {
601
+ "$ref": "#/$defs/__schema6"
602
+ },
603
+ "citationIds": {
604
+ "$ref": "#/$defs/__schema10"
605
+ },
606
+ "fields": {
607
+ "type": "array",
608
+ "items": {
609
+ "type": "object",
610
+ "properties": {
611
+ "field": {
612
+ "type": "string",
613
+ "enum": [
614
+ "originalClassification",
615
+ "classificationLevel",
616
+ "redactionLevel",
617
+ "redactionDescription",
618
+ "redactionPercent"
619
+ ]
620
+ },
621
+ "assertionId": {
622
+ "$ref": "#/$defs/__schema6"
623
+ }
624
+ },
625
+ "required": [
626
+ "field",
627
+ "assertionId"
628
+ ],
629
+ "additionalProperties": false
630
+ }
631
+ },
632
+ "events": {
633
+ "type": "array",
634
+ "items": {
635
+ "type": "object",
636
+ "properties": {
637
+ "id": {
638
+ "$ref": "#/$defs/__schema6"
639
+ },
640
+ "entityId": {
641
+ "$ref": "#/$defs/__schema6"
642
+ },
643
+ "typeAssertionId": {
644
+ "$ref": "#/$defs/__schema6"
645
+ },
646
+ "dateAssertionId": {
647
+ "$ref": "#/$defs/__schema6"
648
+ },
649
+ "citationIds": {
650
+ "$ref": "#/$defs/__schema10"
651
+ }
652
+ },
653
+ "required": [
654
+ "id",
655
+ "entityId",
656
+ "typeAssertionId",
657
+ "dateAssertionId",
658
+ "citationIds"
659
+ ],
660
+ "additionalProperties": false
661
+ }
662
+ },
663
+ "digital": {
664
+ "type": "object",
665
+ "properties": {
666
+ "entityId": {
667
+ "$ref": "#/$defs/__schema6"
668
+ },
669
+ "custodyStatusAssertionId": {
670
+ "$ref": "#/$defs/__schema6"
671
+ },
672
+ "declaredHashesAssertionId": {
673
+ "$ref": "#/$defs/__schema6"
674
+ },
675
+ "actions": {
676
+ "type": "array",
677
+ "items": {
678
+ "type": "object",
679
+ "properties": {
680
+ "id": {
681
+ "$ref": "#/$defs/__schema6"
682
+ },
683
+ "entityId": {
684
+ "$ref": "#/$defs/__schema6"
685
+ },
686
+ "actionAssertionId": {
687
+ "$ref": "#/$defs/__schema6"
688
+ },
689
+ "dateAssertionId": {
690
+ "$ref": "#/$defs/__schema6"
691
+ },
692
+ "citationIds": {
693
+ "$ref": "#/$defs/__schema10"
694
+ }
695
+ },
696
+ "required": [
697
+ "id",
698
+ "entityId",
699
+ "actionAssertionId",
700
+ "dateAssertionId",
701
+ "citationIds"
702
+ ],
703
+ "additionalProperties": false
704
+ }
705
+ }
706
+ },
707
+ "required": [
708
+ "entityId",
709
+ "actions"
710
+ ],
711
+ "additionalProperties": false
712
+ }
713
+ },
714
+ "required": [
715
+ "id",
716
+ "label",
717
+ "entityId",
718
+ "titleAssertionId",
719
+ "pageCountAssertionId",
720
+ "citationIds",
721
+ "fields",
722
+ "events",
723
+ "digital"
724
+ ],
725
+ "additionalProperties": false
726
+ },
727
+ "__schema9": {
728
+ "type": "string",
729
+ "minLength": 1,
730
+ "maxLength": 20000,
731
+ "pattern": "\\S"
732
+ },
733
+ "__schema10": {
734
+ "minItems": 1,
735
+ "type": "array",
736
+ "items": {
737
+ "$ref": "#/$defs/__schema6"
738
+ }
739
+ }
740
+ },
741
+ "$id": "urn:disclosureos:experimental:archival-case-presentation:0.1.0"
742
+ }