@dmptool/types 1.1.3 → 1.2.0

package/dist/questions/tableQuestions.js

@@ -9,7 +9,6 @@ const optionBasedQuestions_1 = require("./optionBasedQuestions");
 const graphQLQuestions_1 = require("./graphQLQuestions");
 const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
-const BaseMeta = question_1.QuestionSchema.shape.meta;
 // Union types for all questions and answers (tables cannot be nested so no TableQuestion here!)
 exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
     graphQLQuestions_1.AffiliationSearchQuestionSchema,
@@ -28,22 +27,18 @@ exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
     textQuestions_1.URLQuestionSchema
 ]);
 exports.TableColumn = zod_1.z.object({
-    heading: zod_1.z.string().optional(), // The heading of the column
-    content: exports.AnyTableColumnQuestionSchema, // The question for the column
+    heading: zod_1.z.string().default('Column A'), // The heading of the column
+    content: exports.AnyTableColumnQuestionSchema.default({ type: 'textArea' }), // The question for the column
 });
 // Table question and answer
 exports.TableQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('table'), // The type of question
-    columns: zod_1.z.array(exports.TableColumn), // The columns of the table
-    attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
+    type: zod_1.z.literal('table'),
+    columns: zod_1.z.array(exports.TableColumn).default([{}]), // The columns of the table
+    attributes: BaseAttributes.merge(zod_1.z.object({
         canAddRows: zod_1.z.boolean().default(true),
         canRemoveRows: zod_1.z.boolean().default(true),
         initialRows: zod_1.z.number().default(1),
         maxRows: zod_1.z.number().optional(), // The maximum number of rows (no default)
         minRows: zod_1.z.number().optional() // The minimum number of rows (no default)
-    })).optional(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('Table').optional(),
-        usageDescription: zod_1.z.literal('For questions that require a tabular format.').optional(),
-    })).optional()
+    })).default({})
 }));

package/dist/questions/textQuestions.d.ts

@@ -1,7 +1,21 @@
 import { z } from "zod";
-export declare const EmailQuestionSchema: z.ZodObject<{} & {
+export declare const EmailQuestionSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
     type: z.ZodLiteral<"email">;
-    attributes: z.ZodOptional<z.ZodObject<{
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -28,23 +42,9 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
         pattern?: string | undefined;
         multiple?: boolean | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    } & {
-        title: z.ZodOptional<z.ZodLiteral<"Email Field">>;
-        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require require email address(es).">>;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-        title?: "Email Field" | undefined;
-        usageDescription?: "For questions that require require email address(es)." | undefined;
-    }, {
-        schemaVersion: "1.0";
-        title?: "Email Field" | undefined;
-        usageDescription?: "For questions that require require email address(es)." | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "email";
-    attributes?: {
+    attributes: {
         maxLength: number;
         multiple: boolean;
         label?: string | undefined;
@@ -52,12 +52,12 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
         labelTranslationKey?: string | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-        title?: "Email Field" | undefined;
-        usageDescription?: "For questions that require require email address(es)." | undefined;
-    } | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
 }, {
     type: "email";
     attributes?: {
@@ -70,14 +70,28 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
         multiple?: boolean | undefined;
     } | undefined;
     meta?: {
-        schemaVersion: "1.0";
-        title?: "Email Field" | undefined;
-        usageDescription?: "For questions that require require email address(es)." | undefined;
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
     } | undefined;
 }>;
-export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
+export declare const TextAreaQuestionSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
     type: z.ZodLiteral<"textArea">;
-    attributes: z.ZodOptional<z.ZodObject<{
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -106,23 +120,9 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         rows?: number | undefined;
         asRichText?: boolean | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    } & {
-        title: z.ZodOptional<z.ZodLiteral<"Text Area">>;
-        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require longer answers, you can select formatting options too.">>;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-        title?: "Text Area" | undefined;
-        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-    }, {
-        schemaVersion: "1.0";
-        title?: "Text Area" | undefined;
-        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "textArea";
-    attributes?: {
+    attributes: {
         cols: number;
         rows: number;
         asRichText: boolean;
@@ -131,12 +131,12 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         labelTranslationKey?: string | undefined;
         maxLength?: number | undefined;
         minLength?: number | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-        title?: "Text Area" | undefined;
-        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-    } | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
 }, {
     type: "textArea";
     attributes?: {
@@ -150,14 +150,28 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         asRichText?: boolean | undefined;
     } | undefined;
     meta?: {
-        schemaVersion: "1.0";
-        title?: "Text Area" | undefined;
-        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
     } | undefined;
 }>;
-export declare const TextQuestionSchema: z.ZodObject<{} & {
+export declare const TextQuestionSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
     type: z.ZodLiteral<"text">;
-    attributes: z.ZodOptional<z.ZodObject<{
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -180,35 +194,21 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
         minLength?: number | undefined;
         pattern?: string | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    } & {
-        title: z.ZodOptional<z.ZodLiteral<"Text Field">>;
-        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require short, simple answers.">>;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-        title?: "Text Field" | undefined;
-        usageDescription?: "For questions that require short, simple answers." | undefined;
-    }, {
-        schemaVersion: "1.0";
-        title?: "Text Field" | undefined;
-        usageDescription?: "For questions that require short, simple answers." | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "text";
-    attributes?: {
+    attributes: {
         maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-        title?: "Text Field" | undefined;
-        usageDescription?: "For questions that require short, simple answers." | undefined;
-    } | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
 }, {
     type: "text";
     attributes?: {
@@ -220,14 +220,28 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
         pattern?: string | undefined;
     } | undefined;
     meta?: {
-        schemaVersion: "1.0";
-        title?: "Text Field" | undefined;
-        usageDescription?: "For questions that require short, simple answers." | undefined;
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
     } | undefined;
 }>;
-export declare const URLQuestionSchema: z.ZodObject<{} & {
+export declare const URLQuestionSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
     type: z.ZodLiteral<"url">;
-    attributes: z.ZodOptional<z.ZodObject<{
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -250,35 +264,21 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
         minLength?: number | undefined;
         pattern?: string | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    } & {
-        title: z.ZodOptional<z.ZodLiteral<"URL Field">>;
-        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a website, DOI or other URL.">>;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-        title?: "URL Field" | undefined;
-        usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-    }, {
-        schemaVersion: "1.0";
-        title?: "URL Field" | undefined;
-        usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "url";
-    attributes?: {
+    attributes: {
         maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-        title?: "URL Field" | undefined;
-        usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-    } | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
 }, {
     type: "url";
     attributes?: {
@@ -290,9 +290,9 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
         pattern?: string | undefined;
     } | undefined;
     meta?: {
-        schemaVersion: "1.0";
-        title?: "URL Field" | undefined;
-        usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
     } | undefined;
 }>;
 export type EmailQuestionType = z.infer<typeof EmailQuestionSchema>;

package/dist/questions/textQuestions.js

@@ -3,9 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.URLQuestionSchema = exports.TextQuestionSchema = exports.TextAreaQuestionSchema = exports.EmailQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
-const BaseMeta = question_1.QuestionSchema.shape.meta;
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
-const TextAttributesSchema = BaseAttributes.unwrap().merge(zod_1.z.object({
+const TextAttributesSchema = BaseAttributes.merge(zod_1.z.object({
     maxLength: zod_1.z.number().default(255),
     minLength: zod_1.z.number().optional(),
     pattern: zod_1.z.string().optional()
@@ -15,42 +14,26 @@ exports.EmailQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('email'),
     attributes: TextAttributesSchema.merge(zod_1.z.object({
         multiple: zod_1.z.boolean().default(false),
-    })).optional(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('Email Field').optional(),
-        usageDescription: zod_1.z.literal('For questions that require require email address(es).').optional(),
-    })).optional()
+    })).default({})
 }));
 // Text area question and answer
 exports.TextAreaQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('textArea'),
-    attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
+    attributes: BaseAttributes.merge(zod_1.z.object({
         cols: zod_1.z.number().default(20),
         maxLength: zod_1.z.number().optional(),
         minLength: zod_1.z.number().optional(),
         rows: zod_1.z.number().default(2),
         asRichText: zod_1.z.boolean().default(true),
-    })).optional(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('Text Area').optional(),
-        usageDescription: zod_1.z.literal('For questions that require longer answers, you can select formatting options too.').optional(),
-    })).optional()
+    })).default({})
 }));
 // Text question and answer
 exports.TextQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('text'),
-    attributes: TextAttributesSchema.optional(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('Text Field').optional(),
-        usageDescription: zod_1.z.literal('For questions that require short, simple answers.').optional(),
-    })).optional()
+    attributes: TextAttributesSchema.default({})
 }));
 // URL question and answer
 exports.URLQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('url'),
-    attributes: TextAttributesSchema.optional(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('URL Field').optional(),
-        usageDescription: zod_1.z.literal('For questions that require a website, DOI or other URL.').optional(),
-    })).optional()
+    attributes: TextAttributesSchema.default({})
 }));

package/dist/schemas/affiliationSearchAnswer.schema.json

@@ -6,29 +6,26 @@
       "properties": {
         "type": {
           "type": "string",
-          "const": "typeaheadSearch"
-        },
-        "answer": {
-          "type": "string"
+          "const": "affiliationSearch"
         },
         "meta": {
           "type": "object",
           "properties": {
             "schemaVersion": {
               "type": "string",
-              "const": "1.0"
+              "default": "1.0"
             }
           },
-          "required": [
-            "schemaVersion"
-          ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "default": {}
+        },
+        "answer": {
+          "type": "string",
+          "default": ""
         }
       },
       "required": [
-        "type",
-        "answer",
-        "meta"
+        "type"
       ],
       "additionalProperties": false
     }

package/dist/schemas/affiliationSearchQuestion.schema.json

@@ -21,28 +21,25 @@
               "type": "string"
             }
           },
-          "additionalProperties": false
+          "additionalProperties": false,
+          "default": {}
         },
         "meta": {
           "type": "object",
           "properties": {
             "schemaVersion": {
               "type": "string",
-              "const": "1.0"
+              "default": "1.0"
             },
             "title": {
-              "type": "string",
-              "const": "Affiliation Search"
+              "type": "string"
             },
             "usageDescription": {
-              "type": "string",
-              "const": "For questions that require the user to select from a controlled list of institutions."
+              "type": "string"
             }
           },
-          "required": [
-            "schemaVersion"
-          ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "default": {}
         },
         "graphQL": {
           "type": "object",
@@ -54,7 +51,8 @@
                 "properties": {
                   "propertyName": {
                     "type": "string",
-                    "const": "displayName"
+                    "const": "displayName",
+                    "default": "displayName"
                   },
                   "label": {
                     "type": "string",
@@ -65,22 +63,24 @@
                     "default": "SignupPage.institution"
                   }
                 },
-                "required": [
-                  "propertyName"
-                ],
                 "additionalProperties": false
-              }
+              },
+              "default": [
+                {}
+              ]
             },
             "localQueryId": {
               "type": "string"
             },
             "query": {
               "type": "string",
-              "const": "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}"
+              "const": "\nquery Affiliations($name: String!){\n  affiliations(name: $name) {\n    totalCount\n    nextCursor\n    items {\n      id\n      displayName\n      uri\n    }\n  }\n}",
+              "default": "\nquery Affiliations($name: String!){\n  affiliations(name: $name) {\n    totalCount\n    nextCursor\n    items {\n      id\n      displayName\n      uri\n    }\n  }\n}"
             },
             "responseField": {
               "type": "string",
-              "const": "affiliations.items"
+              "const": "affiliations.items",
+              "default": "affiliations.items"
             },
             "variables": {
               "type": "array",
@@ -89,7 +89,8 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "const": "name"
+                    "const": "name",
+                    "default": "name"
                   },
                   "type": {
                     "type": "string",
@@ -101,19 +102,19 @@
                   },
                   "minLength": {
                     "type": "number",
-                    "const": 3
+                    "const": 3,
+                    "default": 3
                   },
                   "labelTranslationKey": {
                     "type": "string",
                     "default": "SignupPage.institutionHelp"
                   }
                 },
-                "required": [
-                  "name",
-                  "minLength"
-                ],
                 "additionalProperties": false
-              }
+              },
+              "default": [
+                {}
+              ]
             },
             "queryId": {
               "type": "string",
@@ -121,23 +122,16 @@
             },
             "answerField": {
               "type": "string",
-              "const": "uri"
+              "const": "uri",
+              "default": "uri"
             }
           },
-          "required": [
-            "displayFields",
-            "query",
-            "responseField",
-            "variables",
-            "answerField"
-          ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "default": {}
         }
       },
       "required": [
-        "type",
-        "meta",
-        "graphQL"
+        "type"
       ],
       "additionalProperties": false
     }