@dmptool/types 1.0.5 → 1.0.7

package/dist/answers/tableAnswers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
+exports.TableAnswerSchema = exports.TableRowAnswerSchema = exports.TableColumnAnswerSchema = exports.AnyTableColumnAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 const optionBasedAnswers_1 = require("./optionBasedAnswers");
@@ -12,7 +12,7 @@ exports.AnyTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
     primitiveAnswers_1.BooleanAnswerSchema,
     optionBasedAnswers_1.CheckboxesAnswerSchema,
     primitiveAnswers_1.CurrencyAnswerSchema,
-    dateAnswers_1.DatePickerAnswerSchema,
+    dateAnswers_1.DateAnswerSchema,
     dateAnswers_1.DateRangeAnswerSchema,
     primitiveAnswers_1.EmailAnswerSchema,
     graphQLAnswers_1.FilteredSearchAnswerSchema,
@@ -24,8 +24,15 @@ exports.AnyTableColumnAnswerSchema = zod_1.z.discriminatedUnion('type', [
     graphQLAnswers_1.TypeaheadSearchAnswerSchema,
     primitiveAnswers_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
+});
 // 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.AnyTableColumnAnswerSchema) // The answer to the question (array of answers)
+    answer: zod_1.z.array(exports.TableRowAnswerSchema) // The answers to the question (array of rows containing an array of columns)
 }));

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

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const dateQuestions_1 = require("../dateQuestions");
-describe("DatePickerQuestion", () => {
-    it("should validate a valid DatePickerQuestion object", () => {
-        const validDatePicker = {
-            type: "datePicker",
+describe("DateQuestion", () => {
+    it("should validate a valid DateQuestion object", () => {
+        const validDate = {
+            type: "date",
             attributes: {
                 max: "2023-12-31",
                 min: "2023-01-01",
@@ -14,11 +14,11 @@ describe("DatePickerQuestion", () => {
                 schemaVersion: "1.0"
             }
         };
-        expect(() => dateQuestions_1.DatePickerQuestionSchema.parse(validDatePicker)).not.toThrow();
+        expect(() => dateQuestions_1.DateQuestionSchema.parse(validDate)).not.toThrow();
     });
-    it("should throw an error for an invalid DatePickerQuestion object", () => {
-        const invalidDatePicker = {
-            type: "datePicker",
+    it("should throw an error for an invalid DateQuestion object", () => {
+        const invalidDate = {
+            type: "date",
             attributes: {
                 max: 123, // Invalid type for max
                 min: "2023-01-01",
@@ -28,17 +28,17 @@ describe("DatePickerQuestion", () => {
                 schemaVersion: "1.0"
             }
         };
-        expect(() => dateQuestions_1.DatePickerQuestionSchema.parse(invalidDatePicker)).toThrow();
+        expect(() => dateQuestions_1.DateQuestionSchema.parse(invalidDate)).toThrow();
     });
-    it("should allow optional attributes in DatePickerQuestion", () => {
-        const validDatePicker = {
-            type: "datePicker",
+    it("should allow optional attributes in DateQuestion", () => {
+        const validDate = {
+            type: "date",
             attributes: {},
             meta: {
                 schemaVersion: "1.0"
             }
         };
-        expect(() => dateQuestions_1.DatePickerQuestionSchema.parse(validDatePicker)).not.toThrow();
+        expect(() => dateQuestions_1.DateQuestionSchema.parse(validDate)).not.toThrow();
     });
 });
 describe("DateRangeQuestion", () => {
@@ -47,7 +47,7 @@ describe("DateRangeQuestion", () => {
             type: "dateRange",
             columns: {
                 start: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         label: "Start Date",
                         max: "2023-12-31",
@@ -59,7 +59,7 @@ describe("DateRangeQuestion", () => {
                     }
                 },
                 end: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         label: "End Date",
                         max: "2023-12-31",
@@ -82,7 +82,7 @@ describe("DateRangeQuestion", () => {
             type: "dateRange",
             columns: {
                 start: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         label: "Start Date",
                         max: "2023-12-31",
@@ -94,7 +94,7 @@ describe("DateRangeQuestion", () => {
                     }
                 },
                 end: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         label: 123, // Invalid type for label
                         max: "2023-12-31",
@@ -112,12 +112,12 @@ describe("DateRangeQuestion", () => {
         };
         expect(() => dateQuestions_1.DateRangeQuestionSchema.parse(invalidDateRange)).toThrow();
     });
-    it("should require labels for start and end date pickers", () => {
+    it("should require labels for start and end dates", () => {
         const invalidDateRange = {
             type: "dateRange",
             columns: {
                 start: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         max: "2023-12-31",
                         min: "2023-01-01",
@@ -128,7 +128,7 @@ describe("DateRangeQuestion", () => {
                     }
                 },
                 end: {
-                    type: "datePicker",
+                    type: "date",
                     attributes: {
                         label: "End Date",
                         max: "2023-12-31",

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

@@ -2,6 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const primitiveQuestions_1 = require("../primitiveQuestions");
 describe("Primitive Questions Zod Schemas", () => {
+    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
+            },
+        };
+        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
+    });
+    it('optional fields should throw an error if the value is null', () => {
+        const invalidBooleanQuestion = {
+            type: "boolean",
+            meta: {
+                schemaVersion: "1.0",
+            },
+            attributes: {
+                checked: null, // Invalid value
+            },
+        };
+        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(invalidBooleanQuestion)).toThrow();
+    });
     it("should validate a valid BooleanQuestion", () => {
         const validBooleanQuestion = {
             type: "boolean",
@@ -106,6 +130,74 @@ describe("Primitive Questions Zod Schemas", () => {
         };
         expect(() => primitiveQuestions_1.NumberQuestionSchema.parse(invalidNumberQuestion)).toThrow();
     });
+    it("should validate a valid NumberRangeQuestion", () => {
+        const validNumberRangeQuestion = {
+            type: "numberRange",
+            meta: {
+                schemaVersion: "1.0",
+            },
+            columns: {
+                start: {
+                    type: "number",
+                    attributes: {
+                        label: "Start",
+                        min: 0,
+                        max: 50,
+                        step: 1,
+                    },
+                    meta: {
+                        schemaVersion: "1.0",
+                    },
+                },
+                end: {
+                    type: "number",
+                    attributes: {
+                        label: "End",
+                        min: 50,
+                        max: 100,
+                        step: 1,
+                    },
+                    meta: {
+                        schemaVersion: "1.0",
+                    },
+                },
+            },
+        };
+        expect(() => primitiveQuestions_1.NumberRangeQuestionSchema.parse(validNumberRangeQuestion)).not.toThrow();
+    });
+    it("should invalidate an invalid NumberRangeQuestion", () => {
+        const invalidNumberRangeQuestion = {
+            type: "numberRange",
+            meta: {
+                schemaVersion: "1.0",
+            },
+            columns: {
+                start: {
+                    type: "number",
+                    attributes: {
+                        min: 0,
+                        max: 50,
+                    },
+                    meta: {
+                        schemaVersion: "1.0",
+                    },
+                },
+                end: {
+                    type: "number",
+                    attributes: {
+                        label: "End",
+                        min: 50,
+                        max: 100,
+                        step: 1,
+                    },
+                    meta: {
+                        schemaVersion: "1.0",
+                    },
+                },
+            },
+        };
+        expect(() => primitiveQuestions_1.NumberRangeQuestionSchema.parse(invalidNumberRangeQuestion)).toThrow();
+    });
     it("should validate a valid TextAreaQuestion", () => {
         const validTextAreaQuestion = {
             type: "textArea",

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tableQuestions_1 = require("../tableQuestions");
+describe("TableQuestionSchema", () => {
+    it("should validate a valid TableQuestion object", () => {
+        const validTableQuestion = {
+            type: "table",
+            columns: [
+                {
+                    heading: "Name",
+                    content: {
+                        type: "text",
+                        meta: {
+                            schemaVersion: "1.0"
+                        }
+                    }
+                },
+                {
+                    heading: "Age",
+                    content: {
+                        type: "number",
+                        attributes: {
+                            min: 18,
+                            max: 65,
+                            step: 1,
+                        },
+                        meta: {
+                            schemaVersion: "1.0"
+                        }
+                    }
+                }
+            ],
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        expect(() => tableQuestions_1.TableQuestionSchema.parse(validTableQuestion)).not.toThrow();
+    });
+    it("should throw an error for an invalid TableQuestion object", () => {
+        const invalidTableQuestion = {
+            type: "table",
+            columns: [
+                {
+                    heading: "Name",
+                    content: {
+                        type: "text",
+                        meta: {
+                            schemaVersion: "1.0"
+                        }
+                    }
+                },
+                {
+                    heading: "Age",
+                    content: {
+                        type: "number",
+                        attributes: {
+                            min: '10', // Invalid value
+                            max: 120,
+                            step: 1,
+                        },
+                        meta: {
+                            schemaVersion: "1.0"
+                        }
+                    }
+                }
+            ],
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        expect(() => tableQuestions_1.TableQuestionSchema.parse(invalidTableQuestion)).toThrow();
+    });
+});

package/dist/questions/dateQuestions.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const DatePickerQuestionSchema: z.ZodObject<{
+export declare const DateQuestionSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -11,7 +11,7 @@ export declare const DatePickerQuestionSchema: z.ZodObject<{
         labelTranslationKey?: string | undefined;
     }>;
 } & {
-    type: z.ZodLiteral<"datePicker">;
+    type: z.ZodLiteral<"date">;
     attributes: z.ZodOptional<z.ZodObject<{
         max: z.ZodOptional<z.ZodString>;
         min: z.ZodOptional<z.ZodString>;
@@ -26,7 +26,7 @@ export declare const DatePickerQuestionSchema: z.ZodObject<{
         step?: number | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "datePicker";
+    type: "date";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
@@ -37,7 +37,7 @@ export declare const DatePickerQuestionSchema: z.ZodObject<{
         step?: number | undefined;
     } | undefined;
 }, {
-    type: "datePicker";
+    type: "date";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
@@ -73,7 +73,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
             }>;
-            type: z.ZodLiteral<"datePicker">;
+            type: z.ZodLiteral<"date">;
         } & {
             attributes: z.ZodObject<{
                 label: z.ZodString;
@@ -83,7 +83,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 label: string;
             }>;
         }, "strip", z.ZodTypeAny, {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -92,7 +92,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 label: string;
             };
         }, {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -112,7 +112,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
             }>;
-            type: z.ZodLiteral<"datePicker">;
+            type: z.ZodLiteral<"date">;
         } & {
             attributes: z.ZodObject<{
                 label: z.ZodString;
@@ -122,7 +122,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 label: string;
             }>;
         }, "strip", z.ZodTypeAny, {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -131,7 +131,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
                 label: string;
             };
         }, {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -142,7 +142,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         }>;
     }, "strip", z.ZodTypeAny, {
         start: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -152,7 +152,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             };
         };
         end: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -163,7 +163,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         };
     }, {
         start: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -173,7 +173,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             };
         };
         end: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -191,7 +191,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     };
     columns: {
         start: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -201,7 +201,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             };
         };
         end: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -219,7 +219,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     };
     columns: {
         start: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -229,7 +229,7 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             };
         };
         end: {
-            type: "datePicker";
+            type: "date";
             meta: {
                 schemaVersion: "1.0";
                 labelTranslationKey?: string | undefined;
@@ -240,5 +240,5 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         };
     };
 }>;
-export type DatePickerQuestionType = z.infer<typeof DatePickerQuestionSchema>;
+export type DateQuestionType = z.infer<typeof DateQuestionSchema>;
 export type DateRangeQuestionType = z.infer<typeof DateRangeQuestionSchema>;

package/dist/questions/dateQuestions.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateRangeQuestionSchema = exports.DatePickerQuestionSchema = void 0;
+exports.DateRangeQuestionSchema = exports.DateQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
-// Date picker question and answer
-exports.DatePickerQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('datePicker'), // The type of question
+// Date question and answer
+exports.DateQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('date'), // The type of question
     attributes: zod_1.z.object({
         max: zod_1.z.string().optional(), // The maximum date (no default)
         min: zod_1.z.string().optional(), // The minimum date (no default)
@@ -16,14 +16,14 @@ exports.DatePickerQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.objec
 exports.DateRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('dateRange'), // The type of question
     columns: zod_1.z.object({
-        start: exports.DatePickerQuestionSchema.merge(zod_1.z.object({
+        start: exports.DateQuestionSchema.merge(zod_1.z.object({
             attributes: zod_1.z.object({
-                label: zod_1.z.string() // The label for the start date picker
+                label: zod_1.z.string() // The label for the start date
             })
         })),
-        end: exports.DatePickerQuestionSchema.merge(zod_1.z.object({
+        end: exports.DateQuestionSchema.merge(zod_1.z.object({
             attributes: zod_1.z.object({
-                label: zod_1.z.string() // The label for the end date picker
+                label: zod_1.z.string() // The label for the end date
             })
         }))
     })

package/dist/questions/graphQLQuestions.d.ts

@@ -40,15 +40,15 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }, {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -64,8 +64,8 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     }, {
@@ -81,27 +81,24 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     }>;
-    attributes: z.ZodObject<{
+    attributes: z.ZodOptional<z.ZodObject<{
         multiple: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         multiple?: boolean | undefined;
     }, {
         multiple?: boolean | undefined;
-    }>;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "filteredSearch";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
     };
-    attributes: {
-        multiple?: boolean | undefined;
-    };
     graphQL: {
         displayFields: {
             label: string;
@@ -115,20 +112,20 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     };
+    attributes?: {
+        multiple?: boolean | undefined;
+    } | undefined;
 }, {
     type: "filteredSearch";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
     };
-    attributes: {
-        multiple?: boolean | undefined;
-    };
     graphQL: {
         displayFields: {
             label: string;
@@ -142,11 +139,14 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     };
+    attributes?: {
+        multiple?: boolean | undefined;
+    } | undefined;
 }>;
 export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
     meta: z.ZodObject<{
@@ -189,15 +189,15 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }, {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -213,8 +213,8 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     }, {
@@ -230,8 +230,8 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     }>;
@@ -254,8 +254,8 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     };
@@ -278,8 +278,8 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
             label?: string | undefined;
+            minLength?: number | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
     };