@dmptool/types 1.2.3 → 1.2.5

package/dist/questions/graphQLQuestions.js

@@ -1,9 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AffiliationSearchQuestionSchema = exports.affiliationQuery = exports.FilteredSearchQuestionSchema = void 0;
+exports.LicenseSearchQuestionSchema = exports.licenseQuery = exports.MetadataStandardSearchQuestionSchema = exports.metadataStandardQuery = exports.RepositorySearchQuestionSchema = exports.repositoryQuery = exports.AffiliationSearchQuestionSchema = exports.affiliationQuery = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
+const paginationOptions = zod_1.z.object({
+    type: zod_1.z.enum(['OFFSET', 'CURSOR']).default('OFFSET'), // Type of pagination to use
+    limit: zod_1.z.number().default(10), // Number of items per page
+    offset: zod_1.z.number().optional().default(0), // Offset for pagination (if using offset-based pagination)
+    cursor: zod_1.z.string().optional(), // Cursor for pagination (if using cursor-based pagination)
+    sortField: zod_1.z.string().default('name'), // Field to sort by
+    sortOrder: zod_1.z.enum(['ASC', 'DESC']).default('ASC'), // Sort order
+});
 // 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
@@ -13,6 +21,19 @@ const GraphQLVariable = zod_1.z.object({
     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)
 });
+const GraphQLPaginationVariables = GraphQLVariable.extend({
+    name: zod_1.z.enum(['paginationOptions']).default('paginationOptions'),
+    type: zod_1.z.string().default('paginationOptions'),
+    label: zod_1.z.string().default('Pagination Options'),
+    options: paginationOptions.default({
+        type: 'OFFSET',
+        limit: 10,
+        offset: 0,
+        cursor: undefined,
+        sortField: 'name',
+        sortOrder: 'ASC',
+    })
+});
 // 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().default('id'), // MUST match a property name in the query response
@@ -27,16 +48,6 @@ const GraphQLQuery = zod_1.z.object({
     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'),
-    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
@@ -76,3 +87,238 @@ exports.AffiliationSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zo
         responseField: zod_1.z.literal("affiliations.items").default('affiliations.items'),
     })).default({}),
 }));
+exports.repositoryQuery = '' +
+    'query Repositories($term: String, $keywords: [String!], $repositoryType: String, $paginationOptions: PaginationOptions){ ' +
+    'repositories(term: $term, keywords: $keywords, repositoryType: $repositoryType, paginationOptions: $paginationOptions) { ' +
+    'totalCount ' +
+    'currentOffset ' +
+    'limit ' +
+    'hasNextPage ' +
+    'hasPreviousPage ' +
+    'availableSortFields ' +
+    'items { ' +
+    'id ' +
+    'name ' +
+    'uri ' +
+    'description ' +
+    'website ' +
+    'keywords ' +
+    'repositoryTypes ' +
+    '} ' +
+    '} ' +
+    '}';
+const RepositorySearchTermVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("term").default('term'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Search for a repository"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.term").optional(),
+});
+const RepositorySearchRepositoryTypeVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("repositoryType").default('repositoryType'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Repository type"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.repositoryType").optional(),
+});
+const RepositorySearchKeywordsVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("keywords").default('keywords'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Subject Areas"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.keywords").optional(),
+});
+const RepositorySearchResultName = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("name").default('name'),
+    label: zod_1.z.string().default("Name"),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.name").optional(),
+});
+const RepositorySearchResultDescription = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("description").default('description'),
+    label: zod_1.z.string().default("Description"),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.description").optional(),
+});
+const RepositorySearchResultWebsite = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("website").default('website'),
+    label: zod_1.z.string().default("Website"),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.website").optional(),
+});
+const RepositorySearchResultKeywords = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("keywords").default('keywords'),
+    label: zod_1.z.string().default("Subject Areas"),
+    labelTranslationKey: zod_1.z.string().default("RepositorySearch.keywords").optional(),
+});
+const defaultRepositorySearchTerm = RepositorySearchTermVariable.parse({});
+const defaultRepositorySearchType = RepositorySearchRepositoryTypeVariable.parse({});
+const defaultRepositorySearchSubjectAreas = RepositorySearchKeywordsVariable.parse({});
+const defaultRepositorySearchName = RepositorySearchResultName.parse({});
+const defaultRepositorySearchDescription = RepositorySearchResultDescription.parse({});
+const defaultRepositorySearchWebsite = RepositorySearchResultWebsite.parse({});
+const defaultRepositorySearchKeywords = RepositorySearchResultKeywords.parse({});
+const defaultRepositoryPaginationOptions = GraphQLPaginationVariables.parse({});
+// Repository search question and answer
+exports.RepositorySearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('repositorySearch'),
+    attributes: BaseAttributes.default({}),
+    graphQL: GraphQLQuery.merge(zod_1.z.object({
+        query: zod_1.z.literal(exports.repositoryQuery).default(exports.repositoryQuery),
+        queryId: zod_1.z.string().default('useRepositoriesQuery').optional(),
+        variables: zod_1.z.array(GraphQLVariable).default([
+            defaultRepositorySearchTerm,
+            defaultRepositorySearchSubjectAreas,
+            defaultRepositorySearchType,
+            defaultRepositoryPaginationOptions,
+        ]),
+        answerField: zod_1.z.literal('uri').default('uri'),
+        displayFields: zod_1.z.array(GraphQLDisplayField).default([
+            defaultRepositorySearchName,
+            defaultRepositorySearchDescription,
+            defaultRepositorySearchWebsite,
+            defaultRepositorySearchKeywords,
+        ]),
+        responseField: zod_1.z.literal("repositories.items").default('repositories.items'),
+    })).default({}),
+}));
+exports.metadataStandardQuery = '' +
+    'query MetadataStandards($term: String, $keywords: [String!], $paginationOptions: PaginationOptions){ ' +
+    'metadataStandards(term: $term, keywords: $keywords, paginationOptions: $paginationOptions) { ' +
+    'totalCount ' +
+    'currentOffset ' +
+    'limit ' +
+    'hasNextPage ' +
+    'hasPreviousPage ' +
+    'availableSortFields ' +
+    'items { ' +
+    'id ' +
+    'name ' +
+    'uri ' +
+    'description ' +
+    'keywords ' +
+    '} ' +
+    '} ' +
+    '}';
+const MetadataStandardSearchTermVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("term").default('term'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Search for a metadata standard"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.term").optional(),
+});
+const MetadataStandardSearchKeywordsVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("keywords").default('keywords'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Subject Areas"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.keywords").optional(),
+});
+const MetadataStandardSearchResultName = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("name").default('name'),
+    label: zod_1.z.string().default("Name"),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.name").optional(),
+});
+const MetadataStandardSearchResultDescription = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("description").default('description'),
+    label: zod_1.z.string().default("Description"),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.description").optional(),
+});
+const MetadataStandardSearchResultWebsite = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("website").default('website'),
+    label: zod_1.z.string().default("Website"),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.website").optional(),
+});
+const MetadataStandardSearchResultKeywords = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("keywords").default('keywords'),
+    label: zod_1.z.string().default("Subject Areas"),
+    labelTranslationKey: zod_1.z.string().default("MetadataStandardSearch.keywords").optional(),
+});
+const defaultMetadataStandardSearchTerm = MetadataStandardSearchTermVariable.parse({});
+const defaultMetadataStandardSearchSubjectAreas = MetadataStandardSearchKeywordsVariable.parse({});
+const defaultMetadataStandardPaginationOptions = GraphQLPaginationVariables.parse({});
+const defaultMetadataStandardName = MetadataStandardSearchResultName.parse({});
+const defaultMetadataStandardDescription = MetadataStandardSearchResultDescription.parse({});
+const defaultMetadataStandardWebsite = MetadataStandardSearchResultWebsite.parse({});
+const defaultMetadataStandardKeywords = MetadataStandardSearchResultKeywords.parse({});
+exports.MetadataStandardSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('metadataStandardSearch'),
+    attributes: BaseAttributes.default({}),
+    graphQL: GraphQLQuery.merge(zod_1.z.object({
+        query: zod_1.z.literal(exports.metadataStandardQuery).default(exports.metadataStandardQuery),
+        queryId: zod_1.z.string().default('useMetadataStandardsQuery').optional(),
+        variables: zod_1.z.array(GraphQLVariable).default([
+            defaultMetadataStandardSearchTerm,
+            defaultMetadataStandardSearchSubjectAreas,
+            defaultMetadataStandardPaginationOptions,
+        ]),
+        answerField: zod_1.z.literal('uri').default('uri'),
+        displayFields: zod_1.z.array(GraphQLDisplayField).default([
+            defaultMetadataStandardName,
+            defaultMetadataStandardDescription,
+            defaultMetadataStandardWebsite,
+            defaultMetadataStandardKeywords,
+        ]),
+        responseField: zod_1.z.literal("metadataStandards.items").default('metadataStandards.items'),
+    })).default({}),
+}));
+exports.licenseQuery = '' +
+    'query Licenses($term: String, $paginationOptions: PaginationOptions){ ' +
+    'license(term: $term, paginationOptions: $paginationOptions) { ' +
+    'totalCount ' +
+    'currentOffset ' +
+    'limit ' +
+    'hasNextPage ' +
+    'hasPreviousPage ' +
+    'availableSortFields ' +
+    'items { ' +
+    'id ' +
+    'name ' +
+    'uri ' +
+    'description ' +
+    '} ' +
+    '} ' +
+    '}';
+const LicenseSearchTermVariable = GraphQLVariable.extend({
+    name: zod_1.z.literal("term").default('term'),
+    type: zod_1.z.string().default("string"),
+    label: zod_1.z.string().default("Search for a license"),
+    minLength: zod_1.z.literal(3).default(3),
+    labelTranslationKey: zod_1.z.string().default("LicenseSearch.term").optional(),
+});
+const LicenseSearchResultName = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("name").default('name'),
+    label: zod_1.z.string().default("Name"),
+    labelTranslationKey: zod_1.z.string().default("License.name").optional(),
+});
+const LicenseSearchResultDescription = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("description").default('description'),
+    label: zod_1.z.string().default("Description"),
+    labelTranslationKey: zod_1.z.string().default("License.description").optional(),
+});
+const LicenseSearchResultRecommended = GraphQLDisplayField.extend({
+    propertyName: zod_1.z.literal("recommended").default('recommended'),
+    label: zod_1.z.string().default("Recommended"),
+    labelTranslationKey: zod_1.z.string().default("License.recommended").optional(),
+});
+const defaultLicenseSearchTerm = LicenseSearchTermVariable.parse({});
+const defaultLicensePaginationOptions = GraphQLPaginationVariables.parse({});
+const defaultLicenseName = LicenseSearchResultName.parse({});
+const defaultLicenseDescription = LicenseSearchResultDescription.parse({});
+const defaultLicenseRecommended = LicenseSearchResultRecommended.parse({});
+exports.LicenseSearchQuestionSchema = TypeaheadSearchQuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('licenseSearch'),
+    attributes: BaseAttributes.default({}),
+    graphQL: GraphQLQuery.merge(zod_1.z.object({
+        query: zod_1.z.literal(exports.licenseQuery).default(exports.licenseQuery),
+        queryId: zod_1.z.string().default('useLicensesQuery').optional(),
+        variables: zod_1.z.array(GraphQLVariable).default([
+            defaultLicenseSearchTerm,
+            defaultLicensePaginationOptions,
+        ]),
+        answerField: zod_1.z.literal('uri').default('uri'),
+        displayFields: zod_1.z.array(GraphQLDisplayField).default([
+            defaultLicenseName,
+            defaultLicenseDescription,
+            defaultLicenseRecommended,
+        ]),
+        responseField: zod_1.z.literal("licenses.items").default('licenses.items'),
+    })).default({}),
+}));