@dmptool/types 1.2.3 → 1.2.4

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 (42) hide show
  1. package/README.md +8 -0
  2. package/dist/answers/__tests__/answers.spec.js +122 -6
  3. package/dist/answers/answer.d.ts +3 -3
  4. package/dist/answers/graphQLAnswers.d.ts +120 -25
  5. package/dist/answers/graphQLAnswers.js +22 -5
  6. package/dist/answers/index.d.ts +399 -31
  7. package/dist/answers/index.js +8 -2
  8. package/dist/answers/numberAnswers.d.ts +40 -0
  9. package/dist/answers/numberAnswers.js +8 -1
  10. package/dist/answers/tableAnswers.d.ts +1688 -75
  11. package/dist/answers/tableAnswers.js +63 -2
  12. package/dist/questions/__tests__/graphQLQuestions.spec.js +177 -39
  13. package/dist/questions/__tests__/numberQuestions.spec.js +36 -0
  14. package/dist/questions/__tests__/tableQuestion.spec.js +145 -0
  15. package/dist/questions/__tests__/usage.spec.js +162 -1
  16. package/dist/questions/graphQLQuestions.d.ts +420 -60
  17. package/dist/questions/graphQLQuestions.js +257 -11
  18. package/dist/questions/index.d.ts +4849 -189
  19. package/dist/questions/index.js +9 -2
  20. package/dist/questions/numberQuestions.d.ts +105 -0
  21. package/dist/questions/numberQuestions.js +12 -1
  22. package/dist/questions/question.d.ts +4 -4
  23. package/dist/questions/question.js +25 -4
  24. package/dist/questions/tableQuestions.d.ts +5930 -679
  25. package/dist/questions/tableQuestions.js +175 -3
  26. package/dist/schemas/anyAnswer.schema.json +137 -17
  27. package/dist/schemas/anyQuestion.schema.json +829 -101
  28. package/dist/schemas/anyTableColumnAnswer.schema.json +116 -5
  29. package/dist/schemas/anyTableColumnQuestion.schema.json +326 -24
  30. package/dist/schemas/licenseSearchAnswer.schema.json +49 -0
  31. package/dist/schemas/licenseSearchQuestion.schema.json +164 -0
  32. package/dist/schemas/metadataStandardSearchAnswer.schema.json +49 -0
  33. package/dist/schemas/metadataStandardSearchQuestion.schema.json +174 -0
  34. package/dist/schemas/numberWithContextAnswer.schema.json +45 -0
  35. package/dist/schemas/numberWithContextQuestion.schema.json +84 -0
  36. package/dist/schemas/repositorySearchAnswer.schema.json +49 -0
  37. package/dist/schemas/repositorySearchQuestion.schema.json +180 -0
  38. package/dist/schemas/researchOutputTableAnswer.schema.json +519 -0
  39. package/dist/schemas/researchOutputTableQuestion.schema.json +1183 -0
  40. package/dist/schemas/tableAnswer.schema.json +116 -5
  41. package/dist/schemas/tableQuestion.schema.json +348 -24
  42. package/package.json +9 -5
package/dist/schemas/anyTableColumnAnswer.schema.json CHANGED
@@ -183,7 +183,7 @@
183
183
  "properties": {
184
184
  "type": {
185
185
  "type": "string",
186
- "const": "filteredSearch"
186
+ "const": "licenseSearch"
187
187
  },
188
188
  "meta": {
189
189
  "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
@@ -191,11 +191,56 @@
191
191
  "answer": {
192
192
  "type": "array",
193
193
  "items": {
194
- "type": "string"
194
+ "type": "object",
195
+ "properties": {
196
+ "licenseId": {
197
+ "type": "string",
198
+ "default": ""
199
+ },
200
+ "licenseName": {
201
+ "type": "string",
202
+ "default": ""
203
+ }
204
+ },
205
+ "additionalProperties": false,
206
+ "default": {}
195
207
  },
196
- "default": [
197
- ""
198
- ]
208
+ "default": []
209
+ }
210
+ },
211
+ "required": [
212
+ "type"
213
+ ],
214
+ "additionalProperties": false
215
+ },
216
+ {
217
+ "type": "object",
218
+ "properties": {
219
+ "type": {
220
+ "type": "string",
221
+ "const": "metadataStandardSearch"
222
+ },
223
+ "meta": {
224
+ "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
225
+ },
226
+ "answer": {
227
+ "type": "array",
228
+ "items": {
229
+ "type": "object",
230
+ "properties": {
231
+ "metadataStandardId": {
232
+ "type": "string",
233
+ "default": ""
234
+ },
235
+ "metadataStandardName": {
236
+ "type": "string",
237
+ "default": ""
238
+ }
239
+ },
240
+ "additionalProperties": false,
241
+ "default": {}
242
+ },
243
+ "default": []
199
244
  }
200
245
  },
201
246
  "required": [
@@ -248,6 +293,37 @@
248
293
  ],
249
294
  "additionalProperties": false
250
295
  },
296
+ {
297
+ "type": "object",
298
+ "properties": {
299
+ "type": {
300
+ "type": "string",
301
+ "const": "numberWithContext"
302
+ },
303
+ "meta": {
304
+ "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
305
+ },
306
+ "answer": {
307
+ "type": "object",
308
+ "properties": {
309
+ "value": {
310
+ "type": "number",
311
+ "default": 0
312
+ },
313
+ "context": {
314
+ "type": "string",
315
+ "default": ""
316
+ }
317
+ },
318
+ "additionalProperties": false
319
+ }
320
+ },
321
+ "required": [
322
+ "type",
323
+ "answer"
324
+ ],
325
+ "additionalProperties": false
326
+ },
251
327
  {
252
328
  "type": "object",
253
329
  "properties": {
@@ -268,6 +344,41 @@
268
344
  ],
269
345
  "additionalProperties": false
270
346
  },
347
+ {
348
+ "type": "object",
349
+ "properties": {
350
+ "type": {
351
+ "type": "string",
352
+ "const": "repositorySearch"
353
+ },
354
+ "meta": {
355
+ "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
356
+ },
357
+ "answer": {
358
+ "type": "array",
359
+ "items": {
360
+ "type": "object",
361
+ "properties": {
362
+ "repositoryId": {
363
+ "type": "string",
364
+ "default": ""
365
+ },
366
+ "repositoryName": {
367
+ "type": "string",
368
+ "default": ""
369
+ }
370
+ },
371
+ "additionalProperties": false,
372
+ "default": {}
373
+ },
374
+ "default": []
375
+ }
376
+ },
377
+ "required": [
378
+ "type"
379
+ ],
380
+ "additionalProperties": false
381
+ },
271
382
  {
272
383
  "type": "object",
273
384
  "properties": {
package/dist/schemas/anyTableColumnQuestion.schema.json CHANGED
@@ -436,26 +436,10 @@
436
436
  "properties": {
437
437
  "type": {
438
438
  "type": "string",
439
- "const": "filteredSearch"
439
+ "const": "licenseSearch"
440
440
  },
441
441
  "attributes": {
442
- "type": "object",
443
- "properties": {
444
- "label": {
445
- "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/label"
446
- },
447
- "help": {
448
- "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/help"
449
- },
450
- "labelTranslationKey": {
451
- "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/labelTranslationKey"
452
- },
453
- "multiple": {
454
- "type": "boolean",
455
- "default": true
456
- }
457
- },
458
- "additionalProperties": false,
442
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes",
459
443
  "default": {}
460
444
  },
461
445
  "meta": {
@@ -484,18 +468,32 @@
484
468
  "additionalProperties": false
485
469
  },
486
470
  "default": [
487
- {}
471
+ {
472
+ "propertyName": "name",
473
+ "label": "Name"
474
+ },
475
+ {
476
+ "propertyName": "description",
477
+ "label": "Description"
478
+ },
479
+ {
480
+ "propertyName": "recommended",
481
+ "label": "Recommended"
482
+ }
488
483
  ]
489
484
  },
490
485
  "localQueryId": {
491
486
  "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/graphQL/properties/localQueryId"
492
487
  },
493
488
  "query": {
494
- "type": "string"
489
+ "type": "string",
490
+ "const": "query Licenses($term: String, $paginationOptions: PaginationOptions){ license(term: $term, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description } } }",
491
+ "default": "query Licenses($term: String, $paginationOptions: PaginationOptions){ license(term: $term, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description } } }"
495
492
  },
496
493
  "responseField": {
497
494
  "type": "string",
498
- "default": "query.items"
495
+ "const": "licenses.items",
496
+ "default": "licenses.items"
499
497
  },
500
498
  "variables": {
501
499
  "type": "array",
@@ -526,8 +524,139 @@
526
524
  "additionalProperties": false
527
525
  },
528
526
  "default": [
529
- {}
527
+ {
528
+ "minLength": 3,
529
+ "label": "Search for a license",
530
+ "name": "term",
531
+ "type": "string"
532
+ },
533
+ {
534
+ "label": "Pagination Options",
535
+ "name": "paginationOptions",
536
+ "type": "paginationOptions",
537
+ "options": {
538
+ "type": "OFFSET",
539
+ "limit": 10,
540
+ "offset": 0,
541
+ "sortField": "name",
542
+ "sortOrder": "ASC"
543
+ }
544
+ }
545
+ ]
546
+ },
547
+ "queryId": {
548
+ "type": "string",
549
+ "default": "useLicensesQuery"
550
+ },
551
+ "answerField": {
552
+ "type": "string",
553
+ "const": "uri",
554
+ "default": "uri"
555
+ }
556
+ },
557
+ "additionalProperties": false,
558
+ "default": {}
559
+ }
560
+ },
561
+ "required": [
562
+ "type"
563
+ ],
564
+ "additionalProperties": false
565
+ },
566
+ {
567
+ "type": "object",
568
+ "properties": {
569
+ "type": {
570
+ "type": "string",
571
+ "const": "metadataStandardSearch"
572
+ },
573
+ "attributes": {
574
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes",
575
+ "default": {}
576
+ },
577
+ "meta": {
578
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/meta"
579
+ },
580
+ "graphQL": {
581
+ "type": "object",
582
+ "properties": {
583
+ "displayFields": {
584
+ "type": "array",
585
+ "items": {
586
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/7/properties/graphQL/properties/displayFields/items"
587
+ },
588
+ "default": [
589
+ {
590
+ "propertyName": "name",
591
+ "label": "Name"
592
+ },
593
+ {
594
+ "propertyName": "description",
595
+ "label": "Description"
596
+ },
597
+ {
598
+ "propertyName": "website",
599
+ "label": "Website"
600
+ },
601
+ {
602
+ "propertyName": "keywords",
603
+ "label": "Subject Areas"
604
+ }
605
+ ]
606
+ },
607
+ "localQueryId": {
608
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/graphQL/properties/localQueryId"
609
+ },
610
+ "query": {
611
+ "type": "string",
612
+ "const": "query MetadataStandards($term: String, $keywords: [String!], $paginationOptions: PaginationOptions){ metadataStandards(term: $term, keywords: $keywords, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description keywords } } }",
613
+ "default": "query MetadataStandards($term: String, $keywords: [String!], $paginationOptions: PaginationOptions){ metadataStandards(term: $term, keywords: $keywords, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description keywords } } }"
614
+ },
615
+ "responseField": {
616
+ "type": "string",
617
+ "const": "metadataStandards.items",
618
+ "default": "metadataStandards.items"
619
+ },
620
+ "variables": {
621
+ "type": "array",
622
+ "items": {
623
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/7/properties/graphQL/properties/variables/items"
624
+ },
625
+ "default": [
626
+ {
627
+ "minLength": 3,
628
+ "label": "Search for a metadata standard",
629
+ "name": "term",
630
+ "type": "string"
631
+ },
632
+ {
633
+ "minLength": 3,
634
+ "label": "Subject Areas",
635
+ "name": "keywords",
636
+ "type": "string"
637
+ },
638
+ {
639
+ "label": "Pagination Options",
640
+ "name": "paginationOptions",
641
+ "type": "paginationOptions",
642
+ "options": {
643
+ "type": "OFFSET",
644
+ "limit": 10,
645
+ "offset": 0,
646
+ "sortField": "name",
647
+ "sortOrder": "ASC"
648
+ }
649
+ }
530
650
  ]
651
+ },
652
+ "queryId": {
653
+ "type": "string",
654
+ "default": "useMetadataStandardsQuery"
655
+ },
656
+ "answerField": {
657
+ "type": "string",
658
+ "const": "uri",
659
+ "default": "uri"
531
660
  }
532
661
  },
533
662
  "additionalProperties": false,
@@ -580,6 +709,68 @@
580
709
  ],
581
710
  "additionalProperties": false
582
711
  },
712
+ {
713
+ "type": "object",
714
+ "properties": {
715
+ "type": {
716
+ "type": "string",
717
+ "const": "numberWithContext"
718
+ },
719
+ "attributes": {
720
+ "type": "object",
721
+ "properties": {
722
+ "label": {
723
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/label"
724
+ },
725
+ "help": {
726
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/help"
727
+ },
728
+ "labelTranslationKey": {
729
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes/properties/labelTranslationKey"
730
+ },
731
+ "max": {
732
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/3/properties/attributes/properties/max"
733
+ },
734
+ "min": {
735
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/3/properties/attributes/properties/min"
736
+ },
737
+ "step": {
738
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/3/properties/attributes/properties/step"
739
+ },
740
+ "context": {
741
+ "type": "array",
742
+ "items": {
743
+ "type": "object",
744
+ "properties": {
745
+ "label": {
746
+ "type": "string",
747
+ "default": ""
748
+ },
749
+ "labelTranslationKey": {
750
+ "type": "string"
751
+ },
752
+ "value": {
753
+ "type": "string",
754
+ "default": ""
755
+ }
756
+ },
757
+ "additionalProperties": false
758
+ },
759
+ "default": []
760
+ }
761
+ },
762
+ "additionalProperties": false,
763
+ "default": {}
764
+ },
765
+ "meta": {
766
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/meta"
767
+ }
768
+ },
769
+ "required": [
770
+ "type"
771
+ ],
772
+ "additionalProperties": false
773
+ },
583
774
  {
584
775
  "type": "object",
585
776
  "properties": {
@@ -622,6 +813,117 @@
622
813
  ],
623
814
  "additionalProperties": false
624
815
  },
816
+ {
817
+ "type": "object",
818
+ "properties": {
819
+ "type": {
820
+ "type": "string",
821
+ "const": "repositorySearch"
822
+ },
823
+ "attributes": {
824
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/attributes",
825
+ "default": {}
826
+ },
827
+ "meta": {
828
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/meta"
829
+ },
830
+ "graphQL": {
831
+ "type": "object",
832
+ "properties": {
833
+ "displayFields": {
834
+ "type": "array",
835
+ "items": {
836
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/7/properties/graphQL/properties/displayFields/items"
837
+ },
838
+ "default": [
839
+ {
840
+ "propertyName": "name",
841
+ "label": "Name"
842
+ },
843
+ {
844
+ "propertyName": "description",
845
+ "label": "Description"
846
+ },
847
+ {
848
+ "propertyName": "website",
849
+ "label": "Website"
850
+ },
851
+ {
852
+ "propertyName": "keywords",
853
+ "label": "Subject Areas"
854
+ }
855
+ ]
856
+ },
857
+ "localQueryId": {
858
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/0/properties/graphQL/properties/localQueryId"
859
+ },
860
+ "query": {
861
+ "type": "string",
862
+ "const": "query Repositories($term: String, $keywords: [String!], $repositoryType: String, $paginationOptions: PaginationOptions){ repositories(term: $term, keywords: $keywords, repositoryType: $repositoryType, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description website keywords repositoryTypes } } }",
863
+ "default": "query Repositories($term: String, $keywords: [String!], $repositoryType: String, $paginationOptions: PaginationOptions){ repositories(term: $term, keywords: $keywords, repositoryType: $repositoryType, paginationOptions: $paginationOptions) { totalCount currentOffset limit hasNextPage hasPreviousPage availableSortFields items { id name uri description website keywords repositoryTypes } } }"
864
+ },
865
+ "responseField": {
866
+ "type": "string",
867
+ "const": "repositories.items",
868
+ "default": "repositories.items"
869
+ },
870
+ "variables": {
871
+ "type": "array",
872
+ "items": {
873
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/7/properties/graphQL/properties/variables/items"
874
+ },
875
+ "default": [
876
+ {
877
+ "minLength": 3,
878
+ "label": "Search for a repository",
879
+ "name": "term",
880
+ "type": "string"
881
+ },
882
+ {
883
+ "minLength": 3,
884
+ "label": "Subject Areas",
885
+ "name": "keywords",
886
+ "type": "string"
887
+ },
888
+ {
889
+ "minLength": 3,
890
+ "label": "Repository type",
891
+ "name": "repositoryType",
892
+ "type": "string"
893
+ },
894
+ {
895
+ "label": "Pagination Options",
896
+ "name": "paginationOptions",
897
+ "type": "paginationOptions",
898
+ "options": {
899
+ "type": "OFFSET",
900
+ "limit": 10,
901
+ "offset": 0,
902
+ "sortField": "name",
903
+ "sortOrder": "ASC"
904
+ }
905
+ }
906
+ ]
907
+ },
908
+ "queryId": {
909
+ "type": "string",
910
+ "default": "useRepositoriesQuery"
911
+ },
912
+ "answerField": {
913
+ "type": "string",
914
+ "const": "uri",
915
+ "default": "uri"
916
+ }
917
+ },
918
+ "additionalProperties": false,
919
+ "default": {}
920
+ }
921
+ },
922
+ "required": [
923
+ "type"
924
+ ],
925
+ "additionalProperties": false
926
+ },
625
927
  {
626
928
  "type": "object",
627
929
  "properties": {
@@ -660,7 +962,7 @@
660
962
  "options": {
661
963
  "type": "array",
662
964
  "items": {
663
- "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/9/properties/options/items"
965
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/11/properties/options/items"
664
966
  },
665
967
  "default": [
666
968
  {}
@@ -771,7 +1073,7 @@
771
1073
  "const": "url"
772
1074
  },
773
1075
  "attributes": {
774
- "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/12/properties/attributes",
1076
+ "$ref": "#/definitions/AnyTableColumnQuestion/anyOf/15/properties/attributes",
775
1077
  "default": {}
776
1078
  },
777
1079
  "meta": {
package/dist/schemas/licenseSearchAnswer.schema.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "$ref": "#/definitions/LicenseSearchAnswer",
3
+ "definitions": {
4
+ "LicenseSearchAnswer": {
5
+ "type": "object",
6
+ "properties": {
7
+ "type": {
8
+ "type": "string",
9
+ "const": "licenseSearch"
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
+ "answer": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "object",
26
+ "properties": {
27
+ "licenseId": {
28
+ "type": "string",
29
+ "default": ""
30
+ },
31
+ "licenseName": {
32
+ "type": "string",
33
+ "default": ""
34
+ }
35
+ },
36
+ "additionalProperties": false,
37
+ "default": {}
38
+ },
39
+ "default": []
40
+ }
41
+ },
42
+ "required": [
43
+ "type"
44
+ ],
45
+ "additionalProperties": false
46
+ }
47
+ },
48
+ "$schema": "http://json-schema.org/draft-07/schema#"
49
+ }