@dmptool/types 1.1.1 → 1.1.3

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 (54) hide show
  1. package/dist/answers/__tests__/answers.spec.js +11 -5
  2. package/dist/answers/answer.d.ts +3 -3
  3. package/dist/answers/graphQLAnswers.d.ts +2 -2
  4. package/dist/answers/graphQLAnswers.js +2 -2
  5. package/dist/answers/index.d.ts +92 -55
  6. package/dist/answers/index.js +2 -2
  7. package/dist/answers/optionBasedAnswers.d.ts +27 -2
  8. package/dist/answers/optionBasedAnswers.js +5 -1
  9. package/dist/answers/tableAnswers.d.ts +268 -104
  10. package/dist/answers/tableAnswers.js +2 -1
  11. package/dist/questions/__tests__/graphQLQuestions.spec.js +13 -11
  12. package/dist/questions/__tests__/optionBasedQuestions.spec.js +52 -13
  13. package/dist/questions/dateQuestions.d.ts +68 -47
  14. package/dist/questions/dateQuestions.js +15 -6
  15. package/dist/questions/graphQLQuestions.d.ts +121 -96
  16. package/dist/questions/graphQLQuestions.js +34 -3
  17. package/dist/questions/index.d.ts +1524 -1006
  18. package/dist/questions/index.js +4 -2
  19. package/dist/questions/numberQuestions.d.ts +107 -76
  20. package/dist/questions/numberQuestions.js +20 -7
  21. package/dist/questions/optionBasedQuestions.d.ts +202 -74
  22. package/dist/questions/optionBasedQuestions.js +41 -11
  23. package/dist/questions/question.d.ts +43 -4
  24. package/dist/questions/question.js +13 -2
  25. package/dist/questions/tableQuestions.d.ts +2056 -1428
  26. package/dist/questions/tableQuestions.js +9 -4
  27. package/dist/questions/textQuestions.d.ts +98 -58
  28. package/dist/questions/textQuestions.js +29 -15
  29. package/dist/schemas/affiliationSearchAnswer.schema.json +37 -0
  30. package/dist/schemas/affiliationSearchQuestion.schema.json +146 -0
  31. package/dist/schemas/anyAnswer.schema.json +41 -23
  32. package/dist/schemas/anyQuestion.schema.json +525 -108
  33. package/dist/schemas/anyTableColumnAnswer.schema.json +35 -14
  34. package/dist/schemas/anyTableColumnQuestion.schema.json +396 -80
  35. package/dist/schemas/booleanQuestion.schema.json +11 -3
  36. package/dist/schemas/checkboxesQuestion.schema.json +14 -7
  37. package/dist/schemas/currencyQuestion.schema.json +14 -3
  38. package/dist/schemas/dateQuestion.schema.json +10 -1
  39. package/dist/schemas/dateRangeQuestion.schema.json +14 -1
  40. package/dist/schemas/emailQuestion.schema.json +12 -2
  41. package/dist/schemas/filteredSearchQuestion.schema.json +7 -0
  42. package/dist/schemas/multiselectBoxAnswer.schema.json +40 -0
  43. package/dist/schemas/multiselectBoxQuestion.schema.json +85 -0
  44. package/dist/schemas/numberQuestion.schema.json +12 -2
  45. package/dist/schemas/numberRangeQuestion.schema.json +16 -2
  46. package/dist/schemas/radioButtonsQuestion.schema.json +14 -7
  47. package/dist/schemas/selectBoxAnswer.schema.json +1 -4
  48. package/dist/schemas/selectBoxQuestion.schema.json +17 -8
  49. package/dist/schemas/tableAnswer.schema.json +35 -14
  50. package/dist/schemas/tableQuestion.schema.json +420 -84
  51. package/dist/schemas/textAreaQuestion.schema.json +16 -6
  52. package/dist/schemas/textQuestion.schema.json +10 -1
  53. package/dist/schemas/urlQuestion.schema.json +10 -1
  54. package/package.json +1 -1
package/dist/schemas/booleanQuestion.schema.json CHANGED
@@ -21,7 +21,8 @@
21
21
  "type": "string"
22
22
  },
23
23
  "checked": {
24
- "type": "boolean"
24
+ "type": "boolean",
25
+ "default": false
25
26
  }
26
27
  },
27
28
  "additionalProperties": false
@@ -32,6 +33,14 @@
32
33
  "schemaVersion": {
33
34
  "type": "string",
34
35
  "const": "1.0"
36
+ },
37
+ "title": {
38
+ "type": "string",
39
+ "const": "Yes/No Field"
40
+ },
41
+ "usageDescription": {
42
+ "type": "string",
43
+ "const": "For questions that require a simple Yes/No response."
35
44
  }
36
45
  },
37
46
  "required": [
@@ -41,8 +50,7 @@
41
50
  }
42
51
  },
43
52
  "required": [
44
- "type",
45
- "attributes"
53
+ "type"
46
54
  ],
47
55
  "additionalProperties": false
48
56
  }
package/dist/schemas/checkboxesQuestion.schema.json CHANGED
@@ -29,6 +29,14 @@
29
29
  "schemaVersion": {
30
30
  "type": "string",
31
31
  "const": "1.0"
32
+ },
33
+ "title": {
34
+ "type": "string",
35
+ "const": "Check Boxes"
36
+ },
37
+ "usageDescription": {
38
+ "type": "string",
39
+ "const": "For multiple choice questions where users can select multiple options."
32
40
  }
33
41
  },
34
42
  "required": [
@@ -42,19 +50,18 @@
42
50
  "type": "object",
43
51
  "properties": {
44
52
  "label": {
45
- "type": "string"
53
+ "type": "string",
54
+ "default": "Option A"
46
55
  },
47
56
  "value": {
48
- "type": "string"
57
+ "type": "string",
58
+ "default": "a"
49
59
  },
50
60
  "checked": {
51
- "type": "boolean"
61
+ "type": "boolean",
62
+ "default": false
52
63
  }
53
64
  },
54
- "required": [
55
- "label",
56
- "value"
57
- ],
58
65
  "additionalProperties": false
59
66
  }
60
67
  }
package/dist/schemas/currencyQuestion.schema.json CHANGED
@@ -24,13 +24,16 @@
24
24
  "type": "number"
25
25
  },
26
26
  "min": {
27
- "type": "number"
27
+ "type": "number",
28
+ "default": 0
28
29
  },
29
30
  "step": {
30
- "type": "number"
31
+ "type": "number",
32
+ "default": 1
31
33
  },
32
34
  "denomination": {
33
- "type": "string"
35
+ "type": "string",
36
+ "default": "USD"
34
37
  }
35
38
  },
36
39
  "additionalProperties": false
@@ -41,6 +44,14 @@
41
44
  "schemaVersion": {
42
45
  "type": "string",
43
46
  "const": "1.0"
47
+ },
48
+ "title": {
49
+ "type": "string",
50
+ "const": "Currency Field"
51
+ },
52
+ "usageDescription": {
53
+ "type": "string",
54
+ "const": "For questions that require a monetary amount (e.g. Cost or Budget)."
44
55
  }
45
56
  },
46
57
  "required": [
package/dist/schemas/dateQuestion.schema.json CHANGED
@@ -27,7 +27,8 @@
27
27
  "type": "string"
28
28
  },
29
29
  "step": {
30
- "type": "number"
30
+ "type": "number",
31
+ "default": 1
31
32
  }
32
33
  },
33
34
  "additionalProperties": false
@@ -38,6 +39,14 @@
38
39
  "schemaVersion": {
39
40
  "type": "string",
40
41
  "const": "1.0"
42
+ },
43
+ "title": {
44
+ "type": "string",
45
+ "const": "Date Field"
46
+ },
47
+ "usageDescription": {
48
+ "type": "string",
49
+ "const": "For questions that require a date."
41
50
  }
42
51
  },
43
52
  "required": [
package/dist/schemas/dateRangeQuestion.schema.json CHANGED
@@ -29,6 +29,14 @@
29
29
  "schemaVersion": {
30
30
  "type": "string",
31
31
  "const": "1.0"
32
+ },
33
+ "title": {
34
+ "type": "string",
35
+ "const": "Date Range"
36
+ },
37
+ "usageDescription": {
38
+ "type": "string",
39
+ "const": "For questions that require a date range (e.g. From/To, Start/End)"
32
40
  }
33
41
  },
34
42
  "required": [
@@ -58,7 +66,8 @@
58
66
  "type": "string"
59
67
  },
60
68
  "step": {
61
- "type": "number"
69
+ "type": "number",
70
+ "default": 1
62
71
  }
63
72
  },
64
73
  "additionalProperties": false
@@ -67,6 +76,10 @@
67
76
  "$ref": "#/definitions/DateRangeQuestion/properties/columns/properties/start"
68
77
  }
69
78
  },
79
+ "required": [
80
+ "start",
81
+ "end"
82
+ ],
70
83
  "additionalProperties": false
71
84
  }
72
85
  },
package/dist/schemas/emailQuestion.schema.json CHANGED
@@ -21,7 +21,8 @@
21
21
  "type": "string"
22
22
  },
23
23
  "maxLength": {
24
- "type": "number"
24
+ "type": "number",
25
+ "default": 255
25
26
  },
26
27
  "minLength": {
27
28
  "type": "number"
@@ -30,7 +31,8 @@
30
31
  "type": "string"
31
32
  },
32
33
  "multiple": {
33
- "type": "boolean"
34
+ "type": "boolean",
35
+ "default": false
34
36
  }
35
37
  },
36
38
  "additionalProperties": false
@@ -41,6 +43,14 @@
41
43
  "schemaVersion": {
42
44
  "type": "string",
43
45
  "const": "1.0"
46
+ },
47
+ "title": {
48
+ "type": "string",
49
+ "const": "Email Field"
50
+ },
51
+ "usageDescription": {
52
+ "type": "string",
53
+ "const": "For questions that require require email address(es)."
44
54
  }
45
55
  },
46
56
  "required": [
package/dist/schemas/filteredSearchQuestion.schema.json CHANGED
@@ -32,6 +32,13 @@
32
32
  "schemaVersion": {
33
33
  "type": "string",
34
34
  "const": "1.0"
35
+ },
36
+ "title": {
37
+ "type": "string",
38
+ "const": "Not yet implemented"
39
+ },
40
+ "usageDescription": {
41
+ "type": "string"
35
42
  }
36
43
  },
37
44
  "required": [
package/dist/schemas/multiselectBoxAnswer.schema.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "$ref": "#/definitions/MultiselectBoxAnswer",
3
+ "definitions": {
4
+ "MultiselectBoxAnswer": {
5
+ "type": "object",
6
+ "properties": {
7
+ "type": {
8
+ "type": "string",
9
+ "const": "multiselectBox"
10
+ },
11
+ "answer": {
12
+ "type": "array",
13
+ "items": {
14
+ "type": "string"
15
+ }
16
+ },
17
+ "meta": {
18
+ "type": "object",
19
+ "properties": {
20
+ "schemaVersion": {
21
+ "type": "string",
22
+ "const": "1.0"
23
+ }
24
+ },
25
+ "required": [
26
+ "schemaVersion"
27
+ ],
28
+ "additionalProperties": false
29
+ }
30
+ },
31
+ "required": [
32
+ "type",
33
+ "answer",
34
+ "meta"
35
+ ],
36
+ "additionalProperties": false
37
+ }
38
+ },
39
+ "$schema": "http://json-schema.org/draft-07/schema#"
40
+ }
package/dist/schemas/multiselectBoxQuestion.schema.json ADDED
@@ -0,0 +1,85 @@
1
+ {
2
+ "$ref": "#/definitions/MultiselectBoxQuestion",
3
+ "definitions": {
4
+ "MultiselectBoxQuestion": {
5
+ "type": "object",
6
+ "properties": {
7
+ "type": {
8
+ "type": "string",
9
+ "const": "multiselectBox"
10
+ },
11
+ "attributes": {
12
+ "type": "object",
13
+ "properties": {
14
+ "label": {
15
+ "type": "string"
16
+ },
17
+ "help": {
18
+ "type": "string"
19
+ },
20
+ "labelTranslationKey": {
21
+ "type": "string"
22
+ },
23
+ "multiple": {
24
+ "type": "boolean",
25
+ "const": true
26
+ }
27
+ },
28
+ "required": [
29
+ "multiple"
30
+ ],
31
+ "additionalProperties": false
32
+ },
33
+ "meta": {
34
+ "type": "object",
35
+ "properties": {
36
+ "schemaVersion": {
37
+ "type": "string",
38
+ "const": "1.0"
39
+ },
40
+ "title": {
41
+ "type": "string",
42
+ "const": "Multi-select Box"
43
+ },
44
+ "usageDescription": {
45
+ "type": "string",
46
+ "const": "For questions where multiple answers are valid. Allows users to select several options from a predefined list, providing flexibility in responses."
47
+ }
48
+ },
49
+ "required": [
50
+ "schemaVersion"
51
+ ],
52
+ "additionalProperties": false
53
+ },
54
+ "options": {
55
+ "type": "array",
56
+ "items": {
57
+ "type": "object",
58
+ "properties": {
59
+ "label": {
60
+ "type": "string",
61
+ "default": "Option A"
62
+ },
63
+ "value": {
64
+ "type": "string",
65
+ "default": "a"
66
+ },
67
+ "selected": {
68
+ "type": "boolean",
69
+ "default": false
70
+ }
71
+ },
72
+ "additionalProperties": false
73
+ }
74
+ }
75
+ },
76
+ "required": [
77
+ "type",
78
+ "attributes",
79
+ "options"
80
+ ],
81
+ "additionalProperties": false
82
+ }
83
+ },
84
+ "$schema": "http://json-schema.org/draft-07/schema#"
85
+ }
package/dist/schemas/numberQuestion.schema.json CHANGED
@@ -24,10 +24,12 @@
24
24
  "type": "number"
25
25
  },
26
26
  "min": {
27
- "type": "number"
27
+ "type": "number",
28
+ "default": 0
28
29
  },
29
30
  "step": {
30
- "type": "number"
31
+ "type": "number",
32
+ "default": 1
31
33
  }
32
34
  },
33
35
  "additionalProperties": false
@@ -38,6 +40,14 @@
38
40
  "schemaVersion": {
39
41
  "type": "string",
40
42
  "const": "1.0"
43
+ },
44
+ "title": {
45
+ "type": "string",
46
+ "const": "Number Field"
47
+ },
48
+ "usageDescription": {
49
+ "type": "string",
50
+ "const": "For questions that require a single numeric value."
41
51
  }
42
52
  },
43
53
  "required": [
package/dist/schemas/numberRangeQuestion.schema.json CHANGED
@@ -29,6 +29,14 @@
29
29
  "schemaVersion": {
30
30
  "type": "string",
31
31
  "const": "1.0"
32
+ },
33
+ "title": {
34
+ "type": "string",
35
+ "const": "Number Range"
36
+ },
37
+ "usageDescription": {
38
+ "type": "string",
39
+ "const": "For questions that require a numerical range (e.g. From/To, Min/Max)."
32
40
  }
33
41
  },
34
42
  "required": [
@@ -55,10 +63,12 @@
55
63
  "type": "number"
56
64
  },
57
65
  "min": {
58
- "type": "number"
66
+ "type": "number",
67
+ "default": 0
59
68
  },
60
69
  "step": {
61
- "type": "number"
70
+ "type": "number",
71
+ "default": 1
62
72
  }
63
73
  },
64
74
  "additionalProperties": false
@@ -67,6 +77,10 @@
67
77
  "$ref": "#/definitions/NumberRangeQuestion/properties/columns/properties/start"
68
78
  }
69
79
  },
80
+ "required": [
81
+ "start",
82
+ "end"
83
+ ],
70
84
  "additionalProperties": false
71
85
  }
72
86
  },
package/dist/schemas/radioButtonsQuestion.schema.json CHANGED
@@ -29,6 +29,14 @@
29
29
  "schemaVersion": {
30
30
  "type": "string",
31
31
  "const": "1.0"
32
+ },
33
+ "title": {
34
+ "type": "string",
35
+ "const": "Radio Buttons"
36
+ },
37
+ "usageDescription": {
38
+ "type": "string",
39
+ "const": "For multiple choice questions where users select just one option."
32
40
  }
33
41
  },
34
42
  "required": [
@@ -42,19 +50,18 @@
42
50
  "type": "object",
43
51
  "properties": {
44
52
  "label": {
45
- "type": "string"
53
+ "type": "string",
54
+ "default": "Option A"
46
55
  },
47
56
  "value": {
48
- "type": "string"
57
+ "type": "string",
58
+ "default": "a"
49
59
  },
50
60
  "selected": {
51
- "type": "boolean"
61
+ "type": "boolean",
62
+ "default": false
52
63
  }
53
64
  },
54
- "required": [
55
- "label",
56
- "value"
57
- ],
58
65
  "additionalProperties": false
59
66
  }
60
67
  }
package/dist/schemas/selectBoxAnswer.schema.json CHANGED
@@ -9,10 +9,7 @@
9
9
  "const": "selectBox"
10
10
  },
11
11
  "answer": {
12
- "type": "array",
13
- "items": {
14
- "type": "string"
15
- }
12
+ "type": "string"
16
13
  },
17
14
  "meta": {
18
15
  "type": "object",
package/dist/schemas/selectBoxQuestion.schema.json CHANGED
@@ -21,7 +21,8 @@
21
21
  "type": "string"
22
22
  },
23
23
  "multiple": {
24
- "type": "boolean"
24
+ "type": "boolean",
25
+ "default": false
25
26
  }
26
27
  },
27
28
  "additionalProperties": false
@@ -32,6 +33,14 @@
32
33
  "schemaVersion": {
33
34
  "type": "string",
34
35
  "const": "1.0"
36
+ },
37
+ "title": {
38
+ "type": "string",
39
+ "const": "Select Box"
40
+ },
41
+ "usageDescription": {
42
+ "type": "string",
43
+ "const": "For questions where users select one option from a list."
35
44
  }
36
45
  },
37
46
  "required": [
@@ -45,25 +54,25 @@
45
54
  "type": "object",
46
55
  "properties": {
47
56
  "label": {
48
- "type": "string"
57
+ "type": "string",
58
+ "default": "Option A"
49
59
  },
50
60
  "value": {
51
- "type": "string"
61
+ "type": "string",
62
+ "default": "a"
52
63
  },
53
64
  "selected": {
54
- "type": "boolean"
65
+ "type": "boolean",
66
+ "default": false
55
67
  }
56
68
  },
57
- "required": [
58
- "label",
59
- "value"
60
- ],
61
69
  "additionalProperties": false
62
70
  }
63
71
  }
64
72
  },
65
73
  "required": [
66
74
  "type",
75
+ "attributes",
67
76
  "options"
68
77
  ],
69
78
  "additionalProperties": false
package/dist/schemas/tableAnswer.schema.json CHANGED
@@ -28,10 +28,10 @@
28
28
  "properties": {
29
29
  "type": {
30
30
  "type": "string",
31
- "const": "boolean"
31
+ "const": "typeaheadSearch"
32
32
  },
33
33
  "answer": {
34
- "type": "boolean"
34
+ "type": "string"
35
35
  },
36
36
  "meta": {
37
37
  "type": "object",
@@ -54,6 +54,27 @@
54
54
  ],
55
55
  "additionalProperties": false
56
56
  },
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
77
+ },
57
78
  {
58
79
  "type": "object",
59
80
  "properties": {
@@ -204,10 +225,13 @@
204
225
  "properties": {
205
226
  "type": {
206
227
  "type": "string",
207
- "const": "number"
228
+ "const": "multiselectBox"
208
229
  },
209
230
  "answer": {
210
- "type": "number"
231
+ "type": "array",
232
+ "items": {
233
+ "type": "string"
234
+ }
211
235
  },
212
236
  "meta": {
213
237
  "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
@@ -225,10 +249,10 @@
225
249
  "properties": {
226
250
  "type": {
227
251
  "type": "string",
228
- "const": "radioButtons"
252
+ "const": "number"
229
253
  },
230
254
  "answer": {
231
- "type": "string"
255
+ "type": "number"
232
256
  },
233
257
  "meta": {
234
258
  "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
@@ -246,13 +270,10 @@
246
270
  "properties": {
247
271
  "type": {
248
272
  "type": "string",
249
- "const": "selectBox"
273
+ "const": "radioButtons"
250
274
  },
251
275
  "answer": {
252
- "type": "array",
253
- "items": {
254
- "type": "string"
255
- }
276
+ "type": "string"
256
277
  },
257
278
  "meta": {
258
279
  "$ref": "#/definitions/TableAnswer/properties/answer/items/properties/columns/items/properties/content/anyOf/0/properties/meta"
@@ -270,7 +291,7 @@
270
291
  "properties": {
271
292
  "type": {
272
293
  "type": "string",
273
- "const": "text"
294
+ "const": "selectBox"
274
295
  },
275
296
  "answer": {
276
297
  "type": "string"
@@ -291,7 +312,7 @@
291
312
  "properties": {
292
313
  "type": {
293
314
  "type": "string",
294
- "const": "textArea"
315
+ "const": "text"
295
316
  },
296
317
  "answer": {
297
318
  "type": "string"
@@ -312,7 +333,7 @@
312
333
  "properties": {
313
334
  "type": {
314
335
  "type": "string",
315
- "const": "typeaheadSearch"
336
+ "const": "textArea"
316
337
  },
317
338
  "answer": {
318
339
  "type": "string"