@dmptool/types 1.1.2 → 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 (37) hide show
  1. package/dist/questions/__tests__/graphQLQuestions.spec.js +6 -4
  2. package/dist/questions/__tests__/optionBasedQuestions.spec.js +4 -12
  3. package/dist/questions/dateQuestions.d.ts +31 -41
  4. package/dist/questions/dateQuestions.js +5 -20
  5. package/dist/questions/graphQLQuestions.d.ts +75 -81
  6. package/dist/questions/graphQLQuestions.js +18 -24
  7. package/dist/questions/index.d.ts +524 -723
  8. package/dist/questions/numberQuestions.d.ts +51 -66
  9. package/dist/questions/numberQuestions.js +6 -28
  10. package/dist/questions/optionBasedQuestions.d.ts +44 -69
  11. package/dist/questions/optionBasedQuestions.js +7 -55
  12. package/dist/questions/question.d.ts +0 -8
  13. package/dist/questions/question.js +0 -1
  14. package/dist/questions/tableQuestions.d.ts +717 -998
  15. package/dist/questions/tableQuestions.js +3 -10
  16. package/dist/questions/textQuestions.d.ts +21 -41
  17. package/dist/questions/textQuestions.js +10 -34
  18. package/dist/schemas/affiliationSearchQuestion.schema.json +39 -26
  19. package/dist/schemas/anyQuestion.schema.json +152 -119
  20. package/dist/schemas/anyTableColumnQuestion.schema.json +142 -104
  21. package/dist/schemas/booleanQuestion.schema.json +2 -5
  22. package/dist/schemas/checkboxesQuestion.schema.json +6 -11
  23. package/dist/schemas/currencyQuestion.schema.json +6 -7
  24. package/dist/schemas/dateQuestion.schema.json +2 -5
  25. package/dist/schemas/dateRangeQuestion.schema.json +6 -5
  26. package/dist/schemas/emailQuestion.schema.json +4 -6
  27. package/dist/schemas/filteredSearchQuestion.schema.json +0 -3
  28. package/dist/schemas/multiselectBoxQuestion.schema.json +6 -11
  29. package/dist/schemas/numberQuestion.schema.json +4 -6
  30. package/dist/schemas/numberRangeQuestion.schema.json +8 -6
  31. package/dist/schemas/radioButtonsQuestion.schema.json +6 -11
  32. package/dist/schemas/selectBoxQuestion.schema.json +7 -15
  33. package/dist/schemas/tableQuestion.schema.json +148 -111
  34. package/dist/schemas/textAreaQuestion.schema.json +6 -7
  35. package/dist/schemas/textQuestion.schema.json +2 -5
  36. package/dist/schemas/urlQuestion.schema.json +2 -5
  37. package/package.json +1 -1
package/dist/schemas/tableQuestion.schema.json CHANGED
@@ -21,13 +21,16 @@
21
21
  "type": "string"
22
22
  },
23
23
  "canAddRows": {
24
- "type": "boolean"
24
+ "type": "boolean",
25
+ "default": true
25
26
  },
26
27
  "canRemoveRows": {
27
- "type": "boolean"
28
+ "type": "boolean",
29
+ "default": true
28
30
  },
29
31
  "initialRows": {
30
- "type": "number"
32
+ "type": "number",
33
+ "default": 1
31
34
  },
32
35
  "maxRows": {
33
36
  "type": "number"
@@ -52,10 +55,6 @@
52
55
  "usageDescription": {
53
56
  "type": "string",
54
57
  "const": "For questions that require a tabular format."
55
- },
56
- "defaultJSON": {
57
- "type": "string",
58
- "const": "{\"type\":\"table\",\"columns\":[],\"attributes\":{\"canAddRows\":true,\"canRemoveRows\":true,\"initialRows\":1},\"meta\":{\"schemaVersion\":\"1.0\"}}"
59
58
  }
60
59
  },
61
60
  "required": [
@@ -108,10 +107,6 @@
108
107
  "usageDescription": {
109
108
  "type": "string",
110
109
  "const": "For questions that require the user to select from a controlled list of institutions."
111
- },
112
- "defaultJSON": {
113
- "type": "string",
114
- "const": "{\"type\":\"affiliationSearch\",\"attributes\":{},\"meta\":{\"schemaVersion\":\"1.0\"},\"graphQL\":{\"query\":\"query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}\",\"queryId\":\"useAffiliationsQuery\",\"variables\":[{\"name\":\"term\",\"type\":\"string\",\"label\":\"Search for your institution\",\"minLength\":3,\"labelTranslationKey\":\"SignupPage.institutionHelp\"}],\"answerField\":\"uri\",\"displayFields\":[{\"label\":\"Institution\",\"propertyName\":\"displayName\",\"labelTranslationKey\":\"SignupPage.institution\"}],\"responseField\":\"affiliations.items\"}}"
115
110
  }
116
111
  },
117
112
  "required": [
@@ -128,18 +123,20 @@
128
123
  "type": "object",
129
124
  "properties": {
130
125
  "propertyName": {
131
- "type": "string"
126
+ "type": "string",
127
+ "const": "displayName"
132
128
  },
133
129
  "label": {
134
- "type": "string"
130
+ "type": "string",
131
+ "default": "Institution"
135
132
  },
136
133
  "labelTranslationKey": {
137
- "type": "string"
134
+ "type": "string",
135
+ "default": "SignupPage.institution"
138
136
  }
139
137
  },
140
138
  "required": [
141
- "propertyName",
142
- "label"
139
+ "propertyName"
143
140
  ],
144
141
  "additionalProperties": false
145
142
  }
@@ -148,46 +145,61 @@
148
145
  "type": "string"
149
146
  },
150
147
  "query": {
151
- "type": "string"
148
+ "type": "string",
149
+ "const": "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}"
152
150
  },
153
151
  "responseField": {
154
- "type": "string"
152
+ "type": "string",
153
+ "const": "affiliations.items"
155
154
  },
156
155
  "variables": {
157
156
  "type": "array",
158
157
  "items": {
159
158
  "type": "object",
160
159
  "properties": {
161
- "minLength": {
162
- "type": "number"
163
- },
164
- "label": {
165
- "type": "string"
166
- },
167
- "labelTranslationKey": {
168
- "type": "string"
169
- },
170
160
  "name": {
171
- "type": "string"
161
+ "type": "string",
162
+ "const": "name"
172
163
  },
173
164
  "type": {
174
- "type": "string"
165
+ "type": "string",
166
+ "default": "string"
175
167
  },
176
- "defaultValue": {
177
- "type": "string"
168
+ "label": {
169
+ "type": "string",
170
+ "default": "Search for your institution"
171
+ },
172
+ "minLength": {
173
+ "type": "number",
174
+ "const": 3
175
+ },
176
+ "labelTranslationKey": {
177
+ "type": "string",
178
+ "default": "SignupPage.institutionHelp"
178
179
  }
179
180
  },
180
181
  "required": [
181
182
  "name",
182
- "type"
183
+ "minLength"
183
184
  ],
184
185
  "additionalProperties": false
185
186
  }
187
+ },
188
+ "queryId": {
189
+ "type": "string",
190
+ "default": "useAffiliationsQuery"
191
+ },
192
+ "answerField": {
193
+ "type": "string",
194
+ "const": "uri"
186
195
  }
187
196
  },
188
197
  "required": [
189
198
  "displayFields",
190
- "responseField"
199
+ "query",
200
+ "responseField",
201
+ "variables",
202
+ "answerField"
191
203
  ],
192
204
  "additionalProperties": false
193
205
  }
@@ -219,7 +231,8 @@
219
231
  "$ref": "#/definitions/TableQuestion/properties/attributes/properties/labelTranslationKey"
220
232
  },
221
233
  "checked": {
222
- "type": "boolean"
234
+ "type": "boolean",
235
+ "default": false
223
236
  }
224
237
  },
225
238
  "additionalProperties": false
@@ -237,10 +250,6 @@
237
250
  "usageDescription": {
238
251
  "type": "string",
239
252
  "const": "For questions that require a simple Yes/No response."
240
- },
241
- "defaultJSON": {
242
- "type": "string",
243
- "const": "{\n \"attributes\": {\n \"checked\": false\n },\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
244
253
  }
245
254
  },
246
255
  "required": [
@@ -277,10 +286,6 @@
277
286
  "usageDescription": {
278
287
  "type": "string",
279
288
  "const": "For multiple choice questions where users can select multiple options."
280
- },
281
- "defaultJSON": {
282
- "type": "string",
283
- "const": "{\n \"type\": \"checkBoxes\",\n \"attributes\": {},\n \"options\": [\n {\n \"label\": \"Option 1\",\n \"value\": \"1\",\n \"checked\": false\n }\n ],\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
284
289
  }
285
290
  },
286
291
  "required": [
@@ -294,19 +299,18 @@
294
299
  "type": "object",
295
300
  "properties": {
296
301
  "label": {
297
- "type": "string"
302
+ "type": "string",
303
+ "default": "Option A"
298
304
  },
299
305
  "value": {
300
- "type": "string"
306
+ "type": "string",
307
+ "default": "a"
301
308
  },
302
309
  "checked": {
303
- "type": "boolean"
310
+ "type": "boolean",
311
+ "default": false
304
312
  }
305
313
  },
306
- "required": [
307
- "label",
308
- "value"
309
- ],
310
314
  "additionalProperties": false
311
315
  }
312
316
  }
@@ -340,13 +344,16 @@
340
344
  "type": "number"
341
345
  },
342
346
  "min": {
343
- "type": "number"
347
+ "type": "number",
348
+ "default": 0
344
349
  },
345
350
  "step": {
346
- "type": "number"
351
+ "type": "number",
352
+ "default": 1
347
353
  },
348
354
  "denomination": {
349
- "type": "string"
355
+ "type": "string",
356
+ "default": "USD"
350
357
  }
351
358
  },
352
359
  "additionalProperties": false
@@ -364,10 +371,6 @@
364
371
  "usageDescription": {
365
372
  "type": "string",
366
373
  "const": "For questions that require a monetary amount (e.g. Cost or Budget)."
367
- },
368
- "defaultJSON": {
369
- "type": "string",
370
- "const": "{\n \"type\": \"currency\",\n \"attributes\": {\n \"denomination\": \"USD\",\n \"min\": 0,\n \"step\": 1\n },\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
371
374
  }
372
375
  },
373
376
  "required": [
@@ -407,7 +410,8 @@
407
410
  "type": "string"
408
411
  },
409
412
  "step": {
410
- "type": "number"
413
+ "type": "number",
414
+ "default": 1
411
415
  }
412
416
  },
413
417
  "additionalProperties": false
@@ -425,10 +429,6 @@
425
429
  "usageDescription": {
426
430
  "type": "string",
427
431
  "const": "For questions that require a date."
428
- },
429
- "defaultJSON": {
430
- "type": "string",
431
- "const": "{\"type\":\"date\",\"attributes\":{\"step\":1},\"meta\":{\"schemaVersion\":\"1.0\"}}"
432
432
  }
433
433
  },
434
434
  "required": [
@@ -465,10 +465,6 @@
465
465
  "usageDescription": {
466
466
  "type": "string",
467
467
  "const": "For questions that require a date range (e.g. From/To, Start/End)"
468
- },
469
- "defaultJSON": {
470
- "type": "string",
471
- "const": "{\"type\":\"dateRange\",\"attributes\":{},\"columns\":{\"start\":{\"label\":\"Start\",\"step\":1},\"end\":{\"label\":\"End\",\"step\":1}}}"
472
468
  }
473
469
  },
474
470
  "required": [
@@ -486,6 +482,10 @@
486
482
  "$ref": "#/definitions/TableQuestion/properties/columns/items/properties/content/anyOf/4/properties/attributes"
487
483
  }
488
484
  },
485
+ "required": [
486
+ "start",
487
+ "end"
488
+ ],
489
489
  "additionalProperties": false
490
490
  }
491
491
  },
@@ -515,7 +515,8 @@
515
515
  "$ref": "#/definitions/TableQuestion/properties/attributes/properties/labelTranslationKey"
516
516
  },
517
517
  "maxLength": {
518
- "type": "number"
518
+ "type": "number",
519
+ "default": 255
519
520
  },
520
521
  "minLength": {
521
522
  "type": "number"
@@ -524,7 +525,8 @@
524
525
  "type": "string"
525
526
  },
526
527
  "multiple": {
527
- "type": "boolean"
528
+ "type": "boolean",
529
+ "default": false
528
530
  }
529
531
  },
530
532
  "additionalProperties": false
@@ -542,10 +544,6 @@
542
544
  "usageDescription": {
543
545
  "type": "string",
544
546
  "const": "For questions that require require email address(es)."
545
- },
546
- "defaultJSON": {
547
- "type": "string",
548
- "const": "{\"type\":\"email\",\"attributes\":{\"maxLength\":255,\"minLength\":1,\"multiple\":false},\"meta\":{\"schemaVersion\":\"1.0\"}}"
549
547
  }
550
548
  },
551
549
  "required": [
@@ -596,9 +594,6 @@
596
594
  },
597
595
  "usageDescription": {
598
596
  "type": "string"
599
- },
600
- "defaultJSON": {
601
- "type": "string"
602
597
  }
603
598
  },
604
599
  "required": [
@@ -607,7 +602,76 @@
607
602
  "additionalProperties": false
608
603
  },
609
604
  "graphQL": {
610
- "$ref": "#/definitions/TableQuestion/properties/columns/items/properties/content/anyOf/0/properties/graphQL"
605
+ "type": "object",
606
+ "properties": {
607
+ "displayFields": {
608
+ "type": "array",
609
+ "items": {
610
+ "type": "object",
611
+ "properties": {
612
+ "propertyName": {
613
+ "type": "string"
614
+ },
615
+ "label": {
616
+ "type": "string"
617
+ },
618
+ "labelTranslationKey": {
619
+ "type": "string"
620
+ }
621
+ },
622
+ "required": [
623
+ "propertyName",
624
+ "label"
625
+ ],
626
+ "additionalProperties": false
627
+ }
628
+ },
629
+ "localQueryId": {
630
+ "$ref": "#/definitions/TableQuestion/properties/columns/items/properties/content/anyOf/0/properties/graphQL/properties/localQueryId"
631
+ },
632
+ "query": {
633
+ "type": "string"
634
+ },
635
+ "responseField": {
636
+ "type": "string"
637
+ },
638
+ "variables": {
639
+ "type": "array",
640
+ "items": {
641
+ "type": "object",
642
+ "properties": {
643
+ "minLength": {
644
+ "type": "number"
645
+ },
646
+ "label": {
647
+ "type": "string"
648
+ },
649
+ "labelTranslationKey": {
650
+ "type": "string"
651
+ },
652
+ "name": {
653
+ "type": "string"
654
+ },
655
+ "type": {
656
+ "type": "string"
657
+ },
658
+ "defaultValue": {
659
+ "type": "string"
660
+ }
661
+ },
662
+ "required": [
663
+ "name",
664
+ "type"
665
+ ],
666
+ "additionalProperties": false
667
+ }
668
+ }
669
+ },
670
+ "required": [
671
+ "displayFields",
672
+ "responseField"
673
+ ],
674
+ "additionalProperties": false
611
675
  }
612
676
  },
613
677
  "required": [
@@ -660,10 +724,6 @@
660
724
  "usageDescription": {
661
725
  "type": "string",
662
726
  "const": "For questions that require a single numeric value."
663
- },
664
- "defaultJSON": {
665
- "type": "string",
666
- "const": "{\n \"type\": \"number\",\n \"attributes\": {\n \"min\": 0,\n \"step\": 1\n },\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
667
727
  }
668
728
  },
669
729
  "required": [
@@ -700,10 +760,6 @@
700
760
  "usageDescription": {
701
761
  "type": "string",
702
762
  "const": "For multiple choice questions where users select just one option."
703
- },
704
- "defaultJSON": {
705
- "type": "string",
706
- "const": "{\n \"type\": \"radioButtons\",\n \"attributes\": {},\n \"options\": [\n {\n \"label\": \"Option 1\",\n \"value\": \"option1\",\n \"selected\": false\n }\n ],\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
707
763
  }
708
764
  },
709
765
  "required": [
@@ -723,13 +779,10 @@
723
779
  "$ref": "#/definitions/TableQuestion/properties/columns/items/properties/content/anyOf/2/properties/options/items/properties/value"
724
780
  },
725
781
  "selected": {
726
- "type": "boolean"
782
+ "type": "boolean",
783
+ "default": false
727
784
  }
728
785
  },
729
- "required": [
730
- "label",
731
- "value"
732
- ],
733
786
  "additionalProperties": false
734
787
  }
735
788
  }
@@ -761,12 +814,9 @@
761
814
  },
762
815
  "multiple": {
763
816
  "type": "boolean",
764
- "const": false
817
+ "default": false
765
818
  }
766
819
  },
767
- "required": [
768
- "multiple"
769
- ],
770
820
  "additionalProperties": false
771
821
  },
772
822
  "meta": {
@@ -782,10 +832,6 @@
782
832
  "usageDescription": {
783
833
  "type": "string",
784
834
  "const": "For questions where users select one option from a list."
785
- },
786
- "defaultJSON": {
787
- "type": "string",
788
- "const": "{\n \"type\": \"selectBox\",\n \"attributes\": {\n \"multiple\": false\n },\n \"options\": [\n {\n \"label\": \"Option 1\",\n \"value\": \"option1\"\n }\n ],\n \"meta\": {\n \"schemaVersion\": \"1.0\"\n }\n}"
789
835
  }
790
836
  },
791
837
  "required": [
@@ -827,7 +873,8 @@
827
873
  "$ref": "#/definitions/TableQuestion/properties/attributes/properties/labelTranslationKey"
828
874
  },
829
875
  "cols": {
830
- "type": "number"
876
+ "type": "number",
877
+ "default": 20
831
878
  },
832
879
  "maxLength": {
833
880
  "type": "number"
@@ -836,10 +883,12 @@
836
883
  "type": "number"
837
884
  },
838
885
  "rows": {
839
- "type": "number"
886
+ "type": "number",
887
+ "default": 2
840
888
  },
841
889
  "asRichText": {
842
- "type": "boolean"
890
+ "type": "boolean",
891
+ "default": true
843
892
  }
844
893
  },
845
894
  "additionalProperties": false
@@ -857,10 +906,6 @@
857
906
  "usageDescription": {
858
907
  "type": "string",
859
908
  "const": "For questions that require longer answers, you can select formatting options too."
860
- },
861
- "defaultJSON": {
862
- "type": "string",
863
- "const": "{\"type\":\"textArea\",\"attributes\":{\"cols\":20,\"rows\":2,\"asRichText\":true},\"meta\":{\"schemaVersion\":\"1.0\"}}"
864
909
  }
865
910
  },
866
911
  "required": [
@@ -918,10 +963,6 @@
918
963
  "usageDescription": {
919
964
  "type": "string",
920
965
  "const": "For questions that require short, simple answers."
921
- },
922
- "defaultJSON": {
923
- "type": "string",
924
- "const": "{\"type\":\"text\",\"attributes\":{\"maxLength\":255},\"meta\":{\"schemaVersion\":\"1.0\"}}"
925
966
  }
926
967
  },
927
968
  "required": [
@@ -958,10 +999,6 @@
958
999
  "usageDescription": {
959
1000
  "type": "string",
960
1001
  "const": "For questions that require a website, DOI or other URL."
961
- },
962
- "defaultJSON": {
963
- "type": "string",
964
- "const": "{\"type\":\"url\",\"attributes\":{\"maxLength\":255},\"meta\":{\"schemaVersion\":\"1.0\"}}"
965
1002
  }
966
1003
  },
967
1004
  "required": [
package/dist/schemas/textAreaQuestion.schema.json CHANGED
@@ -21,7 +21,8 @@
21
21
  "type": "string"
22
22
  },
23
23
  "cols": {
24
- "type": "number"
24
+ "type": "number",
25
+ "default": 20
25
26
  },
26
27
  "maxLength": {
27
28
  "type": "number"
@@ -30,10 +31,12 @@
30
31
  "type": "number"
31
32
  },
32
33
  "rows": {
33
- "type": "number"
34
+ "type": "number",
35
+ "default": 2
34
36
  },
35
37
  "asRichText": {
36
- "type": "boolean"
38
+ "type": "boolean",
39
+ "default": true
37
40
  }
38
41
  },
39
42
  "additionalProperties": false
@@ -52,10 +55,6 @@
52
55
  "usageDescription": {
53
56
  "type": "string",
54
57
  "const": "For questions that require longer answers, you can select formatting options too."
55
- },
56
- "defaultJSON": {
57
- "type": "string",
58
- "const": "{\"type\":\"textArea\",\"attributes\":{\"cols\":20,\"rows\":2,\"asRichText\":true},\"meta\":{\"schemaVersion\":\"1.0\"}}"
59
58
  }
60
59
  },
61
60
  "required": [
package/dist/schemas/textQuestion.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"
@@ -46,10 +47,6 @@
46
47
  "usageDescription": {
47
48
  "type": "string",
48
49
  "const": "For questions that require short, simple answers."
49
- },
50
- "defaultJSON": {
51
- "type": "string",
52
- "const": "{\"type\":\"text\",\"attributes\":{\"maxLength\":255},\"meta\":{\"schemaVersion\":\"1.0\"}}"
53
50
  }
54
51
  },
55
52
  "required": [
package/dist/schemas/urlQuestion.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"
@@ -46,10 +47,6 @@
46
47
  "usageDescription": {
47
48
  "type": "string",
48
49
  "const": "For questions that require a website, DOI or other URL."
49
- },
50
- "defaultJSON": {
51
- "type": "string",
52
- "const": "{\"type\":\"url\",\"attributes\":{\"maxLength\":255},\"meta\":{\"schemaVersion\":\"1.0\"}}"
53
50
  }
54
51
  },
55
52
  "required": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dmptool/types",
3
- "version": "1.1.2",
3
+ "version": "1.1.3",
4
4
  "description": "TypeScript types for DMPTool",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",