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