@dmptool/types 2.1.0 → 2.2.1

package/dist/questions/numberQuestions.js

@@ -6,13 +6,13 @@ const question_1 = require("./question");
 const NumberAttributesSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.BaseAttributesSchema.shape), { max: zod_1.z.number().optional(), min: zod_1.z.number().default(0), step: zod_1.z.number().default(1) // For floats, use a decimal with the level of precision: 0.01
  }));
 const DefaultNumberAttributes = NumberAttributesSchema.parse({});
-exports.CurrencyQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('currency'), attributes: zod_1.z.object(Object.assign(Object.assign({}, NumberAttributesSchema.shape), { denomination: zod_1.z.string().default('USD') })) }));
+exports.CurrencyQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('currency'), attributes: zod_1.z.object(Object.assign(Object.assign({}, NumberAttributesSchema.shape), { denomination: zod_1.z.string().default('USD') })), showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultCurrencyQuestion = exports.CurrencyQuestionSchema.parse({
     type: 'currency',
     attributes: DefaultNumberAttributes,
     meta: question_1.DefaultMeta
 });
-exports.NumberQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('number'), attributes: NumberAttributesSchema }));
+exports.NumberQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('number'), attributes: NumberAttributesSchema, showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultNumberQuestion = exports.NumberQuestionSchema.parse({
     type: 'number',
     attributes: DefaultNumberAttributes,
@@ -23,7 +23,7 @@ const NumberRangeEndColumnSchema = zod_1.z.object(Object.assign(Object.assign({}
 exports.NumberRangeQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('numberRange'), columns: zod_1.z.object({
         start: NumberRangeStartColumnSchema,
         end: NumberRangeEndColumnSchema
-    }) }));
+    }), showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultNumberRangeQuestion = exports.NumberRangeQuestionSchema.parse({
     type: 'numberRange',
     attributes: question_1.BaseAttributesSchema.parse({}),
@@ -42,7 +42,7 @@ const NumberWithContextAttributesSchema = zod_1.z.object(Object.assign(Object.as
         selected: zod_1.z.boolean().default(false)
     })) }));
 const DefaultNumberWithContextAttributes = NumberWithContextAttributesSchema.parse(Object.assign(Object.assign({}, exports.DefaultNumberQuestion.attributes), { context: [] }));
-exports.NumberWithContextQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('numberWithContext'), attributes: NumberWithContextAttributesSchema }));
+exports.NumberWithContextQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('numberWithContext'), attributes: NumberWithContextAttributesSchema, showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultNumberWithContextQuestion = exports.NumberWithContextQuestionSchema.parse({
     type: 'numberWithContext',
     attributes: DefaultNumberWithContextAttributes,

package/dist/questions/optionBasedQuestions.d.ts

@@ -5,6 +5,7 @@ export declare const BooleanQuestionSchema: z.ZodObject<{
         label: z.ZodString;
         value: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>;
+    showCommentField: z.ZodOptional<z.ZodBoolean>;
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
         title: z.ZodOptional<z.ZodString>;
@@ -22,6 +23,7 @@ export declare const DefaultBooleanQuestion: {
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
+    showCommentField?: boolean | undefined;
 };
 export declare const CheckboxesQuestionSchema: z.ZodObject<{
     type: z.ZodLiteral<"checkBoxes">;
@@ -29,7 +31,9 @@ export declare const CheckboxesQuestionSchema: z.ZodObject<{
         checked: z.ZodDefault<z.ZodBoolean>;
         label: z.ZodDefault<z.ZodString>;
         value: z.ZodDefault<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
+    showCommentField: z.ZodOptional<z.ZodBoolean>;
     attributes: z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
@@ -47,6 +51,7 @@ export declare const DefaultCheckboxesQuestion: {
         checked: boolean;
         label: string;
         value: string;
+        description?: string | undefined;
     }[];
     attributes: {
         label?: string | undefined;
@@ -58,14 +63,16 @@ export declare const DefaultCheckboxesQuestion: {
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
+    showCommentField?: boolean | undefined;
 };
 export declare const RadioButtonsQuestionSchema: z.ZodObject<{
     type: z.ZodLiteral<"radioButtons">;
     options: z.ZodArray<z.ZodObject<{
-        selected: z.ZodDefault<z.ZodBoolean>;
         label: z.ZodDefault<z.ZodString>;
         value: z.ZodDefault<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
+    showCommentField: z.ZodOptional<z.ZodBoolean>;
     attributes: z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
@@ -80,9 +87,9 @@ export declare const RadioButtonsQuestionSchema: z.ZodObject<{
 export declare const DefaultRadioButtonsQuestion: {
     type: "radioButtons";
     options: {
-        selected: boolean;
         label: string;
         value: string;
+        description?: string | undefined;
     }[];
     attributes: {
         label?: string | undefined;
@@ -94,13 +101,14 @@ export declare const DefaultRadioButtonsQuestion: {
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
+    showCommentField?: boolean | undefined;
 };
 export declare const SelectBoxQuestionSchema: z.ZodObject<{
     type: z.ZodLiteral<"selectBox">;
     options: z.ZodArray<z.ZodObject<{
-        selected: z.ZodDefault<z.ZodBoolean>;
         label: z.ZodDefault<z.ZodString>;
         value: z.ZodDefault<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     attributes: z.ZodObject<{
         multiple: z.ZodLiteral<false>;
@@ -108,6 +116,7 @@ export declare const SelectBoxQuestionSchema: z.ZodObject<{
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
+    showCommentField: z.ZodOptional<z.ZodBoolean>;
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
         title: z.ZodOptional<z.ZodString>;
@@ -117,9 +126,9 @@ export declare const SelectBoxQuestionSchema: z.ZodObject<{
 export declare const DefaultSelectBoxQuestion: {
     type: "selectBox";
     options: {
-        selected: boolean;
         label: string;
         value: string;
+        description?: string | undefined;
     }[];
     attributes: {
         multiple: false;
@@ -132,13 +141,14 @@ export declare const DefaultSelectBoxQuestion: {
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
+    showCommentField?: boolean | undefined;
 };
 export declare const MultiselectBoxQuestionSchema: z.ZodObject<{
     type: z.ZodLiteral<"multiselectBox">;
     options: z.ZodArray<z.ZodObject<{
-        selected: z.ZodDefault<z.ZodBoolean>;
         label: z.ZodDefault<z.ZodString>;
         value: z.ZodDefault<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     attributes: z.ZodObject<{
         multiple: z.ZodLiteral<true>;
@@ -146,6 +156,7 @@ export declare const MultiselectBoxQuestionSchema: z.ZodObject<{
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
+    showCommentField: z.ZodOptional<z.ZodBoolean>;
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
         title: z.ZodOptional<z.ZodString>;
@@ -155,9 +166,9 @@ export declare const MultiselectBoxQuestionSchema: z.ZodObject<{
 export declare const DefaultMultiselectBoxQuestion: {
     type: "multiselectBox";
     options: {
-        selected: boolean;
         label: string;
         value: string;
+        description?: string | undefined;
     }[];
     attributes: {
         multiple: true;
@@ -170,6 +181,7 @@ export declare const DefaultMultiselectBoxQuestion: {
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
+    showCommentField?: boolean | undefined;
 };
 export type BooleanQuestionType = z.infer<typeof BooleanQuestionSchema>;
 export type CheckboxesQuestionType = z.infer<typeof CheckboxesQuestionSchema>;

package/dist/questions/optionBasedQuestions.js

@@ -4,14 +4,21 @@ exports.MultiselectBoxQuestionJSONSchema = exports.SelectBoxQuestionJSONSchema =
 const zod_1 = require("zod");
 const question_1 = require("./question");
 // A select box, radio buttons, or checkboxes option
+// NOTE: Question option shapes are intentionally minimal: they describe the configurable
+// properties of each option (label, value, description). We deliberately do NOT include
+// answer-state flags such as `selected` on question definitions because those represent
+// user response state and belong in answer objects/schemas (not in the question configuration).
+// For checkboxes we include a `checked` default on the question option to allow a configured
+// default checked state. Radio/select/multiselect questions should not contain `selected`;
+// user selections are captured by the answer schemas.
 const OptionSchema = zod_1.z.object({
     label: zod_1.z.string().default('Option A'),
     value: zod_1.z.string().default('a'),
+    description: zod_1.z.string().optional(),
 });
+const DefaultOption = OptionSchema.parse({});
 const CheckedOptionSchema = zod_1.z.object(Object.assign(Object.assign({}, OptionSchema.shape), { checked: zod_1.z.boolean().default(false) }));
 const DefaultCheckedOption = CheckedOptionSchema.parse({});
-const SelectedOptionSchema = zod_1.z.object(Object.assign(Object.assign({}, OptionSchema.shape), { selected: zod_1.z.boolean().default(false) }));
-const DefaultSelectedOption = SelectedOptionSchema.parse({});
 const selectBoxAttributes = zod_1.z.object(Object.assign(Object.assign({}, question_1.BaseAttributesSchema.shape), { multiple: zod_1.z.literal(false) }));
 const DefaultSelectBoxAttributes = selectBoxAttributes.parse({
     multiple: false
@@ -20,7 +27,7 @@ const DefaultSelectBoxAttributes = selectBoxAttributes.parse({
 exports.BooleanQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('boolean'), attributes: zod_1.z.object({
         label: zod_1.z.string(),
         value: zod_1.z.boolean().default(false),
-    }) }));
+    }), showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultBooleanQuestion = exports.BooleanQuestionSchema.parse({
     type: 'boolean',
     attributes: {
@@ -30,7 +37,7 @@ exports.DefaultBooleanQuestion = exports.BooleanQuestionSchema.parse({
     meta: question_1.DefaultMeta
 });
 // Check boxes question and answer
-exports.CheckboxesQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('checkBoxes'), options: zod_1.z.array(CheckedOptionSchema) }));
+exports.CheckboxesQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('checkBoxes'), options: zod_1.z.array(CheckedOptionSchema), showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultCheckboxesQuestion = exports.CheckboxesQuestionSchema.parse({
     type: 'checkBoxes',
     attributes: CheckedOptionSchema,
@@ -38,32 +45,38 @@ exports.DefaultCheckboxesQuestion = exports.CheckboxesQuestionSchema.parse({
     options: [DefaultCheckedOption]
 });
 // Radio buttons question and answer
-exports.RadioButtonsQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('radioButtons'), options: zod_1.z.array(SelectedOptionSchema) }));
+exports.RadioButtonsQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('radioButtons'), 
+    // Questions should not include the `selected` flag on options
+    options: zod_1.z.array(OptionSchema), showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultRadioButtonsQuestion = exports.RadioButtonsQuestionSchema.parse({
     type: 'radioButtons',
     attributes: DefaultSelectBoxAttributes,
     meta: question_1.DefaultMeta,
-    options: [DefaultSelectedOption]
+    options: [DefaultOption]
 });
 // Select box question and answer
-exports.SelectBoxQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('selectBox'), options: zod_1.z.array(SelectedOptionSchema), attributes: selectBoxAttributes }));
+exports.SelectBoxQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('selectBox'), 
+    // Questions should not include the `selected` flag on options
+    options: zod_1.z.array(OptionSchema), attributes: selectBoxAttributes, showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultSelectBoxQuestion = exports.SelectBoxQuestionSchema.parse({
     type: 'selectBox',
     attributes: DefaultSelectBoxAttributes,
     meta: question_1.DefaultMeta,
-    options: [DefaultSelectedOption]
+    options: [DefaultOption]
 });
 const multiselectBoxAttributes = zod_1.z.object(Object.assign(Object.assign({}, selectBoxAttributes.shape), { multiple: zod_1.z.literal(true) }));
 const DefaultMultiselectBoxAttributes = multiselectBoxAttributes.parse({
     multiple: true
 });
 // Multi-select box question and answer
-exports.MultiselectBoxQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, exports.SelectBoxQuestionSchema.shape), { type: zod_1.z.literal('multiselectBox'), options: zod_1.z.array(SelectedOptionSchema), attributes: multiselectBoxAttributes }));
+exports.MultiselectBoxQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, exports.SelectBoxQuestionSchema.shape), { type: zod_1.z.literal('multiselectBox'), 
+    // Questions should not include the `selected` flag on options
+    options: zod_1.z.array(OptionSchema), attributes: multiselectBoxAttributes, showCommentField: zod_1.z.boolean().optional() }));
 exports.DefaultMultiselectBoxQuestion = exports.MultiselectBoxQuestionSchema.parse({
     type: 'multiselectBox',
     attributes: DefaultMultiselectBoxAttributes,
     meta: question_1.DefaultMeta,
-    options: [DefaultSelectedOption]
+    options: [DefaultOption]
 });
 exports.BooleanQuestionJSONSchema = zod_1.z.toJSONSchema(exports.BooleanQuestionSchema);
 exports.CheckboxesQuestionJSONSchema = zod_1.z.toJSONSchema(exports.CheckboxesQuestionSchema);