@dmptool/types 1.1.1 → 1.1.3

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: {
@@ -147,7 +137,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
             attributes: {
                 label: "Fruits",
                 help: "Select all fruits you like",
-                multiple: true,
+                multiple: false,
             },
             options: [
                 {
@@ -158,6 +148,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Canada",
                     value: "ca",
+                    selected: false,
                 },
             ],
             meta: {
@@ -187,3 +178,51 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
         (0, globals_1.expect)(() => optionBasedQuestions_1.SelectBoxQuestionSchema.parse(invalidSelectBoxQuestion)).toThrow();
     });
 });
+(0, globals_1.describe)("MultiselectBoxQuestion", () => {
+    (0, globals_1.it)("should validate a valid MultiselectBoxQuestion object", () => {
+        const validSelectBoxQuestion = {
+            type: "multiselectBox",
+            attributes: {
+                label: "Fruits",
+                help: "Select all fruits you like",
+                multiple: true,
+            },
+            options: [
+                {
+                    label: "USA",
+                    value: "us",
+                    selected: true,
+                },
+                {
+                    label: "Canada",
+                    value: "ca",
+                    selected: false,
+                },
+            ],
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        (0, globals_1.expect)(() => optionBasedQuestions_1.MultiselectBoxQuestionSchema.parse(validSelectBoxQuestion)).not.toThrow();
+    });
+    (0, globals_1.it)("should throw an error for an invalid MultiselectBoxQuestion object", () => {
+        const invalidSelectBoxQuestion = {
+            type: "multiselectBox",
+            questionText: "Select your country",
+            options: [
+                {
+                    label: "USA",
+                    value: "us",
+                    selected: "true", // Invalid type for selected
+                },
+            ],
+            attributes: {
+                multiple: "true", // Invalid type for multiple
+            },
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        (0, globals_1.expect)(() => optionBasedQuestions_1.MultiselectBoxQuestionSchema.parse(invalidSelectBoxQuestion)).toThrow();
+    });
+});

package/dist/questions/dateQuestions.d.ts

@@ -1,13 +1,5 @@
 import { z } from "zod";
-export declare const DateQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const DateQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"date">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
@@ -16,14 +8,14 @@ export declare const DateQuestionSchema: z.ZodObject<{
     } & {
         max: z.ZodOptional<z.ZodString>;
         min: z.ZodOptional<z.ZodString>;
-        step: z.ZodOptional<z.ZodNumber>;
+        step: z.ZodDefault<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: string | undefined;
         min?: string | undefined;
-        step?: number | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -32,18 +24,34 @@ export declare const DateQuestionSchema: z.ZodObject<{
         min?: string | undefined;
         step?: number | undefined;
     }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        title: z.ZodOptional<z.ZodLiteral<"Date Field">>;
+        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a date.">>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Date Field" | undefined;
+        usageDescription?: "For questions that require a date." | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Date Field" | undefined;
+        usageDescription?: "For questions that require a date." | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "date";
     attributes?: {
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: string | undefined;
         min?: string | undefined;
-        step?: number | undefined;
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Date Field" | undefined;
+        usageDescription?: "For questions that require a date." | undefined;
     } | undefined;
 }, {
     type: "date";
@@ -57,6 +65,8 @@ export declare const DateQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Date Field" | undefined;
+        usageDescription?: "For questions that require a date." | undefined;
     } | undefined;
 }>;
 export declare const DateRangeQuestionSchema: z.ZodObject<{
@@ -73,31 +83,24 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
 } & {
     type: z.ZodLiteral<"dateRange">;
     columns: z.ZodObject<{
-        start: z.ZodOptional<z.ZodObject<{
+        start: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
-            step: z.ZodOptional<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -105,22 +108,22 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        }>>;
-        end: z.ZodOptional<z.ZodObject<{
+        }>;
+        end: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
-            step: z.ZodOptional<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -128,61 +131,75 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        }>>;
+        }>;
     }, "strip", z.ZodTypeAny, {
-        start?: {
+        start: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     }, {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
+        };
     }>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        title: z.ZodOptional<z.ZodLiteral<"Date Range">>;
+        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a date range (e.g. From/To, Start/End)">>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Date Range" | undefined;
+        usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Date Range" | undefined;
+        usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "dateRange";
     columns: {
-        start?: {
+        start: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -191,26 +208,28 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Date Range" | undefined;
+        usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
     } | undefined;
 }, {
     type: "dateRange";
     columns: {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -219,6 +238,8 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Date Range" | undefined;
+        usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
     } | undefined;
 }>;
 export type DateQuestionType = z.infer<typeof DateQuestionSchema>;

package/dist/questions/dateQuestions.js

@@ -4,21 +4,30 @@ exports.DateRangeQuestionSchema = exports.DateQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
+const BaseMeta = question_1.QuestionSchema.shape.meta;
 const DateAttributesSchema = BaseAttributes.unwrap().merge(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)
-    step: zod_1.z.number().optional() // The step value (default is 1 day)
+    max: zod_1.z.string().optional(),
+    min: zod_1.z.string().optional(),
+    step: zod_1.z.number().default(1),
 }));
 // 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: DateAttributesSchema.optional(),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Date Field').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a date.').optional(),
+    })).optional(),
 }));
 // Date range question and answer
 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: DateAttributesSchema.optional(),
-        end: DateAttributesSchema.optional()
-    })
+        start: DateAttributesSchema,
+        end: DateAttributesSchema
+    }),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Date Range').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a date range (e.g. From/To, Start/End)').optional(),
+    })).optional(),
 }));