@dmptool/types 1.1.2 → 1.1.3

package/dist/questions/tableQuestions.js

@@ -32,25 +32,18 @@ exports.TableColumn = zod_1.z.object({
     content: exports.AnyTableColumnQuestionSchema, // The question for the column
 });
 // Table question and answer
-const defaultTableJSON = {
-    type: 'table',
-    columns: [],
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { canAddRows: true, canRemoveRows: true, initialRows: 1, maxRows: undefined, minRows: undefined }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 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({
-        canAddRows: zod_1.z.boolean().optional(), // Whether to allow adding rows (default is true)
-        canRemoveRows: zod_1.z.boolean().optional(), // Whether to allow removing rows (default is true)
-        initialRows: zod_1.z.number().optional(), // The initial number of rows (default is 1)
+        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(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultTableJSON)).optional()
     })).optional()
 }));

package/dist/questions/textQuestions.d.ts

@@ -6,19 +6,19 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
-        maxLength: z.ZodOptional<z.ZodNumber>;
+        maxLength: z.ZodDefault<z.ZodNumber>;
         minLength: z.ZodOptional<z.ZodNumber>;
         pattern: z.ZodOptional<z.ZodString>;
     } & {
-        multiple: z.ZodOptional<z.ZodBoolean>;
+        multiple: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        maxLength: number;
+        multiple: boolean;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
-        multiple?: boolean | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -33,34 +33,30 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Email Field">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require require email address(es).">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Email Field" | undefined;
         usageDescription?: "For questions that require require email address(es)." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Email Field" | undefined;
         usageDescription?: "For questions that require require email address(es)." | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "email";
     attributes?: {
+        maxLength: number;
+        multiple: boolean;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
-        multiple?: boolean | undefined;
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
         title?: "Email Field" | undefined;
         usageDescription?: "For questions that require require email address(es)." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "email";
@@ -77,7 +73,6 @@ export declare const EmailQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Email Field" | undefined;
         usageDescription?: "For questions that require require email address(es)." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
@@ -87,20 +82,20 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
-        cols: z.ZodOptional<z.ZodNumber>;
+        cols: z.ZodDefault<z.ZodNumber>;
         maxLength: z.ZodOptional<z.ZodNumber>;
         minLength: z.ZodOptional<z.ZodNumber>;
-        rows: z.ZodOptional<z.ZodNumber>;
-        asRichText: z.ZodOptional<z.ZodBoolean>;
+        rows: z.ZodDefault<z.ZodNumber>;
+        asRichText: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        cols: number;
+        rows: number;
+        asRichText: boolean;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         maxLength?: number | undefined;
         minLength?: number | undefined;
-        cols?: number | undefined;
-        rows?: number | undefined;
-        asRichText?: boolean | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -116,35 +111,31 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Text Area">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require longer answers, you can select formatting options too.">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Text Area" | undefined;
         usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Text Area" | undefined;
         usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "textArea";
     attributes?: {
+        cols: number;
+        rows: number;
+        asRichText: boolean;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         maxLength?: number | undefined;
         minLength?: number | undefined;
-        cols?: number | undefined;
-        rows?: number | undefined;
-        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;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "textArea";
@@ -162,7 +153,6 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Text Area" | undefined;
         usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const TextQuestionSchema: z.ZodObject<{} & {
@@ -172,14 +162,14 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
-        maxLength: z.ZodOptional<z.ZodNumber>;
+        maxLength: z.ZodDefault<z.ZodNumber>;
         minLength: z.ZodOptional<z.ZodNumber>;
         pattern: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
     }, {
@@ -195,25 +185,22 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Text Field">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require short, simple answers.">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Text Field" | undefined;
         usageDescription?: "For questions that require short, simple answers." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Text Field" | undefined;
         usageDescription?: "For questions that require short, simple answers." | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "text";
     attributes?: {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
     } | undefined;
@@ -221,7 +208,6 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Text Field" | undefined;
         usageDescription?: "For questions that require short, simple answers." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "text";
@@ -237,7 +223,6 @@ export declare const TextQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Text Field" | undefined;
         usageDescription?: "For questions that require short, simple answers." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const URLQuestionSchema: z.ZodObject<{} & {
@@ -247,14 +232,14 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
-        maxLength: z.ZodOptional<z.ZodNumber>;
+        maxLength: z.ZodDefault<z.ZodNumber>;
         minLength: z.ZodOptional<z.ZodNumber>;
         pattern: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
     }, {
@@ -270,25 +255,22 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
     } & {
         title: z.ZodOptional<z.ZodLiteral<"URL Field">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a website, DOI or other URL.">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "URL Field" | undefined;
         usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "URL Field" | undefined;
         usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "url";
     attributes?: {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | undefined;
         minLength?: number | undefined;
         pattern?: string | undefined;
     } | undefined;
@@ -296,7 +278,6 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "URL Field" | undefined;
         usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "url";
@@ -312,7 +293,6 @@ export declare const URLQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "URL Field" | undefined;
         usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export type EmailQuestionType = z.infer<typeof EmailQuestionSchema>;

package/dist/questions/textQuestions.js

@@ -6,75 +6,51 @@ 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({
-    maxLength: zod_1.z.number().optional(), // The maximum length of the text (no default)
-    minLength: zod_1.z.number().optional(), // The minimum length of the text (no default)
-    pattern: zod_1.z.string().optional() // The regex pattern to match (no default)
+    maxLength: zod_1.z.number().default(255),
+    minLength: zod_1.z.number().optional(),
+    pattern: zod_1.z.string().optional()
 }));
 // Email question and answer
-const defaultEmailJSON = {
-    type: 'email',
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { maxLength: 255, minLength: 1, pattern: undefined, multiple: false }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 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().optional(), // Allow multiple emails (default is false; comma separated)
+        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(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultEmailJSON)).optional(),
     })).optional()
 }));
 // Text area question and answer
-const defaultTextAreaJSON = {
-    type: 'textArea',
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { cols: 20, maxLength: undefined, minLength: undefined, rows: 2, asRichText: true }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 exports.TextAreaQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('textArea'), // The type of question
+    type: zod_1.z.literal('textArea'),
     attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
-        cols: zod_1.z.number().optional(), // The number of columns (default is 20)
-        maxLength: zod_1.z.number().optional(), // The maximum length of the text (no default)
-        minLength: zod_1.z.number().optional(), // The minimum length of the text (no default)
-        rows: zod_1.z.number().optional(), // The number of rows (default is 2)
-        asRichText: zod_1.z.boolean().optional() // Whether to use a WYSIWYG editor (default true)
+        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(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultTextAreaJSON)).optional(),
     })).optional()
 }));
 // Text question and answer
-const defaultTextJSON = {
-    type: 'text',
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { maxLength: 255, minLength: undefined, pattern: undefined }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 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(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultTextJSON)).optional(),
     })).optional()
 }));
 // URL question and answer
-const defaultURLJSON = {
-    type: 'url',
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { maxLength: 255, minLength: undefined, pattern: undefined }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 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(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultURLJSON)).optional(),
     })).optional()
 }));

package/dist/schemas/affiliationSearchQuestion.schema.json

@@ -37,10 +37,6 @@
             "usageDescription": {
               "type": "string",
               "const": "For questions that require the user to select from a controlled list of institutions."
-            },
-            "defaultJSON": {
-              "type": "string",
-              "const": "{\"type\":\"affiliationSearch\",\"attributes\":{},\"meta\":{\"schemaVersion\":\"1.0\"},\"graphQL\":{\"query\":\"query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}\",\"queryId\":\"useAffiliationsQuery\",\"variables\":[{\"name\":\"term\",\"type\":\"string\",\"label\":\"Search for your institution\",\"minLength\":3,\"labelTranslationKey\":\"SignupPage.institutionHelp\"}],\"answerField\":\"uri\",\"displayFields\":[{\"label\":\"Institution\",\"propertyName\":\"displayName\",\"labelTranslationKey\":\"SignupPage.institution\"}],\"responseField\":\"affiliations.items\"}}"
             }
           },
           "required": [
@@ -57,18 +53,20 @@
                 "type": "object",
                 "properties": {
                   "propertyName": {
-                    "type": "string"
+                    "type": "string",
+                    "const": "displayName"
                   },
                   "label": {
-                    "type": "string"
+                    "type": "string",
+                    "default": "Institution"
                   },
                   "labelTranslationKey": {
-                    "type": "string"
+                    "type": "string",
+                    "default": "SignupPage.institution"
                   }
                 },
                 "required": [
-                  "propertyName",
-                  "label"
+                  "propertyName"
                 ],
                 "additionalProperties": false
               }
@@ -77,46 +75,61 @@
               "type": "string"
             },
             "query": {
-              "type": "string"
+              "type": "string",
+              "const": "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}"
             },
             "responseField": {
-              "type": "string"
+              "type": "string",
+              "const": "affiliations.items"
             },
             "variables": {
               "type": "array",
               "items": {
                 "type": "object",
                 "properties": {
-                  "minLength": {
-                    "type": "number"
-                  },
-                  "label": {
-                    "type": "string"
-                  },
-                  "labelTranslationKey": {
-                    "type": "string"
-                  },
                   "name": {
-                    "type": "string"
+                    "type": "string",
+                    "const": "name"
                   },
                   "type": {
-                    "type": "string"
+                    "type": "string",
+                    "default": "string"
+                  },
+                  "label": {
+                    "type": "string",
+                    "default": "Search for your institution"
+                  },
+                  "minLength": {
+                    "type": "number",
+                    "const": 3
                   },
-                  "defaultValue": {
-                    "type": "string"
+                  "labelTranslationKey": {
+                    "type": "string",
+                    "default": "SignupPage.institutionHelp"
                   }
                 },
                 "required": [
                   "name",
-                  "type"
+                  "minLength"
                 ],
                 "additionalProperties": false
               }
+            },
+            "queryId": {
+              "type": "string",
+              "default": "useAffiliationsQuery"
+            },
+            "answerField": {
+              "type": "string",
+              "const": "uri"
             }
           },
           "required": [
             "displayFields",
-            "responseField"
+            "query",
+            "responseField",
+            "variables",
+            "answerField"
           ],
           "additionalProperties": false
         }