@dmptool/types 1.0.1 → 1.0.3

package/README.md

@@ -4,8 +4,104 @@ This package provides Types, Zod schemas and JSON schemas to aide in integration
 
 [Zod](https://www.npmjs.com/package/zod) schemas and Typescript Types can be found in the `src/` directory and JSON schemas can be found in the `schemas/` directory.
 
+## Available Schemas/Types
+
+The current version of the schemas can always be found in `CURRENT_SCHEMA_VERSION`. You will need to include the version is any object you create using the types in this file.
+
+Naming conventions:
+- Zod schemas do not include the word `Type` (e.g. `BooleanQuestion`, `CheckboxesAnswer`)
+- Types include the word `Type` (e.g. `BooleanQuestionType`, `CheckboxesAnswerType`)
+
+### DMP Template Support
+
+The `QuestionTypesEnum` contains a list of all the possible question types currently supported by the DMP Tool. These values correspond with the `type` property of a question type. For example, the `BooleanQuestion` has `type: 'boolean'` and the `SelectBoxQuestion` has `type: 'checkboxes'`.
+
+The available question schemas/types are:
+- `AnyQuestion` A Union of all the question types
+- `AnyTableColumnQuestion` A subset of `AnyQuestion`. All of the question types that can be part of a table
+- `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.
+- `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.
+- `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.
+- `TextAreaQuestion` A text area field. If the `isRichText` flag is set, the user should see a WYSIWYG editor.
+- `TextQuestion` A simple text field
+- `TypeaheadSearchQuestion` A complex question type that allows the user to type into a text field and fires off a graphQL query. The user can select a single result.
+- `URLQuestion` A simple URL field.
+
+### DMP Support
+
+Each of the question types above has a corresponding answer. The `type` in each answer type must match the `type` of the related question. For example `BooleanAnswer` has `type: 'boolean'` and and the `SelectBoxAnswer` has `type: 'checkboxes'`.
+
+The available answer schemas/types are:
+- `AnyAnswer` A Union of all the answer types
+- `AnyTableColumnAnswer` A subset of `AnyAnswer`. All of the answer types that can be part of a table
+- `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.
+- `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.
+- `RadioButtonsAnswer` A answer type that supports an array of `option` objects. The user may "select" a single option.
+- `SelectBoxAnswer` A drop down select box that supports an array of `option` objects. A `multiple` flag can be set to allow multi-select.
+- `TableAnswer` A table answer type. Each column in the table can be any one of the `AnyTableColumnAnswer` types.
+- `TextAreaAnswer` A text area field. If the `isRichText` flag is set, the user should see a WYSIWYG editor.
+- `TextAnswer` A simple text field
+- `TypeaheadSearchAnswer` A complex answer type that allows the user to type into a text field and fires off a graphQL query. The user can select a single result.
+- `URLAnswer` A simple URL field.
+
+#### Coming soon
+
+RDA Common Standard for DMPs
+
+DMP Tool specific extensions to the RDA Common Standard for DMPs
+
 ## Usage
 
+Add the DMP Tool types to your `package.json` by running `npm add @dmptool/types`
+
+Once added, you can then import the Types and Zod shemas like this:
+`import { BooleanQuestion, BooleanQuestionType, CURRENT_SCHEMA_VERSION } from '@dmptool/types';`
+
+const boolQ: BooleanQuestionType = {
+  type: "boolean",
+  attributes: {
+    checked: true
+  },
+  meta: {
+    schemaVersion: CURRENT_SCHEMA_VERSION
+  }
+}
+
+const isBoolQ = BooleanQuestion.parse(boolQ);
+console.log('isBoolQ', isBoolQ);
+console.log(BooleanQuestion.parse(123));
+
+
+
+
+```
+ZodError: [
+  {
+    "code": "invalid_type",
+    "expected": "object",
+    "received": "number",
+    "path": [],
+    "message": "Expected object, received number"
+  }
+]
+```
+
+## Development
+
 To run tests: `npm run test`
 
 To run linter checks: `npm run lint`
@@ -41,32 +137,3 @@ latest: 1.0.0
 
 published 6 minutes ago by npm-user-name <email-address>
 ```
-
-## Types/Schemas
-
-If you want to work with DMP Templates or Answers to template questions, the following :
-  - CURRENT_SCHEMA_VERSION (the current version of the schemas)
-  - QuestionTypesEnum (Contains the `type` for each Question/Answer below)
-  - AnyQuestion & AnyAnswer (Union of all types below)
-  - AnyTableColumnQuestion & AnyTableColumnAnswer (Union of all types except table. Tables cannot be nested)
-  - BooleanQuestion & Boolean Answer
-  - CheckboxesQuestion & Checkboxes Answer
-  - CurrencyQuestion & CurrencyAnswer
-  - DatePickerQuestion & DatePickerAnswer
-  - DateRangeQuestion & DateRangeAnswer
-  - EmailQuestion & EmailAnswer
-  - FilteredSearchQuestion & FilteredSearchAnswer
-  - NumberQuestion & NumberAnswer
-  - RadioButtonsQuestion & RadioButtonsAnswer
-  - SelectBoxQuestion & SelectBoxAnswer
-  - TableQuestion & TableAnswer
-  - TextAreaQuestion & TextAreaAnswer
-  - TextQuestion & TextAnswer
-  - TypeaheadSearchQuestion & TypeaheadSearchAnswer
-  - URLQuestion & URLAnswer
-
-### Coming soon
-
-RDA Common Standard for DMPs
-
-DMP Tool specific extensions to the RDA Common Standard for DMPs

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

@@ -7,116 +7,121 @@ const optionBasedAnswers_1 = require("../optionBasedAnswers");
 const primitiveAnswers_1 = require("../primitiveAnswers");
 const tableAnswers_1 = require("../tableAnswers");
 const __1 = require("..");
+const questions_1 = require("../../questions");
 (0, globals_1.describe)('Answer Type Validations', () => {
     (0, globals_1.it)('should validate BooleanAnswer', () => {
-        const validData = { type: 'boolean', answer: true };
-        (0, globals_1.expect)(() => primitiveAnswers_1.BooleanAnswer.parse(validData)).not.toThrow();
+        const validData = { type: 'boolean', answer: true, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.BooleanAnswerSchema.parse(validData)).not.toThrow();
         const invalidData = { type: 'boolean', answer: 'true' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.BooleanAnswer.parse(invalidData)).toThrow();
+        (0, globals_1.expect)(() => primitiveAnswers_1.BooleanAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate CheckboxesAnswer', () => {
-        const validData = { type: 'checkBoxes', answer: ['option1', 'option2'] };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.CheckboxesAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'checkBoxes', answer: 'option1' };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.CheckboxesAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'checkBoxes', answer: ['option1', 'option2'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.CheckboxesAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'checkBoxes', answer: 'option1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.CheckboxesAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate CurrencyAnswer', () => {
-        const validData = { type: 'currency', answer: 100.5 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.CurrencyAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'currency', answer: '100.5' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.CurrencyAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'currency', answer: 100.5, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.CurrencyAnswerSchema.parse(validData)).not.toThrow();
+        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' };
-        (0, globals_1.expect)(() => dateAnswers_1.DatePickerAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'datePicker', answer: 12345 };
-        (0, globals_1.expect)(() => dateAnswers_1.DatePickerAnswer.parse(invalidData)).toThrow();
+        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 DateRangeAnswer', () => {
         const validData = {
             type: 'dateRange',
             answer: { start: '2023-10-01', end: '2023-10-31' },
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
         };
-        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswer.parse(validData)).not.toThrow();
+        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswerSchema.parse(validData)).not.toThrow();
         const invalidData = {
             type: 'dateRange',
             answer: { start: '2023-10-01', end: 12345 },
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
         };
-        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswer.parse(invalidData)).toThrow();
+        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate EmailAnswer', () => {
-        const validData = { type: 'email', answer: 'test@example.com' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.EmailAnswer.parse(validData)).not.toThrow();
+        const validData = { type: 'email', answer: 'test@example.com', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.EmailAnswerSchema.parse(validData)).not.toThrow();
         const invalidData = { type: 'email', answer: 12345 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.EmailAnswer.parse(invalidData)).toThrow();
+        (0, globals_1.expect)(() => primitiveAnswers_1.EmailAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate FilteredSearchAnswer', () => {
-        const validData = { type: 'filteredSearch', answer: ['item1', 'item2'] };
-        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'filteredSearch', answer: 'item1' };
-        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'filteredSearch', answer: ['item1', 'item2'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'filteredSearch', answer: 'item1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate NumberAnswer', () => {
-        const validData = { type: 'number', answer: 42 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.NumberAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'number', answer: '42' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.NumberAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'number', answer: 42, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.NumberAnswerSchema.parse(validData)).not.toThrow();
+        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 RadioButtonsAnswer', () => {
-        const validData = { type: 'radioButtons', answer: 'option1' };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.RadioButtonsAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'radioButtons', answer: ['option1'] };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.RadioButtonsAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'radioButtons', answer: 'option1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.RadioButtonsAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'radioButtons', answer: ['option1'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.RadioButtonsAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate SelectBoxAnswer', () => {
-        const validData = { type: 'selectBox', answer: 'option1' };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.SelectBoxAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'selectBox', answer: ['option1'] };
-        (0, globals_1.expect)(() => optionBasedAnswers_1.SelectBoxAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'selectBox', answer: ['option1'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.SelectBoxAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'selectBox', answer: 'option1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => optionBasedAnswers_1.SelectBoxAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate TextAnswer', () => {
-        const validData = { type: 'text', answer: 'Some text' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.TextAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'text', answer: 12345 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.TextAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'text', answer: 'Some text', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.TextAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'text', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.TextAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate TextAreaAnswer', () => {
-        const validData = { type: 'textArea', answer: 'Some long text' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.TextAreaAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'textArea', answer: 12345 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.TextAreaAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'textArea', answer: 'Some long text', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.TextAreaAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'textArea', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.TextAreaAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate TypeaheadSearchAnswer', () => {
-        const validData = { type: 'typeaheadSearch', answer: 'Search term' };
-        (0, globals_1.expect)(() => graphQLAnswers_1.TypeaheadSearchAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'typeaheadSearch', answer: 12345 };
-        (0, globals_1.expect)(() => graphQLAnswers_1.TypeaheadSearchAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'typeaheadSearch', answer: 'Search term', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.TypeaheadSearchAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'typeaheadSearch', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.TypeaheadSearchAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate URLAnswer', () => {
-        const validData = { type: 'url', answer: 'https://example.com' };
-        (0, globals_1.expect)(() => primitiveAnswers_1.URLAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'url', answer: 12345 };
-        (0, globals_1.expect)(() => primitiveAnswers_1.URLAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'url', answer: 'https://example.com', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.URLAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'url', answer: 12345, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => primitiveAnswers_1.URLAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate TableAnswer', () => {
         const validData = {
             type: 'table',
             answer: [
-                { type: 'text', answer: 'Row 1' },
-                { type: 'number', answer: 42 },
+                { type: 'text', answer: 'Row 1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } },
+                { type: 'number', answer: 42, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } },
             ],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
         };
-        (0, globals_1.expect)(() => tableAnswers_1.TableAnswer.parse(validData)).not.toThrow();
+        (0, globals_1.expect)(() => tableAnswers_1.TableAnswerSchema.parse(validData)).not.toThrow();
         const invalidData = {
             type: 'table',
             answer: [{ type: 'text', answer: 12345 }],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
         };
-        (0, globals_1.expect)(() => tableAnswers_1.TableAnswer.parse(invalidData)).toThrow();
+        (0, globals_1.expect)(() => tableAnswers_1.TableAnswerSchema.parse(invalidData)).toThrow();
     });
     (0, globals_1.it)('should validate AnyAnswer', () => {
-        const validData = { type: 'text', answer: 'Some text' };
-        (0, globals_1.expect)(() => __1.AnyAnswer.parse(validData)).not.toThrow();
-        const invalidData = { type: 'unknown', answer: 'Some text' };
-        (0, globals_1.expect)(() => __1.AnyAnswer.parse(invalidData)).toThrow();
+        const validData = { type: 'text', answer: 'Some text', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => __1.AnyAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'unknown', answer: 'Some text', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => __1.AnyAnswerSchema.parse(invalidData)).toThrow();
     });
 });

package/dist/answers/answer.d.ts

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

package/dist/answers/answer.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Answer = void 0;
+exports.AnswerSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("../questions/question");
 // Abstract base schema for all answers
-exports.Answer = zod_1.z.object({
+exports.AnswerSchema = zod_1.z.object({
     type: question_1.QuestionTypesEnum, // The type of answer
     answer: zod_1.z.string(), // The answer to the question (string)
+    meta: zod_1.z.object({
+        schemaVersion: zod_1.z.literal(question_1.CURRENT_SCHEMA_VERSION), // The schema version of the answer
+    })
 });

package/dist/answers/dateAnswers.d.ts

@@ -1,16 +1,37 @@
 import { z } from 'zod';
-export declare const DatePickerAnswer: z.ZodObject<{
+export declare const DatePickerAnswerSchema: z.ZodObject<{
     answer: z.ZodString;
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+    }, {
+        schemaVersion: "1.0";
+    }>;
 } & {
     type: z.ZodLiteral<"datePicker">;
 }, "strip", z.ZodTypeAny, {
     type: "datePicker";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string;
 }, {
     type: "datePicker";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string;
 }>;
-export declare const DateRangeAnswer: z.ZodObject<{} & {
+export declare const DateRangeAnswerSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+    }, {
+        schemaVersion: "1.0";
+    }>;
+} & {
     type: z.ZodLiteral<"dateRange">;
     answer: z.ZodObject<{
         start: z.ZodString;
@@ -24,16 +45,22 @@ export declare const DateRangeAnswer: z.ZodObject<{} & {
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "dateRange";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: {
         start: string;
         end: string;
     };
 }, {
     type: "dateRange";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: {
         start: string;
         end: string;
     };
 }>;
-export type DatePickerAnswerType = z.infer<typeof DatePickerAnswer>;
-export type DateRangeAnswerType = z.infer<typeof DateRangeAnswer>;
+export type DatePickerAnswerType = z.infer<typeof DatePickerAnswerSchema>;
+export type DateRangeAnswerType = z.infer<typeof DateRangeAnswerSchema>;

package/dist/answers/dateAnswers.js

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

package/dist/answers/graphQLAnswers.d.ts

@@ -1,23 +1,51 @@
 import { z } from 'zod';
-export declare const FilteredSearchAnswer: z.ZodObject<{} & {
+export declare const FilteredSearchAnswerSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+    }, {
+        schemaVersion: "1.0";
+    }>;
+} & {
     type: z.ZodLiteral<"filteredSearch">;
     answer: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     type: "filteredSearch";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string[];
 }, {
     type: "filteredSearch";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string[];
 }>;
-export declare const TypeaheadSearchAnswer: z.ZodObject<{} & {
+export declare const TypeaheadSearchAnswerSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+    }, {
+        schemaVersion: "1.0";
+    }>;
+} & {
     type: z.ZodLiteral<"typeaheadSearch">;
     answer: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: "typeaheadSearch";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string;
 }, {
     type: "typeaheadSearch";
+    meta: {
+        schemaVersion: "1.0";
+    };
     answer: string;
 }>;
-export type FilteredSearchAnswerType = z.infer<typeof FilteredSearchAnswer>;
-export type TypeaheadSearchAnswerType = z.infer<typeof TypeaheadSearchAnswer>;
+export type FilteredSearchAnswerType = z.infer<typeof FilteredSearchAnswerSchema>;
+export type TypeaheadSearchAnswerType = z.infer<typeof TypeaheadSearchAnswerSchema>;

package/dist/answers/graphQLAnswers.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeaheadSearchAnswer = exports.FilteredSearchAnswer = void 0;
+exports.TypeaheadSearchAnswerSchema = exports.FilteredSearchAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to GraphQL Question Types
-exports.FilteredSearchAnswer = answer_1.Answer.merge(zod_1.z.object({
+exports.FilteredSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('filteredSearch'), // The type of answer
     answer: zod_1.z.array(zod_1.z.string()) // The answer to the filtered search (array of strings)
 }));
-exports.TypeaheadSearchAnswer = answer_1.Answer.merge(zod_1.z.object({
+exports.TypeaheadSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('typeaheadSearch'), // The type of answer
     answer: zod_1.z.string() // The answer to the typeahead search (string)
 }));