@dmptool/types 1.0.3 → 1.0.5

package/README.md

@@ -69,8 +69,9 @@ DMP Tool specific extensions to the RDA Common Standard for DMPs
 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';`
+`import { BooleanQuestionSchema, BooleanQuestionType, CURRENT_SCHEMA_VERSION } from '@dmptool/types';`
 
+// Use the available Type to help define the JSON object
 const boolQ: BooleanQuestionType = {
   type: "boolean",
   attributes: {
@@ -81,13 +82,34 @@ const boolQ: BooleanQuestionType = {
   }
 }
 
-const isBoolQ = BooleanQuestion.parse(boolQ);
+// Use the Zod Schema to validate the JSON 
+const isBoolQ = BooleanQuestionSchema.parse(boolQ);
 console.log('isBoolQ', isBoolQ);
-console.log(BooleanQuestion.parse(123));
 
+// Force an error to see (see below for what a Zod error message looks like)
+try {
+  BooleanQuestionSchema.parse(123);
+} catch (e) {
+  console.log(e.message);
+}
+
+// Use the Schema Maps to get the correct Schema for the specificed question type
+try {
+  // Validate the questionJSON against the Zod schema
+  QuestionSchemaMap[boolQ.type]?.parse(boolQ);
+} catch (e) {
+  console.log(e.message);
+}
 
+// Use the Any unions to generically define a Question or Answer type
+public questionJSON: AnyQuestionType;
+
+// Use the QuestionTypesEnum to fetch a list of all the valid question types
+console.log(QuestionTypeEnums);
+```
 
 
+Example Zod error:
 ```
 ZodError: [
   {

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", "option", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
+    type: z.ZodEnum<["boolean", "checkBoxes", "currency", "datePicker", "dateRange", "email", "filteredSearch", "number", "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" | "option" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
+    type: "number" | "boolean" | "checkBoxes" | "currency" | "datePicker" | "dateRange" | "email" | "filteredSearch" | "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";
+    type: "number" | "boolean" | "checkBoxes" | "currency" | "datePicker" | "dateRange" | "email" | "filteredSearch" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "typeaheadSearch" | "url";
     meta: {
         schemaVersion: "1.0";
     };

package/dist/answers/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { QuestionTypesEnum } from '../questions';
 export * from './answer';
 export * from './dateAnswers';
 export * from './graphQLAnswers';
@@ -877,4 +878,5 @@ export declare const AnyAnswerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObje
     };
     answer: string;
 }>]>;
+export declare const AnswerSchemaMap: Record<z.infer<typeof QuestionTypesEnum>, z.ZodTypeAny>;
 export type AnyAnswerType = z.infer<typeof AnyAnswerSchema>;

package/dist/answers/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyAnswerSchema = void 0;
+exports.AnswerSchemaMap = exports.AnyAnswerSchema = void 0;
 const zod_1 = require("zod");
 const dateAnswers_1 = require("./dateAnswers");
 const graphQLAnswers_1 = require("./graphQLAnswers");
@@ -46,3 +46,21 @@ exports.AnyAnswerSchema = zod_1.z.discriminatedUnion('type', [
     graphQLAnswers_1.TypeaheadSearchAnswerSchema,
     primitiveAnswers_1.URLAnswerSchema
 ]);
+// Export a mapping between question types and their corresponding answer schemas
+exports.AnswerSchemaMap = {
+    boolean: primitiveAnswers_1.BooleanAnswerSchema,
+    checkBoxes: optionBasedAnswers_1.CheckboxesAnswerSchema,
+    currency: primitiveAnswers_1.CurrencyAnswerSchema,
+    datePicker: dateAnswers_1.DatePickerAnswerSchema,
+    dateRange: dateAnswers_1.DateRangeAnswerSchema,
+    email: primitiveAnswers_1.EmailAnswerSchema,
+    filteredSearch: graphQLAnswers_1.FilteredSearchAnswerSchema,
+    number: primitiveAnswers_1.NumberAnswerSchema,
+    radioButtons: optionBasedAnswers_1.RadioButtonsAnswerSchema,
+    selectBox: optionBasedAnswers_1.SelectBoxAnswerSchema,
+    table: tableAnswers_1.TableAnswerSchema,
+    text: primitiveAnswers_1.TextAnswerSchema,
+    textArea: primitiveAnswers_1.TextAreaAnswerSchema,
+    typeaheadSearch: graphQLAnswers_1.TypeaheadSearchAnswerSchema,
+    url: primitiveAnswers_1.URLAnswerSchema
+};

package/dist/questions/dateQuestions.d.ts

@@ -12,7 +12,7 @@ export declare const DatePickerQuestionSchema: z.ZodObject<{
     }>;
 } & {
     type: z.ZodLiteral<"datePicker">;
-    attributes: z.ZodObject<{
+    attributes: z.ZodOptional<z.ZodObject<{
         max: z.ZodOptional<z.ZodString>;
         min: z.ZodOptional<z.ZodString>;
         step: z.ZodOptional<z.ZodNumber>;
@@ -24,29 +24,29 @@ export declare const DatePickerQuestionSchema: z.ZodObject<{
         max?: string | undefined;
         min?: string | undefined;
         step?: number | undefined;
-    }>;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "datePicker";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
     };
-    attributes: {
+    attributes?: {
         max?: string | undefined;
         min?: string | undefined;
         step?: number | undefined;
-    };
+    } | undefined;
 }, {
     type: "datePicker";
     meta: {
         schemaVersion: "1.0";
         labelTranslationKey?: string | undefined;
     };
-    attributes: {
+    attributes?: {
         max?: string | undefined;
         min?: string | undefined;
         step?: number | undefined;
-    };
+    } | undefined;
 }>;
 export declare const DateRangeQuestionSchema: z.ZodObject<{
     meta: z.ZodObject<{

package/dist/questions/dateQuestions.js

@@ -10,7 +10,7 @@ exports.DatePickerQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.objec
         max: zod_1.z.string().optional(), // The maximum date (no default)
         min: zod_1.z.string().optional(), // The minimum date (no default)
         step: zod_1.z.number().optional() // The step value (default is 1 day)
-    })
+    }).optional(),
 }));
 // Date range question and answer
 exports.DateRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({

package/dist/questions/graphQLQuestions.d.ts

@@ -29,7 +29,7 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
         localQueryId: z.ZodOptional<z.ZodString>;
         query: z.ZodOptional<z.ZodString>;
         responseField: z.ZodString;
-        variables: z.ZodArray<z.ZodObject<{
+        variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
             minLength: z.ZodOptional<z.ZodNumber>;
             label: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -50,7 +50,7 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }>, "many">;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         displayFields: {
             label: string;
@@ -58,16 +58,16 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     }, {
         displayFields: {
             label: string;
@@ -75,16 +75,16 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     }>;
     attributes: z.ZodObject<{
         multiple: z.ZodOptional<z.ZodBoolean>;
@@ -109,16 +109,16 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     };
 }, {
     type: "filteredSearch";
@@ -136,16 +136,16 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     };
 }>;
 export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
@@ -178,7 +178,7 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
         localQueryId: z.ZodOptional<z.ZodString>;
         query: z.ZodOptional<z.ZodString>;
         responseField: z.ZodString;
-        variables: z.ZodArray<z.ZodObject<{
+        variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
             minLength: z.ZodOptional<z.ZodNumber>;
             label: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -199,7 +199,7 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }>, "many">;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         displayFields: {
             label: string;
@@ -207,16 +207,16 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     }, {
         displayFields: {
             label: string;
@@ -224,16 +224,16 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "typeaheadSearch";
@@ -248,16 +248,16 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     };
 }, {
     type: "typeaheadSearch";
@@ -272,16 +272,16 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        variables: {
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        variables?: {
             type: string;
             name: string;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             label?: string | undefined;
             defaultValue?: string | undefined;
-        }[];
-        localQueryId?: string | undefined;
-        query?: string | undefined;
+        }[] | undefined;
     };
 }>;
 export type FilteredSearchQuestionType = z.infer<typeof FilteredSearchQuestionSchema>;

package/dist/questions/graphQLQuestions.js

@@ -24,7 +24,7 @@ const GraphQLQuery = zod_1.z.object({
     localQueryId: zod_1.z.string().optional(), // The ID of the query (required if no query)
     query: zod_1.z.string().optional(), // The GraphQL query to execute (required if no localQueryId)
     responseField: zod_1.z.string(), // How to get at the location of displayFields in the response
-    variables: zod_1.z.array(GraphQLVariable) // The variables for the query
+    variables: zod_1.z.array(GraphQLVariable).optional() // The variables for the query
 });
 // Filtered search question and answer
 exports.FilteredSearchQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({