@dmptool/types 1.0.8 → 1.1.1

package/dist/questions/optionBasedQuestions.d.ts

@@ -1,236 +1,265 @@
 import { z } from "zod";
-export declare const CheckboxesQuestionSchema: z.ZodObject<{
-    meta: z.ZodObject<{
+export declare const BooleanQuestionSchema: z.ZodObject<{
+    meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
-        labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
-        labelTranslationKey?: string | undefined;
     }, {
         schemaVersion: "1.0";
+    }>>;
+} & {
+    type: z.ZodLiteral<"boolean">;
+    attributes: z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    } & {
+        checked: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
+        checked?: boolean | undefined;
+    }, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        checked?: boolean | undefined;
     }>;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    attributes: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        checked?: boolean | undefined;
+    };
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}, {
+    type: "boolean";
+    attributes: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        checked?: boolean | undefined;
+    };
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}>;
+export declare const CheckboxesQuestionSchema: z.ZodObject<{
+    attributes: z.ZodOptional<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+    }, {
+        label?: string | undefined;
+        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<"checkBoxes">;
     options: z.ZodArray<z.ZodObject<{
-        type: z.ZodLiteral<"option">;
-        attributes: z.ZodObject<{
-            label: z.ZodString;
-            value: z.ZodString;
-        } & {
-            checked: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        }, {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        }>;
+        label: z.ZodString;
+        value: z.ZodString;
+    } & {
+        checked: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        checked?: boolean | undefined;
     }, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        checked?: boolean | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    type: "checkBoxes";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        checked?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
+    type: "checkBoxes";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }, {
-    type: "checkBoxes";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            checked?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        checked?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
+    type: "checkBoxes";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }>;
 export declare const RadioButtonsQuestionSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    attributes: z.ZodOptional<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }, {
-        schemaVersion: "1.0";
+        label?: string | undefined;
+        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<"radioButtons">;
     options: z.ZodArray<z.ZodObject<{
-        type: z.ZodLiteral<"option">;
-        attributes: z.ZodObject<{
-            label: z.ZodString;
-            value: z.ZodString;
-        } & {
-            selected: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        }, {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        }>;
+        label: z.ZodString;
+        value: z.ZodString;
+    } & {
+        selected: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    type: "radioButtons";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
+    type: "radioButtons";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }, {
-    type: "radioButtons";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
+    type: "radioButtons";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }>;
 export declare const SelectBoxQuestionSchema: z.ZodObject<{
-    meta: z.ZodObject<{
+    meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
-        labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
-        labelTranslationKey?: string | undefined;
     }, {
         schemaVersion: "1.0";
-        labelTranslationKey?: string | undefined;
-    }>;
+    }>>;
 } & {
     type: z.ZodLiteral<"selectBox">;
     options: z.ZodArray<z.ZodObject<{
-        type: z.ZodLiteral<"option">;
-        attributes: z.ZodObject<{
-            label: z.ZodString;
-            value: z.ZodString;
-        } & {
-            selected: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        }, {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        }>;
+        label: z.ZodString;
+        value: z.ZodString;
+    } & {
+        selected: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }, {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }>, "many">;
     attributes: z.ZodOptional<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    } & {
         multiple: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     }, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "selectBox";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
-        labelTranslationKey?: string | undefined;
-    };
+    type: "selectBox";
     attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }, {
-    type: "selectBox";
     options: {
-        type: "option";
-        attributes: {
-            value: string;
-            label: string;
-            selected?: boolean | undefined;
-        };
+        value: string;
+        label: string;
+        selected?: boolean | undefined;
     }[];
-    meta: {
-        schemaVersion: "1.0";
-        labelTranslationKey?: string | undefined;
-    };
+    type: "selectBox";
     attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }>;
+export type BooleanQuestionType = z.infer<typeof BooleanQuestionSchema>;
 export type CheckboxesQuestionType = z.infer<typeof CheckboxesQuestionSchema>;
 export type RadioButtonsQuestionType = z.infer<typeof RadioButtonsQuestionSchema>;
 export type SelectBoxQuestionType = z.infer<typeof SelectBoxQuestionSchema>;

package/dist/questions/optionBasedQuestions.js

@@ -1,29 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectBoxQuestionSchema = exports.RadioButtonsQuestionSchema = exports.CheckboxesQuestionSchema = void 0;
+exports.SelectBoxQuestionSchema = exports.RadioButtonsQuestionSchema = exports.CheckboxesQuestionSchema = exports.BooleanQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 // A select box, radio buttons, or checkboxes option
 const OptionSchema = zod_1.z.object({
-    type: zod_1.z.literal('option'), // The type of option
-    attributes: zod_1.z.object({
-        label: zod_1.z.string(), // The label of the option
-        value: zod_1.z.string(), // The value of the option
-    }),
+    label: zod_1.z.string(), // The label of the option
+    value: zod_1.z.string(), // The value of the option
 });
-const BaseOptionAttributes = OptionSchema.shape.attributes;
-const CheckedOptionSchema = zod_1.z.object({
-    type: zod_1.z.literal('option'),
-    attributes: BaseOptionAttributes.extend({
+const BaseAttributes = question_1.QuestionSchema.shape.attributes;
+const CheckedOptionSchema = OptionSchema.merge(zod_1.z.object({
+    checked: zod_1.z.boolean().optional(),
+}));
+const SelectedOptionSchema = OptionSchema.merge(zod_1.z.object({
+    selected: zod_1.z.boolean().optional(),
+}));
+exports.BooleanQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('boolean'),
+    attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
         checked: zod_1.z.boolean().optional(),
-    }),
-});
-const SelectedOptionSchema = zod_1.z.object({
-    type: zod_1.z.literal('option'),
-    attributes: BaseOptionAttributes.extend({
-        selected: zod_1.z.boolean().optional(),
-    }),
-});
+    })),
+}));
 // Check boxes question and answer
 exports.CheckboxesQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('checkBoxes'), // The type of question
@@ -38,7 +35,7 @@ exports.RadioButtonsQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.obj
 exports.SelectBoxQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('selectBox'), // The type of question
     options: zod_1.z.array(SelectedOptionSchema),
-    attributes: zod_1.z.object({
+    attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
         multiple: zod_1.z.boolean().optional() // Whether to allow multiple selections (default is false)
-    }).optional()
+    })).optional()
 }));

package/dist/questions/question.d.ts

@@ -3,27 +3,45 @@ export declare const CURRENT_SCHEMA_VERSION = "1.0";
 export declare const QuestionTypesEnum: z.ZodEnum<["boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
 export declare const QuestionSchema: z.ZodObject<{
     type: z.ZodEnum<["boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
-    meta: z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    attributes: z.ZodOptional<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }, {
-        schemaVersion: "1.0";
+        label?: string | undefined;
+        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";
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
-    meta: {
-        schemaVersion: "1.0";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }, {
     type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
-    meta: {
-        schemaVersion: "1.0";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    };
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
 }>;
 export type QuestionType = z.infer<typeof QuestionSchema>;

package/dist/questions/question.js

@@ -22,11 +22,17 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'typeaheadSearch',
     'url'
 ]);
+const DefaultMetaSchema = zod_1.z.object({
+    schemaVersion: zod_1.z.literal(exports.CURRENT_SCHEMA_VERSION), // The schema version (default is CURRENT_SCHEMA_VERSION)
+});
+const DefaultAttributesSchema = zod_1.z.object({
+    label: zod_1.z.string().optional(), // UI label for the field
+    help: zod_1.z.string().optional(), // Help/tooltip text for the field
+    labelTranslationKey: zod_1.z.string().optional() // The translation key for the label (DMP Tool only)
+});
 // Base abstract type for all questions
 exports.QuestionSchema = zod_1.z.object({
     type: exports.QuestionTypesEnum, // The type of question
-    meta: zod_1.z.object({
-        schemaVersion: zod_1.z.literal(exports.CURRENT_SCHEMA_VERSION), // The schema version (default is CURRENT_SCHEMA_VERSION)
-        labelTranslationKey: zod_1.z.string().optional() // The translation key for the label (DMP Tool only)
-    }),
+    attributes: DefaultAttributesSchema.optional(), // Field attributes
+    meta: DefaultMetaSchema.optional(), // Meta information for the field
 });