@dmptool/types 1.0.6 → 1.0.8

package/README.md

@@ -22,11 +22,12 @@ The available question schemas/types are:
 - `BooleanQuestion` A Yes/No True/False question.
 - `CheckboxesQuestion` A question type that supports an array of `option` objects. The user may "check" multiple options.
 - `CurrencyQuestion` A number field that supports the defintiion of a `denomination`. 
-- `DatePickerQuestion` A date field. Supports `YYYY-MM-DD` format.
-- `DateRangeQuestion` A series of 2 date picker fields. Meant to capture "From" and "To" or "Start" and "End" dates.
+- `DateQuestion` A date field. Supports `YYYY-MM-DD` format.
+- `DateRangeQuestion` A series of 2 date fields. Meant to capture "From" and "To" or "Start" and "End" dates.
 - `EmailQuestion` An email address. Supports multiple emails that are comma separated.
 - `FilteredSearchQuestion` A complex field that allows the user to enter a search term and filters. The field fires a graphQL query and allows the user to potentially select multiple results.
 - `NumberQuestion` A numeric field. Supports both integers and floats.
+- `NumberRangeQuestion` A series of 2 number fields. Meant to capture "From" and "To" or "Min" and "Max" numbers.
 - `RadioButtonsQuestion` A question type that supports an array of `option` objects. The user may "select" a single option.
 - `SelectBoxQuestion` A drop down select box that supports an array of `option` objects. A `multiple` flag can be set to allow multi-select.
 - `TableQuestion` A table question type. Each column in the table can be any one of the `AnyTableColumnQuestion` types.
@@ -45,8 +46,8 @@ The available answer schemas/types are:
 - `BooleanAnswer` A Yes/No True/False answer.
 - `CheckboxesAnswer` A answer type that supports an array of `option` objects. The user may "check" multiple options.
 - `CurrencyAnswer` A number field that supports the defintiion of a `denomination`. 
-- `DatePickerAnswer` A date field. Supports `YYYY-MM-DD` format.
-- `DateRangeAnswer` A series of 2 date picker fields. Meant to capture "From" and "To" or "Start" and "End" dates.
+- `DateAnswer` A date field. Supports `YYYY-MM-DD` format.
+- `DateRangeAnswer` A series of 2 date fields. Meant to capture "From" and "To" or "Start" and "End" dates.
 - `EmailAnswer` An email address. Supports multiple emails that are comma separated.
 - `FilteredSearchAnswer` A complex field that allows the user to enter a search term and filters. The field fires a graphQL query and allows the user to potentially select multiple results.
 - `NumberAnswer` A numeric field. Supports both integers and floats.

package/dist/answers/__tests__/answers.spec.js

@@ -27,11 +27,11 @@ const questions_1 = require("../../questions");
         const invalidData = { type: 'currency', answer: '100.5', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => primitiveAnswers_1.CurrencyAnswerSchema.parse(invalidData)).toThrow();
     });
-    (0, globals_1.it)('should validate DatePickerAnswer', () => {
-        const validData = { type: 'datePicker', answer: '2023-10-01', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
-        (0, globals_1.expect)(() => dateAnswers_1.DatePickerAnswerSchema.parse(validData)).not.toThrow();
-        const invalidData = { type: 'datePicker', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
-        (0, globals_1.expect)(() => dateAnswers_1.DatePickerAnswerSchema.parse(invalidData)).toThrow();
+    (0, globals_1.it)('should validate DateAnswer', () => {
+        const validData = { type: 'date', answer: '2023-10-01', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => dateAnswers_1.DateAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'date', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => dateAnswers_1.DateAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate DateRangeAnswer', () => {
         const validData = {
@@ -65,6 +65,20 @@ const questions_1 = require("../../questions");
         const invalidData = { type: 'number', answer: '42', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => primitiveAnswers_1.NumberAnswerSchema.parse(invalidData)).toThrow();
     });
+    (0, globals_1.it)('should validate NumberRangeAnswer', () => {
+        const validData = {
+            type: 'numberRange',
+            answer: { start: 1, end: 10 },
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => primitiveAnswers_1.NumberRangeAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = {
+            type: 'numberRange',
+            answer: { start: '1', end: 10 },
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => primitiveAnswers_1.NumberRangeAnswerSchema.parse(invalidData)).toThrow();
+    });
     (0, globals_1.it)('should validate RadioButtonsAnswer', () => {
         const validData = { type: 'radioButtons', answer: 'option1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => optionBasedAnswers_1.RadioButtonsAnswerSchema.parse(validData)).not.toThrow();
@@ -105,8 +119,46 @@ const questions_1 = require("../../questions");
         const validData = {
             type: 'table',
             answer: [
-                { type: 'text', answer: 'Row 1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } },
-                { type: 'number', answer: 42, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } },
+                {
+                    columns: [
+                        {
+                            heading: "Name",
+                            content: {
+                                type: 'text',
+                                answer: 'Leia Organa',
+                                meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                            }
+                        },
+                        {
+                            heading: "Age",
+                            content: {
+                                type: 'number',
+                                answer: 28,
+                                meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                            }
+                        }
+                    ]
+                },
+                {
+                    columns: [
+                        {
+                            heading: "Name",
+                            content: {
+                                type: 'text',
+                                answer: 'Han Solo',
+                                meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                            }
+                        },
+                        {
+                            heading: "Age",
+                            content: {
+                                type: 'number',
+                                answer: 35,
+                                meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                            }
+                        }
+                    ]
+                }
             ],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
         };

package/dist/answers/answer.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 export declare const AnswerSchema: z.ZodObject<{
-    type: z.ZodEnum<["boolean", "checkBoxes", "currency", "datePicker", "dateRange", "email", "filteredSearch", "number", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
+    type: z.ZodEnum<["boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
     answer: z.ZodString;
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
@@ -10,13 +10,13 @@ export declare const AnswerSchema: z.ZodObject<{
         schemaVersion: "1.0";
     }>;
 }, "strip", z.ZodTypeAny, {
-    type: "number" | "boolean" | "checkBoxes" | "currency" | "datePicker" | "dateRange" | "email" | "filteredSearch" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
+    type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
     meta: {
         schemaVersion: "1.0";
     };
     answer: string;
 }, {
-    type: "number" | "boolean" | "checkBoxes" | "currency" | "datePicker" | "dateRange" | "email" | "filteredSearch" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
+    type: "number" | "boolean" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
     meta: {
         schemaVersion: "1.0";
     };

package/dist/answers/dateAnswers.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const DatePickerAnswerSchema: z.ZodObject<{
+export declare const DateAnswerSchema: z.ZodObject<{
     answer: z.ZodString;
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
@@ -9,15 +9,15 @@ export declare const DatePickerAnswerSchema: z.ZodObject<{
         schemaVersion: "1.0";
     }>;
 } & {
-    type: z.ZodLiteral<"datePicker">;
+    type: z.ZodLiteral<"date">;
 }, "strip", z.ZodTypeAny, {
-    type: "datePicker";
+    type: "date";
     meta: {
         schemaVersion: "1.0";
     };
     answer: string;
 }, {
-    type: "datePicker";
+    type: "date";
     meta: {
         schemaVersion: "1.0";
     };
@@ -62,5 +62,5 @@ export declare const DateRangeAnswerSchema: z.ZodObject<{
         end: string;
     };
 }>;
-export type DatePickerAnswerType = z.infer<typeof DatePickerAnswerSchema>;
+export type DateAnswerType = z.infer<typeof DateAnswerSchema>;
 export type DateRangeAnswerType = z.infer<typeof DateRangeAnswerSchema>;

package/dist/answers/dateAnswers.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateRangeAnswerSchema = exports.DatePickerAnswerSchema = void 0;
+exports.DateRangeAnswerSchema = exports.DateAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to Date Question Types
-exports.DatePickerAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('datePicker'), // The type of question
+exports.DateAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('date'), // The type of question
 }));
 exports.DateRangeAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('dateRange'), // The type of answer