@dmptool/types 1.1.1 → 1.1.2

package/dist/questions/optionBasedQuestions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectBoxQuestionSchema = exports.RadioButtonsQuestionSchema = exports.CheckboxesQuestionSchema = exports.BooleanQuestionSchema = void 0;
+exports.MultiselectBoxQuestionSchema = 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
@@ -9,33 +9,111 @@ const OptionSchema = zod_1.z.object({
     value: zod_1.z.string(), // The value of the option
 });
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
+const BaseMeta = question_1.QuestionSchema.shape.meta;
 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(),
 }));
+// Yes/No (boolean) question
+const defaultBooleanJSON = {
+    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { checked: false }),
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 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(),
-    })),
+    })).optional(),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Yes/No Field').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a simple Yes/No response.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultBooleanJSON, null, 2)).optional(),
+    })).optional()
 }));
 // Check boxes question and answer
+const defaultCheckboxesJSON = {
+    type: 'checkBoxes',
+    attributes: Object.assign({}, question_1.defaultAttributes),
+    options: [
+        {
+            label: 'Option 1',
+            value: '1',
+            checked: false
+        }
+    ],
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 exports.CheckboxesQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('checkBoxes'), // The type of question
-    options: zod_1.z.array(CheckedOptionSchema)
+    options: zod_1.z.array(CheckedOptionSchema),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Check Boxes').optional(),
+        usageDescription: zod_1.z.literal('For multiple choice questions where users can select multiple options.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultCheckboxesJSON, null, 2)).optional(),
+    })).optional()
 }));
 // Radio buttons question and answer
+const defaultRadioButtonsJSON = {
+    type: 'radioButtons',
+    attributes: Object.assign({}, question_1.defaultAttributes),
+    options: [
+        {
+            label: 'Option 1',
+            value: 'option1',
+            selected: false
+        }
+    ],
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 exports.RadioButtonsQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('radioButtons'), // The type of question
-    options: zod_1.z.array(SelectedOptionSchema)
+    options: zod_1.z.array(SelectedOptionSchema),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Radio Buttons').optional(),
+        usageDescription: zod_1.z.literal('For multiple choice questions where users select just one option.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultRadioButtonsJSON, null, 2)).optional(),
+    })).optional()
 }));
 // Select box question and answer
+const selectBoxAttributes = BaseAttributes.unwrap().merge(zod_1.z.object({
+    multiple: zod_1.z.boolean()
+}));
+const defaultSelectBoxJSON = {
+    type: 'selectBox',
+    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { multiple: false }),
+    options: [
+        {
+            label: 'Option 1',
+            value: 'option1',
+        }
+    ],
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 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: BaseAttributes.unwrap().merge(zod_1.z.object({
-        multiple: zod_1.z.boolean().optional() // Whether to allow multiple selections (default is false)
+    attributes: selectBoxAttributes.merge(zod_1.z.object({
+        multiple: zod_1.z.literal(false) // Whether to allow multiple selections (default is false)
+    })),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Select Box').optional(),
+        usageDescription: zod_1.z.literal('For questions where users select one option from a list.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultSelectBoxJSON, null, 2)).optional(),
     })).optional()
 }));
+// Multi-select box question and answer
+const defaultMultiselectBoxJSON = defaultSelectBoxJSON;
+defaultMultiselectBoxJSON.attributes.multiple = true;
+exports.MultiselectBoxQuestionSchema = exports.SelectBoxQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('multiselectBox'),
+    attributes: selectBoxAttributes.merge(zod_1.z.object({
+        multiple: zod_1.z.literal(true) // Whether to allow multiple selections (default is false)
+    })),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Multi-select Box').optional(),
+        usageDescription: zod_1.z.literal('For questions where multiple answers are valid. Allows users to select several options from a predefined list, providing flexibility in responses.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultMultiselectBoxJSON, null, 2)).optional(),
+    })).optional(),
+}));

package/dist/questions/question.d.ts

@@ -1,8 +1,39 @@
 import { z } from "zod";
 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 QuestionTypesEnum: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
+export declare const defaultMeta: z.infer<typeof DefaultMetaSchema>;
+export declare const defaultAttributes: z.infer<typeof DefaultAttributesSchema>;
+declare const DefaultMetaSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<"1.0">;
+    title: z.ZodOptional<z.ZodString>;
+    usageDescription: z.ZodOptional<z.ZodString>;
+    defaultJSON: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    schemaVersion: "1.0";
+    title?: string | undefined;
+    usageDescription?: string | undefined;
+    defaultJSON?: string | undefined;
+}, {
+    schemaVersion: "1.0";
+    title?: string | undefined;
+    usageDescription?: string | undefined;
+    defaultJSON?: string | undefined;
+}>;
+declare const DefaultAttributesSchema: 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;
+}>;
 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"]>;
+    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
@@ -18,13 +49,22 @@ export declare const QuestionSchema: z.ZodObject<{
     }>>;
     meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+        defaultJSON: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
     attributes?: {
         label?: string | undefined;
         help?: string | undefined;
@@ -32,9 +72,12 @@ export declare const QuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
-    type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
     attributes?: {
         label?: string | undefined;
         help?: string | undefined;
@@ -42,6 +85,10 @@ export declare const QuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export type QuestionType = z.infer<typeof QuestionSchema>;
+export {};

package/dist/questions/question.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionSchema = exports.QuestionTypesEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
+exports.QuestionSchema = exports.defaultAttributes = exports.defaultMeta = exports.QuestionTypesEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
 const zod_1 = require("zod");
 exports.CURRENT_SCHEMA_VERSION = '1.0'; // The current schema version
 // The type of question
 exports.QuestionTypesEnum = zod_1.z.enum([
+    'affiliationSearch',
     'boolean',
     'checkBoxes',
     'currency',
@@ -12,6 +13,7 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'dateRange',
     'email',
     'filteredSearch',
+    'multiselectBox',
     'number',
     'numberRange',
     'radioButtons',
@@ -19,11 +21,21 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'table',
     'text',
     'textArea',
-    'typeaheadSearch',
     'url'
 ]);
+exports.defaultMeta = {
+    schemaVersion: exports.CURRENT_SCHEMA_VERSION,
+};
+exports.defaultAttributes = {
+    label: undefined,
+    help: undefined,
+    labelTranslationKey: undefined,
+};
 const DefaultMetaSchema = zod_1.z.object({
     schemaVersion: zod_1.z.literal(exports.CURRENT_SCHEMA_VERSION), // The schema version (default is CURRENT_SCHEMA_VERSION)
+    title: zod_1.z.string().optional(), // The title of the question type
+    usageDescription: zod_1.z.string().optional(), // A description of when to use the question type
+    defaultJSON: zod_1.z.string().optional(), // A default version of the question
 });
 const DefaultAttributesSchema = zod_1.z.object({
     label: zod_1.z.string().optional(), // UI label for the field