@dmptool/types 1.1.0 → 1.1.2

package/dist/questions/index.js

@@ -31,31 +31,35 @@ __exportStar(require("./optionBasedQuestions"), exports);
 __exportStar(require("./tableQuestions"), exports);
 __exportStar(require("./textQuestions"), exports);
 exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
-    numberQuestions_1.BooleanQuestionSchema,
+    graphQLQuestions_1.AffiliationSearchQuestionSchema,
+    optionBasedQuestions_1.BooleanQuestionSchema,
     optionBasedQuestions_1.CheckboxesQuestionSchema,
     numberQuestions_1.CurrencyQuestionSchema,
     dateQuestions_1.DateQuestionSchema,
     dateQuestions_1.DateRangeQuestionSchema,
     textQuestions_1.EmailQuestionSchema,
     graphQLQuestions_1.FilteredSearchQuestionSchema,
+    optionBasedQuestions_1.MultiselectBoxQuestionSchema,
     numberQuestions_1.NumberQuestionSchema,
+    numberQuestions_1.NumberRangeQuestionSchema,
     optionBasedQuestions_1.RadioButtonsQuestionSchema,
     optionBasedQuestions_1.SelectBoxQuestionSchema,
     tableQuestions_1.TableQuestionSchema,
     textQuestions_1.TextAreaQuestionSchema,
     textQuestions_1.TextQuestionSchema,
-    graphQLQuestions_1.TypeaheadSearchQuestionSchema,
     textQuestions_1.URLQuestionSchema
 ]);
 // Export a mapping between Zod Schemas and their corresponding question type label
 exports.QuestionSchemaMap = {
-    boolean: numberQuestions_1.BooleanQuestionSchema,
+    affiliationSearch: graphQLQuestions_1.AffiliationSearchQuestionSchema,
+    boolean: optionBasedQuestions_1.BooleanQuestionSchema,
     checkBoxes: optionBasedQuestions_1.CheckboxesQuestionSchema,
     currency: numberQuestions_1.CurrencyQuestionSchema,
     date: dateQuestions_1.DateQuestionSchema,
     dateRange: dateQuestions_1.DateRangeQuestionSchema,
     email: textQuestions_1.EmailQuestionSchema,
     filteredSearch: graphQLQuestions_1.FilteredSearchQuestionSchema,
+    multiselectBox: optionBasedQuestions_1.MultiselectBoxQuestionSchema,
     number: numberQuestions_1.NumberQuestionSchema,
     numberRange: numberQuestions_1.NumberRangeQuestionSchema,
     radioButtons: optionBasedQuestions_1.RadioButtonsQuestionSchema,
@@ -63,7 +67,6 @@ exports.QuestionSchemaMap = {
     table: tableQuestions_1.TableQuestionSchema,
     text: textQuestions_1.TextQuestionSchema,
     textArea: textQuestions_1.TextAreaQuestionSchema,
-    typeaheadSearch: graphQLQuestions_1.TypeaheadSearchQuestionSchema,
     url: textQuestions_1.URLQuestionSchema
 };
 ;

package/dist/questions/numberQuestions.d.ts

@@ -1,63 +1,5 @@
 import { z } from "zod";
-export declare const BooleanQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
-    type: z.ZodLiteral<"boolean">;
-    attributes: z.ZodOptional<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;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-    } | undefined;
-}, {
-    type: "boolean";
-    attributes?: {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-        checked?: boolean | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-    } | undefined;
-}>;
-export declare const CurrencyQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const CurrencyQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"currency">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
@@ -86,6 +28,23 @@ export declare const CurrencyQuestionSchema: z.ZodObject<{
         step?: number | undefined;
         denomination?: string | undefined;
     }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        title: z.ZodOptional<z.ZodLiteral<"Currency Field">>;
+        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a monetary amount (e.g. Cost or Budget).">>;
+        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+        defaultJSON?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+        defaultJSON?: string | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "currency";
     attributes?: {
@@ -99,6 +58,9 @@ export declare const CurrencyQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "currency";
@@ -113,17 +75,12 @@ export declare const CurrencyQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }>;
-export declare const NumberQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const NumberQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"number">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
@@ -148,6 +105,23 @@ export declare const NumberQuestionSchema: z.ZodObject<{
         min?: number | undefined;
         step?: number | undefined;
     }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        title: z.ZodOptional<z.ZodLiteral<"Number Field">>;
+        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a single numeric value.">>;
+        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+        defaultJSON?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+        defaultJSON?: string | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "number";
     attributes?: {
@@ -160,6 +134,9 @@ export declare const NumberQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "number";
@@ -173,6 +150,9 @@ export declare const NumberQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const NumberRangeQuestionSchema: z.ZodObject<{
@@ -189,13 +169,6 @@ export declare const NumberRangeQuestionSchema: 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<"numberRange">;
     columns: z.ZodObject<{
@@ -280,6 +253,23 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
             step?: number | undefined;
         } | undefined;
     }>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        title: z.ZodOptional<z.ZodLiteral<"Number Range">>;
+        usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a numerical range (e.g. From/To, Min/Max).">>;
+        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Number Range" | undefined;
+        usageDescription?: "For questions that require a numerical range (e.g. From/To, Min/Max)." | undefined;
+        defaultJSON?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Number Range" | undefined;
+        usageDescription?: "For questions that require a numerical range (e.g. From/To, Min/Max)." | undefined;
+        defaultJSON?: string | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "numberRange";
     columns: {
@@ -307,6 +297,9 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Number Range" | undefined;
+        usageDescription?: "For questions that require a numerical range (e.g. From/To, Min/Max)." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "numberRange";
@@ -335,9 +328,11 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Number Range" | undefined;
+        usageDescription?: "For questions that require a numerical range (e.g. From/To, Min/Max)." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }>;
-export type BooleanQuestionType = z.infer<typeof BooleanQuestionSchema>;
 export type CurrencyQuestionType = z.infer<typeof CurrencyQuestionSchema>;
 export type NumberQuestionType = z.infer<typeof NumberQuestionSchema>;
 export type NumberRangeQuestionType = z.infer<typeof NumberRangeQuestionSchema>;

package/dist/questions/numberQuestions.js

@@ -1,34 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NumberRangeQuestionSchema = exports.NumberQuestionSchema = exports.CurrencyQuestionSchema = exports.BooleanQuestionSchema = void 0;
+exports.NumberRangeQuestionSchema = exports.NumberQuestionSchema = exports.CurrencyQuestionSchema = 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 NumberAttributesSchema = BaseAttributes.unwrap().merge(zod_1.z.object({
     max: zod_1.z.number().optional(), // The highest value allowed (default no max)
     min: zod_1.z.number().optional(), // The lowest amount allowed (default 0)
     step: zod_1.z.number().optional() // The amount to increment. To allow decimals, use 0.01 (default 1)
 }));
-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(), // Whether it is checked by default
-    })).optional(),
-}));
+const defaultCurrencyJSON = {
+    type: 'currency',
+    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { denomination: 'USD', max: undefined, min: 0, step: 1 }),
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 exports.CurrencyQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('currency'),
     attributes: NumberAttributesSchema.merge(zod_1.z.object({
         denomination: zod_1.z.string().optional(), // The currency type (default is "USD")
     })).optional(),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Currency Field').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a monetary amount (e.g. Cost or Budget).').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultCurrencyJSON, null, 2)).optional(),
+    })).optional()
 }));
+const defaultNumberJSON = {
+    type: 'number',
+    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { max: undefined, min: 0, step: 1 }),
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 exports.NumberQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('number'),
     attributes: NumberAttributesSchema.optional(),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Number Field').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a single numeric value.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultNumberJSON, null, 2)).optional(),
+    })).optional()
 }));
+const defaultNumberRangeJSON = {
+    type: 'numberRange',
+    attributes: Object.assign({}, question_1.defaultAttributes),
+    columns: {
+        start: Object.assign(Object.assign({}, question_1.defaultAttributes), { label: 'From', max: undefined, min: 0, step: 1 }),
+        end: Object.assign(Object.assign({}, question_1.defaultAttributes), { label: 'To', max: undefined, min: 0, step: 1 })
+    },
+    meta: Object.assign({}, question_1.defaultMeta)
+};
 exports.NumberRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('numberRange'),
     columns: zod_1.z.object({
         start: NumberAttributesSchema.optional(),
         end: NumberAttributesSchema.optional()
-    })
+    }),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Number Range').optional(),
+        usageDescription: zod_1.z.literal('For questions that require a numerical range (e.g. From/To, Min/Max).').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultNumberRangeJSON, null, 2)).optional(),
+    })).optional()
 }));