@dmptool/types 1.1.1 → 1.1.3

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,20 @@ 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>;
+    } & {
+        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";
     graphQL: {
@@ -128,6 +134,8 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Not yet implemented" | undefined;
+        usageDescription?: string | undefined;
     } | undefined;
 }, {
     type: "filteredSearch";
@@ -157,9 +165,11 @@ export declare const FilteredSearchQuestionSchema: z.ZodObject<{
     } | undefined;
     meta?: {
         schemaVersion: "1.0";
+        title?: "Not yet implemented" | undefined;
+        usageDescription?: 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,145 +183,160 @@ 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">;
+    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;
+    }>;
+    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;
     }>;
 }, "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;
+    };
     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;
         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;
+    };
     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;
         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,45 @@ 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
 }));
+exports.AffiliationSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('affiliationSearch'),
+    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}}}'),
+        queryId: zod_1.z.string().default('useAffiliationsQuery').optional(),
+        variables: zod_1.z.array(zod_1.z.object({
+            name: zod_1.z.literal("name"),
+            type: zod_1.z.string().default("string"),
+            label: zod_1.z.string().default("Search for your institution"),
+            minLength: zod_1.z.literal(3),
+            labelTranslationKey: zod_1.z.string().default("SignupPage.institutionHelp").optional(),
+        })),
+        answerField: zod_1.z.literal('uri'),
+        displayFields: zod_1.z.array(zod_1.z.object({
+            propertyName: zod_1.z.literal("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(),
+    }))
+}));