@dmptool/types 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 UC Curation Center (California Digital Library)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# dmptool-types
+
+This package provides Types, Zod schemas and JSON schemas to aide in integrations with the DMP Tool.
+
+## 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 build the Types, Zod schemas and JSON schemas: `npm run build`
+
+## 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)
+  - 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.d.ts

@@ -0,0 +1,558 @@
+import { z } from 'zod';
+export declare const BooleanAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    answer: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    answer: boolean;
+}, {
+    type: "boolean";
+    answer: boolean;
+}>;
+export declare const CheckboxesAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"checkBoxes">;
+    answer: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "checkBoxes";
+    answer: string[];
+}, {
+    type: "checkBoxes";
+    answer: string[];
+}>;
+export declare const CurrencyAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"currency">;
+    answer: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "currency";
+    answer: number;
+}, {
+    type: "currency";
+    answer: number;
+}>;
+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 declare const EmailAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"email">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "email";
+    answer: string;
+}, {
+    type: "email";
+    answer: string;
+}>;
+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 NumberAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    answer: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "number";
+    answer: number;
+}, {
+    type: "number";
+    answer: number;
+}>;
+export declare const RadioButtonsAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"radioButtons">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "radioButtons";
+    answer: string;
+}, {
+    type: "radioButtons";
+    answer: string;
+}>;
+export declare const SelectBoxAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"selectBox">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "selectBox";
+    answer: string;
+}, {
+    type: "selectBox";
+    answer: string;
+}>;
+export declare const TextAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "text";
+    answer: string;
+}, {
+    type: "text";
+    answer: string;
+}>;
+export declare const TextAreaAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"textArea">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "textArea";
+    answer: string;
+}, {
+    type: "textArea";
+    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 declare const URLAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"url">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "url";
+    answer: string;
+}, {
+    type: "url";
+    answer: string;
+}>;
+export declare const AnyAnswer: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    answer: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    answer: boolean;
+}, {
+    type: "boolean";
+    answer: boolean;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"checkBoxes">;
+    answer: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "checkBoxes";
+    answer: string[];
+}, {
+    type: "checkBoxes";
+    answer: string[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"currency">;
+    answer: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "currency";
+    answer: number;
+}, {
+    type: "currency";
+    answer: number;
+}>, z.ZodObject<{
+    answer: z.ZodString;
+} & {
+    type: z.ZodLiteral<"datePicker">;
+}, "strip", z.ZodTypeAny, {
+    type: "datePicker";
+    answer: string;
+}, {
+    type: "datePicker";
+    answer: string;
+}>, 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;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"email">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "email";
+    answer: string;
+}, {
+    type: "email";
+    answer: string;
+}>, z.ZodObject<{} & {
+    type: z.ZodLiteral<"filteredSearch">;
+    answer: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "filteredSearch";
+    answer: string[];
+}, {
+    type: "filteredSearch";
+    answer: string[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    answer: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "number";
+    answer: number;
+}, {
+    type: "number";
+    answer: number;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"radioButtons">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "radioButtons";
+    answer: string;
+}, {
+    type: "radioButtons";
+    answer: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"selectBox">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "selectBox";
+    answer: string;
+}, {
+    type: "selectBox";
+    answer: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"textArea">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "textArea";
+    answer: string;
+}, {
+    type: "textArea";
+    answer: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "text";
+    answer: string;
+}, {
+    type: "text";
+    answer: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"typeaheadSearch">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "typeaheadSearch";
+    answer: string;
+}, {
+    type: "typeaheadSearch";
+    answer: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"url">;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "url";
+    answer: string;
+}, {
+    type: "url";
+    answer: string;
+}>]>;
+export declare const TableAnswer: z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    answer: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"boolean">;
+        answer: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        type: "boolean";
+        answer: boolean;
+    }, {
+        type: "boolean";
+        answer: boolean;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"checkBoxes">;
+        answer: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "checkBoxes";
+        answer: string[];
+    }, {
+        type: "checkBoxes";
+        answer: string[];
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"currency">;
+        answer: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: "currency";
+        answer: number;
+    }, {
+        type: "currency";
+        answer: number;
+    }>, z.ZodObject<{
+        answer: z.ZodString;
+    } & {
+        type: z.ZodLiteral<"datePicker">;
+    }, "strip", z.ZodTypeAny, {
+        type: "datePicker";
+        answer: string;
+    }, {
+        type: "datePicker";
+        answer: string;
+    }>, 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;
+        };
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"email">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "email";
+        answer: string;
+    }, {
+        type: "email";
+        answer: string;
+    }>, z.ZodObject<{} & {
+        type: z.ZodLiteral<"filteredSearch">;
+        answer: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "filteredSearch";
+        answer: string[];
+    }, {
+        type: "filteredSearch";
+        answer: string[];
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"number">;
+        answer: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: "number";
+        answer: number;
+    }, {
+        type: "number";
+        answer: number;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"radioButtons">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "radioButtons";
+        answer: string;
+    }, {
+        type: "radioButtons";
+        answer: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"selectBox">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "selectBox";
+        answer: string;
+    }, {
+        type: "selectBox";
+        answer: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"textArea">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "textArea";
+        answer: string;
+    }, {
+        type: "textArea";
+        answer: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "text";
+        answer: string;
+    }, {
+        type: "text";
+        answer: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"typeaheadSearch">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "typeaheadSearch";
+        answer: string;
+    }, {
+        type: "typeaheadSearch";
+        answer: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"url">;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "url";
+        answer: string;
+    }, {
+        type: "url";
+        answer: string;
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "table";
+    answer: ({
+        type: "boolean";
+        answer: boolean;
+    } | {
+        type: "checkBoxes";
+        answer: string[];
+    } | {
+        type: "currency";
+        answer: number;
+    } | {
+        type: "datePicker";
+        answer: string;
+    } | {
+        type: "dateRange";
+        answer: {
+            start: string;
+            end: string;
+        };
+    } | {
+        type: "email";
+        answer: string;
+    } | {
+        type: "filteredSearch";
+        answer: string[];
+    } | {
+        type: "number";
+        answer: number;
+    } | {
+        type: "radioButtons";
+        answer: string;
+    } | {
+        type: "selectBox";
+        answer: string;
+    } | {
+        type: "text";
+        answer: string;
+    } | {
+        type: "textArea";
+        answer: string;
+    } | {
+        type: "typeaheadSearch";
+        answer: string;
+    } | {
+        type: "url";
+        answer: string;
+    })[];
+}, {
+    type: "table";
+    answer: ({
+        type: "boolean";
+        answer: boolean;
+    } | {
+        type: "checkBoxes";
+        answer: string[];
+    } | {
+        type: "currency";
+        answer: number;
+    } | {
+        type: "datePicker";
+        answer: string;
+    } | {
+        type: "dateRange";
+        answer: {
+            start: string;
+            end: string;
+        };
+    } | {
+        type: "email";
+        answer: string;
+    } | {
+        type: "filteredSearch";
+        answer: string[];
+    } | {
+        type: "number";
+        answer: number;
+    } | {
+        type: "radioButtons";
+        answer: string;
+    } | {
+        type: "selectBox";
+        answer: string;
+    } | {
+        type: "text";
+        answer: string;
+    } | {
+        type: "textArea";
+        answer: string;
+    } | {
+        type: "typeaheadSearch";
+        answer: string;
+    } | {
+        type: "url";
+        answer: string;
+    })[];
+}>;
+export type AnyAnswerType = z.infer<typeof AnyAnswer>;
+export type BooleanAnswerType = z.infer<typeof BooleanAnswer>;
+export type CheckboxesAnswerType = z.infer<typeof CheckboxesAnswer>;
+export type CurrencyAnswerType = z.infer<typeof CurrencyAnswer>;
+export type DatePickerAnswerType = z.infer<typeof DatePickerAnswer>;
+export type DateRangeAnswerType = z.infer<typeof DateRangeAnswer>;
+export type EmailAnswerType = z.infer<typeof EmailAnswer>;
+export type FilteredSearchAnswerType = z.infer<typeof FilteredSearchAnswer>;
+export type NumberAnswerType = z.infer<typeof NumberAnswer>;
+export type RadioButtonsAnswerType = z.infer<typeof RadioButtonsAnswer>;
+export type SelectBoxAnswerType = z.infer<typeof SelectBoxAnswer>;
+export type TableAnswerType = z.infer<typeof TableAnswer>;
+export type TextAnswerType = z.infer<typeof TextAnswer>;
+export type TextAreaAnswerType = z.infer<typeof TextAreaAnswer>;
+export type TypeaheadSearchAnswerType = z.infer<typeof TypeaheadSearchAnswer>;
+export type URLAnswerType = z.infer<typeof URLAnswer>;

package/dist/answers.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableAnswer = exports.AnyAnswer = exports.URLAnswer = exports.TypeaheadSearchAnswer = exports.TextAreaAnswer = exports.TextAnswer = exports.SelectBoxAnswer = exports.RadioButtonsAnswer = exports.NumberAnswer = exports.FilteredSearchAnswer = exports.EmailAnswer = exports.DateRangeAnswer = exports.DatePickerAnswer = exports.CurrencyAnswer = exports.CheckboxesAnswer = exports.BooleanAnswer = void 0;
+const zod_1 = require("zod");
+const primitiveQuestions_1 = require("./primitiveQuestions");
+const Answer = zod_1.z.object({
+    type: primitiveQuestions_1.QuestionTypesEnum, // The type of answer
+    answer: zod_1.z.string(), // The answer to the question (string)
+});
+exports.BooleanAnswer = zod_1.z.object({
+    type: zod_1.z.literal('boolean'), // The type of answer
+    answer: zod_1.z.boolean() // The answer to the question (true/false)
+});
+exports.CheckboxesAnswer = zod_1.z.object({
+    type: zod_1.z.literal('checkBoxes'), // The type of answer
+    answer: zod_1.z.array(zod_1.z.string()) // The answer to the question (array of strings)
+});
+exports.CurrencyAnswer = zod_1.z.object({
+    type: zod_1.z.literal('currency'), // The type of answer
+    answer: zod_1.z.number() // The answer to the question (number)
+});
+exports.DatePickerAnswer = Answer.merge(zod_1.z.object({
+    type: zod_1.z.literal('datePicker'), // The type of question
+}));
+exports.DateRangeAnswer = 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)
+    })
+}));
+exports.EmailAnswer = zod_1.z.object({
+    type: zod_1.z.literal('email'), // The type of question
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.FilteredSearchAnswer = 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.NumberAnswer = zod_1.z.object({
+    type: zod_1.z.literal('number'), // The type of answer
+    answer: zod_1.z.number() // The answer to the question (number)
+});
+exports.RadioButtonsAnswer = zod_1.z.object({
+    type: zod_1.z.literal('radioButtons'), // The type of answer
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.SelectBoxAnswer = zod_1.z.object({
+    type: zod_1.z.literal('selectBox'), // The type of answer
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.TextAnswer = zod_1.z.object({
+    type: zod_1.z.literal('text'), // The type of answer
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.TextAreaAnswer = zod_1.z.object({
+    type: zod_1.z.literal('textArea'), // The type of answer
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.TypeaheadSearchAnswer = 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)
+});
+exports.URLAnswer = zod_1.z.object({
+    type: zod_1.z.literal('url'), // The type of answer
+    answer: zod_1.z.string() // The answer to the question (string)
+});
+exports.AnyAnswer = zod_1.z.discriminatedUnion('type', [
+    exports.BooleanAnswer,
+    exports.CheckboxesAnswer,
+    exports.CurrencyAnswer,
+    exports.DatePickerAnswer,
+    exports.DateRangeAnswer,
+    exports.EmailAnswer,
+    exports.FilteredSearchAnswer,
+    exports.NumberAnswer,
+    exports.RadioButtonsAnswer,
+    exports.SelectBoxAnswer,
+    exports.TextAreaAnswer,
+    exports.TextAnswer,
+    exports.TypeaheadSearchAnswer,
+    exports.URLAnswer
+]);
+exports.TableAnswer = zod_1.z.object({
+    type: zod_1.z.literal('table'), // The type of answer
+    answer: zod_1.z.array(exports.AnyAnswer) // The answer to the question (array of answers)
+});