@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
@@ -8,27 +8,24 @@
8
8
  "type": "string",
9
9
  "const": "boolean"
10
10
  },
11
- "answer": {
12
- "type": "boolean"
13
- },
14
11
  "meta": {
15
12
  "type": "object",
16
13
  "properties": {
17
14
  "schemaVersion": {
18
15
  "type": "string",
19
- "const": "1.0"
16
+ "default": "1.0"
20
17
  }
21
18
  },
22
- "required": [
23
- "schemaVersion"
24
- ],
25
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "boolean",
24
+ "default": false
26
25
  }
27
26
  },
28
27
  "required": [
29
- "type",
30
- "answer",
31
- "meta"
28
+ "type"
32
29
  ],
33
30
  "additionalProperties": false
34
31
  }
@@ -25,28 +25,25 @@
25
25
  "default": false
26
26
  }
27
27
  },
28
- "additionalProperties": false
28
+ "additionalProperties": false,
29
+ "default": {}
29
30
  },
30
31
  "meta": {
31
32
  "type": "object",
32
33
  "properties": {
33
34
  "schemaVersion": {
34
35
  "type": "string",
35
- "const": "1.0"
36
+ "default": "1.0"
36
37
  },
37
38
  "title": {
38
- "type": "string",
39
- "const": "Yes/No Field"
39
+ "type": "string"
40
40
  },
41
41
  "usageDescription": {
42
- "type": "string",
43
- "const": "For questions that require a simple Yes/No response."
42
+ "type": "string"
44
43
  }
45
44
  },
46
- "required": [
47
- "schemaVersion"
48
- ],
49
- "additionalProperties": false
45
+ "additionalProperties": false,
46
+ "default": {}
50
47
  }
51
48
  },
52
49
  "required": [
@@ -8,30 +8,29 @@
8
8
  "type": "string",
9
9
  "const": "checkBoxes"
10
10
  },
11
- "answer": {
12
- "type": "array",
13
- "items": {
14
- "type": "string"
15
- }
16
- },
17
11
  "meta": {
18
12
  "type": "object",
19
13
  "properties": {
20
14
  "schemaVersion": {
21
15
  "type": "string",
22
- "const": "1.0"
16
+ "default": "1.0"
23
17
  }
24
18
  },
25
- "required": [
26
- "schemaVersion"
27
- ],
28
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string"
26
+ },
27
+ "default": [
28
+ ""
29
+ ]
29
30
  }
30
31
  },
31
32
  "required": [
32
- "type",
33
- "answer",
34
- "meta"
33
+ "type"
35
34
  ],
36
35
  "additionalProperties": false
37
36
  }
@@ -21,28 +21,25 @@
21
21
  "type": "string"
22
22
  }
23
23
  },
24
- "additionalProperties": false
24
+ "additionalProperties": false,
25
+ "default": {}
25
26
  },
26
27
  "meta": {
27
28
  "type": "object",
28
29
  "properties": {
29
30
  "schemaVersion": {
30
31
  "type": "string",
31
- "const": "1.0"
32
+ "default": "1.0"
32
33
  },
33
34
  "title": {
34
- "type": "string",
35
- "const": "Check Boxes"
35
+ "type": "string"
36
36
  },
37
37
  "usageDescription": {
38
- "type": "string",
39
- "const": "For multiple choice questions where users can select multiple options."
38
+ "type": "string"
40
39
  }
41
40
  },
42
- "required": [
43
- "schemaVersion"
44
- ],
45
- "additionalProperties": false
41
+ "additionalProperties": false,
42
+ "default": {}
46
43
  },
47
44
  "options": {
48
45
  "type": "array",
@@ -63,12 +60,14 @@
63
60
  }
64
61
  },
65
62
  "additionalProperties": false
66
- }
63
+ },
64
+ "default": [
65
+ {}
66
+ ]
67
67
  }
68
68
  },
69
69
  "required": [
70
- "type",
71
- "options"
70
+ "type"
72
71
  ],
73
72
  "additionalProperties": false
74
73
  }
@@ -8,27 +8,24 @@
8
8
  "type": "string",
9
9
  "const": "currency"
10
10
  },
11
- "answer": {
12
- "type": "number"
13
- },
14
11
  "meta": {
15
12
  "type": "object",
16
13
  "properties": {
17
14
  "schemaVersion": {
18
15
  "type": "string",
19
- "const": "1.0"
16
+ "default": "1.0"
20
17
  }
21
18
  },
22
- "required": [
23
- "schemaVersion"
24
- ],
25
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "number",
24
+ "default": 0
26
25
  }
27
26
  },
28
27
  "required": [
29
- "type",
30
- "answer",
31
- "meta"
28
+ "type"
32
29
  ],
33
30
  "additionalProperties": false
34
31
  }
@@ -36,28 +36,25 @@
36
36
  "default": "USD"
37
37
  }
38
38
  },
39
- "additionalProperties": false
39
+ "additionalProperties": false,
40
+ "default": {}
40
41
  },
41
42
  "meta": {
42
43
  "type": "object",
43
44
  "properties": {
44
45
  "schemaVersion": {
45
46
  "type": "string",
46
- "const": "1.0"
47
+ "default": "1.0"
47
48
  },
48
49
  "title": {
49
- "type": "string",
50
- "const": "Currency Field"
50
+ "type": "string"
51
51
  },
52
52
  "usageDescription": {
53
- "type": "string",
54
- "const": "For questions that require a monetary amount (e.g. Cost or Budget)."
53
+ "type": "string"
55
54
  }
56
55
  },
57
- "required": [
58
- "schemaVersion"
59
- ],
60
- "additionalProperties": false
56
+ "additionalProperties": false,
57
+ "default": {}
61
58
  }
62
59
  },
63
60
  "required": [
@@ -8,27 +8,24 @@
8
8
  "type": "string",
9
9
  "const": "date"
10
10
  },
11
- "answer": {
12
- "type": "string"
13
- },
14
11
  "meta": {
15
12
  "type": "object",
16
13
  "properties": {
17
14
  "schemaVersion": {
18
15
  "type": "string",
19
- "const": "1.0"
16
+ "default": "1.0"
20
17
  }
21
18
  },
22
- "required": [
23
- "schemaVersion"
24
- ],
25
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "string",
24
+ "default": ""
26
25
  }
27
26
  },
28
27
  "required": [
29
- "type",
30
- "answer",
31
- "meta"
28
+ "type"
32
29
  ],
33
30
  "additionalProperties": false
34
31
  }
@@ -31,28 +31,25 @@
31
31
  "default": 1
32
32
  }
33
33
  },
34
- "additionalProperties": false
34
+ "additionalProperties": false,
35
+ "default": {}
35
36
  },
36
37
  "meta": {
37
38
  "type": "object",
38
39
  "properties": {
39
40
  "schemaVersion": {
40
41
  "type": "string",
41
- "const": "1.0"
42
+ "default": "1.0"
42
43
  },
43
44
  "title": {
44
- "type": "string",
45
- "const": "Date Field"
45
+ "type": "string"
46
46
  },
47
47
  "usageDescription": {
48
- "type": "string",
49
- "const": "For questions that require a date."
48
+ "type": "string"
50
49
  }
51
50
  },
52
- "required": [
53
- "schemaVersion"
54
- ],
55
- "additionalProperties": false
51
+ "additionalProperties": false,
52
+ "default": {}
56
53
  }
57
54
  },
58
55
  "required": [
@@ -8,40 +8,35 @@
8
8
  "type": "string",
9
9
  "const": "dateRange"
10
10
  },
11
- "answer": {
11
+ "meta": {
12
12
  "type": "object",
13
13
  "properties": {
14
- "start": {
15
- "type": "string"
16
- },
17
- "end": {
18
- "type": "string"
14
+ "schemaVersion": {
15
+ "type": "string",
16
+ "default": "1.0"
19
17
  }
20
18
  },
21
- "required": [
22
- "start",
23
- "end"
24
- ],
25
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
26
21
  },
27
- "meta": {
22
+ "answer": {
28
23
  "type": "object",
29
24
  "properties": {
30
- "schemaVersion": {
25
+ "start": {
26
+ "type": "string",
27
+ "default": ""
28
+ },
29
+ "end": {
31
30
  "type": "string",
32
- "const": "1.0"
31
+ "default": ""
33
32
  }
34
33
  },
35
- "required": [
36
- "schemaVersion"
37
- ],
38
- "additionalProperties": false
34
+ "additionalProperties": false,
35
+ "default": {}
39
36
  }
40
37
  },
41
38
  "required": [
42
- "type",
43
- "answer",
44
- "meta"
39
+ "type"
45
40
  ],
46
41
  "additionalProperties": false
47
42
  }
@@ -21,28 +21,25 @@
21
21
  "type": "string"
22
22
  }
23
23
  },
24
- "additionalProperties": false
24
+ "additionalProperties": false,
25
+ "default": {}
25
26
  },
26
27
  "meta": {
27
28
  "type": "object",
28
29
  "properties": {
29
30
  "schemaVersion": {
30
31
  "type": "string",
31
- "const": "1.0"
32
+ "default": "1.0"
32
33
  },
33
34
  "title": {
34
- "type": "string",
35
- "const": "Date Range"
35
+ "type": "string"
36
36
  },
37
37
  "usageDescription": {
38
- "type": "string",
39
- "const": "For questions that require a date range (e.g. From/To, Start/End)"
38
+ "type": "string"
40
39
  }
41
40
  },
42
- "required": [
43
- "schemaVersion"
44
- ],
45
- "additionalProperties": false
41
+ "additionalProperties": false,
42
+ "default": {}
46
43
  },
47
44
  "columns": {
48
45
  "type": "object",
@@ -51,7 +48,8 @@
51
48
  "type": "object",
52
49
  "properties": {
53
50
  "label": {
54
- "$ref": "#/definitions/DateRangeQuestion/properties/attributes/properties/label"
51
+ "type": "string",
52
+ "default": "From"
55
53
  },
56
54
  "help": {
57
55
  "$ref": "#/definitions/DateRangeQuestion/properties/attributes/properties/help"
@@ -70,22 +68,42 @@
70
68
  "default": 1
71
69
  }
72
70
  },
73
- "additionalProperties": false
71
+ "additionalProperties": false,
72
+ "default": {}
74
73
  },
75
74
  "end": {
76
- "$ref": "#/definitions/DateRangeQuestion/properties/columns/properties/start"
75
+ "type": "object",
76
+ "properties": {
77
+ "label": {
78
+ "type": "string",
79
+ "default": "To"
80
+ },
81
+ "help": {
82
+ "$ref": "#/definitions/DateRangeQuestion/properties/attributes/properties/help"
83
+ },
84
+ "labelTranslationKey": {
85
+ "$ref": "#/definitions/DateRangeQuestion/properties/attributes/properties/labelTranslationKey"
86
+ },
87
+ "max": {
88
+ "$ref": "#/definitions/DateRangeQuestion/properties/columns/properties/start/properties/max"
89
+ },
90
+ "min": {
91
+ "$ref": "#/definitions/DateRangeQuestion/properties/columns/properties/start/properties/min"
92
+ },
93
+ "step": {
94
+ "$ref": "#/definitions/DateRangeQuestion/properties/columns/properties/start/properties/step"
95
+ }
96
+ },
97
+ "additionalProperties": false,
98
+ "default": {}
77
99
  }
78
100
  },
79
- "required": [
80
- "start",
81
- "end"
82
- ],
83
- "additionalProperties": false
101
+ "additionalProperties": false,
102
+ "default": {}
84
103
  }
85
104
  },
86
105
  "required": [
87
- "type",
88
- "columns"
106
+ "type"
89
107
  ],
90
108
  "additionalProperties": false
91
109
  }
@@ -8,27 +8,24 @@
8
8
  "type": "string",
9
9
  "const": "email"
10
10
  },
11
- "answer": {
12
- "type": "string"
13
- },
14
11
  "meta": {
15
12
  "type": "object",
16
13
  "properties": {
17
14
  "schemaVersion": {
18
15
  "type": "string",
19
- "const": "1.0"
16
+ "default": "1.0"
20
17
  }
21
18
  },
22
- "required": [
23
- "schemaVersion"
24
- ],
25
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "string",
24
+ "default": ""
26
25
  }
27
26
  },
28
27
  "required": [
29
- "type",
30
- "answer",
31
- "meta"
28
+ "type"
32
29
  ],
33
30
  "additionalProperties": false
34
31
  }
@@ -35,28 +35,25 @@
35
35
  "default": false
36
36
  }
37
37
  },
38
- "additionalProperties": false
38
+ "additionalProperties": false,
39
+ "default": {}
39
40
  },
40
41
  "meta": {
41
42
  "type": "object",
42
43
  "properties": {
43
44
  "schemaVersion": {
44
45
  "type": "string",
45
- "const": "1.0"
46
+ "default": "1.0"
46
47
  },
47
48
  "title": {
48
- "type": "string",
49
- "const": "Email Field"
49
+ "type": "string"
50
50
  },
51
51
  "usageDescription": {
52
- "type": "string",
53
- "const": "For questions that require require email address(es)."
52
+ "type": "string"
54
53
  }
55
54
  },
56
- "required": [
57
- "schemaVersion"
58
- ],
59
- "additionalProperties": false
55
+ "additionalProperties": false,
56
+ "default": {}
60
57
  }
61
58
  },
62
59
  "required": [
@@ -8,30 +8,29 @@
8
8
  "type": "string",
9
9
  "const": "multiselectBox"
10
10
  },
11
- "answer": {
12
- "type": "array",
13
- "items": {
14
- "type": "string"
15
- }
16
- },
17
11
  "meta": {
18
12
  "type": "object",
19
13
  "properties": {
20
14
  "schemaVersion": {
21
15
  "type": "string",
22
- "const": "1.0"
16
+ "default": "1.0"
23
17
  }
24
18
  },
25
- "required": [
26
- "schemaVersion"
27
- ],
28
- "additionalProperties": false
19
+ "additionalProperties": false,
20
+ "default": {}
21
+ },
22
+ "answer": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string"
26
+ },
27
+ "default": [
28
+ ""
29
+ ]
29
30
  }
30
31
  },
31
32
  "required": [
32
- "type",
33
- "answer",
34
- "meta"
33
+ "type"
35
34
  ],
36
35
  "additionalProperties": false
37
36
  }
@@ -28,28 +28,27 @@
28
28
  "required": [
29
29
  "multiple"
30
30
  ],
31
- "additionalProperties": false
31
+ "additionalProperties": false,
32
+ "default": {
33
+ "multiple": true
34
+ }
32
35
  },
33
36
  "meta": {
34
37
  "type": "object",
35
38
  "properties": {
36
39
  "schemaVersion": {
37
40
  "type": "string",
38
- "const": "1.0"
41
+ "default": "1.0"
39
42
  },
40
43
  "title": {
41
- "type": "string",
42
- "const": "Multi-select Box"
44
+ "type": "string"
43
45
  },
44
46
  "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
+ "type": "string"
47
48
  }
48
49
  },
49
- "required": [
50
- "schemaVersion"
51
- ],
52
- "additionalProperties": false
50
+ "additionalProperties": false,
51
+ "default": {}
53
52
  },
54
53
  "options": {
55
54
  "type": "array",
@@ -70,13 +69,14 @@
70
69
  }
71
70
  },
72
71
  "additionalProperties": false
73
- }
72
+ },
73
+ "default": [
74
+ {}
75
+ ]
74
76
  }
75
77
  },
76
78
  "required": [
77
- "type",
78
- "attributes",
79
- "options"
79
+ "type"
80
80
  ],
81
81
  "additionalProperties": false
82
82
  }