@dmptool/types 1.0.0 → 1.0.1

package/README.md

@@ -2,15 +2,45 @@
 
 This package provides Types, Zod schemas and JSON schemas to aide in integrations with the DMP Tool.
 
+[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.
+
 ## Usage
 
 To run tests: `npm run test`
 
 To run linter checks: `npm run lint`
 
-To generate JSON schemas from the Zod schemas: `npm run generate`
+To just generate JSON schemas from the Zod schemas: `npm run generate`
+
+To build the Types, Zod schemas and JSON schemas all at once: `npm run build`
+
+To publish changes:
+- Increment the `version` in `package.json`
+- Run `npm login` and login to you npm account
+- Run `npm publish --access public`
+
+To view the current published version run `npm view @dmptool/types`. You should see something like this:
+```
+@dmptool/types@1.0.0 | MIT | deps: 3 | versions: 1
+TypeScript types for DMPTool
+
+dist
+.tarball: https://registry.npmjs.org/@dmptool/types/-/types-1.0.0.tgz
+.shasum: e9b4200e487ed2e4ae0ef342ca75f90bf6bdd335
+.integrity: sha512-wFhYELbbM17VGx7REVaDXi0TJKMXnGJRiwszfXqnKY46QeQvPnktwgYDDuuWaupFZV1jJaSq7cfs6vK1oHeOyA==
+.unpackedSize: 286.4 kB
+
+dependencies:
+fs: ^0.0.1-security         zod-to-json-schema: ^3.24.5 zod: ^3.24.4                
+
+maintainers:
+- npm-user-name <email-address>
+
+dist-tags:
+latest: 1.0.0 
 
-To build the Types, Zod schemas and JSON schemas: `npm run build`
+published 6 minutes ago by npm-user-name <email-address>
+```
 
 ## Types/Schemas
 
@@ -18,6 +48,7 @@ If you want to work with DMP Templates or Answers to template questions, the fol
   - 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

package/dist/answers/__tests__/answers.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const dateAnswers_1 = require("../dateAnswers");
+const graphQLAnswers_1 = require("../graphQLAnswers");
+const optionBasedAnswers_1 = require("../optionBasedAnswers");
+const primitiveAnswers_1 = require("../primitiveAnswers");
+const tableAnswers_1 = require("../tableAnswers");
+const __1 = require("..");
+(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 invalidData = { type: 'boolean', answer: 'true' };
+        (0, globals_1.expect)(() => primitiveAnswers_1.BooleanAnswer.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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (0, globals_1.it)('should validate DateRangeAnswer', () => {
+        const validData = {
+            type: 'dateRange',
+            answer: { start: '2023-10-01', end: '2023-10-31' },
+        };
+        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswer.parse(validData)).not.toThrow();
+        const invalidData = {
+            type: 'dateRange',
+            answer: { start: '2023-10-01', end: 12345 },
+        };
+        (0, globals_1.expect)(() => dateAnswers_1.DateRangeAnswer.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 invalidData = { type: 'email', answer: 12345 };
+        (0, globals_1.expect)(() => primitiveAnswers_1.EmailAnswer.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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (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();
+    });
+    (0, globals_1.it)('should validate TableAnswer', () => {
+        const validData = {
+            type: 'table',
+            answer: [
+                { type: 'text', answer: 'Row 1' },
+                { type: 'number', answer: 42 },
+            ],
+        };
+        (0, globals_1.expect)(() => tableAnswers_1.TableAnswer.parse(validData)).not.toThrow();
+        const invalidData = {
+            type: 'table',
+            answer: [{ type: 'text', answer: 12345 }],
+        };
+        (0, globals_1.expect)(() => tableAnswers_1.TableAnswer.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();
+    });
+});

package/dist/answers/answer.d.ts

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

package/dist/answers/answer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Answer = 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({
+    type: question_1.QuestionTypesEnum, // The type of answer
+    answer: zod_1.z.string(), // The answer to the question (string)
+});

package/dist/answers/dateAnswers.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const DatePickerAnswer: z.ZodObject<{
+    answer: z.ZodString;
+} & {
+    type: z.ZodLiteral<"datePicker">;
+}, "strip", z.ZodTypeAny, {
+    type: "datePicker";
+    answer: string;
+}, {
+    type: "datePicker";
+    answer: string;
+}>;
+export declare const DateRangeAnswer: z.ZodObject<{} & {
+    type: z.ZodLiteral<"dateRange">;
+    answer: z.ZodObject<{
+        start: z.ZodString;
+        end: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        start: string;
+        end: string;
+    }, {
+        start: string;
+        end: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "dateRange";
+    answer: {
+        start: string;
+        end: string;
+    };
+}, {
+    type: "dateRange";
+    answer: {
+        start: string;
+        end: string;
+    };
+}>;
+export type DatePickerAnswerType = z.infer<typeof DatePickerAnswer>;
+export type DateRangeAnswerType = z.infer<typeof DateRangeAnswer>;

package/dist/answers/dateAnswers.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateRangeAnswer = exports.DatePickerAnswer = 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({
+    type: zod_1.z.literal('datePicker'), // The type of question
+}));
+exports.DateRangeAnswer = answer_1.Answer.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)
+        end: zod_1.z.string() // The end date (string)
+    })
+}));

package/dist/answers/graphQLAnswers.d.ts

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

package/dist/answers/graphQLAnswers.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeaheadSearchAnswer = exports.FilteredSearchAnswer = 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({
+    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({
+    type: zod_1.z.literal('typeaheadSearch'), // The type of answer
+    answer: zod_1.z.string() // The answer to the typeahead search (string)
+}));