@dmptool/types 1.1.2 → 1.2.0

package/dist/answers/tableAnswers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableAnswerSchema = exports.TableRowAnswerSchema = exports.TableColumnAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
+exports.TableAnswerSchema = exports.TableRowAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 const optionBasedAnswers_1 = require("./optionBasedAnswers");
@@ -8,6 +8,7 @@ const dateAnswers_1 = require("./dateAnswers");
 const graphQLAnswers_1 = require("./graphQLAnswers");
 const numberAnswers_1 = require("./numberAnswers");
 const textAnswers_1 = require("./textAnswers");
+const questions_1 = require("../questions");
 // Answers to Table Column Question Types (note that TableAnswer is not included here because we don't allow nested tables)
 exports.AnyTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
     graphQLAnswers_1.AffiliationSearchAnswerSchema,
@@ -26,15 +27,18 @@ exports.AnyTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
     textAnswers_1.TextAreaAnswerSchema,
     textAnswers_1.URLAnswerSchema
 ]);
-exports.TableColumnAnswerSchema = zod_1.z.object({
-    heading: zod_1.z.string(), // The heading of the column
-    content: exports.AnyTableColumnAnswerSchema // The answer to the column (based on the type)
-});
 exports.TableRowAnswerSchema = zod_1.z.object({
-    columns: zod_1.z.array(exports.TableColumnAnswerSchema) // The answers for each column in the row
+    columns: zod_1.z.array(exports.AnyTableColumnAnswerSchema) // The answers for each column in the row
 });
 // Answers to Table Question Types
 exports.TableAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('table'), // The type of answer
-    answer: zod_1.z.array(exports.TableRowAnswerSchema) // The answers to the question (array of rows containing an array of columns)
+    type: zod_1.z.literal('table'),
+    columnHeadings: zod_1.z.array(zod_1.z.string()).default(['Column A']),
+    answer: zod_1.z.array(exports.TableRowAnswerSchema).default([{
+            columns: [{
+                    type: 'textArea',
+                    answer: '',
+                    meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                }]
+        }])
 }));

package/dist/answers/textAnswers.d.ts

@@ -1,99 +1,99 @@
 import { z } from 'zod';
 export declare const EmailAnswerSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     }, {
-        schemaVersion: "1.0";
-    }>;
+        schemaVersion?: string | undefined;
+    }>>;
 } & {
     type: z.ZodLiteral<"email">;
-    answer: z.ZodString;
+    answer: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "email";
     meta: {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     };
     answer: string;
 }, {
     type: "email";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: string;
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: string | undefined;
 }>;
 export declare const TextAnswerSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     }, {
-        schemaVersion: "1.0";
-    }>;
+        schemaVersion?: string | undefined;
+    }>>;
 } & {
     type: z.ZodLiteral<"text">;
-    answer: z.ZodString;
+    answer: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "text";
     meta: {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     };
     answer: string;
 }, {
     type: "text";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: string;
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: string | undefined;
 }>;
 export declare const TextAreaAnswerSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     }, {
-        schemaVersion: "1.0";
-    }>;
+        schemaVersion?: string | undefined;
+    }>>;
 } & {
     type: z.ZodLiteral<"textArea">;
-    answer: z.ZodString;
+    answer: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "textArea";
     meta: {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     };
     answer: string;
 }, {
     type: "textArea";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: string;
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: string | undefined;
 }>;
 export declare const URLAnswerSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     }, {
-        schemaVersion: "1.0";
-    }>;
+        schemaVersion?: string | undefined;
+    }>>;
 } & {
     type: z.ZodLiteral<"url">;
-    answer: z.ZodString;
+    answer: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "url";
     meta: {
-        schemaVersion: "1.0";
+        schemaVersion: string;
     };
     answer: string;
 }, {
     type: "url";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: string;
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: string | undefined;
 }>;
 export type EmailAnswerType = z.infer<typeof EmailAnswerSchema>;
 export type TextAnswerType = z.infer<typeof TextAnswerSchema>;

package/dist/answers/textAnswers.js

@@ -5,18 +5,18 @@ const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to Text Based Question Types
 exports.EmailAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('email'), // The type of question
-    answer: zod_1.z.string() // The answer to the question (string)
+    type: zod_1.z.literal('email'),
+    answer: zod_1.z.string().default('')
 }));
 exports.TextAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('text'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
+    type: zod_1.z.literal('text'),
+    answer: zod_1.z.string().default('')
 }));
 exports.TextAreaAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('textArea'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
+    type: zod_1.z.literal('textArea'),
+    answer: zod_1.z.string().default('')
 }));
 exports.URLAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('url'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
+    type: zod_1.z.literal('url'),
+    answer: zod_1.z.string().default('')
 }));

package/dist/questions/__tests__/graphQLQuestions.spec.js

@@ -57,16 +57,18 @@ const graphQLQuestions_1 = require("../graphQLQuestions");
             type: "affiliationSearch",
             attributes: {
                 label: "Search",
-                help: "Search for a user",
+                help: "Search for a institution",
             },
             graphQL: {
+                query: graphQLQuestions_1.affiliationQuery,
                 displayFields: [
-                    { propertyName: "title", label: "Title" },
+                    { propertyName: "displayName", label: "Name" },
                 ],
                 localQueryId: "12345",
-                responseField: "results",
+                answerField: "uri",
+                responseField: "affiliations.items",
                 variables: [
-                    { name: "query", type: "string" },
+                    { type: "string", name: "name", label: "Term", minLength: 3 },
                 ],
             },
             meta: {

package/dist/questions/__tests__/optionBasedQuestions.spec.js

@@ -3,18 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
 const optionBasedQuestions_1 = require("../optionBasedQuestions");
 (0, globals_1.describe)("BooleanQuestion", () => {
-    (0, globals_1.it)('optional fields should not throw an error if the value is undefined', () => {
-        const validBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: undefined, // Valid value
-            },
-        };
-        (0, globals_1.expect)(() => optionBasedQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
-    });
     (0, globals_1.it)('optional fields should throw an error if the value is null', () => {
         const invalidBooleanQuestion = {
             type: "boolean",
@@ -69,6 +57,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Banana",
                     value: "banana",
+                    checked: false,
                 },
             ],
             meta: {
@@ -115,6 +104,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Female",
                     value: "female",
+                    selected: true,
                 },
             ],
             meta: {
@@ -158,6 +148,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Canada",
                     value: "ca",
+                    selected: false,
                 },
             ],
             meta: {
@@ -205,6 +196,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Canada",
                     value: "ca",
+                    selected: false,
                 },
             ],
             meta: {

package/dist/questions/__tests__/usage.spec.d.ts

@@ -0,0 +1,8 @@
+import { AnyQuestionType } from "../index";
+export interface QuestionFormatInterface {
+    type?: string;
+    title?: string;
+    usageDescription?: string;
+    defaultJSON?: AnyQuestionType;
+    schemaVersion?: string;
+}

package/dist/questions/__tests__/usage.spec.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const question_1 = require("../question");
+const index_1 = require("../index");
+// Parse the Zod schema with no input to generate the default JSON schemas
+function questionFormatInfo(name) {
+    if (name in index_1.QuestionSchemaMap) {
+        const usage = question_1.QuestionFormatsUsage[name];
+        const schema = index_1.QuestionSchemaMap[name];
+        const parsedSchema = schema.parse({ type: name });
+        return {
+            type: name,
+            title: usage === null || usage === void 0 ? void 0 : usage.title,
+            usageDescription: usage === null || usage === void 0 ? void 0 : usage.usageDescription,
+            defaultJSON: parsedSchema
+        };
+    }
+    else {
+        return null;
+    }
+}
+describe('Get question format information', () => {
+    it('for affiliationSearch question format', () => {
+        const format = questionFormatInfo('affiliationSearch');
+        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('affiliationSearch');
+        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Affiliation Search');
+        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+        const expectedJSON = {
+            type: 'affiliationSearch',
+            attributes: {},
+            meta: { schemaVersion: '1.0' },
+            graphQL: {
+                displayFields: [{
+                        label: "Institution",
+                        propertyName: "displayName",
+                    }],
+                query: index_1.affiliationQuery,
+                responseField: 'affiliations.items',
+                variables: [{
+                        label: "Search for your institution",
+                        minLength: 3,
+                        name: "name",
+                        type: "string",
+                    }],
+                answerField: 'uri'
+            }
+        };
+        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+    });
+    it('for boolean question format', () => {
+        const format = questionFormatInfo('boolean');
+        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('boolean');
+        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Yes/No Field');
+        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+        const expectedJSON = {
+            type: 'boolean',
+            attributes: { checked: false },
+            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+        };
+        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+    });
+    it('for checkBoxes question format', () => {
+        const format = questionFormatInfo('checkBoxes');
+        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('checkBoxes');
+        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Check Boxes');
+        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+        const expectedJSON = {
+            type: 'checkBoxes',
+            attributes: {},
+            options: [{
+                    label: 'Option A',
+                    value: 'a',
+                    checked: false
+                }],
+            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+        };
+        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+    });
+    it('for currency question format', () => {
+        const format = questionFormatInfo('currency');
+        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('currency');
+        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Currency Field');
+        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+        const expectedJSON = {
+            type: 'currency',
+            attributes: {
+                denomination: 'USD',
+                min: 0,
+                step: 1
+            },
+            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+        };
+        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+    });
+});
+it('for date question format', () => {
+    const format = questionFormatInfo('date');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('date');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Date Field');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'date',
+        attributes: {
+            step: 1
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for dateRange question format', () => {
+    const format = questionFormatInfo('dateRange');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('dateRange');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Date Range');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'dateRange',
+        attributes: {},
+        columns: {
+            start: {
+                label: 'From',
+                step: 1
+            },
+            end: {
+                label: 'To',
+                step: 1
+            }
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for email question format', () => {
+    const format = questionFormatInfo('email');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('email');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Email Field');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'email',
+        attributes: {
+            maxLength: 255,
+            multiple: false,
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for multiselectBox question format', () => {
+    const format = questionFormatInfo('multiselectBox');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('multiselectBox');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Multi-select Box');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'multiselectBox',
+        attributes: {
+            multiple: true,
+        },
+        options: [{
+                label: 'Option A',
+                value: 'a',
+                selected: false
+            }],
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for number question format', () => {
+    const format = questionFormatInfo('number');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('number');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Number Field');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'number',
+        attributes: {
+            min: 0,
+            step: 1,
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for numberRange format', () => {
+    const format = questionFormatInfo('numberRange');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('numberRange');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Number Range');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'numberRange',
+        attributes: {},
+        columns: {
+            start: {
+                label: 'From',
+                min: 0,
+                step: 1,
+            },
+            end: {
+                label: 'To',
+                min: 0,
+                step: 1,
+            }
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for radioButtons question format', () => {
+    const format = questionFormatInfo('radioButtons');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('radioButtons');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Radio Buttons');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'radioButtons',
+        attributes: {},
+        options: [{
+                label: 'Option A',
+                value: 'a',
+                selected: false
+            }],
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for selectBox question format', () => {
+    const format = questionFormatInfo('selectBox');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('selectBox');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Select Box');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'selectBox',
+        attributes: {
+            multiple: false,
+        },
+        options: [{
+                label: 'Option A',
+                value: 'a',
+                selected: false
+            }],
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for table question format', () => {
+    const format = questionFormatInfo('table');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('table');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Table');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'table',
+        attributes: {
+            canAddRows: true,
+            canRemoveRows: true,
+            initialRows: 1
+        },
+        columns: [{
+                heading: 'Column A',
+                content: {
+                    type: 'textArea',
+                    attributes: {
+                        asRichText: true,
+                        cols: 20,
+                        rows: 2,
+                    },
+                    meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION }
+                }
+            }],
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for text question format', () => {
+    const format = questionFormatInfo('text');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('text');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Text Field');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'text',
+        attributes: {
+            maxLength: 255,
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for textArea question format', () => {
+    const format = questionFormatInfo('textArea');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('textArea');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Text Area');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'textArea',
+        attributes: {
+            asRichText: true,
+            cols: 20,
+            rows: 2,
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});
+it('for url question format', () => {
+    const format = questionFormatInfo('url');
+    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('url');
+    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('URL Field');
+    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
+    const expectedJSON = {
+        type: 'url',
+        attributes: {
+            maxLength: 255,
+        },
+        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
+    };
+    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
+});