@dmptool/types 1.1.1 → 1.1.3

package/dist/questions/tableQuestions.js

@@ -9,8 +9,10 @@ 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,
     optionBasedQuestions_1.BooleanQuestionSchema,
     optionBasedQuestions_1.CheckboxesQuestionSchema,
     numberQuestions_1.CurrencyQuestionSchema,
@@ -23,7 +25,6 @@ exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
     optionBasedQuestions_1.SelectBoxQuestionSchema,
     textQuestions_1.TextAreaQuestionSchema,
     textQuestions_1.TextQuestionSchema,
-    graphQLQuestions_1.TypeaheadSearchQuestionSchema,
     textQuestions_1.URLQuestionSchema
 ]);
 exports.TableColumn = zod_1.z.object({
@@ -35,10 +36,14 @@ 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(),
+    })).optional()
 }));

package/dist/questions/textQuestions.d.ts

@@ -1,32 +1,24 @@
 import { z } from "zod";
-export declare const EmailQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const EmailQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"email">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         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;
@@ -36,19 +28,35 @@ 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?: {
+        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;
     } | undefined;
 }, {
     type: "email";
@@ -63,6 +71,8 @@ export declare const EmailQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Email Field" | undefined;
+        usageDescription?: "For questions that require require email address(es)." | undefined;
     } | undefined;
 }>;
 export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
@@ -72,18 +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>;
+        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;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -92,39 +104,41 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         minLength?: number | undefined;
         cols?: number | undefined;
         rows?: number | undefined;
+        asRichText?: boolean | undefined;
     }>>;
-    meta: z.ZodObject<{
+    meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
     } & {
-        asRichText: z.ZodOptional<z.ZodBoolean>;
+        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";
-        asRichText?: boolean | undefined;
+        title?: "Text Area" | undefined;
+        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
     }, {
         schemaVersion: "1.0";
-        asRichText?: boolean | undefined;
-    }>;
+        title?: "Text Area" | undefined;
+        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "textArea";
-    meta: {
-        schemaVersion: "1.0";
-        asRichText?: boolean | undefined;
-    };
     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;
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+        title?: "Text Area" | undefined;
+        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
     } | undefined;
 }, {
     type: "textArea";
-    meta: {
-        schemaVersion: "1.0";
-        asRichText?: boolean | undefined;
-    };
     attributes?: {
         label?: string | undefined;
         help?: string | undefined;
@@ -133,31 +147,29 @@ export declare const TextAreaQuestionSchema: z.ZodObject<{} & {
         minLength?: number | undefined;
         cols?: number | undefined;
         rows?: number | undefined;
+        asRichText?: boolean | undefined;
     } | undefined;
-}>;
-export declare const TextQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
+    meta?: {
         schemaVersion: "1.0";
-    }>>;
-} & {
+        title?: "Text Area" | undefined;
+        usageDescription?: "For questions that require longer answers, you can select formatting options too." | undefined;
+    } | undefined;
+}>;
+export declare const TextQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"text">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         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;
     }, {
@@ -168,18 +180,34 @@ 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?: {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | 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;
 }, {
     type: "text";
@@ -193,31 +221,25 @@ export declare const TextQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Text Field" | undefined;
+        usageDescription?: "For questions that require short, simple answers." | undefined;
     } | undefined;
 }>;
-export declare const URLQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const URLQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"url">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         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;
     }, {
@@ -228,18 +250,34 @@ 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?: {
+        maxLength: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        maxLength?: number | 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;
 }, {
     type: "url";
@@ -253,6 +291,8 @@ export declare const URLQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "URL Field" | undefined;
+        usageDescription?: "For questions that require a website, DOI or other URL." | undefined;
     } | undefined;
 }>;
 export type EmailQuestionType = z.infer<typeof EmailQuestionSchema>;

package/dist/questions/textQuestions.js

@@ -6,37 +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
 exports.EmailQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('email'), // The type of question
+    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(),
+    })).optional()
 }));
 // Text area question and answer
 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)
+        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().extend({
-        asRichText: zod_1.z.boolean().optional() // Whether to use rich text (default is false)
-    })
+    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()
 }));
 // Text question and answer
 exports.TextQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('text'), // The type of question
+    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()
 }));
 // URL question and answer
 exports.URLQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('url'), // The type of question
+    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()
 }));

package/dist/schemas/affiliationSearchAnswer.schema.json

@@ -0,0 +1,37 @@
+{
+  "$ref": "#/definitions/AffiliationSearchAnswer",
+  "definitions": {
+    "AffiliationSearchAnswer": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "typeaheadSearch"
+        },
+        "answer": {
+          "type": "string"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": {
+              "type": "string",
+              "const": "1.0"
+            }
+          },
+          "required": [
+            "schemaVersion"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "type",
+        "answer",
+        "meta"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schemas/affiliationSearchQuestion.schema.json

@@ -0,0 +1,146 @@
+{
+  "$ref": "#/definitions/AffiliationSearchQuestion",
+  "definitions": {
+    "AffiliationSearchQuestion": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "affiliationSearch"
+        },
+        "attributes": {
+          "type": "object",
+          "properties": {
+            "label": {
+              "type": "string"
+            },
+            "help": {
+              "type": "string"
+            },
+            "labelTranslationKey": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": {
+              "type": "string",
+              "const": "1.0"
+            },
+            "title": {
+              "type": "string",
+              "const": "Affiliation Search"
+            },
+            "usageDescription": {
+              "type": "string",
+              "const": "For questions that require the user to select from a controlled list of institutions."
+            }
+          },
+          "required": [
+            "schemaVersion"
+          ],
+          "additionalProperties": false
+        },
+        "graphQL": {
+          "type": "object",
+          "properties": {
+            "displayFields": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "propertyName": {
+                    "type": "string",
+                    "const": "displayName"
+                  },
+                  "label": {
+                    "type": "string",
+                    "default": "Institution"
+                  },
+                  "labelTranslationKey": {
+                    "type": "string",
+                    "default": "SignupPage.institution"
+                  }
+                },
+                "required": [
+                  "propertyName"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "localQueryId": {
+              "type": "string"
+            },
+            "query": {
+              "type": "string",
+              "const": "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}"
+            },
+            "responseField": {
+              "type": "string",
+              "const": "affiliations.items"
+            },
+            "variables": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "const": "name"
+                  },
+                  "type": {
+                    "type": "string",
+                    "default": "string"
+                  },
+                  "label": {
+                    "type": "string",
+                    "default": "Search for your institution"
+                  },
+                  "minLength": {
+                    "type": "number",
+                    "const": 3
+                  },
+                  "labelTranslationKey": {
+                    "type": "string",
+                    "default": "SignupPage.institutionHelp"
+                  }
+                },
+                "required": [
+                  "name",
+                  "minLength"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "queryId": {
+              "type": "string",
+              "default": "useAffiliationsQuery"
+            },
+            "answerField": {
+              "type": "string",
+              "const": "uri"
+            }
+          },
+          "required": [
+            "displayFields",
+            "query",
+            "responseField",
+            "variables",
+            "answerField"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "type",
+        "meta",
+        "graphQL"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}