@dmptool/types 2.2.0 → 2.3.0

package/dist/answers/tableAnswers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyTableColumnAnswerJSONSchema = exports.ResearchOutputTableAnswerJSONSchema = exports.TableAnswerJSONSchema = exports.DefaultResearchOutputTableAnswer = exports.ResearchOutputTableAnswerSchema = exports.DefaultTableAnswer = exports.TableAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
+exports.AnyTableColumnAnswerJSONSchema = exports.ResearchOutputTableRowAnswerJSONSchema = exports.TableRowAnswerJSONSchema = exports.ResearchOutputTableAnswerJSONSchema = exports.TableAnswerJSONSchema = exports.DefaultResearchOutputTableAnswer = exports.ResearchOutputTableAnswerSchema = exports.DefaultTableAnswer = exports.TableAnswerSchema = exports.DefaultResearchOutputTableRowAnswer = exports.ResearchOutputTableRowAnswerSchema = exports.DefaultTableRowAnswer = exports.TableRowAnswerSchema = exports.AnyResearchOutputTableColumnAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 const optionBasedAnswers_1 = require("./optionBasedAnswers");
@@ -30,40 +30,63 @@ exports.AnyTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
     textAnswers_1.TextAreaAnswerSchema,
     textAnswers_1.URLAnswerSchema
 ]);
-const TableRowAnswerSchema = zod_1.z.object({
+// A subset of AnyTableColumnAnswerSchema that includes the commonStandardId field.
+// This is used to map answers in the Research Output table to elements of the
+// RDA Common Standard.
+const roCheckBoxesAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, optionBasedAnswers_1.CheckboxesAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roDateAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, dateAnswers_1.DateAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roLicenseSearchAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, graphQLAnswers_1.LicenseSearchAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roMetadataStandardSearchAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, graphQLAnswers_1.MetadataStandardSearchAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roNumberWithContextAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, numberAnswers_1.NumberWithContextAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roRadioButtonsAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, optionBasedAnswers_1.RadioButtonsAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roRepositorySearchAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, graphQLAnswers_1.RepositorySearchAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roSelectBoxAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, optionBasedAnswers_1.SelectBoxAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roTextAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, textAnswers_1.TextAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+const roTextAreaAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, textAnswers_1.TextAreaAnswerSchema.shape), { commonStandardId: zod_1.z.string().optional() }));
+exports.AnyResearchOutputTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
+    roCheckBoxesAnswerSchema,
+    roDateAnswerSchema,
+    roLicenseSearchAnswerSchema,
+    roMetadataStandardSearchAnswerSchema,
+    roNumberWithContextAnswerSchema,
+    roRadioButtonsAnswerSchema,
+    roRepositorySearchAnswerSchema,
+    roSelectBoxAnswerSchema,
+    roTextAnswerSchema,
+    roTextAreaAnswerSchema
+]);
+exports.TableRowAnswerSchema = zod_1.z.object({
     columns: zod_1.z.array(exports.AnyTableColumnAnswerSchema) // The answers for each column in the row
 });
-const DefaultTableRowAnswer = TableRowAnswerSchema.parse({
+exports.DefaultTableRowAnswer = exports.TableRowAnswerSchema.parse({
     columns: [textAnswers_1.DefaultTextAreaAnswer]
 });
+exports.ResearchOutputTableRowAnswerSchema = zod_1.z.object({
+    columns: zod_1.z.array(exports.AnyResearchOutputTableColumnAnswerSchema)
+});
+exports.DefaultResearchOutputTableRowAnswer = exports.ResearchOutputTableRowAnswerSchema.parse({
+    columns: [
+        Object.assign(Object.assign({}, textAnswers_1.DefaultTextAnswer), { commonStandardId: 'title' }),
+        Object.assign(Object.assign({}, optionBasedAnswers_1.DefaultSelectBoxAnswer), { commonStandardId: 'type' }),
+    ]
+});
 // Answers to Table Question Types
-exports.TableAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, answer_1.AnswerSchema.shape), { type: zod_1.z.literal('table'), columnHeadings: zod_1.z.array(zod_1.z.string()).default(['Column A']), answer: zod_1.z.array(TableRowAnswerSchema) }));
+exports.TableAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, answer_1.AnswerSchema.shape), { type: zod_1.z.literal('table'), columnHeadings: zod_1.z.array(zod_1.z.string()).default(['Column A']), answer: zod_1.z.array(exports.TableRowAnswerSchema) }));
 exports.DefaultTableAnswer = exports.TableAnswerSchema.parse({
     type: 'table',
     columnHeadings: ['Column A'],
-    answer: [DefaultTableRowAnswer],
+    answer: [exports.DefaultTableRowAnswer],
     meta: questions_1.DefaultMeta
 });
-exports.ResearchOutputTableAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, exports.TableAnswerSchema.shape), { type: zod_1.z.literal('researchOutputTable'), columnHeadings: zod_1.z.array(zod_1.z.string()).default(['Title', 'Type']) }));
+exports.ResearchOutputTableAnswerSchema = zod_1.z.object(Object.assign(Object.assign({}, exports.TableAnswerSchema.shape), { type: zod_1.z.literal('researchOutputTable'), columnHeadings: zod_1.z.array(zod_1.z.string()).default(['Title', 'Type']), answer: zod_1.z.array(exports.ResearchOutputTableRowAnswerSchema) }));
 exports.DefaultResearchOutputTableAnswer = exports.ResearchOutputTableAnswerSchema.parse({
     type: 'researchOutputTable',
     columnHeadings: ['Title', 'Type'],
-    answer: [{
-            columns: [
-                {
-                    type: 'text',
-                    answer: '',
-                    meta: questions_1.DefaultMeta
-                },
-                {
-                    type: 'selectBox',
-                    answer: '',
-                    meta: questions_1.DefaultMeta
-                }
-            ]
-        }],
+    answer: [exports.DefaultResearchOutputTableRowAnswer],
     meta: questions_1.DefaultMeta
 });
 exports.TableAnswerJSONSchema = zod_1.z.toJSONSchema(exports.TableAnswerSchema);
 exports.ResearchOutputTableAnswerJSONSchema = zod_1.z.toJSONSchema(exports.ResearchOutputTableAnswerSchema);
+exports.TableRowAnswerJSONSchema = zod_1.z.toJSONSchema(exports.TableRowAnswerSchema);
+exports.ResearchOutputTableRowAnswerJSONSchema = zod_1.z.toJSONSchema(exports.ResearchOutputTableRowAnswerSchema);
 exports.AnyTableColumnAnswerJSONSchema = zod_1.z.toJSONSchema(exports.AnyTableColumnAnswerSchema);

package/dist/dmp/__tests__/commonStandard.spec.js

@@ -24,10 +24,10 @@ describe('validate the RDA common standard', () => {
                 contact: {
                     name: 'Test Contact',
                     mbox: 'tester@example.com',
-                    contact_id: {
-                        identifier: '123456789',
-                        type: 'other'
-                    }
+                    contact_id: [{
+                            identifier: '123456789',
+                            type: 'other'
+                        }]
                 },
                 dataset: [{
                         title: 'Test Dataset',
@@ -66,10 +66,10 @@ describe('validate the RDA common standard', () => {
                 contact: {
                     name: 'Test Contact',
                     mbox: 'tester@example.com',
-                    contact_id: {
-                        identifier: 'https://orcid.org/0000-0000-0000-0000',
-                        type: 'orcid'
-                    },
+                    contact_id: [{
+                            identifier: 'https://orcid.org/0000-0000-0000-0000',
+                            type: 'orcid'
+                        }],
                     affiliation: [{
                             name: 'Test University',
                             affiliation_id: {
@@ -80,10 +80,10 @@ describe('validate the RDA common standard', () => {
                 },
                 contributor: [{
                         name: 'Test Contact',
-                        contributor_id: {
-                            identifier: 'https://orcid.org/0000-0000-0000-0000',
-                            type: 'orcid'
-                        },
+                        contributor_id: [{
+                                identifier: 'https://orcid.org/0000-0000-0000-0000',
+                                type: 'orcid'
+                            }],
                         affiliation: [{
                                 name: 'Test University',
                                 affiliation_id: {
@@ -117,10 +117,10 @@ describe('validate the RDA common standard', () => {
                         metadata: [{
                                 description: 'Description of metadata',
                                 language: 'eng',
-                                metadata_standard_id: {
-                                    identifier: 'https://example.com/metadata-standards/123',
-                                    type: 'url'
-                                }
+                                metadata_standard_id: [{
+                                        identifier: 'https://example.com/metadata-standards/123',
+                                        type: 'url'
+                                    }]
                             }],
                         preservation_statement: 'Statement about preservation',
                         security_and_privacy: [{
@@ -185,19 +185,23 @@ describe('validate the RDA common standard', () => {
             project: [{
                     title: 'Test Project',
                     description: 'This is a test project',
-                    project_id: {
-                        identifier: '123456789',
-                        type: 'other'
-                    },
+                    project_id: [{
+                            identifier: '123456789',
+                            type: 'other'
+                        }],
                     start: '2025-01-01',
                     end: '2028-01-31',
                     funding: [{
                             name: 'Funder Organization',
-                            funding_status: 'planned',
+                            funding_status: 'granted',
                             funder_id: {
                                 identifier: 'https://ror.org/0987654321',
                                 type: 'ror'
-                            }
+                            },
+                            grant_id: [{
+                                    identifier: '123456789',
+                                    type: 'other'
+                                }]
                         }]
                 }]
         };

package/dist/dmp/__tests__/extensions.spec.js

@@ -5,7 +5,9 @@ const extension_1 = require("../extension");
 describe('extensions', () => {
     it('validates a minimal DMP Tool extension', () => {
         const expected = {
+            rda_schema_version: "1.2",
             provenance: 'your-application',
+            status: 'draft',
             privacy: 'private',
             featured: 'no',
         };
@@ -13,7 +15,9 @@ describe('extensions', () => {
     });
     it('validates a full DMP Tool extension', () => {
         const validData = {
+            rda_schema_version: "1.2",
             provenance: 'your-application',
+            status: 'complete',
             privacy: 'private',
             featured: 'no',
             registered: '2026-01-01T10:32:45Z',
@@ -24,12 +28,6 @@ describe('extensions', () => {
                     type: 'url'
                 }
             },
-            related_identifier: [{
-                    identifier: 'https://doi.org/10.1234/dmp.123456789',
-                    descriptor: 'cites',
-                    work_type: 'dataset',
-                    type: 'doi'
-                }],
             research_facility: [{
                     name: 'Super telescope',
                     type: 'observatory',
@@ -52,18 +50,26 @@ describe('extensions', () => {
                         type: 'url'
                     }
                 }],
+            funding_project: [{
+                    project_id: {
+                        identifier: '123456789',
+                        type: 'other'
+                    },
+                    funder_id: {
+                        identifier: 'https://ror.org/0987654321',
+                        type: 'ror'
+                    },
+                    project_identifier: {
+                        identifier: 'https://example.com/erbgierg',
+                        type: 'url'
+                    }
+                }],
             version: [{
-                    access_url: 'https://example.com/dmp/123456789?version=2026-01-01T10:32:45Z',
-                    version_date: '2026-01-01T10:32:45Z',
+                    access_url: 'https://example.com/dmps/123456789?version=2026-01-01T10:32:45Z',
+                    version: '2026-01-01T10:32:45Z',
                 }],
             narrative: {
-                download_urls: {
-                    csv: 'https://example.com/dmp/123456789/narrative.csv',
-                    docx: 'https://example.com/dmp/123456789/narrative.docx',
-                    html: 'https://example.com/dmp/123456789/narrative.html',
-                    pdf: 'https://example.com/dmp/123456789/narrative.pdf',
-                    txt: 'https://example.com/dmp/123456789/narrative.txt',
-                },
+                download_url: 'https://example.com/dmps/123456789/narrative',
                 template: {
                     id: 1234567,
                     title: 'Narrative Template',