@dmptool/types 1.1.3 → 1.2.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 (76) hide show
  1. package/README.md +119 -47
  2. package/dist/answers/__tests__/answers.spec.js +20 -28
  3. package/dist/answers/__tests__/usage.spec.d.ts +1 -0
  4. package/dist/answers/__tests__/usage.spec.js +175 -0
  5. package/dist/answers/answer.d.ts +12 -15
  6. package/dist/answers/answer.js +3 -4
  7. package/dist/answers/dateAnswers.d.ts +30 -30
  8. package/dist/answers/dateAnswers.js +6 -5
  9. package/dist/answers/graphQLAnswers.d.ts +25 -25
  10. package/dist/answers/graphQLAnswers.js +4 -4
  11. package/dist/answers/index.d.ts +860 -1088
  12. package/dist/answers/index.js +2 -2
  13. package/dist/answers/numberAnswers.d.ts +41 -41
  14. package/dist/answers/numberAnswers.js +8 -8
  15. package/dist/answers/optionBasedAnswers.d.ts +55 -55
  16. package/dist/answers/optionBasedAnswers.js +10 -10
  17. package/dist/answers/tableAnswers.d.ts +811 -1772
  18. package/dist/answers/tableAnswers.js +12 -8
  19. package/dist/answers/textAnswers.d.ts +44 -44
  20. package/dist/answers/textAnswers.js +8 -8
  21. package/dist/questions/__tests__/graphQLQuestions.spec.js +1 -1
  22. package/dist/questions/__tests__/usage.spec.d.ts +8 -0
  23. package/dist/questions/__tests__/usage.spec.js +312 -0
  24. package/dist/questions/dateQuestions.d.ts +81 -82
  25. package/dist/questions/dateQuestions.js +12 -16
  26. package/dist/questions/graphQLQuestions.d.ts +142 -142
  27. package/dist/questions/graphQLQuestions.js +35 -30
  28. package/dist/questions/index.d.ts +1494 -1674
  29. package/dist/questions/index.js +2 -2
  30. package/dist/questions/numberQuestions.d.ts +97 -98
  31. package/dist/questions/numberQuestions.js +7 -19
  32. package/dist/questions/optionBasedQuestions.d.ts +163 -166
  33. package/dist/questions/optionBasedQuestions.js +20 -36
  34. package/dist/questions/question.d.ts +24 -48
  35. package/dist/questions/question.js +78 -17
  36. package/dist/questions/tableQuestions.d.ts +2219 -2231
  37. package/dist/questions/tableQuestions.js +6 -11
  38. package/dist/questions/textQuestions.d.ts +104 -104
  39. package/dist/questions/textQuestions.js +6 -23
  40. package/dist/schemas/affiliationSearchAnswer.schema.json +9 -12
  41. package/dist/schemas/affiliationSearchQuestion.schema.json +30 -36
  42. package/dist/schemas/anyAnswer.schema.json +228 -237
  43. package/dist/schemas/anyQuestion.schema.json +292 -493
  44. package/dist/schemas/anyTableColumnAnswer.schema.json +93 -106
  45. package/dist/schemas/anyTableColumnQuestion.schema.json +164 -325
  46. package/dist/schemas/booleanAnswer.schema.json +8 -11
  47. package/dist/schemas/booleanQuestion.schema.json +7 -10
  48. package/dist/schemas/checkboxesAnswer.schema.json +13 -14
  49. package/dist/schemas/checkboxesQuestion.schema.json +12 -13
  50. package/dist/schemas/currencyAnswer.schema.json +8 -11
  51. package/dist/schemas/currencyQuestion.schema.json +7 -10
  52. package/dist/schemas/dateAnswer.schema.json +8 -11
  53. package/dist/schemas/dateQuestion.schema.json +7 -10
  54. package/dist/schemas/dateRangeAnswer.schema.json +16 -21
  55. package/dist/schemas/dateRangeQuestion.schema.json +38 -20
  56. package/dist/schemas/emailAnswer.schema.json +8 -11
  57. package/dist/schemas/emailQuestion.schema.json +7 -10
  58. package/dist/schemas/multiselectBoxAnswer.schema.json +13 -14
  59. package/dist/schemas/multiselectBoxQuestion.schema.json +14 -14
  60. package/dist/schemas/numberAnswer.schema.json +8 -11
  61. package/dist/schemas/numberQuestion.schema.json +7 -10
  62. package/dist/schemas/numberRangeAnswer.schema.json +17 -22
  63. package/dist/schemas/numberRangeQuestion.schema.json +18 -19
  64. package/dist/schemas/radioButtonsAnswer.schema.json +8 -11
  65. package/dist/schemas/radioButtonsQuestion.schema.json +12 -13
  66. package/dist/schemas/selectBoxAnswer.schema.json +8 -11
  67. package/dist/schemas/selectBoxQuestion.schema.json +18 -15
  68. package/dist/schemas/tableAnswer.schema.json +337 -343
  69. package/dist/schemas/tableQuestion.schema.json +178 -352
  70. package/dist/schemas/textAnswer.schema.json +8 -11
  71. package/dist/schemas/textAreaAnswer.schema.json +8 -11
  72. package/dist/schemas/textAreaQuestion.schema.json +7 -10
  73. package/dist/schemas/textQuestion.schema.json +7 -10
  74. package/dist/schemas/urlAnswer.schema.json +8 -11
  75. package/dist/schemas/urlQuestion.schema.json +7 -10
  76. package/package.json +1 -1
package/dist/schemas/tableAnswer.schema.json CHANGED
@@ -8,6 +8,26 @@
8
8
  "type": "string",
9
9
  "const": "table"
10
10
  },
11
+ "meta": {
12
+ "type": "object",
13
+ "properties": {
14
+ "schemaVersion": {
15
+ "type": "string",
16
+ "default": "1.0"
17
+ }
18
+ },
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "columnHeadings": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string"
26
+ },
27
+ "default": [
28
+ "Column A"
29
+ ]
30
+ },
11
31
  "answer": {
12
32
  "type": "array",
13
33
  "items": {
@@ -16,368 +36,334 @@
16
36
  "columns": {
17
37
  "type": "array",
18
38
  "items": {
19
- "type": "object",
20
- "properties": {
21
- "heading": {
22
- "type": "string"
39
+ "anyOf": [
40
+ {
41
+ "type": "object",
42
+ "properties": {
43
+ "type": {
44
+ "type": "string",
45
+ "const": "affiliationSearch"
46
+ },
47
+ "meta": {
48
+ "$ref": "#/definitions/TableAnswer/properties/meta"
49
+ },
50
+ "answer": {
51
+ "type": "string",
52
+ "default": ""
53
+ }
54
+ },
55
+ "required": [
56
+ "type"
57
+ ],
58
+ "additionalProperties": false
23
59
  },
24
- "content": {
25
- "anyOf": [
26
- {
27
- "type": "object",
28
- "properties": {
29
- "type": {
30
- "type": "string",
31
- "const": "typeaheadSearch"
32
- },
33
- "answer": {
34
- "type": "string"
35
- },
36
- "meta": {
37
- "type": "object",
38
- "properties": {
39
- "schemaVersion": {
40
- "type": "string",
41
- "const": "1.0"
42
- }
43
- },
44
- "required": [
45
- "schemaVersion"
46
- ],
47
- "additionalProperties": false
48
- }
49
- },
50
- "required": [
51
- "type",
52
- "answer",
53
- "meta"
54
- ],
55
- "additionalProperties": false
60
+ {
61
+ "type": "object",
62
+ "properties": {
63
+ "type": {
64
+ "type": "string",
65
+ "const": "boolean"
56
66
  },
57
- {
58
- "type": "object",
59
- "properties": {
60
- "type": {
61
- "type": "string",
62
- "const": "boolean"
63
- },
64
- "answer": {
65
- "type": "boolean"
66
- },
67
- "meta": {
68
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
69
- }
70
- },
71
- "required": [
72
- "type",
73
- "answer",
74
- "meta"
75
- ],
76
- "additionalProperties": false
67
+ "meta": {
68
+ "$ref": "#/definitions/TableAnswer/properties/meta"
77
69
  },
78
- {
79
- "type": "object",
80
- "properties": {
81
- "type": {
82
- "type": "string",
83
- "const": "checkBoxes"
84
- },
85
- "answer": {
86
- "type": "array",
87
- "items": {
88
- "type": "string"
89
- }
90
- },
91
- "meta": {
92
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
93
- }
94
- },
95
- "required": [
96
- "type",
97
- "answer",
98
- "meta"
99
- ],
100
- "additionalProperties": false
70
+ "answer": {
71
+ "type": "boolean",
72
+ "default": false
73
+ }
74
+ },
75
+ "required": [
76
+ "type"
77
+ ],
78
+ "additionalProperties": false
79
+ },
80
+ {
81
+ "type": "object",
82
+ "properties": {
83
+ "type": {
84
+ "type": "string",
85
+ "const": "checkBoxes"
101
86
  },
102
- {
103
- "type": "object",
104
- "properties": {
105
- "type": {
106
- "type": "string",
107
- "const": "currency"
108
- },
109
- "answer": {
110
- "type": "number"
111
- },
112
- "meta": {
113
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
114
- }
115
- },
116
- "required": [
117
- "type",
118
- "answer",
119
- "meta"
120
- ],
121
- "additionalProperties": false
87
+ "meta": {
88
+ "$ref": "#/definitions/TableAnswer/properties/meta"
122
89
  },
123
- {
124
- "type": "object",
125
- "properties": {
126
- "type": {
127
- "type": "string",
128
- "const": "date"
129
- },
130
- "answer": {
131
- "type": "string"
132
- },
133
- "meta": {
134
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
135
- }
90
+ "answer": {
91
+ "type": "array",
92
+ "items": {
93
+ "type": "string"
136
94
  },
137
- "required": [
138
- "type",
139
- "answer",
140
- "meta"
141
- ],
142
- "additionalProperties": false
95
+ "default": [
96
+ ""
97
+ ]
98
+ }
99
+ },
100
+ "required": [
101
+ "type"
102
+ ],
103
+ "additionalProperties": false
104
+ },
105
+ {
106
+ "type": "object",
107
+ "properties": {
108
+ "type": {
109
+ "type": "string",
110
+ "const": "currency"
143
111
  },
144
- {
145
- "type": "object",
146
- "properties": {
147
- "type": {
148
- "type": "string",
149
- "const": "dateRange"
150
- },
151
- "answer": {
152
- "type": "object",
153
- "properties": {
154
- "start": {
155
- "type": "string"
156
- },
157
- "end": {
158
- "type": "string"
159
- }
160
- },
161
- "required": [
162
- "start",
163
- "end"
164
- ],
165
- "additionalProperties": false
166
- },
167
- "meta": {
168
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
169
- }
170
- },
171
- "required": [
172
- "type",
173
- "answer",
174
- "meta"
175
- ],
176
- "additionalProperties": false
112
+ "meta": {
113
+ "$ref": "#/definitions/TableAnswer/properties/meta"
177
114
  },
178
- {
179
- "type": "object",
180
- "properties": {
181
- "type": {
182
- "type": "string",
183
- "const": "email"
184
- },
185
- "answer": {
186
- "type": "string"
187
- },
188
- "meta": {
189
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
190
- }
191
- },
192
- "required": [
193
- "type",
194
- "answer",
195
- "meta"
196
- ],
197
- "additionalProperties": false
115
+ "answer": {
116
+ "type": "number",
117
+ "default": 0
118
+ }
119
+ },
120
+ "required": [
121
+ "type"
122
+ ],
123
+ "additionalProperties": false
124
+ },
125
+ {
126
+ "type": "object",
127
+ "properties": {
128
+ "type": {
129
+ "type": "string",
130
+ "const": "date"
198
131
  },
199
- {
200
- "type": "object",
201
- "properties": {
202
- "type": {
203
- "type": "string",
204
- "const": "filteredSearch"
205
- },
206
- "answer": {
207
- "type": "array",
208
- "items": {
209
- "type": "string"
210
- }
211
- },
212
- "meta": {
213
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
214
- }
215
- },
216
- "required": [
217
- "type",
218
- "answer",
219
- "meta"
220
- ],
221
- "additionalProperties": false
132
+ "meta": {
133
+ "$ref": "#/definitions/TableAnswer/properties/meta"
222
134
  },
223
- {
224
- "type": "object",
225
- "properties": {
226
- "type": {
227
- "type": "string",
228
- "const": "multiselectBox"
229
- },
230
- "answer": {
231
- "type": "array",
232
- "items": {
233
- "type": "string"
234
- }
235
- },
236
- "meta": {
237
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
238
- }
239
- },
240
- "required": [
241
- "type",
242
- "answer",
243
- "meta"
244
- ],
245
- "additionalProperties": false
135
+ "answer": {
136
+ "type": "string",
137
+ "default": ""
138
+ }
139
+ },
140
+ "required": [
141
+ "type"
142
+ ],
143
+ "additionalProperties": false
144
+ },
145
+ {
146
+ "type": "object",
147
+ "properties": {
148
+ "type": {
149
+ "type": "string",
150
+ "const": "dateRange"
246
151
  },
247
- {
248
- "type": "object",
249
- "properties": {
250
- "type": {
251
- "type": "string",
252
- "const": "number"
253
- },
254
- "answer": {
255
- "type": "number"
256
- },
257
- "meta": {
258
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
259
- }
260
- },
261
- "required": [
262
- "type",
263
- "answer",
264
- "meta"
265
- ],
266
- "additionalProperties": false
152
+ "meta": {
153
+ "$ref": "#/definitions/TableAnswer/properties/meta"
267
154
  },
268
- {
155
+ "answer": {
269
156
  "type": "object",
270
157
  "properties": {
271
- "type": {
158
+ "start": {
272
159
  "type": "string",
273
- "const": "radioButtons"
274
- },
275
- "answer": {
276
- "type": "string"
160
+ "default": ""
277
161
  },
278
- "meta": {
279
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
280
- }
281
- },
282
- "required": [
283
- "type",
284
- "answer",
285
- "meta"
286
- ],
287
- "additionalProperties": false
288
- },
289
- {
290
- "type": "object",
291
- "properties": {
292
- "type": {
162
+ "end": {
293
163
  "type": "string",
294
- "const": "selectBox"
295
- },
296
- "answer": {
297
- "type": "string"
298
- },
299
- "meta": {
300
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
164
+ "default": ""
301
165
  }
302
166
  },
303
- "required": [
304
- "type",
305
- "answer",
306
- "meta"
307
- ],
308
- "additionalProperties": false
167
+ "additionalProperties": false,
168
+ "default": {}
169
+ }
170
+ },
171
+ "required": [
172
+ "type"
173
+ ],
174
+ "additionalProperties": false
175
+ },
176
+ {
177
+ "type": "object",
178
+ "properties": {
179
+ "type": {
180
+ "type": "string",
181
+ "const": "email"
309
182
  },
310
- {
311
- "type": "object",
312
- "properties": {
313
- "type": {
314
- "type": "string",
315
- "const": "text"
316
- },
317
- "answer": {
318
- "type": "string"
319
- },
320
- "meta": {
321
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
322
- }
323
- },
324
- "required": [
325
- "type",
326
- "answer",
327
- "meta"
328
- ],
329
- "additionalProperties": false
183
+ "meta": {
184
+ "$ref": "#/definitions/TableAnswer/properties/meta"
330
185
  },
331
- {
332
- "type": "object",
333
- "properties": {
334
- "type": {
335
- "type": "string",
336
- "const": "textArea"
337
- },
338
- "answer": {
339
- "type": "string"
340
- },
341
- "meta": {
342
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
343
- }
186
+ "answer": {
187
+ "type": "string",
188
+ "default": ""
189
+ }
190
+ },
191
+ "required": [
192
+ "type"
193
+ ],
194
+ "additionalProperties": false
195
+ },
196
+ {
197
+ "type": "object",
198
+ "properties": {
199
+ "type": {
200
+ "type": "string",
201
+ "const": "filteredSearch"
202
+ },
203
+ "meta": {
204
+ "$ref": "#/definitions/TableAnswer/properties/meta"
205
+ },
206
+ "answer": {
207
+ "type": "array",
208
+ "items": {
209
+ "type": "string"
344
210
  },
345
- "required": [
346
- "type",
347
- "answer",
348
- "meta"
349
- ],
350
- "additionalProperties": false
211
+ "default": [
212
+ ""
213
+ ]
214
+ }
215
+ },
216
+ "required": [
217
+ "type"
218
+ ],
219
+ "additionalProperties": false
220
+ },
221
+ {
222
+ "type": "object",
223
+ "properties": {
224
+ "type": {
225
+ "type": "string",
226
+ "const": "multiselectBox"
351
227
  },
352
- {
353
- "type": "object",
354
- "properties": {
355
- "type": {
356
- "type": "string",
357
- "const": "url"
358
- },
359
- "answer": {
360
- "type": "string"
361
- },
362
- "meta": {
363
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
364
- }
228
+ "meta": {
229
+ "$ref": "#/definitions/TableAnswer/properties/meta"
230
+ },
231
+ "answer": {
232
+ "type": "array",
233
+ "items": {
234
+ "type": "string"
365
235
  },
366
- "required": [
367
- "type",
368
- "answer",
369
- "meta"
370
- ],
371
- "additionalProperties": false
236
+ "default": [
237
+ ""
238
+ ]
372
239
  }
373
- ]
240
+ },
241
+ "required": [
242
+ "type"
243
+ ],
244
+ "additionalProperties": false
245
+ },
246
+ {
247
+ "type": "object",
248
+ "properties": {
249
+ "type": {
250
+ "type": "string",
251
+ "const": "number"
252
+ },
253
+ "meta": {
254
+ "$ref": "#/definitions/TableAnswer/properties/meta"
255
+ },
256
+ "answer": {
257
+ "type": "number",
258
+ "default": 0
259
+ }
260
+ },
261
+ "required": [
262
+ "type"
263
+ ],
264
+ "additionalProperties": false
265
+ },
266
+ {
267
+ "type": "object",
268
+ "properties": {
269
+ "type": {
270
+ "type": "string",
271
+ "const": "radioButtons"
272
+ },
273
+ "meta": {
274
+ "$ref": "#/definitions/TableAnswer/properties/meta"
275
+ },
276
+ "answer": {
277
+ "type": "string",
278
+ "default": ""
279
+ }
280
+ },
281
+ "required": [
282
+ "type"
283
+ ],
284
+ "additionalProperties": false
285
+ },
286
+ {
287
+ "type": "object",
288
+ "properties": {
289
+ "type": {
290
+ "type": "string",
291
+ "const": "selectBox"
292
+ },
293
+ "meta": {
294
+ "$ref": "#/definitions/TableAnswer/properties/meta"
295
+ },
296
+ "answer": {
297
+ "type": "string",
298
+ "default": ""
299
+ }
300
+ },
301
+ "required": [
302
+ "type"
303
+ ],
304
+ "additionalProperties": false
305
+ },
306
+ {
307
+ "type": "object",
308
+ "properties": {
309
+ "type": {
310
+ "type": "string",
311
+ "const": "text"
312
+ },
313
+ "meta": {
314
+ "$ref": "#/definitions/TableAnswer/properties/meta"
315
+ },
316
+ "answer": {
317
+ "type": "string",
318
+ "default": ""
319
+ }
320
+ },
321
+ "required": [
322
+ "type"
323
+ ],
324
+ "additionalProperties": false
325
+ },
326
+ {
327
+ "type": "object",
328
+ "properties": {
329
+ "type": {
330
+ "type": "string",
331
+ "const": "textArea"
332
+ },
333
+ "meta": {
334
+ "$ref": "#/definitions/TableAnswer/properties/meta"
335
+ },
336
+ "answer": {
337
+ "type": "string",
338
+ "default": ""
339
+ }
340
+ },
341
+ "required": [
342
+ "type"
343
+ ],
344
+ "additionalProperties": false
345
+ },
346
+ {
347
+ "type": "object",
348
+ "properties": {
349
+ "type": {
350
+ "type": "string",
351
+ "const": "url"
352
+ },
353
+ "meta": {
354
+ "$ref": "#/definitions/TableAnswer/properties/meta"
355
+ },
356
+ "answer": {
357
+ "type": "string",
358
+ "default": ""
359
+ }
360
+ },
361
+ "required": [
362
+ "type"
363
+ ],
364
+ "additionalProperties": false
374
365
  }
375
- },
376
- "required": [
377
- "heading",
378
- "content"
379
- ],
380
- "additionalProperties": false
366
+ ]
381
367
  }
382
368
  }
383
369
  },
@@ -385,16 +371,24 @@
385
371
  "columns"
386
372
  ],
387
373
  "additionalProperties": false
388
- }
389
- },
390
- "meta": {
391
- "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
374
+ },
375
+ "default": [
376
+ {
377
+ "columns": [
378
+ {
379
+ "type": "textArea",
380
+ "answer": "",
381
+ "meta": {
382
+ "schemaVersion": "1.0"
383
+ }
384
+ }
385
+ ]
386
+ }
387
+ ]
392
388
  }
393
389
  },
394
390
  "required": [
395
- "type",
396
- "answer",
397
- "meta"
391
+ "type"
398
392
  ],
399
393
  "additionalProperties": false
400
394
  }