@dmptool/types 1.1.1 → 1.1.2

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

@@ -147,7 +147,7 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
             attributes: {
                 label: "Fruits",
                 help: "Select all fruits you like",
-                multiple: true,
+                multiple: false,
             },
             options: [
                 {
@@ -187,3 +187,50 @@ const optionBasedQuestions_1 = require("../optionBasedQuestions");
         (0, globals_1.expect)(() => optionBasedQuestions_1.SelectBoxQuestionSchema.parse(invalidSelectBoxQuestion)).toThrow();
     });
 });
+(0, globals_1.describe)("MultiselectBoxQuestion", () => {
+    (0, globals_1.it)("should validate a valid MultiselectBoxQuestion object", () => {
+        const validSelectBoxQuestion = {
+            type: "multiselectBox",
+            attributes: {
+                label: "Fruits",
+                help: "Select all fruits you like",
+                multiple: true,
+            },
+            options: [
+                {
+                    label: "USA",
+                    value: "us",
+                    selected: true,
+                },
+                {
+                    label: "Canada",
+                    value: "ca",
+                },
+            ],
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        (0, globals_1.expect)(() => optionBasedQuestions_1.MultiselectBoxQuestionSchema.parse(validSelectBoxQuestion)).not.toThrow();
+    });
+    (0, globals_1.it)("should throw an error for an invalid MultiselectBoxQuestion object", () => {
+        const invalidSelectBoxQuestion = {
+            type: "multiselectBox",
+            questionText: "Select your country",
+            options: [
+                {
+                    label: "USA",
+                    value: "us",
+                    selected: "true", // Invalid type for selected
+                },
+            ],
+            attributes: {
+                multiple: "true", // Invalid type for multiple
+            },
+            meta: {
+                schemaVersion: "1.0"
+            }
+        };
+        (0, globals_1.expect)(() => optionBasedQuestions_1.MultiselectBoxQuestionSchema.parse(invalidSelectBoxQuestion)).toThrow();
+    });
+});

package/dist/questions/dateQuestions.d.ts

@@ -1,13 +1,5 @@
 import { z } from "zod";
-export declare const DateQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const DateQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"date">;
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
@@ -32,6 +24,23 @@ export declare const DateQuestionSchema: z.ZodObject<{
         min?: string | undefined;
         step?: number | undefined;
     }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+    } & {
+        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?: {
@@ -44,6 +53,9 @@ export declare const DateQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Date Field" | undefined;
+        usageDescription?: "For questions that require a date." | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "date";
@@ -57,6 +69,9 @@ export declare const DateQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         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<{
@@ -73,13 +88,6 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
 } & {
     type: z.ZodLiteral<"dateRange">;
     columns: z.ZodObject<{
@@ -164,6 +172,23 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
             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: {
@@ -191,6 +216,9 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         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";
@@ -219,6 +247,9 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         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

@@ -4,21 +4,45 @@ exports.DateRangeQuestionSchema = exports.DateQuestionSchema = void 0;
 const zod_1 = require("zod");
 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)
 }));
 // 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()
-    })
+    }),
+    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

@@ -1,13 +1,5 @@
 import { z } from "zod";
-export declare const FilteredSearchQuestionSchema: z.ZodObject<{
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
+export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
     type: z.ZodLiteral<"filteredSearch">;
     graphQL: z.ZodObject<{
         displayFields: z.ZodArray<z.ZodObject<{
@@ -100,6 +92,23 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
         labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     }>>;
+    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";
     graphQL: {
@@ -128,6 +137,9 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Not yet implemented" | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }, {
     type: "filteredSearch";
@@ -157,9 +169,12 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Not yet implemented" | undefined;
+        usageDescription?: string | undefined;
+        defaultJSON?: string | undefined;
     } | undefined;
 }>;
-export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
+export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
     attributes: z.ZodOptional<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
@@ -173,15 +188,6 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
-    }, {
-        schemaVersion: "1.0";
-    }>>;
-} & {
-    type: z.ZodLiteral<"typeaheadSearch">;
     graphQL: z.ZodObject<{
         displayFields: z.ZodArray<z.ZodObject<{
             propertyName: z.ZodString;
@@ -256,8 +262,33 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
             defaultValue?: string | undefined;
         }[] | 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: "typeaheadSearch";
+    type: "affiliationSearch";
+    meta: {
+        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;
@@ -281,11 +312,14 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-    } | undefined;
 }, {
-    type: "typeaheadSearch";
+    type: "affiliationSearch";
+    meta: {
+        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;
@@ -309,9 +343,6 @@ export declare const TypeaheadSearchQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-    } | undefined;
 }>;
 export type FilteredSearchQuestionType = z.infer<typeof FilteredSearchQuestionSchema>;
-export type TypeaheadSearchQuestionType = z.infer<typeof TypeaheadSearchQuestionSchema>;
+export type AffiliationSearchQuestionType = z.infer<typeof AffiliationSearchQuestionSchema>;

package/dist/questions/graphQLQuestions.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeaheadSearchQuestionSchema = exports.FilteredSearchQuestionSchema = void 0;
+exports.AffiliationSearchQuestionSchema = exports.FilteredSearchQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
+const BaseMeta = question_1.QuestionSchema.shape.meta;
 // An input variable for a GraphQL query
 const GraphQLVariable = zod_1.z.object({
     minLength: zod_1.z.number().optional(), // A min length for the variable before executing the query
@@ -28,15 +29,51 @@ const GraphQLQuery = zod_1.z.object({
     variables: zod_1.z.array(GraphQLVariable).optional() // The variables for the query
 });
 // Filtered search question and answer
+// TODO: This one is for future use to help build out the components of the
+//       Research Outputs Question Type (e.g. License selector, Repository selector, etc.)
 exports.FilteredSearchQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('filteredSearch'), // The type of question
     graphQL: GraphQLQuery, // The GraphQL query options for the filtered search
     attributes: BaseAttributes.unwrap().merge(zod_1.z.object({
         multiple: zod_1.z.boolean().optional() // Whether to allow multiple selections (default is true)
-    })).optional()
+    })).optional(),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Not yet implemented').optional(),
+    })).optional(),
 }));
 // Typeahead search question and answer
-exports.TypeaheadSearchQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
+const TypeaheadSearchQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('typeaheadSearch'), // The type of question
     graphQL: GraphQLQuery, // The GraphQL query options for the typeahead search
 }));
+const defaultAffiliationSearchJSON = {
+    type: 'affiliationSearch',
+    attributes: Object.assign({}, question_1.defaultAttributes),
+    meta: Object.assign({}, question_1.defaultMeta),
+    graphQL: {
+        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}",
+        queryId: "useAffiliationsQuery",
+        variables: [{
+                name: "term",
+                type: "string",
+                label: "Search for your institution",
+                minLength: 3,
+                labelTranslationKey: "SignupPage.institutionHelp"
+            }],
+        answerField: "uri",
+        displayFields: [{
+                label: "Institution",
+                propertyName: "displayName",
+                labelTranslationKey: "SignupPage.institution"
+            }],
+        responseField: "affiliations.items"
+    },
+};
+exports.AffiliationSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('affiliationSearch'),
+    meta: BaseMeta.unwrap().merge(zod_1.z.object({
+        title: zod_1.z.literal('Affiliation Search').optional(),
+        usageDescription: zod_1.z.literal('For questions that require the user to select from a controlled list of institutions.').optional(),
+        defaultJSON: zod_1.z.literal(JSON.stringify(defaultAffiliationSearchJSON)).optional(),
+    }))
+}));