@dmptool/types 1.1.1 → 1.1.3

package/dist/questions/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./optionBasedQuestions"), exports);
 __exportStar(require("./tableQuestions"), exports);
 __exportStar(require("./textQuestions"), exports);
 exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
+    graphQLQuestions_1.AffiliationSearchQuestionSchema,
     optionBasedQuestions_1.BooleanQuestionSchema,
     optionBasedQuestions_1.CheckboxesQuestionSchema,
     numberQuestions_1.CurrencyQuestionSchema,
@@ -38,6 +39,7 @@ exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
     dateQuestions_1.DateRangeQuestionSchema,
     textQuestions_1.EmailQuestionSchema,
     graphQLQuestions_1.FilteredSearchQuestionSchema,
+    optionBasedQuestions_1.MultiselectBoxQuestionSchema,
     numberQuestions_1.NumberQuestionSchema,
     numberQuestions_1.NumberRangeQuestionSchema,
     optionBasedQuestions_1.RadioButtonsQuestionSchema,
@@ -45,11 +47,11 @@ exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
     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 = {
+    affiliationSearch: graphQLQuestions_1.AffiliationSearchQuestionSchema,
     boolean: optionBasedQuestions_1.BooleanQuestionSchema,
     checkBoxes: optionBasedQuestions_1.CheckboxesQuestionSchema,
     currency: numberQuestions_1.CurrencyQuestionSchema,
@@ -57,6 +59,7 @@ exports.QuestionSchemaMap = {
     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,
@@ -64,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,13 +1,5 @@
 import { z } from "zod";
-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>;
@@ -15,18 +7,18 @@ export declare const CurrencyQuestionSchema: z.ZodObject<{
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
         max: z.ZodOptional<z.ZodNumber>;
-        min: z.ZodOptional<z.ZodNumber>;
-        step: z.ZodOptional<z.ZodNumber>;
+        min: z.ZodDefault<z.ZodNumber>;
+        step: z.ZodDefault<z.ZodNumber>;
     } & {
-        denomination: z.ZodOptional<z.ZodString>;
+        denomination: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        min: number;
+        step: number;
+        denomination: string;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: number | undefined;
-        min?: number | undefined;
-        step?: number | undefined;
-        denomination?: string | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -36,19 +28,35 @@ 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).">>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "currency";
     attributes?: {
+        min: number;
+        step: number;
+        denomination: string;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: number | undefined;
-        min?: number | undefined;
-        step?: number | undefined;
-        denomination?: string | undefined;
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Currency Field" | undefined;
+        usageDescription?: "For questions that require a monetary amount (e.g. Cost or Budget)." | undefined;
     } | undefined;
 }, {
     type: "currency";
@@ -63,17 +71,11 @@ 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;
     } | 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>;
@@ -81,15 +83,15 @@ export declare const NumberQuestionSchema: z.ZodObject<{
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
         max: z.ZodOptional<z.ZodNumber>;
-        min: z.ZodOptional<z.ZodNumber>;
-        step: z.ZodOptional<z.ZodNumber>;
+        min: z.ZodDefault<z.ZodNumber>;
+        step: z.ZodDefault<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
+        min: number;
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: number | undefined;
-        min?: number | undefined;
-        step?: number | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -98,18 +100,34 @@ 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.">>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "number";
     attributes?: {
+        min: number;
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: number | undefined;
-        min?: number | undefined;
-        step?: number | undefined;
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Number Field" | undefined;
+        usageDescription?: "For questions that require a single numeric value." | undefined;
     } | undefined;
 }, {
     type: "number";
@@ -123,6 +141,8 @@ 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;
     } | undefined;
 }>;
 export declare const NumberRangeQuestionSchema: z.ZodObject<{
@@ -139,31 +159,24 @@ 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<{
-        start: z.ZodOptional<z.ZodObject<{
+        start: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodNumber>;
-            min: z.ZodOptional<z.ZodNumber>;
-            step: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodDefault<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -171,22 +184,22 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
             max?: number | undefined;
             min?: number | undefined;
             step?: number | undefined;
-        }>>;
-        end: z.ZodOptional<z.ZodObject<{
+        }>;
+        end: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodNumber>;
-            min: z.ZodOptional<z.ZodNumber>;
-            step: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodDefault<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -194,61 +207,75 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
             max?: number | undefined;
             min?: number | undefined;
             step?: number | undefined;
-        }>>;
+        }>;
     }, "strip", z.ZodTypeAny, {
-        start?: {
+        start: {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     }, {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
             min?: number | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
             min?: number | undefined;
             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).">>;
+    }, "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;
+    }, {
+        schemaVersion: "1.0";
+        title?: "Number Range" | undefined;
+        usageDescription?: "For questions that require a numerical range (e.g. From/To, Min/Max)." | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "numberRange";
     columns: {
-        start?: {
+        start: {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            min: number;
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
-            min?: number | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -257,26 +284,28 @@ 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;
     } | undefined;
 }, {
     type: "numberRange";
     columns: {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
             min?: number | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: number | undefined;
             min?: number | undefined;
             step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -285,6 +314,8 @@ 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;
     } | undefined;
 }>;
 export type CurrencyQuestionType = z.infer<typeof CurrencyQuestionSchema>;

package/dist/questions/numberQuestions.js

@@ -4,25 +4,38 @@ exports.NumberRangeQuestionSchema = exports.NumberQuestionSchema = exports.Curre
 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)
+    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
 }));
 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")
+        denomination: zod_1.z.string().default('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(),
+    })).optional()
 }));
 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(),
+    })).optional()
 }));
 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()
-    })
+        start: NumberAttributesSchema,
+        end: NumberAttributesSchema
+    }),
+    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(),
+    })).optional()
 }));