@dmptool/types 1.1.0 → 1.1.1

package/README.md

@@ -76,6 +76,8 @@ Once added, you can then import the Types and Zod shemas like this:
 const boolQ: BooleanQuestionType = {
   type: "boolean",
   attributes: {
+    label: "Yes or No",
+    help: "Are you sure?",
     checked: true
   },
   meta: {

package/dist/answers/__tests__/answers.spec.js

@@ -12,9 +12,9 @@ const questions_1 = require("../../questions");
 (0, globals_1.describe)('Answer Type Validations', () => {
     (0, globals_1.it)('should validate BooleanAnswer', () => {
         const validData = { type: 'boolean', answer: true, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
-        (0, globals_1.expect)(() => numberAnswers_1.BooleanAnswerSchema.parse(validData)).not.toThrow();
+        (0, globals_1.expect)(() => optionBasedAnswers_1.BooleanAnswerSchema.parse(validData)).not.toThrow();
         const invalidData = { type: 'boolean', answer: 'true' };
-        (0, globals_1.expect)(() => numberAnswers_1.BooleanAnswerSchema.parse(invalidData)).toThrow();
+        (0, globals_1.expect)(() => optionBasedAnswers_1.BooleanAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate CheckboxesAnswer', () => {
         const validData = { type: 'checkBoxes', answer: ['option1', 'option2'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };

package/dist/answers/index.d.ts

@@ -1,8 +1,8 @@
 import { z } from 'zod';
 import { DateAnswerType, DateRangeAnswerType } from './dateAnswers';
 import { FilteredSearchAnswerType, TypeaheadSearchAnswerType } from './graphQLAnswers';
-import { CheckboxesAnswerType, RadioButtonsAnswerType, SelectBoxAnswerType } from './optionBasedAnswers';
-import { BooleanAnswerType, CurrencyAnswerType, NumberAnswerType, NumberRangeAnswerType } from './numberAnswers';
+import { BooleanAnswerType, CheckboxesAnswerType, RadioButtonsAnswerType, SelectBoxAnswerType } from './optionBasedAnswers';
+import { CurrencyAnswerType, NumberAnswerType, NumberRangeAnswerType } from './numberAnswers';
 import { TableAnswerType } from './tableAnswers';
 import { EmailAnswerType, TextAnswerType, TextAreaAnswerType, URLAnswerType } from './textAnswers';
 import { QuestionTypesEnum } from '../questions';
@@ -638,6 +638,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -656,12 +662,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -728,6 +728,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -746,12 +752,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -820,6 +820,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -838,12 +844,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -912,6 +912,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -930,12 +936,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -1010,6 +1010,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -1028,12 +1034,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -1108,6 +1108,12 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -1126,12 +1132,6 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {

package/dist/answers/index.js

@@ -32,7 +32,7 @@ __exportStar(require("./tableAnswers"), exports);
 __exportStar(require("./textAnswers"), exports);
 // Union of all possible answers
 exports.AnyAnswerSchema = zod_1.z.discriminatedUnion('type', [
-    numberAnswers_1.BooleanAnswerSchema,
+    optionBasedAnswers_1.BooleanAnswerSchema,
     optionBasedAnswers_1.CheckboxesAnswerSchema,
     numberAnswers_1.CurrencyAnswerSchema,
     dateAnswers_1.DateAnswerSchema,
@@ -50,7 +50,7 @@ exports.AnyAnswerSchema = zod_1.z.discriminatedUnion('type', [
 ]);
 // Export a mapping between question types and their corresponding answer schemas
 exports.AnswerSchemaMap = {
-    boolean: numberAnswers_1.BooleanAnswerSchema,
+    boolean: optionBasedAnswers_1.BooleanAnswerSchema,
     checkBoxes: optionBasedAnswers_1.CheckboxesAnswerSchema,
     currency: numberAnswers_1.CurrencyAnswerSchema,
     date: dateAnswers_1.DateAnswerSchema,

package/dist/answers/numberAnswers.d.ts

@@ -1,28 +1,4 @@
 import { z } from 'zod';
-export declare const BooleanAnswerSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>;
-} & {
-    type: z.ZodLiteral<"boolean">;
-    answer: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    type: "boolean";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: boolean;
-}, {
-    type: "boolean";
-    meta: {
-        schemaVersion: "1.0";
-    };
-    answer: boolean;
-}>;
 export declare const CurrencyAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
@@ -110,7 +86,6 @@ export declare const NumberRangeAnswerSchema: z.ZodObject<{
         end: number;
     };
 }>;
-export type BooleanAnswerType = z.infer<typeof BooleanAnswerSchema>;
 export type CurrencyAnswerType = z.infer<typeof CurrencyAnswerSchema>;
 export type NumberAnswerType = z.infer<typeof NumberAnswerSchema>;
 export type NumberRangeAnswerType = z.infer<typeof NumberRangeAnswerSchema>;

package/dist/answers/numberAnswers.js

@@ -1,13 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NumberRangeAnswerSchema = exports.NumberAnswerSchema = exports.CurrencyAnswerSchema = exports.BooleanAnswerSchema = void 0;
+exports.NumberRangeAnswerSchema = exports.NumberAnswerSchema = exports.CurrencyAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to Number Question Types
-exports.BooleanAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('boolean'), // The type of answer
-    answer: zod_1.z.boolean() // The answer to the question (true/false)
-}));
 exports.CurrencyAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('currency'), // The type of answer
     answer: zod_1.z.number() // The answer to the question (number)

package/dist/answers/optionBasedAnswers.d.ts

@@ -1,4 +1,28 @@
 import { z } from 'zod';
+export declare const BooleanAnswerSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+    }, {
+        schemaVersion: "1.0";
+    }>;
+} & {
+    type: z.ZodLiteral<"boolean">;
+    answer: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    meta: {
+        schemaVersion: "1.0";
+    };
+    answer: boolean;
+}, {
+    type: "boolean";
+    meta: {
+        schemaVersion: "1.0";
+    };
+    answer: boolean;
+}>;
 export declare const CheckboxesAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
@@ -71,6 +95,7 @@ export declare const SelectBoxAnswerSchema: z.ZodObject<{
     };
     answer: string[];
 }>;
+export type BooleanAnswerType = z.infer<typeof BooleanAnswerSchema>;
 export type CheckboxesAnswerType = z.infer<typeof CheckboxesAnswerSchema>;
 export type RadioButtonsAnswerType = z.infer<typeof RadioButtonsAnswerSchema>;
 export type SelectBoxAnswerType = z.infer<typeof SelectBoxAnswerSchema>;

package/dist/answers/optionBasedAnswers.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectBoxAnswerSchema = exports.RadioButtonsAnswerSchema = exports.CheckboxesAnswerSchema = void 0;
+exports.SelectBoxAnswerSchema = exports.RadioButtonsAnswerSchema = exports.CheckboxesAnswerSchema = exports.BooleanAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to Option Based Question Types
+exports.BooleanAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('boolean'), // The type of answer
+    answer: zod_1.z.boolean() // The answer to the question (true/false)
+}));
 exports.CheckboxesAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('checkBoxes'), // The type of answer
     answer: zod_1.z.array(zod_1.z.string()) // The answer to the question (array of strings)

package/dist/answers/tableAnswers.d.ts

@@ -706,6 +706,12 @@ export declare const TableColumnAnswerSchema: z.ZodObject<{
             schemaVersion: "1.0";
         };
         answer: string;
+    } | {
+        type: "boolean";
+        meta: {
+            schemaVersion: "1.0";
+        };
+        answer: boolean;
     } | {
         type: "checkBoxes";
         meta: {
@@ -724,12 +730,6 @@ export declare const TableColumnAnswerSchema: z.ZodObject<{
             schemaVersion: "1.0";
         };
         answer: string[];
-    } | {
-        type: "boolean";
-        meta: {
-            schemaVersion: "1.0";
-        };
-        answer: boolean;
     } | {
         type: "currency";
         meta: {
@@ -796,6 +796,12 @@ export declare const TableColumnAnswerSchema: z.ZodObject<{
             schemaVersion: "1.0";
         };
         answer: string;
+    } | {
+        type: "boolean";
+        meta: {
+            schemaVersion: "1.0";
+        };
+        answer: boolean;
     } | {
         type: "checkBoxes";
         meta: {
@@ -814,12 +820,6 @@ export declare const TableColumnAnswerSchema: z.ZodObject<{
             schemaVersion: "1.0";
         };
         answer: string[];
-    } | {
-        type: "boolean";
-        meta: {
-            schemaVersion: "1.0";
-        };
-        answer: boolean;
     } | {
         type: "currency";
         meta: {
@@ -1228,6 +1228,12 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string;
+        } | {
+            type: "boolean";
+            meta: {
+                schemaVersion: "1.0";
+            };
+            answer: boolean;
         } | {
             type: "checkBoxes";
             meta: {
@@ -1246,12 +1252,6 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string[];
-        } | {
-            type: "boolean";
-            meta: {
-                schemaVersion: "1.0";
-            };
-            answer: boolean;
         } | {
             type: "currency";
             meta: {
@@ -1318,6 +1318,12 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string;
+        } | {
+            type: "boolean";
+            meta: {
+                schemaVersion: "1.0";
+            };
+            answer: boolean;
         } | {
             type: "checkBoxes";
             meta: {
@@ -1336,12 +1342,6 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string[];
-        } | {
-            type: "boolean";
-            meta: {
-                schemaVersion: "1.0";
-            };
-            answer: boolean;
         } | {
             type: "currency";
             meta: {
@@ -1410,6 +1410,12 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string;
+        } | {
+            type: "boolean";
+            meta: {
+                schemaVersion: "1.0";
+            };
+            answer: boolean;
         } | {
             type: "checkBoxes";
             meta: {
@@ -1428,12 +1434,6 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string[];
-        } | {
-            type: "boolean";
-            meta: {
-                schemaVersion: "1.0";
-            };
-            answer: boolean;
         } | {
             type: "currency";
             meta: {
@@ -1502,6 +1502,12 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string;
+        } | {
+            type: "boolean";
+            meta: {
+                schemaVersion: "1.0";
+            };
+            answer: boolean;
         } | {
             type: "checkBoxes";
             meta: {
@@ -1520,12 +1526,6 @@ export declare const TableRowAnswerSchema: z.ZodObject<{
                 schemaVersion: "1.0";
             };
             answer: string[];
-        } | {
-            type: "boolean";
-            meta: {
-                schemaVersion: "1.0";
-            };
-            answer: boolean;
         } | {
             type: "currency";
             meta: {
@@ -1945,6 +1945,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -1963,12 +1969,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -2035,6 +2035,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -2053,12 +2059,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -2127,6 +2127,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -2145,12 +2151,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -2219,6 +2219,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -2237,12 +2243,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -2317,6 +2317,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -2335,12 +2341,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {
@@ -2415,6 +2415,12 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string;
+            } | {
+                type: "boolean";
+                meta: {
+                    schemaVersion: "1.0";
+                };
+                answer: boolean;
             } | {
                 type: "checkBoxes";
                 meta: {
@@ -2433,12 +2439,6 @@ export declare const TableAnswerSchema: z.ZodObject<{
                     schemaVersion: "1.0";
                 };
                 answer: string[];
-            } | {
-                type: "boolean";
-                meta: {
-                    schemaVersion: "1.0";
-                };
-                answer: boolean;
             } | {
                 type: "currency";
                 meta: {

package/dist/answers/tableAnswers.js

@@ -10,7 +10,7 @@ const numberAnswers_1 = require("./numberAnswers");
 const textAnswers_1 = require("./textAnswers");
 // 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', [
-    numberAnswers_1.BooleanAnswerSchema,
+    optionBasedAnswers_1.BooleanAnswerSchema,
     optionBasedAnswers_1.CheckboxesAnswerSchema,
     numberAnswers_1.CurrencyAnswerSchema,
     dateAnswers_1.DateAnswerSchema,

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

@@ -2,54 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const numberQuestions_1 = require("../numberQuestions");
 describe("Number 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(() => numberQuestions_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(() => numberQuestions_1.BooleanQuestionSchema.parse(invalidBooleanQuestion)).toThrow();
-    });
-    it("should validate a valid BooleanQuestion", () => {
-        const validBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: true,
-            },
-        };
-        expect(() => numberQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid BooleanQuestion", () => {
-        const invalidBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: "true", // Invalid type
-            },
-        };
-        expect(() => numberQuestions_1.BooleanQuestionSchema.parse(invalidBooleanQuestion)).toThrow();
-    });
     it("should validate a valid CurrencyQuestion", () => {
         const validCurrencyQuestion = {
             type: "currency",