@dmptool/types 1.0.8 → 1.1.1

package/dist/questions/index.js

@@ -16,7 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QuestionSchemaMap = exports.AnyQuestionSchema = void 0;
 const zod_1 = require("zod");
-const primitiveQuestions_1 = require("./primitiveQuestions");
+const numberQuestions_1 = require("./numberQuestions");
+const textQuestions_1 = require("./textQuestions");
 const dateQuestions_1 = require("./dateQuestions");
 const optionBasedQuestions_1 = require("./optionBasedQuestions");
 const graphQLQuestions_1 = require("./graphQLQuestions");
@@ -25,43 +26,45 @@ const tableQuestions_1 = require("./tableQuestions");
 __exportStar(require("./question"), exports);
 __exportStar(require("./dateQuestions"), exports);
 __exportStar(require("./graphQLQuestions"), exports);
+__exportStar(require("./numberQuestions"), exports);
 __exportStar(require("./optionBasedQuestions"), exports);
-__exportStar(require("./primitiveQuestions"), exports);
 __exportStar(require("./tableQuestions"), exports);
-// All of the possible questions
+__exportStar(require("./textQuestions"), exports);
 exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
-    primitiveQuestions_1.BooleanQuestionSchema,
+    optionBasedQuestions_1.BooleanQuestionSchema,
     optionBasedQuestions_1.CheckboxesQuestionSchema,
-    primitiveQuestions_1.CurrencyQuestionSchema,
+    numberQuestions_1.CurrencyQuestionSchema,
     dateQuestions_1.DateQuestionSchema,
     dateQuestions_1.DateRangeQuestionSchema,
-    primitiveQuestions_1.EmailQuestionSchema,
+    textQuestions_1.EmailQuestionSchema,
     graphQLQuestions_1.FilteredSearchQuestionSchema,
-    primitiveQuestions_1.NumberQuestionSchema,
+    numberQuestions_1.NumberQuestionSchema,
+    numberQuestions_1.NumberRangeQuestionSchema,
     optionBasedQuestions_1.RadioButtonsQuestionSchema,
     optionBasedQuestions_1.SelectBoxQuestionSchema,
     tableQuestions_1.TableQuestionSchema,
-    primitiveQuestions_1.TextAreaQuestionSchema,
-    primitiveQuestions_1.TextQuestionSchema,
+    textQuestions_1.TextAreaQuestionSchema,
+    textQuestions_1.TextQuestionSchema,
     graphQLQuestions_1.TypeaheadSearchQuestionSchema,
-    primitiveQuestions_1.URLQuestionSchema
+    textQuestions_1.URLQuestionSchema
 ]);
-// Export a mapping between question types and their corresponding question schemas
+// Export a mapping between Zod Schemas and their corresponding question type label
 exports.QuestionSchemaMap = {
-    boolean: primitiveQuestions_1.BooleanQuestionSchema,
+    boolean: optionBasedQuestions_1.BooleanQuestionSchema,
     checkBoxes: optionBasedQuestions_1.CheckboxesQuestionSchema,
-    currency: primitiveQuestions_1.CurrencyQuestionSchema,
+    currency: numberQuestions_1.CurrencyQuestionSchema,
     date: dateQuestions_1.DateQuestionSchema,
     dateRange: dateQuestions_1.DateRangeQuestionSchema,
-    email: primitiveQuestions_1.EmailQuestionSchema,
+    email: textQuestions_1.EmailQuestionSchema,
     filteredSearch: graphQLQuestions_1.FilteredSearchQuestionSchema,
-    number: primitiveQuestions_1.NumberQuestionSchema,
-    numberRange: primitiveQuestions_1.NumberRangeQuestionSchema,
+    number: numberQuestions_1.NumberQuestionSchema,
+    numberRange: numberQuestions_1.NumberRangeQuestionSchema,
     radioButtons: optionBasedQuestions_1.RadioButtonsQuestionSchema,
     selectBox: optionBasedQuestions_1.SelectBoxQuestionSchema,
     table: tableQuestions_1.TableQuestionSchema,
-    text: primitiveQuestions_1.TextQuestionSchema,
-    textArea: primitiveQuestions_1.TextAreaQuestionSchema,
+    text: textQuestions_1.TextQuestionSchema,
+    textArea: textQuestions_1.TextAreaQuestionSchema,
     typeaheadSearch: graphQLQuestions_1.TypeaheadSearchQuestionSchema,
-    url: primitiveQuestions_1.URLQuestionSchema
+    url: textQuestions_1.URLQuestionSchema
 };
+;

package/dist/questions/numberQuestions.d.ts

@@ -0,0 +1,292 @@
+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";
+    }>>;
+} & {
+    type: z.ZodLiteral<"currency">;
+    attributes: z.ZodOptional<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>;
+    } & {
+        denomination: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        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;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+        denomination?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "currency";
+    attributes?: {
+        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";
+    } | undefined;
+}, {
+    type: "currency";
+    attributes?: {
+        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";
+    } | 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";
+    }>>;
+} & {
+    type: z.ZodLiteral<"number">;
+    attributes: z.ZodOptional<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>;
+    }, "strip", z.ZodTypeAny, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    }, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "number";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}, {
+    type: "number";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}>;
+export declare const NumberRangeQuestionSchema: 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<"numberRange">;
+    columns: z.ZodObject<{
+        start: z.ZodOptional<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>;
+        }, "strip", z.ZodTypeAny, {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        }, {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        }>>;
+        end: z.ZodOptional<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>;
+        }, "strip", z.ZodTypeAny, {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        }, {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        start?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+        end?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+    }, {
+        start?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+        end?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "numberRange";
+    columns: {
+        start?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+        end?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+    };
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}, {
+    type: "numberRange";
+    columns: {
+        start?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+        end?: {
+            label?: string | undefined;
+            help?: string | undefined;
+            labelTranslationKey?: string | undefined;
+            max?: number | undefined;
+            min?: number | undefined;
+            step?: number | undefined;
+        } | undefined;
+    };
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+    } | undefined;
+    meta?: {
+        schemaVersion: "1.0";
+    } | undefined;
+}>;
+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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 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.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(),
+}));
+exports.NumberQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('number'),
+    attributes: NumberAttributesSchema.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()
+    })
+}));