@disclosureos/schema 1.1.0 → 2.0.0-beta.0

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 (22) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/README.md +92 -0
  3. package/dist/experimental/v2/index.d.ts +1602 -0
  4. package/dist/experimental/v2/index.js +4532 -0
  5. package/dist/experimental/v2/index.js.map +1 -0
  6. package/package.json +45 -7
  7. package/schema/experimental/acquisition-bindings-0.1.0.schema.json +127 -0
  8. package/schema/experimental/dataset-release-0.1.0.schema.json +279 -0
  9. package/schema/experimental/historical-testimony-selection-0.1.0.schema.json +102 -0
  10. package/schema/experimental/instrument-research-review-0.1.0.schema.json +627 -0
  11. package/schema/experimental/measurement-bindings-0.1.0.schema.json +199 -0
  12. package/schema/experimental/migration-compatibility-0.1.0.schema.json +189 -0
  13. package/schema/experimental/migration-legacy-scores-0.1.0.schema.json +116 -0
  14. package/schema/experimental/migration-resolution-0.1.0.schema.json +120 -0
  15. package/schema/experimental/migration-review-0.1.0.schema.json +223 -0
  16. package/schema/experimental/physical-sample-selection-0.1.0.schema.json +278 -0
  17. package/schema/experimental/profile-evaluation-0.1.0.schema.json +231 -0
  18. package/schema/experimental/profile-preparation-0.1.0.schema.json +177 -0
  19. package/schema/experimental/released-document-selection-0.1.0.schema.json +102 -0
  20. package/schema/experimental/reproduction-packet-0.1.0.schema.json +252 -0
  21. package/schema/experimental/research-evaluation-0.1.0.schema.json +174 -0
  22. package/schema/experimental/source-intake-0.1.0.schema.json +497 -0
package/schema/experimental/profile-evaluation-0.1.0.schema.json ADDED
@@ -0,0 +1,231 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "kind": {
6
+ "type": "string",
7
+ "const": "profile_evaluation"
8
+ },
9
+ "schemaVersion": {
10
+ "type": "string",
11
+ "const": "0.1.0"
12
+ },
13
+ "id": {
14
+ "type": "string",
15
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
16
+ },
17
+ "workflow": {
18
+ "type": "string",
19
+ "enum": [
20
+ "released-documents:0.1.0",
21
+ "historical-testimony:0.1.0",
22
+ "physical-samples:0.1.0"
23
+ ]
24
+ },
25
+ "history": {
26
+ "type": "object",
27
+ "properties": {
28
+ "sha256": {
29
+ "type": "string",
30
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
31
+ },
32
+ "byteLength": {
33
+ "type": "integer",
34
+ "minimum": 1,
35
+ "maximum": 9007199254740991
36
+ }
37
+ },
38
+ "required": [
39
+ "sha256",
40
+ "byteLength"
41
+ ],
42
+ "additionalProperties": false
43
+ },
44
+ "selection": {
45
+ "type": "object",
46
+ "properties": {
47
+ "sha256": {
48
+ "type": "string",
49
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
50
+ },
51
+ "byteLength": {
52
+ "type": "integer",
53
+ "minimum": 1,
54
+ "maximum": 9007199254740991
55
+ }
56
+ },
57
+ "required": [
58
+ "sha256",
59
+ "byteLength"
60
+ ],
61
+ "additionalProperties": false
62
+ },
63
+ "assets": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "ref": {
69
+ "type": "string",
70
+ "pattern": "^source:[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
71
+ },
72
+ "fileRef": {
73
+ "type": "string",
74
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
75
+ },
76
+ "sha256": {
77
+ "type": "string",
78
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
79
+ },
80
+ "byteLength": {
81
+ "type": "integer",
82
+ "minimum": 1,
83
+ "maximum": 9007199254740991
84
+ }
85
+ },
86
+ "required": [
87
+ "ref",
88
+ "fileRef",
89
+ "sha256",
90
+ "byteLength"
91
+ ],
92
+ "additionalProperties": false
93
+ }
94
+ },
95
+ "dependencies": {
96
+ "type": "object",
97
+ "properties": {
98
+ "vocabularies": {
99
+ "minItems": 1,
100
+ "type": "array",
101
+ "items": {
102
+ "type": "object",
103
+ "properties": {
104
+ "ref": {
105
+ "type": "string",
106
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
107
+ },
108
+ "id": {
109
+ "type": "string",
110
+ "minLength": 1,
111
+ "pattern": "\\S"
112
+ },
113
+ "version": {
114
+ "type": "string",
115
+ "minLength": 1,
116
+ "pattern": "\\S"
117
+ },
118
+ "sha256": {
119
+ "type": "string",
120
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
121
+ },
122
+ "byteLength": {
123
+ "type": "integer",
124
+ "minimum": 1,
125
+ "maximum": 9007199254740991
126
+ }
127
+ },
128
+ "required": [
129
+ "ref",
130
+ "id",
131
+ "version",
132
+ "sha256",
133
+ "byteLength"
134
+ ],
135
+ "additionalProperties": false
136
+ }
137
+ },
138
+ "implementation": {
139
+ "type": "object",
140
+ "properties": {
141
+ "ref": {
142
+ "type": "string",
143
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
144
+ },
145
+ "id": {
146
+ "type": "string",
147
+ "minLength": 1,
148
+ "pattern": "\\S"
149
+ },
150
+ "version": {
151
+ "type": "string",
152
+ "minLength": 1,
153
+ "pattern": "\\S"
154
+ },
155
+ "sha256": {
156
+ "type": "string",
157
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
158
+ },
159
+ "byteLength": {
160
+ "type": "integer",
161
+ "minimum": 1,
162
+ "maximum": 9007199254740991
163
+ }
164
+ },
165
+ "required": [
166
+ "ref",
167
+ "id",
168
+ "version",
169
+ "sha256",
170
+ "byteLength"
171
+ ],
172
+ "additionalProperties": false
173
+ },
174
+ "environment": {
175
+ "type": "object",
176
+ "properties": {
177
+ "ref": {
178
+ "type": "string",
179
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
180
+ },
181
+ "id": {
182
+ "type": "string",
183
+ "minLength": 1,
184
+ "pattern": "\\S"
185
+ },
186
+ "version": {
187
+ "type": "string",
188
+ "minLength": 1,
189
+ "pattern": "\\S"
190
+ },
191
+ "sha256": {
192
+ "type": "string",
193
+ "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
194
+ },
195
+ "byteLength": {
196
+ "type": "integer",
197
+ "minimum": 1,
198
+ "maximum": 9007199254740991
199
+ }
200
+ },
201
+ "required": [
202
+ "ref",
203
+ "id",
204
+ "version",
205
+ "sha256",
206
+ "byteLength"
207
+ ],
208
+ "additionalProperties": false
209
+ }
210
+ },
211
+ "required": [
212
+ "vocabularies",
213
+ "implementation",
214
+ "environment"
215
+ ],
216
+ "additionalProperties": false
217
+ }
218
+ },
219
+ "required": [
220
+ "kind",
221
+ "schemaVersion",
222
+ "id",
223
+ "workflow",
224
+ "history",
225
+ "selection",
226
+ "assets",
227
+ "dependencies"
228
+ ],
229
+ "additionalProperties": false,
230
+ "$id": "urn:disclosureos:experimental:profile-evaluation:0.1.0"
231
+ }
package/schema/experimental/profile-preparation-0.1.0.schema.json ADDED
@@ -0,0 +1,177 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "kind": {
6
+ "type": "string",
7
+ "const": "profile_preparation"
8
+ },
9
+ "schemaVersion": {
10
+ "type": "string",
11
+ "const": "0.1.0"
12
+ },
13
+ "id": {
14
+ "type": "string",
15
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
16
+ },
17
+ "workflow": {
18
+ "type": "string",
19
+ "enum": [
20
+ "released-documents:0.1.0",
21
+ "historical-testimony:0.1.0",
22
+ "physical-samples:0.1.0"
23
+ ]
24
+ },
25
+ "history": {
26
+ "type": "string",
27
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
28
+ },
29
+ "selection": {
30
+ "type": "string",
31
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
32
+ },
33
+ "assets": {
34
+ "type": "array",
35
+ "items": {
36
+ "type": "object",
37
+ "properties": {
38
+ "ref": {
39
+ "type": "string",
40
+ "pattern": "^source:[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
41
+ },
42
+ "fileRef": {
43
+ "type": "string",
44
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
45
+ },
46
+ "path": {
47
+ "type": "string",
48
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
49
+ }
50
+ },
51
+ "required": [
52
+ "ref",
53
+ "fileRef",
54
+ "path"
55
+ ],
56
+ "additionalProperties": false
57
+ }
58
+ },
59
+ "dependencies": {
60
+ "type": "object",
61
+ "properties": {
62
+ "vocabularies": {
63
+ "minItems": 1,
64
+ "type": "array",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "ref": {
69
+ "type": "string",
70
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
71
+ },
72
+ "id": {
73
+ "type": "string",
74
+ "minLength": 1,
75
+ "pattern": "\\S"
76
+ },
77
+ "version": {
78
+ "type": "string",
79
+ "minLength": 1,
80
+ "pattern": "\\S"
81
+ },
82
+ "path": {
83
+ "type": "string",
84
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
85
+ }
86
+ },
87
+ "required": [
88
+ "ref",
89
+ "id",
90
+ "version",
91
+ "path"
92
+ ],
93
+ "additionalProperties": false
94
+ }
95
+ },
96
+ "implementation": {
97
+ "type": "object",
98
+ "properties": {
99
+ "ref": {
100
+ "type": "string",
101
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
102
+ },
103
+ "id": {
104
+ "type": "string",
105
+ "minLength": 1,
106
+ "pattern": "\\S"
107
+ },
108
+ "version": {
109
+ "type": "string",
110
+ "minLength": 1,
111
+ "pattern": "\\S"
112
+ },
113
+ "path": {
114
+ "type": "string",
115
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
116
+ }
117
+ },
118
+ "required": [
119
+ "ref",
120
+ "id",
121
+ "version",
122
+ "path"
123
+ ],
124
+ "additionalProperties": false
125
+ },
126
+ "environment": {
127
+ "type": "object",
128
+ "properties": {
129
+ "ref": {
130
+ "type": "string",
131
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
132
+ },
133
+ "id": {
134
+ "type": "string",
135
+ "minLength": 1,
136
+ "pattern": "\\S"
137
+ },
138
+ "version": {
139
+ "type": "string",
140
+ "minLength": 1,
141
+ "pattern": "\\S"
142
+ },
143
+ "path": {
144
+ "type": "string",
145
+ "pattern": "^(?:[A-Za-z0-9][A-Za-z0-9._ -]*\\/)*[A-Za-z0-9][A-Za-z0-9._ -]*(?![\\s\\S])"
146
+ }
147
+ },
148
+ "required": [
149
+ "ref",
150
+ "id",
151
+ "version",
152
+ "path"
153
+ ],
154
+ "additionalProperties": false
155
+ }
156
+ },
157
+ "required": [
158
+ "vocabularies",
159
+ "implementation",
160
+ "environment"
161
+ ],
162
+ "additionalProperties": false
163
+ }
164
+ },
165
+ "required": [
166
+ "kind",
167
+ "schemaVersion",
168
+ "id",
169
+ "workflow",
170
+ "history",
171
+ "selection",
172
+ "assets",
173
+ "dependencies"
174
+ ],
175
+ "additionalProperties": false,
176
+ "$id": "urn:disclosureos:experimental:profile-preparation:0.1.0"
177
+ }
package/schema/experimental/released-document-selection-0.1.0.schema.json ADDED
@@ -0,0 +1,102 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "properties": {
5
+ "kind": {
6
+ "type": "string",
7
+ "const": "released_document_selection"
8
+ },
9
+ "schemaVersion": {
10
+ "type": "string",
11
+ "const": "0.1.0"
12
+ },
13
+ "id": {
14
+ "type": "string",
15
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
16
+ },
17
+ "historyId": {
18
+ "type": "string",
19
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
20
+ },
21
+ "observationId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
24
+ },
25
+ "documents": {
26
+ "minItems": 1,
27
+ "type": "array",
28
+ "items": {
29
+ "type": "object",
30
+ "properties": {
31
+ "sourceRef": {
32
+ "type": "string",
33
+ "pattern": "^source:[A-Za-z0-9][A-Za-z0-9._-]*(?![\\s\\S])"
34
+ },
35
+ "release": {
36
+ "oneOf": [
37
+ {
38
+ "type": "object",
39
+ "properties": {
40
+ "state": {
41
+ "type": "string",
42
+ "const": "known"
43
+ },
44
+ "releasedBy": {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "pattern": "\\S"
48
+ },
49
+ "reference": {
50
+ "type": "string",
51
+ "minLength": 1,
52
+ "pattern": "\\S"
53
+ }
54
+ },
55
+ "required": [
56
+ "state",
57
+ "releasedBy",
58
+ "reference"
59
+ ],
60
+ "additionalProperties": false
61
+ },
62
+ {
63
+ "type": "object",
64
+ "properties": {
65
+ "state": {
66
+ "type": "string",
67
+ "const": "unknown"
68
+ },
69
+ "reason": {
70
+ "type": "string",
71
+ "minLength": 1,
72
+ "pattern": "\\S"
73
+ }
74
+ },
75
+ "required": [
76
+ "state",
77
+ "reason"
78
+ ],
79
+ "additionalProperties": false
80
+ }
81
+ ]
82
+ }
83
+ },
84
+ "required": [
85
+ "sourceRef",
86
+ "release"
87
+ ],
88
+ "additionalProperties": false
89
+ }
90
+ }
91
+ },
92
+ "required": [
93
+ "kind",
94
+ "schemaVersion",
95
+ "id",
96
+ "historyId",
97
+ "observationId",
98
+ "documents"
99
+ ],
100
+ "additionalProperties": false,
101
+ "$id": "urn:disclosureos:experimental:released-document-selection:0.1.0"
102
+ }