@dmptool/types 2.2.1 → 2.3.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 (26) hide show
  1. package/dist/answers/__tests__/answers.spec.js +27 -14
  2. package/dist/answers/__tests__/defaults.spec.js +2 -0
  3. package/dist/answers/index.d.ts +102 -0
  4. package/dist/answers/index.js +1 -0
  5. package/dist/answers/tableAnswers.d.ts +614 -136
  6. package/dist/answers/tableAnswers.js +43 -20
  7. package/dist/dmp/__tests__/commonStandard.spec.js +26 -22
  8. package/dist/dmp/__tests__/extensions.spec.js +21 -15
  9. package/dist/dmp/extension.d.ts +385 -92
  10. package/dist/dmp/extension.js +49 -103
  11. package/dist/dmp/index.d.ts +515 -2
  12. package/dist/dmp/index.js +11 -1
  13. package/dist/questions/__tests__/defaults.spec.js +10 -0
  14. package/dist/questions/__tests__/tableQuestion.spec.js +5 -0
  15. package/dist/questions/index.d.ts +10 -0
  16. package/dist/questions/tableQuestions.d.ts +30 -0
  17. package/dist/questions/tableQuestions.js +47 -10
  18. package/dist/schemas/anyAnswer.schema.json +514 -0
  19. package/dist/schemas/anyQuestion.schema.json +30 -0
  20. package/dist/schemas/dmpExtension.schema.json +636 -140
  21. package/dist/schemas/researchOutputTableAnswer.schema.json +6047 -11983
  22. package/package.json +1 -1
  23. package/schemas/anyAnswer.schema.json +514 -0
  24. package/schemas/anyQuestion.schema.json +30 -0
  25. package/schemas/dmpExtension.schema.json +636 -140
  26. package/schemas/researchOutputTableAnswer.schema.json +6047 -11983
package/dist/dmp/extension.d.ts CHANGED
@@ -1,11 +1,6 @@
1
1
  import { z } from 'zod';
2
2
  export declare const DefaultNarrative: {
3
- download_urls?: {
4
- csv?: string | undefined;
5
- docx?: string | undefined;
6
- html?: string | undefined;
7
- pdf?: string | undefined;
8
- } | undefined;
3
+ download_url?: string | undefined;
9
4
  template?: {
10
5
  id: number;
11
6
  title: string;
@@ -317,6 +312,108 @@ export declare const DefaultNarrative: {
317
312
  schemaVersion: string;
318
313
  };
319
314
  comment?: string | undefined;
315
+ } | {
316
+ type: "researchOutputTable";
317
+ columnHeadings: string[];
318
+ answer: {
319
+ columns: ({
320
+ type: "checkBoxes";
321
+ answer: string[];
322
+ meta: {
323
+ schemaVersion: string;
324
+ };
325
+ commonStandardId?: string | undefined;
326
+ comment?: string | undefined;
327
+ } | {
328
+ type: "date";
329
+ answer: string;
330
+ meta: {
331
+ schemaVersion: string;
332
+ };
333
+ commonStandardId?: string | undefined;
334
+ comment?: string | undefined;
335
+ } | {
336
+ type: "licenseSearch";
337
+ answer: {
338
+ licenseId: string;
339
+ licenseName: string;
340
+ }[];
341
+ meta: {
342
+ schemaVersion: string;
343
+ };
344
+ commonStandardId?: string | undefined;
345
+ comment?: string | undefined;
346
+ } | {
347
+ type: "metadataStandardSearch";
348
+ answer: {
349
+ metadataStandardId: string;
350
+ metadataStandardName: string;
351
+ }[];
352
+ meta: {
353
+ schemaVersion: string;
354
+ };
355
+ commonStandardId?: string | undefined;
356
+ comment?: string | undefined;
357
+ } | {
358
+ type: "numberWithContext";
359
+ answer: {
360
+ value: number;
361
+ context: string;
362
+ };
363
+ meta: {
364
+ schemaVersion: string;
365
+ };
366
+ commonStandardId?: string | undefined;
367
+ comment?: string | undefined;
368
+ } | {
369
+ type: "radioButtons";
370
+ answer: string;
371
+ meta: {
372
+ schemaVersion: string;
373
+ };
374
+ commonStandardId?: string | undefined;
375
+ comment?: string | undefined;
376
+ } | {
377
+ type: "repositorySearch";
378
+ answer: {
379
+ repositoryId: string;
380
+ repositoryName: string;
381
+ }[];
382
+ meta: {
383
+ schemaVersion: string;
384
+ };
385
+ commonStandardId?: string | undefined;
386
+ comment?: string | undefined;
387
+ } | {
388
+ type: "selectBox";
389
+ answer: string;
390
+ meta: {
391
+ schemaVersion: string;
392
+ };
393
+ commonStandardId?: string | undefined;
394
+ comment?: string | undefined;
395
+ } | {
396
+ type: "text";
397
+ answer: string;
398
+ meta: {
399
+ schemaVersion: string;
400
+ };
401
+ commonStandardId?: string | undefined;
402
+ comment?: string | undefined;
403
+ } | {
404
+ type: "textArea";
405
+ answer: string;
406
+ meta: {
407
+ schemaVersion: string;
408
+ };
409
+ commonStandardId?: string | undefined;
410
+ comment?: string | undefined;
411
+ })[];
412
+ }[];
413
+ meta: {
414
+ schemaVersion: string;
415
+ };
416
+ comment?: string | undefined;
320
417
  };
321
418
  } | undefined;
322
419
  }[];
@@ -327,7 +424,11 @@ export declare const DefaultNarrative: {
327
424
  } | undefined;
328
425
  };
329
426
  export declare const ExtensionSchema: z.ZodObject<{
427
+ rda_schema_version: z.ZodDefault<z.ZodString>;
330
428
  provenance: z.ZodString;
429
+ status: z.ZodDefault<z.ZodEnum<{
430
+ [x: string]: string;
431
+ }>>;
331
432
  privacy: z.ZodDefault<z.ZodEnum<{
332
433
  [x: string]: string;
333
434
  }>>;
@@ -336,13 +437,9 @@ export declare const ExtensionSchema: z.ZodObject<{
336
437
  no: "no";
337
438
  }>>;
338
439
  registered: z.ZodOptional<z.ZodISODateTime>;
440
+ tombstoned: z.ZodOptional<z.ZodISODateTime>;
339
441
  narrative: z.ZodOptional<z.ZodObject<{
340
- download_urls: z.ZodOptional<z.ZodObject<{
341
- csv: z.ZodOptional<z.ZodString>;
342
- docx: z.ZodOptional<z.ZodString>;
343
- html: z.ZodOptional<z.ZodString>;
344
- pdf: z.ZodOptional<z.ZodString>;
345
- }, z.core.$strip>>;
442
+ download_url: z.ZodOptional<z.ZodString>;
346
443
  template: z.ZodOptional<z.ZodObject<{
347
444
  id: z.ZodNumber;
348
445
  title: z.ZodString;
@@ -475,6 +572,108 @@ export declare const ExtensionSchema: z.ZodObject<{
475
572
  schemaVersion: z.ZodDefault<z.ZodString>;
476
573
  }, z.core.$strip>;
477
574
  comment: z.ZodOptional<z.ZodString>;
575
+ }, z.core.$strip>, z.ZodObject<{
576
+ type: z.ZodLiteral<"researchOutputTable">;
577
+ columnHeadings: z.ZodDefault<z.ZodArray<z.ZodString>>;
578
+ answer: z.ZodArray<z.ZodObject<{
579
+ columns: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
580
+ commonStandardId: z.ZodOptional<z.ZodString>;
581
+ type: z.ZodLiteral<"checkBoxes">;
582
+ answer: z.ZodDefault<z.ZodArray<z.ZodString>>;
583
+ meta: z.ZodObject<{
584
+ schemaVersion: z.ZodDefault<z.ZodString>;
585
+ }, z.core.$strip>;
586
+ comment: z.ZodOptional<z.ZodString>;
587
+ }, z.core.$strip>, z.ZodObject<{
588
+ commonStandardId: z.ZodOptional<z.ZodString>;
589
+ type: z.ZodLiteral<"date">;
590
+ answer: z.ZodDefault<z.ZodString>;
591
+ meta: z.ZodObject<{
592
+ schemaVersion: z.ZodDefault<z.ZodString>;
593
+ }, z.core.$strip>;
594
+ comment: z.ZodOptional<z.ZodString>;
595
+ }, z.core.$strip>, z.ZodObject<{
596
+ commonStandardId: z.ZodOptional<z.ZodString>;
597
+ type: z.ZodLiteral<"licenseSearch">;
598
+ answer: z.ZodDefault<z.ZodArray<z.ZodObject<{
599
+ licenseId: z.ZodDefault<z.ZodString>;
600
+ licenseName: z.ZodDefault<z.ZodString>;
601
+ }, z.core.$strip>>>;
602
+ meta: z.ZodObject<{
603
+ schemaVersion: z.ZodDefault<z.ZodString>;
604
+ }, z.core.$strip>;
605
+ comment: z.ZodOptional<z.ZodString>;
606
+ }, z.core.$strip>, z.ZodObject<{
607
+ commonStandardId: z.ZodOptional<z.ZodString>;
608
+ type: z.ZodLiteral<"metadataStandardSearch">;
609
+ answer: z.ZodDefault<z.ZodArray<z.ZodObject<{
610
+ metadataStandardId: z.ZodDefault<z.ZodString>;
611
+ metadataStandardName: z.ZodDefault<z.ZodString>;
612
+ }, z.core.$strip>>>;
613
+ meta: z.ZodObject<{
614
+ schemaVersion: z.ZodDefault<z.ZodString>;
615
+ }, z.core.$strip>;
616
+ comment: z.ZodOptional<z.ZodString>;
617
+ }, z.core.$strip>, z.ZodObject<{
618
+ commonStandardId: z.ZodOptional<z.ZodString>;
619
+ type: z.ZodLiteral<"numberWithContext">;
620
+ answer: z.ZodObject<{
621
+ value: z.ZodDefault<z.ZodNumber>;
622
+ context: z.ZodDefault<z.ZodString>;
623
+ }, z.core.$strip>;
624
+ meta: z.ZodObject<{
625
+ schemaVersion: z.ZodDefault<z.ZodString>;
626
+ }, z.core.$strip>;
627
+ comment: z.ZodOptional<z.ZodString>;
628
+ }, z.core.$strip>, z.ZodObject<{
629
+ commonStandardId: z.ZodOptional<z.ZodString>;
630
+ type: z.ZodLiteral<"radioButtons">;
631
+ answer: z.ZodDefault<z.ZodString>;
632
+ meta: z.ZodObject<{
633
+ schemaVersion: z.ZodDefault<z.ZodString>;
634
+ }, z.core.$strip>;
635
+ comment: z.ZodOptional<z.ZodString>;
636
+ }, z.core.$strip>, z.ZodObject<{
637
+ commonStandardId: z.ZodOptional<z.ZodString>;
638
+ type: z.ZodLiteral<"repositorySearch">;
639
+ answer: z.ZodDefault<z.ZodArray<z.ZodObject<{
640
+ repositoryId: z.ZodDefault<z.ZodString>;
641
+ repositoryName: z.ZodDefault<z.ZodString>;
642
+ }, z.core.$strip>>>;
643
+ meta: z.ZodObject<{
644
+ schemaVersion: z.ZodDefault<z.ZodString>;
645
+ }, z.core.$strip>;
646
+ comment: z.ZodOptional<z.ZodString>;
647
+ }, z.core.$strip>, z.ZodObject<{
648
+ commonStandardId: z.ZodOptional<z.ZodString>;
649
+ type: z.ZodLiteral<"selectBox">;
650
+ answer: z.ZodDefault<z.ZodString>;
651
+ meta: z.ZodObject<{
652
+ schemaVersion: z.ZodDefault<z.ZodString>;
653
+ }, z.core.$strip>;
654
+ comment: z.ZodOptional<z.ZodString>;
655
+ }, z.core.$strip>, z.ZodObject<{
656
+ commonStandardId: z.ZodOptional<z.ZodString>;
657
+ type: z.ZodLiteral<"text">;
658
+ answer: z.ZodDefault<z.ZodString>;
659
+ meta: z.ZodObject<{
660
+ schemaVersion: z.ZodDefault<z.ZodString>;
661
+ }, z.core.$strip>;
662
+ comment: z.ZodOptional<z.ZodString>;
663
+ }, z.core.$strip>, z.ZodObject<{
664
+ commonStandardId: z.ZodOptional<z.ZodString>;
665
+ type: z.ZodLiteral<"textArea">;
666
+ answer: z.ZodDefault<z.ZodString>;
667
+ meta: z.ZodObject<{
668
+ schemaVersion: z.ZodDefault<z.ZodString>;
669
+ }, z.core.$strip>;
670
+ comment: z.ZodOptional<z.ZodString>;
671
+ }, z.core.$strip>], "type">>;
672
+ }, z.core.$strip>>;
673
+ meta: z.ZodObject<{
674
+ schemaVersion: z.ZodDefault<z.ZodString>;
675
+ }, z.core.$strip>;
676
+ comment: z.ZodOptional<z.ZodString>;
478
677
  }, z.core.$strip>, z.ZodObject<{
479
678
  type: z.ZodLiteral<"selectBox">;
480
679
  answer: z.ZodDefault<z.ZodString>;
@@ -665,95 +864,80 @@ export declare const ExtensionSchema: z.ZodObject<{
665
864
  }, z.core.$strip>>;
666
865
  research_domain: z.ZodOptional<z.ZodObject<{
667
866
  name: z.ZodString;
668
- research_domain_identifier: z.ZodObject<{
669
- identifier: z.ZodOptional<z.ZodString>;
670
- type: z.ZodDefault<z.ZodEnum<{
671
- url: "url";
672
- other: "other";
673
- ark: "ark";
674
- doi: "doi";
675
- handle: "handle";
676
- }>>;
677
- }, z.core.$strip>;
867
+ research_domain_identifier: z.ZodOptional<z.ZodObject<{
868
+ identifier: z.ZodString;
869
+ type: z.ZodEnum<{
870
+ [x: string]: string;
871
+ }>;
872
+ }, z.core.$strip>>;
678
873
  }, z.core.$strip>>;
679
- related_identifier: z.ZodOptional<z.ZodArray<z.ZodObject<{
680
- descriptor: z.ZodDefault<z.ZodEnum<{
681
- [x: string]: string;
682
- }>>;
683
- identifier: z.ZodString;
684
- type: z.ZodDefault<z.ZodEnum<{
685
- url: "url";
686
- ark: "ark";
687
- doi: "doi";
688
- handle: "handle";
689
- }>>;
690
- work_type: z.ZodDefault<z.ZodEnum<{
691
- [x: string]: string;
692
- }>>;
693
- }, z.core.$strip>>>;
694
874
  research_facility: z.ZodOptional<z.ZodArray<z.ZodObject<{
695
875
  name: z.ZodString;
696
- type: z.ZodDefault<z.ZodEnum<{
876
+ type: z.ZodEnum<{
697
877
  [x: string]: string;
698
- }>>;
699
- research_facility_identifier: z.ZodObject<{
878
+ }>;
879
+ research_facility_identifier: z.ZodOptional<z.ZodObject<{
700
880
  identifier: z.ZodString;
701
- type: z.ZodDefault<z.ZodEnum<{
702
- url: "url";
703
- other: "other";
704
- ark: "ark";
705
- doi: "doi";
706
- handle: "handle";
707
- }>>;
708
- }, z.core.$strip>;
881
+ type: z.ZodEnum<{
882
+ [x: string]: string;
883
+ }>;
884
+ }, z.core.$strip>>;
709
885
  }, z.core.$strip>>>;
710
886
  version: z.ZodOptional<z.ZodArray<z.ZodObject<{
711
887
  access_url: z.ZodString;
712
- version_date: z.ZodISODateTime;
888
+ version: z.ZodISODateTime;
713
889
  }, z.core.$strip>>>;
714
890
  funding_opportunity: z.ZodOptional<z.ZodArray<z.ZodObject<{
715
891
  project_id: z.ZodObject<{
716
892
  identifier: z.ZodString;
717
- type: z.ZodDefault<z.ZodEnum<{
718
- url: "url";
719
- other: "other";
720
- ark: "ark";
721
- doi: "doi";
722
- handle: "handle";
723
- }>>;
893
+ type: z.ZodEnum<{
894
+ [x: string]: string;
895
+ }>;
724
896
  }, z.core.$strip>;
725
897
  funder_id: z.ZodObject<{
726
898
  identifier: z.ZodString;
727
- type: z.ZodDefault<z.ZodEnum<{
728
- url: "url";
729
- other: "other";
730
- ror: "ror";
731
- }>>;
899
+ type: z.ZodEnum<{
900
+ [x: string]: string;
901
+ }>;
732
902
  }, z.core.$strip>;
733
903
  opportunity_identifier: z.ZodObject<{
734
904
  identifier: z.ZodString;
735
- type: z.ZodDefault<z.ZodEnum<{
736
- url: "url";
737
- other: "other";
738
- ark: "ark";
739
- doi: "doi";
740
- handle: "handle";
741
- }>>;
905
+ type: z.ZodEnum<{
906
+ [x: string]: string;
907
+ }>;
908
+ }, z.core.$strip>;
909
+ }, z.core.$strip>>>;
910
+ funding_project: z.ZodOptional<z.ZodArray<z.ZodObject<{
911
+ project_id: z.ZodObject<{
912
+ identifier: z.ZodString;
913
+ type: z.ZodEnum<{
914
+ [x: string]: string;
915
+ }>;
916
+ }, z.core.$strip>;
917
+ funder_id: z.ZodObject<{
918
+ identifier: z.ZodString;
919
+ type: z.ZodEnum<{
920
+ [x: string]: string;
921
+ }>;
922
+ }, z.core.$strip>;
923
+ project_identifier: z.ZodObject<{
924
+ identifier: z.ZodString;
925
+ type: z.ZodEnum<{
926
+ [x: string]: string;
927
+ }>;
742
928
  }, z.core.$strip>;
743
929
  }, z.core.$strip>>>;
744
930
  }, z.core.$strip>;
745
931
  export declare const DefaultExtensionSchema: {
932
+ rda_schema_version: string;
746
933
  provenance: string;
934
+ status: string;
747
935
  privacy: string;
748
936
  featured: "yes" | "no";
749
937
  registered?: string | undefined;
938
+ tombstoned?: string | undefined;
750
939
  narrative?: {
751
- download_urls?: {
752
- csv?: string | undefined;
753
- docx?: string | undefined;
754
- html?: string | undefined;
755
- pdf?: string | undefined;
756
- } | undefined;
940
+ download_url?: string | undefined;
757
941
  template?: {
758
942
  id: number;
759
943
  title: string;
@@ -1065,6 +1249,108 @@ export declare const DefaultExtensionSchema: {
1065
1249
  schemaVersion: string;
1066
1250
  };
1067
1251
  comment?: string | undefined;
1252
+ } | {
1253
+ type: "researchOutputTable";
1254
+ columnHeadings: string[];
1255
+ answer: {
1256
+ columns: ({
1257
+ type: "checkBoxes";
1258
+ answer: string[];
1259
+ meta: {
1260
+ schemaVersion: string;
1261
+ };
1262
+ commonStandardId?: string | undefined;
1263
+ comment?: string | undefined;
1264
+ } | {
1265
+ type: "date";
1266
+ answer: string;
1267
+ meta: {
1268
+ schemaVersion: string;
1269
+ };
1270
+ commonStandardId?: string | undefined;
1271
+ comment?: string | undefined;
1272
+ } | {
1273
+ type: "licenseSearch";
1274
+ answer: {
1275
+ licenseId: string;
1276
+ licenseName: string;
1277
+ }[];
1278
+ meta: {
1279
+ schemaVersion: string;
1280
+ };
1281
+ commonStandardId?: string | undefined;
1282
+ comment?: string | undefined;
1283
+ } | {
1284
+ type: "metadataStandardSearch";
1285
+ answer: {
1286
+ metadataStandardId: string;
1287
+ metadataStandardName: string;
1288
+ }[];
1289
+ meta: {
1290
+ schemaVersion: string;
1291
+ };
1292
+ commonStandardId?: string | undefined;
1293
+ comment?: string | undefined;
1294
+ } | {
1295
+ type: "numberWithContext";
1296
+ answer: {
1297
+ value: number;
1298
+ context: string;
1299
+ };
1300
+ meta: {
1301
+ schemaVersion: string;
1302
+ };
1303
+ commonStandardId?: string | undefined;
1304
+ comment?: string | undefined;
1305
+ } | {
1306
+ type: "radioButtons";
1307
+ answer: string;
1308
+ meta: {
1309
+ schemaVersion: string;
1310
+ };
1311
+ commonStandardId?: string | undefined;
1312
+ comment?: string | undefined;
1313
+ } | {
1314
+ type: "repositorySearch";
1315
+ answer: {
1316
+ repositoryId: string;
1317
+ repositoryName: string;
1318
+ }[];
1319
+ meta: {
1320
+ schemaVersion: string;
1321
+ };
1322
+ commonStandardId?: string | undefined;
1323
+ comment?: string | undefined;
1324
+ } | {
1325
+ type: "selectBox";
1326
+ answer: string;
1327
+ meta: {
1328
+ schemaVersion: string;
1329
+ };
1330
+ commonStandardId?: string | undefined;
1331
+ comment?: string | undefined;
1332
+ } | {
1333
+ type: "text";
1334
+ answer: string;
1335
+ meta: {
1336
+ schemaVersion: string;
1337
+ };
1338
+ commonStandardId?: string | undefined;
1339
+ comment?: string | undefined;
1340
+ } | {
1341
+ type: "textArea";
1342
+ answer: string;
1343
+ meta: {
1344
+ schemaVersion: string;
1345
+ };
1346
+ commonStandardId?: string | undefined;
1347
+ comment?: string | undefined;
1348
+ })[];
1349
+ }[];
1350
+ meta: {
1351
+ schemaVersion: string;
1352
+ };
1353
+ comment?: string | undefined;
1068
1354
  };
1069
1355
  } | undefined;
1070
1356
  }[];
@@ -1076,42 +1362,49 @@ export declare const DefaultExtensionSchema: {
1076
1362
  } | undefined;
1077
1363
  research_domain?: {
1078
1364
  name: string;
1079
- research_domain_identifier: {
1080
- type: "url" | "other" | "ark" | "doi" | "handle";
1081
- identifier?: string | undefined;
1082
- };
1365
+ research_domain_identifier?: {
1366
+ identifier: string;
1367
+ type: string;
1368
+ } | undefined;
1083
1369
  } | undefined;
1084
- related_identifier?: {
1085
- descriptor: string;
1086
- identifier: string;
1087
- type: "url" | "ark" | "doi" | "handle";
1088
- work_type: string;
1089
- }[] | undefined;
1090
1370
  research_facility?: {
1091
1371
  name: string;
1092
1372
  type: string;
1093
- research_facility_identifier: {
1373
+ research_facility_identifier?: {
1094
1374
  identifier: string;
1095
- type: "url" | "other" | "ark" | "doi" | "handle";
1096
- };
1375
+ type: string;
1376
+ } | undefined;
1097
1377
  }[] | undefined;
1098
1378
  version?: {
1099
1379
  access_url: string;
1100
- version_date: string;
1380
+ version: string;
1101
1381
  }[] | undefined;
1102
1382
  funding_opportunity?: {
1103
1383
  project_id: {
1104
1384
  identifier: string;
1105
- type: "url" | "other" | "ark" | "doi" | "handle";
1385
+ type: string;
1106
1386
  };
1107
1387
  funder_id: {
1108
1388
  identifier: string;
1109
- type: "url" | "other" | "ror";
1389
+ type: string;
1110
1390
  };
1111
1391
  opportunity_identifier: {
1112
1392
  identifier: string;
1113
- type: "url" | "other" | "ark" | "doi" | "handle";
1393
+ type: string;
1394
+ };
1395
+ }[] | undefined;
1396
+ funding_project?: {
1397
+ project_id: {
1398
+ identifier: string;
1399
+ type: string;
1400
+ };
1401
+ funder_id: {
1402
+ identifier: string;
1403
+ type: string;
1404
+ };
1405
+ project_identifier: {
1406
+ identifier: string;
1407
+ type: string;
1114
1408
  };
1115
1409
  }[] | undefined;
1116
1410
  };
1117
- export type ExtensionType = z.infer<typeof ExtensionSchema>;