@dmptool/types 1.1.2 → 1.1.3

package/dist/questions/__tests__/graphQLQuestions.spec.js

@@ -57,16 +57,18 @@ const graphQLQuestions_1 = require("../graphQLQuestions");
             type: "affiliationSearch",
             attributes: {
                 label: "Search",
-                help: "Search for a user",
+                help: "Search for a institution",
             },
             graphQL: {
+                query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}",
                 displayFields: [
-                    { propertyName: "title", label: "Title" },
+                    { propertyName: "displayName", label: "Name" },
                 ],
                 localQueryId: "12345",
-                responseField: "results",
+                answerField: "uri",
+                responseField: "affiliations.items",
                 variables: [
-                    { name: "query", type: "string" },
+                    { type: "string", name: "name", label: "Term", minLength: 3 },
                 ],
             },
             meta: {

package/dist/questions/__tests__/optionBasedQuestions.spec.js

@@ -3,18 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
 const optionBasedQuestions_1 = require("../optionBasedQuestions");
 (0, globals_1.describe)("BooleanQuestion", () => {
-    (0, globals_1.it)('optional fields should not throw an error if the value is undefined', () => {
-        const validBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: undefined, // Valid value
-            },
-        };
-        (0, globals_1.expect)(() => optionBasedQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
-    });
     (0, globals_1.it)('optional fields should throw an error if the value is null', () => {
         const invalidBooleanQuestion = {
             type: "boolean",
@@ -69,6 +57,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Banana",
                     value: "banana",
+                    checked: false,
                 },
             ],
             meta: {
@@ -115,6 +104,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Female",
                     value: "female",
+                    selected: true,
                 },
             ],
             meta: {
@@ -158,6 +148,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Canada",
                     value: "ca",
+                    selected: false,
                 },
             ],
             meta: {
@@ -205,6 +196,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
                 {
                     label: "Canada",
                     value: "ca",
+                    selected: false,
                 },
             ],
             meta: {

package/dist/questions/dateQuestions.d.ts

@@ -8,14 +8,14 @@ export declare const DateQuestionSchema: z.ZodObject<{} & {
     } & {
         max: z.ZodOptional<z.ZodString>;
         min: z.ZodOptional<z.ZodString>;
-        step: z.ZodOptional<z.ZodNumber>;
+        step: z.ZodDefault<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: string | undefined;
         min?: string | undefined;
-        step?: number | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
@@ -29,33 +29,29 @@ export declare const DateQuestionSchema: z.ZodObject<{} & {
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Date Field">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a date.">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Date Field" | undefined;
         usageDescription?: "For questions that require a date." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Date Field" | undefined;
         usageDescription?: "For questions that require a date." | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "date";
     attributes?: {
+        step: number;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         max?: string | undefined;
         min?: string | undefined;
-        step?: number | undefined;
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
         title?: "Date Field" | undefined;
         usageDescription?: "For questions that require a date." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "date";
@@ -71,7 +67,6 @@ export declare const DateQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Date Field" | undefined;
         usageDescription?: "For questions that require a date." | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const DateRangeQuestionSchema: z.ZodObject<{
@@ -91,21 +86,21 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
 } & {
     type: z.ZodLiteral<"dateRange">;
     columns: z.ZodObject<{
-        start: z.ZodOptional<z.ZodObject<{
+        start: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
-            step: z.ZodOptional<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -113,22 +108,22 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        }>>;
-        end: z.ZodOptional<z.ZodObject<{
+        }>;
+        end: z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         } & {
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
-            step: z.ZodOptional<z.ZodNumber>;
+            step: z.ZodDefault<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
         }, {
             label?: string | undefined;
             help?: string | undefined;
@@ -136,78 +131,75 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        }>>;
+        }>;
     }, "strip", z.ZodTypeAny, {
-        start?: {
+        start: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     }, {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
+        };
     }>;
     meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Date Range">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require a date range (e.g. From/To, Start/End)">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Date Range" | undefined;
         usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Date Range" | undefined;
         usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "dateRange";
     columns: {
-        start?: {
+        start: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
+            step: number;
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -218,27 +210,26 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         schemaVersion: "1.0";
         title?: "Date Range" | undefined;
         usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "dateRange";
     columns: {
-        start?: {
+        start: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
-        end?: {
+        };
+        end: {
             label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
             step?: number | undefined;
-        } | undefined;
+        };
     };
     attributes?: {
         label?: string | undefined;
@@ -249,7 +240,6 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         schemaVersion: "1.0";
         title?: "Date Range" | undefined;
         usageDescription?: "For questions that require a date range (e.g. From/To, Start/End)" | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export type DateQuestionType = z.infer<typeof DateQuestionSchema>;

package/dist/questions/dateQuestions.js

@@ -6,43 +6,28 @@ const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
 const BaseMeta = question_1.QuestionSchema.shape.meta;
 const DateAttributesSchema = BaseAttributes.unwrap().merge(zod_1.z.object({
-    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)
+    max: zod_1.z.string().optional(),
+    min: zod_1.z.string().optional(),
+    step: zod_1.z.number().default(1),
 }));
 // Date question and answer
-const defaultDateJSON = {
-    type: 'date',
-    attributes: Object.assign(Object.assign({}, question_1.defaultAttributes), { max: undefined, min: undefined, step: 1 }),
-    meta: Object.assign({}, question_1.defaultMeta)
-};
 exports.DateQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('date'), // The type of question
     attributes: DateAttributesSchema.optional(),
     meta: BaseMeta.unwrap().merge(zod_1.z.object({
         title: zod_1.z.literal('Date Field').optional(),
         usageDescription: zod_1.z.literal('For questions that require a date.').optional(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultDateJSON)).optional(),
     })).optional(),
 }));
 // Date range question and answer
-const defaultDateRangeJSON = {
-    type: 'dateRange',
-    attributes: Object.assign({}, question_1.defaultAttributes),
-    columns: {
-        start: Object.assign(Object.assign({}, question_1.defaultAttributes), { label: 'Start', max: undefined, min: undefined, step: 1 }),
-        end: Object.assign(Object.assign({}, question_1.defaultAttributes), { label: 'End', max: undefined, min: undefined, step: 1 })
-    }
-};
 exports.DateRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('dateRange'), // The type of question
     columns: zod_1.z.object({
-        start: DateAttributesSchema.optional(),
-        end: DateAttributesSchema.optional()
+        start: DateAttributesSchema,
+        end: DateAttributesSchema
     }),
     meta: BaseMeta.unwrap().merge(zod_1.z.object({
         title: zod_1.z.literal('Date Range').optional(),
         usageDescription: zod_1.z.literal('For questions that require a date range (e.g. From/To, Start/End)').optional(),
-        defaultJSON: zod_1.z.literal(JSON.stringify(defaultDateRangeJSON)).optional(),
     })).optional(),
 }));

package/dist/questions/graphQLQuestions.d.ts

@@ -95,19 +95,16 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
     meta: z.ZodOptional<z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
         usageDescription: z.ZodOptional<z.ZodString>;
-        defaultJSON: z.ZodOptional<z.ZodString>;
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Not yet implemented">>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Not yet implemented" | undefined;
         usageDescription?: string | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Not yet implemented" | undefined;
         usageDescription?: string | undefined;
-        defaultJSON?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "filteredSearch";
@@ -139,7 +136,6 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Not yet implemented" | undefined;
         usageDescription?: string | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "filteredSearch";
@@ -171,7 +167,6 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
         schemaVersion: "1.0";
         title?: "Not yet implemented" | undefined;
         usageDescription?: string | undefined;
-        defaultJSON?: string | undefined;
     } | undefined;
 }>;
 export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
@@ -188,98 +183,97 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }>>;
+} & {
+    type: z.ZodLiteral<"affiliationSearch">;
     graphQL: z.ZodObject<{
-        displayFields: z.ZodArray<z.ZodObject<{
-            propertyName: z.ZodString;
-            label: z.ZodString;
-            labelTranslationKey: z.ZodOptional<z.ZodString>;
+        localQueryId: z.ZodOptional<z.ZodString>;
+    } & {
+        query: z.ZodLiteral<"query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}">;
+        queryId: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        variables: z.ZodArray<z.ZodObject<{
+            name: z.ZodLiteral<"name">;
+            type: z.ZodDefault<z.ZodString>;
+            label: z.ZodDefault<z.ZodString>;
+            minLength: z.ZodLiteral<3>;
+            labelTranslationKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
+            type: string;
             label: string;
-            propertyName: string;
+            minLength: 3;
+            name: "name";
             labelTranslationKey?: string | undefined;
         }, {
-            label: string;
-            propertyName: string;
+            minLength: 3;
+            name: "name";
+            type?: string | undefined;
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
         }>, "many">;
-        localQueryId: z.ZodOptional<z.ZodString>;
-        query: z.ZodOptional<z.ZodString>;
-        responseField: z.ZodString;
-        variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            minLength: z.ZodOptional<z.ZodNumber>;
-            label: z.ZodOptional<z.ZodString>;
-            labelTranslationKey: z.ZodOptional<z.ZodString>;
-            name: z.ZodString;
-            type: z.ZodString;
-            defaultValue: z.ZodOptional<z.ZodString>;
+        answerField: z.ZodLiteral<"uri">;
+        displayFields: z.ZodArray<z.ZodObject<{
+            propertyName: z.ZodLiteral<"displayName">;
+            label: z.ZodDefault<z.ZodString>;
+            labelTranslationKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
-            type: string;
-            name: string;
-            label?: string | undefined;
+            label: string;
+            propertyName: "displayName";
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
         }, {
-            type: string;
-            name: string;
+            propertyName: "displayName";
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
-        }>, "many">>;
+        }>, "many">;
+        responseField: z.ZodLiteral<"affiliations.items">;
     }, "strip", z.ZodTypeAny, {
         displayFields: {
             label: string;
-            propertyName: string;
+            propertyName: "displayName";
             labelTranslationKey?: string | undefined;
         }[];
-        responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
+        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        responseField: "affiliations.items";
+        variables: {
             type: string;
-            name: string;
-            label?: string | undefined;
+            label: string;
+            minLength: 3;
+            name: "name";
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        answerField: "uri";
+        localQueryId?: string | undefined;
+        queryId?: string | undefined;
     }, {
         displayFields: {
-            label: string;
-            propertyName: string;
+            propertyName: "displayName";
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
         }[];
-        responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
-            type: string;
-            name: string;
+        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        responseField: "affiliations.items";
+        variables: {
+            minLength: 3;
+            name: "name";
+            type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        answerField: "uri";
+        localQueryId?: string | undefined;
+        queryId?: string | undefined;
     }>;
-} & {
-    type: z.ZodLiteral<"affiliationSearch">;
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
     } & {
         title: z.ZodOptional<z.ZodLiteral<"Affiliation Search">>;
         usageDescription: z.ZodOptional<z.ZodLiteral<"For questions that require the user to select from a controlled list of institutions.">>;
-        defaultJSON: z.ZodOptional<z.ZodLiteral<string>>;
     }, "strip", z.ZodTypeAny, {
         schemaVersion: "1.0";
         title?: "Affiliation Search" | undefined;
         usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
-        defaultJSON?: string | undefined;
     }, {
         schemaVersion: "1.0";
         title?: "Affiliation Search" | undefined;
         usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
-        defaultJSON?: string | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "affiliationSearch";
@@ -287,25 +281,25 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         schemaVersion: "1.0";
         title?: "Affiliation Search" | undefined;
         usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
-        defaultJSON?: string | undefined;
     };
     graphQL: {
         displayFields: {
             label: string;
-            propertyName: string;
+            propertyName: "displayName";
             labelTranslationKey?: string | undefined;
         }[];
-        responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
+        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        responseField: "affiliations.items";
+        variables: {
             type: string;
-            name: string;
-            label?: string | undefined;
+            label: string;
+            minLength: 3;
+            name: "name";
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        answerField: "uri";
+        localQueryId?: string | undefined;
+        queryId?: string | undefined;
     };
     attributes?: {
         label?: string | undefined;
@@ -318,25 +312,25 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         schemaVersion: "1.0";
         title?: "Affiliation Search" | undefined;
         usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
-        defaultJSON?: string | undefined;
     };
     graphQL: {
         displayFields: {
-            label: string;
-            propertyName: string;
+            propertyName: "displayName";
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
         }[];
-        responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
-            type: string;
-            name: string;
+        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        responseField: "affiliations.items";
+        variables: {
+            minLength: 3;
+            name: "name";
+            type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-            minLength?: number | undefined;
-            defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        answerField: "uri";
+        localQueryId?: string | undefined;
+        queryId?: string | undefined;
     };
     attributes?: {
         label?: string | undefined;