@dmptool/types 1.2.2 → 1.2.4

package/dist/questions/tableQuestions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableQuestionSchema = exports.TableColumn = exports.AnyTableColumnQuestionSchema = void 0;
+exports.ResearchOutputTableQuestionSchema = exports.ResearchOutputTableColumnPreferenceSchema = exports.TableQuestionSchema = exports.TableColumn = exports.AnyTableColumnQuestionSchema = void 0;
 const zod_1 = require("zod");
 const numberQuestions_1 = require("./numberQuestions");
 const textQuestions_1 = require("./textQuestions");
@@ -18,9 +18,12 @@ exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
     dateQuestions_1.DateQuestionSchema,
     dateQuestions_1.DateRangeQuestionSchema,
     textQuestions_1.EmailQuestionSchema,
-    graphQLQuestions_1.FilteredSearchQuestionSchema,
+    graphQLQuestions_1.LicenseSearchQuestionSchema,
+    graphQLQuestions_1.MetadataStandardSearchQuestionSchema,
     numberQuestions_1.NumberQuestionSchema,
+    numberQuestions_1.NumberWithContextQuestionSchema,
     optionBasedQuestions_1.RadioButtonsQuestionSchema,
+    graphQLQuestions_1.RepositorySearchQuestionSchema,
     optionBasedQuestions_1.SelectBoxQuestionSchema,
     textQuestions_1.TextAreaQuestionSchema,
     textQuestions_1.TextQuestionSchema,
@@ -28,9 +31,15 @@ exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
 ]);
 exports.TableColumn = zod_1.z.object({
     heading: zod_1.z.string().default('Column A'), // The heading of the column
+    required: zod_1.z.boolean().default(false), // Whether the column is required
+    enabled: zod_1.z.boolean().default(true), // Whether the column is enabled
     content: exports.AnyTableColumnQuestionSchema.default({ type: 'textArea' }), // The question for the column
+    meta: zod_1.z.object({
+        schemaVersion: zod_1.z.string().default(question_1.CURRENT_SCHEMA_VERSION), // The schema version
+        labelTranslationKey: zod_1.z.string().optional(),
+    }).default({})
 });
-// Table question and answer
+// Table question
 exports.TableQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('table'),
     columns: zod_1.z.array(exports.TableColumn).default([{}]), // The columns of the table
@@ -42,3 +51,166 @@ exports.TableQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
         minRows: zod_1.z.number().optional() // The minimum number of rows (no default)
     })).default({})
 }));
+exports.ResearchOutputTableColumnPreferenceSchema = zod_1.z.object({
+    label: zod_1.z.string().default(''), // The label of the preference option
+    value: zod_1.z.string().default('') // The value of the preference option
+});
+const ResearchOutputTitleColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Title'),
+    required: zod_1.z.literal(true),
+    content: textQuestions_1.TextQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            help: zod_1.z.string().default('Enter the title of this research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.title.heading')
+        }).default({})
+    }).default({ type: 'text' })
+});
+const ResearchOutputDescriptionColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Description'),
+    content: textQuestions_1.TextAreaQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            help: zod_1.z.string().default('Provide a brief description of this research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.description.heading')
+        }).default({})
+    }).default({ type: 'textArea' })
+});
+const ResearchOutputOutputTypeColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Output Type'),
+    required: zod_1.z.literal(true),
+    content: optionBasedQuestions_1.SelectBoxQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            multiple: zod_1.z.literal(false),
+            help: zod_1.z.string().default('Select the type that best describes this research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.outputType.heading')
+        }).default({ multiple: false }),
+    }).default({ type: 'selectBox' })
+});
+const ResearchOutputDataFlagsColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Data Flags'),
+    enabled: zod_1.z.boolean().default(false),
+    content: optionBasedQuestions_1.CheckboxesQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            help: zod_1.z.string().default('Select any data flags that apply to this research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.dataFlags.heading')
+        }).default({}),
+        options: zod_1.z.array(zod_1.z.object({
+            label: zod_1.z.string(),
+            value: zod_1.z.string()
+        })).default([
+            { label: 'May contain sensitive data?', value: 'sensitive' },
+            { label: 'May contain personally identifiable information?', value: 'personal' },
+        ])
+    }).default({ type: 'checkBoxes' })
+});
+const ResearchOutputAccessLevelColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Initial Access Level'),
+    enabled: zod_1.z.boolean().default(false),
+    content: optionBasedQuestions_1.SelectBoxQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            multiple: zod_1.z.literal(false),
+            help: zod_1.z.string().default('The initial access level for the research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.accessLevel.heading')
+        }).default({ multiple: false }),
+        options: zod_1.z.array(zod_1.z.object({
+            label: zod_1.z.string(),
+            value: zod_1.z.string()
+        })).default([
+            { label: 'Unrestricted Access', value: 'open' },
+            { label: 'Controlled Access', value: 'restricted' },
+            { label: 'Other', value: 'closed' },
+        ])
+    }).default({ type: 'selectBox' })
+});
+const ResearchOutputReleaseDateColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Anticipated Release Date'),
+    enabled: zod_1.z.boolean().default(false),
+    content: dateQuestions_1.DateQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            help: zod_1.z.string().default('The anticipated release date for the research output'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.releaseDate.heading')
+        }).default({})
+    }).default({ type: 'date' })
+});
+const ResearchOutputByteSizeColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Byte Size'),
+    enabled: zod_1.z.boolean().default(false),
+    content: numberQuestions_1.NumberWithContextQuestionSchema.extend({
+        attributes: zod_1.z.object({
+            min: zod_1.z.number().default(0),
+            help: zod_1.z.string().default('The size of the research output in bytes'),
+            labelTranslationKey: zod_1.z.string().default('researchOutput.byteSize.heading'),
+            context: zod_1.z.array(zod_1.z.object({
+                label: zod_1.z.string().default('MB (megabytes)'),
+                value: zod_1.z.string().default('mb')
+            })).default([
+                { label: 'bytes', value: 'bytes' },
+                { label: 'KB (kilobytes)', value: 'kb' },
+                { label: 'MB (megabytes)', value: 'mb' },
+                { label: 'GB (gigabytes)', value: 'gb' },
+                { label: 'TB (terabytes)', value: 'tb' },
+                { label: 'PB (petabytes)', value: 'pb' }
+            ])
+        }).default({})
+    }).default({ type: 'numberWithContext' })
+});
+const ResearchOutputRepositoryColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Repository'),
+    enabled: zod_1.z.boolean().default(false),
+    content: graphQLQuestions_1.RepositorySearchQuestionSchema.default({ type: 'repositorySearch' }),
+    preferences: zod_1.z.array(exports.ResearchOutputTableColumnPreferenceSchema).default([]),
+    attributes: zod_1.z.object({
+        help: zod_1.z.string().default('Select repositor(ies) you would prefer users to deposit in'),
+        labelTranslationKey: zod_1.z.string().default('researchOutput.repository.heading')
+    }).default({})
+});
+const ResearchOutputMetadataStandardColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('Metadata Standard'),
+    enabled: zod_1.z.boolean().default(false),
+    content: graphQLQuestions_1.MetadataStandardSearchQuestionSchema.default({ type: 'metadataStandardSearch' }),
+    preferences: zod_1.z.array(exports.ResearchOutputTableColumnPreferenceSchema).default([]),
+    attributes: zod_1.z.object({
+        help: zod_1.z.string().default('Select metadata standard(s) you would prefer users to use'),
+        labelTranslationKey: zod_1.z.string().default('researchOutput.metadataStandard.heading')
+    }).default({})
+});
+const ResearchOutputLicenseColumnSchema = exports.TableColumn.extend({
+    heading: zod_1.z.string().default('License'),
+    enabled: zod_1.z.boolean().default(false),
+    content: graphQLQuestions_1.LicenseSearchQuestionSchema.default({ type: 'licenseSearch' }),
+    preferences: zod_1.z.array(exports.ResearchOutputTableColumnPreferenceSchema).default([]),
+    attributes: zod_1.z.object({
+        help: zod_1.z.string().default('Select license(s) you would prefer users to apply to the research output'),
+        labelTranslationKey: zod_1.z.string().default('researchOutput.license.heading')
+    }).default({})
+});
+const defaultTitleColumn = ResearchOutputTitleColumnSchema.parse({
+    required: true,
+    content: { type: 'text' }
+});
+const defaultDescriptionColumn = ResearchOutputDescriptionColumnSchema.parse({});
+const defaultOutputTypeColumn = ResearchOutputOutputTypeColumnSchema.parse({
+    required: true,
+    content: { type: 'selectBox' }
+});
+const defaultDataFlagsColumn = ResearchOutputDataFlagsColumnSchema.parse({});
+const defaultAccessLevelColumn = ResearchOutputAccessLevelColumnSchema.parse({});
+const defaultReleaseDateColumn = ResearchOutputReleaseDateColumnSchema.parse({});
+const defaultByteSizeColumn = ResearchOutputByteSizeColumnSchema.parse({});
+const defaultRepositoryColumn = ResearchOutputRepositoryColumnSchema.parse({});
+const defaultMetadataStandardColumn = ResearchOutputMetadataStandardColumnSchema.parse({});
+const defaultLicenseColumn = ResearchOutputLicenseColumnSchema.parse({});
+exports.ResearchOutputTableQuestionSchema = exports.TableQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('researchOutputTable'),
+    columns: zod_1.z.array(exports.TableColumn).default([
+        defaultTitleColumn,
+        defaultDescriptionColumn,
+        defaultOutputTypeColumn,
+        defaultDataFlagsColumn,
+        defaultAccessLevelColumn,
+        defaultReleaseDateColumn,
+        defaultByteSizeColumn,
+        defaultRepositoryColumn,
+        defaultMetadataStandardColumn,
+        defaultLicenseColumn
+    ]),
+}));

package/dist/schemas/anyAnswer.schema.json

@@ -8,7 +8,7 @@
           "properties": {
             "type": {
               "type": "string",
-              "const": "boolean"
+              "const": "affiliationSearch"
             },
             "meta": {
               "type": "object",
@@ -21,6 +21,37 @@
               "additionalProperties": false,
               "default": {}
             },
+            "answer": {
+              "type": "object",
+              "properties": {
+                "affiliationId": {
+                  "type": "string",
+                  "default": ""
+                },
+                "affiliationName": {
+                  "type": "string",
+                  "default": ""
+                }
+              },
+              "additionalProperties": false,
+              "default": {}
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "boolean"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
             "answer": {
               "type": "boolean",
               "default": false
@@ -147,6 +178,101 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "licenseSearch"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
+            "answer": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "licenseId": {
+                    "type": "string",
+                    "default": ""
+                  },
+                  "licenseName": {
+                    "type": "string",
+                    "default": ""
+                  }
+                },
+                "additionalProperties": false,
+                "default": {}
+              },
+              "default": []
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "metadataStandardSearch"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
+            "answer": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "metadataStandardId": {
+                    "type": "string",
+                    "default": ""
+                  },
+                  "metadataStandardName": {
+                    "type": "string",
+                    "default": ""
+                  }
+                },
+                "additionalProperties": false,
+                "default": {}
+              },
+              "default": []
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "multiselectBox"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
+            "answer": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": [
+                ""
+              ]
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -167,6 +293,37 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "numberRange"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
+            "answer": {
+              "type": "object",
+              "properties": {
+                "start": {
+                  "type": "number",
+                  "default": 0
+                },
+                "end": {
+                  "type": "number",
+                  "default": 0
+                }
+              },
+              "additionalProperties": false,
+              "default": {}
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -187,6 +344,41 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "repositorySearch"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
+            },
+            "answer": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "repositoryId": {
+                    "type": "string",
+                    "default": ""
+                  },
+                  "repositoryName": {
+                    "type": "string",
+                    "default": ""
+                  }
+                },
+                "additionalProperties": false,
+                "default": {}
+              },
+              "default": []
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -235,37 +427,6 @@
                     "type": "array",
                     "items": {
                       "anyOf": [
-                        {
-                          "type": "object",
-                          "properties": {
-                            "type": {
-                              "type": "string",
-                              "const": "affiliationSearch"
-                            },
-                            "meta": {
-                              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
-                            },
-                            "answer": {
-                              "type": "object",
-                              "properties": {
-                                "affiliationId": {
-                                  "type": "string",
-                                  "default": ""
-                                },
-                                "affiliationName": {
-                                  "type": "string",
-                                  "default": ""
-                                }
-                              },
-                              "additionalProperties": false,
-                              "default": {}
-                            }
-                          },
-                          "required": [
-                            "type"
-                          ],
-                          "additionalProperties": false
-                        },
                         {
                           "$ref": "#/definitions/AnyAnswer/anyOf/0"
                         },
@@ -285,63 +446,59 @@
                           "$ref": "#/definitions/AnyAnswer/anyOf/5"
                         },
                         {
-                          "type": "object",
-                          "properties": {
-                            "type": {
-                              "type": "string",
-                              "const": "filteredSearch"
-                            },
-                            "meta": {
-                              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
-                            },
-                            "answer": {
-                              "type": "array",
-                              "items": {
-                                "type": "string"
-                              },
-                              "default": [
-                                ""
-                              ]
-                            }
-                          },
-                          "required": [
-                            "type"
-                          ],
-                          "additionalProperties": false
+                          "$ref": "#/definitions/AnyAnswer/anyOf/6"
+                        },
+                        {
+                          "$ref": "#/definitions/AnyAnswer/anyOf/7"
+                        },
+                        {
+                          "$ref": "#/definitions/AnyAnswer/anyOf/8"
+                        },
+                        {
+                          "$ref": "#/definitions/AnyAnswer/anyOf/9"
+                        },
+                        {
+                          "$ref": "#/definitions/AnyAnswer/anyOf/10"
                         },
                         {
                           "type": "object",
                           "properties": {
                             "type": {
                               "type": "string",
-                              "const": "multiselectBox"
+                              "const": "numberWithContext"
                             },
                             "meta": {
                               "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
                             },
                             "answer": {
-                              "type": "array",
-                              "items": {
-                                "type": "string"
+                              "type": "object",
+                              "properties": {
+                                "value": {
+                                  "type": "number",
+                                  "default": 0
+                                },
+                                "context": {
+                                  "type": "string",
+                                  "default": ""
+                                }
                               },
-                              "default": [
-                                ""
-                              ]
+                              "additionalProperties": false
                             }
                           },
                           "required": [
-                            "type"
+                            "type",
+                            "answer"
                           ],
                           "additionalProperties": false
                         },
                         {
-                          "$ref": "#/definitions/AnyAnswer/anyOf/6"
+                          "$ref": "#/definitions/AnyAnswer/anyOf/12"
                         },
                         {
-                          "$ref": "#/definitions/AnyAnswer/anyOf/7"
+                          "$ref": "#/definitions/AnyAnswer/anyOf/13"
                         },
                         {
-                          "$ref": "#/definitions/AnyAnswer/anyOf/8"
+                          "$ref": "#/definitions/AnyAnswer/anyOf/14"
                         },
                         {
                           "type": "object",
@@ -433,13 +590,13 @@
           "additionalProperties": false
         },
         {
-          "$ref": "#/definitions/AnyAnswer/anyOf/9/properties/answer/items/properties/columns/items/anyOf/12"
+          "$ref": "#/definitions/AnyAnswer/anyOf/15/properties/answer/items/properties/columns/items/anyOf/15"
         },
         {
-          "$ref": "#/definitions/AnyAnswer/anyOf/9/properties/answer/items/properties/columns/items/anyOf/13"
+          "$ref": "#/definitions/AnyAnswer/anyOf/15/properties/answer/items/properties/columns/items/anyOf/16"
         },
         {
-          "$ref": "#/definitions/AnyAnswer/anyOf/9/properties/answer/items/properties/columns/items/anyOf/14"
+          "$ref": "#/definitions/AnyAnswer/anyOf/15/properties/answer/items/properties/columns/items/anyOf/17"
         }
       ]
     }