@dmptool/types 1.1.3 → 1.2.1

package/dist/questions/graphQLQuestions.d.ts

@@ -1,29 +1,43 @@
 import { z } from "zod";
-export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
+export declare const FilteredSearchQuestionSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
     type: z.ZodLiteral<"filteredSearch">;
-    graphQL: z.ZodObject<{
-        displayFields: z.ZodArray<z.ZodObject<{
-            propertyName: z.ZodString;
-            label: z.ZodString;
+    graphQL: z.ZodDefault<z.ZodObject<{
+        displayFields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            propertyName: z.ZodDefault<z.ZodString>;
+            label: z.ZodDefault<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             label: string;
             propertyName: string;
             labelTranslationKey?: string | undefined;
         }, {
-            label: string;
-            propertyName: string;
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }>, "many">;
+            propertyName?: string | undefined;
+        }>, "many">>;
         localQueryId: z.ZodOptional<z.ZodString>;
         query: z.ZodOptional<z.ZodString>;
-        responseField: z.ZodString;
-        variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        responseField: z.ZodDefault<z.ZodString>;
+        variables: z.ZodDefault<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;
+            name: z.ZodDefault<z.ZodString>;
+            type: z.ZodDefault<z.ZodString>;
             defaultValue: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             type: string;
@@ -33,11 +47,11 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
             minLength?: number | undefined;
             defaultValue?: string | undefined;
         }, {
-            type: string;
-            name: string;
+            type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
+            name?: string | undefined;
             defaultValue?: string | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -47,67 +61,64 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
+        variables: {
             type: string;
             name: string;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
     }, {
-        displayFields: {
-            label: string;
-            propertyName: string;
+        displayFields?: {
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        responseField: string;
+            propertyName?: string | undefined;
+        }[] | undefined;
         localQueryId?: string | undefined;
         query?: string | undefined;
+        responseField?: string | undefined;
         variables?: {
-            type: string;
-            name: string;
+            type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
+            name?: string | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
-    }>;
-    attributes: z.ZodOptional<z.ZodObject<{
+    }>>;
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
     } & {
-        multiple: z.ZodOptional<z.ZodBoolean>;
+        multiple: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        multiple: boolean;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        multiple?: boolean | undefined;
     }, {
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
         multiple?: boolean | undefined;
     }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
-        usageDescription: 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;
-    }, {
-        schemaVersion: "1.0";
-        title?: "Not yet implemented" | undefined;
-        usageDescription?: string | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "filteredSearch";
+    attributes: {
+        multiple: boolean;
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
     graphQL: {
         displayFields: {
             label: string;
@@ -115,17 +126,19 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
             labelTranslationKey?: string | undefined;
         }[];
         responseField: string;
-        localQueryId?: string | undefined;
-        query?: string | undefined;
-        variables?: {
+        variables: {
             type: string;
             name: string;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
             defaultValue?: string | undefined;
-        }[] | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
     };
+}, {
+    type: "filteredSearch";
     attributes?: {
         label?: string | undefined;
         help?: string | undefined;
@@ -133,44 +146,47 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{} & {
         multiple?: boolean | undefined;
     } | undefined;
     meta?: {
-        schemaVersion: "1.0";
-        title?: "Not yet implemented" | undefined;
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
         usageDescription?: string | undefined;
     } | undefined;
-}, {
-    type: "filteredSearch";
-    graphQL: {
-        displayFields: {
-            label: string;
-            propertyName: string;
+    graphQL?: {
+        displayFields?: {
+            label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        responseField: string;
+            propertyName?: string | undefined;
+        }[] | undefined;
         localQueryId?: string | undefined;
         query?: string | undefined;
+        responseField?: string | undefined;
         variables?: {
-            type: string;
-            name: string;
+            type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
             minLength?: number | undefined;
+            name?: string | undefined;
             defaultValue?: string | undefined;
         }[] | undefined;
-    };
-    attributes?: {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-        multiple?: boolean | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
-        title?: "Not yet implemented" | undefined;
-        usageDescription?: string | undefined;
     } | undefined;
 }>;
+export declare const affiliationQuery: string;
 export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
-    attributes: z.ZodOptional<z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }, {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    }>>;
+} & {
+    type: z.ZodLiteral<"affiliationSearch">;
+    attributes: z.ZodDefault<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -183,18 +199,16 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     }>>;
-} & {
-    type: z.ZodLiteral<"affiliationSearch">;
-    graphQL: z.ZodObject<{
+    graphQL: z.ZodDefault<z.ZodObject<{
         localQueryId: z.ZodOptional<z.ZodString>;
     } & {
-        query: z.ZodLiteral<"query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}">;
+        query: z.ZodDefault<z.ZodLiteral<string>>;
         queryId: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-        variables: z.ZodArray<z.ZodObject<{
-            name: z.ZodLiteral<"name">;
+        variables: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodDefault<z.ZodLiteral<"name">>;
             type: z.ZodDefault<z.ZodString>;
             label: z.ZodDefault<z.ZodString>;
-            minLength: z.ZodLiteral<3>;
+            minLength: z.ZodDefault<z.ZodLiteral<3>>;
             labelTranslationKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             type: string;
@@ -203,15 +217,15 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
             name: "name";
             labelTranslationKey?: string | undefined;
         }, {
-            minLength: 3;
-            name: "name";
             type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }>, "many">;
-        answerField: z.ZodLiteral<"uri">;
-        displayFields: z.ZodArray<z.ZodObject<{
-            propertyName: z.ZodLiteral<"displayName">;
+            minLength?: 3 | undefined;
+            name?: "name" | undefined;
+        }>, "many">>;
+        answerField: z.ZodDefault<z.ZodLiteral<"uri">>;
+        displayFields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            propertyName: z.ZodDefault<z.ZodLiteral<"displayName">>;
             label: z.ZodDefault<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
@@ -219,18 +233,18 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
             propertyName: "displayName";
             labelTranslationKey?: string | undefined;
         }, {
-            propertyName: "displayName";
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }>, "many">;
-        responseField: z.ZodLiteral<"affiliations.items">;
+            propertyName?: "displayName" | undefined;
+        }>, "many">>;
+        responseField: z.ZodDefault<z.ZodLiteral<"affiliations.items">>;
     }, "strip", z.ZodTypeAny, {
         displayFields: {
             label: string;
             propertyName: "displayName";
             labelTranslationKey?: string | undefined;
         }[];
-        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        query: string;
         responseField: "affiliations.items";
         variables: {
             type: string;
@@ -243,44 +257,35 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         localQueryId?: string | undefined;
         queryId?: string | undefined;
     }, {
-        displayFields: {
-            propertyName: "displayName";
+        displayFields?: {
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
-        responseField: "affiliations.items";
-        variables: {
-            minLength: 3;
-            name: "name";
+            propertyName?: "displayName" | undefined;
+        }[] | undefined;
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        responseField?: "affiliations.items" | undefined;
+        variables?: {
             type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        answerField: "uri";
-        localQueryId?: string | undefined;
+            minLength?: 3 | undefined;
+            name?: "name" | undefined;
+        }[] | undefined;
         queryId?: string | undefined;
-    }>;
-    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.">>;
-    }, "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;
-    }, {
-        schemaVersion: "1.0";
-        title?: "Affiliation Search" | undefined;
-        usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
-    }>;
+        answerField?: "uri" | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     type: "affiliationSearch";
+    attributes: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+    };
     meta: {
-        schemaVersion: "1.0";
-        title?: "Affiliation Search" | undefined;
-        usageDescription?: "For questions that require the user to select from a controlled list of institutions." | undefined;
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
     };
     graphQL: {
         displayFields: {
@@ -288,7 +293,7 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
             propertyName: "displayName";
             labelTranslationKey?: string | undefined;
         }[];
-        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
+        query: string;
         responseField: "affiliations.items";
         variables: {
             type: string;
@@ -301,41 +306,36 @@ export declare const AffiliationSearchQuestionSchema: z.ZodObject<{
         localQueryId?: string | undefined;
         queryId?: string | undefined;
     };
+}, {
+    type: "affiliationSearch";
     attributes?: {
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
     } | undefined;
-}, {
-    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;
-    };
-    graphQL: {
-        displayFields: {
-            propertyName: "displayName";
+    meta?: {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    } | undefined;
+    graphQL?: {
+        displayFields?: {
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        query: "query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}";
-        responseField: "affiliations.items";
-        variables: {
-            minLength: 3;
-            name: "name";
+            propertyName?: "displayName" | undefined;
+        }[] | undefined;
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+        responseField?: "affiliations.items" | undefined;
+        variables?: {
             type?: string | undefined;
             label?: string | undefined;
             labelTranslationKey?: string | undefined;
-        }[];
-        answerField: "uri";
-        localQueryId?: string | undefined;
+            minLength?: 3 | undefined;
+            name?: "name" | undefined;
+        }[] | undefined;
         queryId?: string | undefined;
-    };
-    attributes?: {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
+        answerField?: "uri" | undefined;
     } | undefined;
 }>;
 export type FilteredSearchQuestionType = z.infer<typeof FilteredSearchQuestionSchema>;

package/dist/questions/graphQLQuestions.js

@@ -1,73 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AffiliationSearchQuestionSchema = exports.FilteredSearchQuestionSchema = void 0;
+exports.AffiliationSearchQuestionSchema = exports.affiliationQuery = 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
     label: zod_1.z.string().optional(), // The label for the variable (default to the name)
     labelTranslationKey: zod_1.z.string().optional(), // The translation key for the label (DMP Tool only)
-    name: zod_1.z.string(), // MUST match the input variable name in the query
-    type: zod_1.z.string(), // The type of the variable (default is string)
+    name: zod_1.z.string().default('search'), // MUST match the input variable name in the query
+    type: zod_1.z.string().default('string'), // The type of the variable (default is string)
     defaultValue: zod_1.z.string().optional() // The default value for the variable (no default)
 });
 // A property from a GraphQL query response that will be displayed to the user
 const GraphQLDisplayField = zod_1.z.object({
-    propertyName: zod_1.z.string(), // MUST match a property name in the query response
-    label: zod_1.z.string(), // The label for the field
+    propertyName: zod_1.z.string().default('id'), // MUST match a property name in the query response
+    label: zod_1.z.string().default('Id'), // The label for the field
     labelTranslationKey: zod_1.z.string().optional() // The translation key for the label (DMP Tool only)
 });
 // A GraphQL query object
 const GraphQLQuery = zod_1.z.object({
-    displayFields: zod_1.z.array(GraphQLDisplayField), // The fields to display from the query response
+    displayFields: zod_1.z.array(GraphQLDisplayField).default([{}]), // The fields to display from the query response
     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).optional() // The variables for the query
+    responseField: zod_1.z.string().default('query.items'), // How to get at the location of displayFields in the response
+    variables: zod_1.z.array(GraphQLVariable).default([{}]) // 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(),
-    meta: BaseMeta.unwrap().merge(zod_1.z.object({
-        title: zod_1.z.literal('Not yet implemented').optional(),
-    })).optional(),
+    type: zod_1.z.literal('filteredSearch'),
+    graphQL: GraphQLQuery.default({}), // The GraphQL query options for the search
+    attributes: BaseAttributes.merge(zod_1.z.object({
+        multiple: zod_1.z.boolean().default(true) // Whether to allow multiple selections
+    })).default({})
 }));
 // Typeahead search question and answer
 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
 }));
+exports.affiliationQuery = '' +
+    'query Affiliations($name: String!){' +
+    'affiliations(name: $name) {' +
+    'totalCount' +
+    'nextCursor' +
+    'items {' +
+    'id' +
+    'displayName' +
+    'uri' +
+    '}' +
+    '}' +
+    '}';
 exports.AffiliationSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('affiliationSearch'),
+    attributes: BaseAttributes.default({}),
     graphQL: GraphQLQuery.merge(zod_1.z.object({
-        query: zod_1.z.literal('query Affiliations($name: String!){affiliations(name: $name) { totalCount nextCursor items {id displayName uri}}}'),
+        query: zod_1.z.literal(exports.affiliationQuery).default(exports.affiliationQuery),
         queryId: zod_1.z.string().default('useAffiliationsQuery').optional(),
         variables: zod_1.z.array(zod_1.z.object({
-            name: zod_1.z.literal("name"),
+            name: zod_1.z.literal("name").default('name'),
             type: zod_1.z.string().default("string"),
             label: zod_1.z.string().default("Search for your institution"),
-            minLength: zod_1.z.literal(3),
+            minLength: zod_1.z.literal(3).default(3),
             labelTranslationKey: zod_1.z.string().default("SignupPage.institutionHelp").optional(),
-        })),
-        answerField: zod_1.z.literal('uri'),
+        })).default([{}]),
+        answerField: zod_1.z.literal('uri').default('uri'),
         displayFields: zod_1.z.array(zod_1.z.object({
-            propertyName: zod_1.z.literal("displayName"),
+            propertyName: zod_1.z.literal("displayName").default('displayName'),
             label: zod_1.z.string().default("Institution"),
             labelTranslationKey: zod_1.z.string().default("SignupPage.institution").optional(),
-        })),
-        responseField: zod_1.z.literal("affiliations.items")
-    })),
-    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(),
-    }))
+        })).default([{}]),
+        responseField: zod_1.z.literal("affiliations.items").default('affiliations.items'),
+    })).default({}),
 }));