@dmptool/types 1.2.2 → 1.2.4

package/README.md

@@ -24,10 +24,14 @@ The available question schemas/types are:
 - `DateQuestion` A date field. Supports `YYYY-MM-DD` format.
 - `DateRangeQuestion` A series of 2 date fields. Meant to capture "From" and "To" or "Start" and "End" dates.
 - `EmailQuestion` An email address. Supports multiple emails that are comma separated.
+- `LicenseSearch` A GraphQL enabled question to search for relevant Licenses
+- `MetadataStandardSearch` A GraphQL enabled question to search for relevant Metadata Standards
 - `MultiselectBoxQuestion` A select box that allows for multiple selections
 - `NumberQuestion` A numeric field. Supports both integers and floats.
 - `NumberRangeQuestion` A series of 2 number fields. Meant to capture "From" and "To" or "Min" and "Max" numbers.
 - `RadioButtonsQuestion` A question type that supports an array of `option` objects. The user may "select" a single option.
+- `RepositorySearch` A GraphQL enabled question to search for relevant Repositories
+- `ResearchOutputsTable` A table/collection of questions to allow for users to define title, description, repositories, license, etc. for multiple research outputs.
 - `SelectBoxQuestion` A drop down select box that supports an array of `option` objects. A `multiple` flag can be set to allow multi-select.
 - `TableQuestion` A table question type. Each column in the table can be any one of the `AnyTableColumnQuestion` types.
 - `TextQuestion` A simple text field
@@ -48,10 +52,14 @@ The available answer schemas/types are:
 - `DateAnswer` A date field. Supports `YYYY-MM-DD` format.
 - `DateRangeAnswer` A series of 2 date fields. Meant to capture "From" and "To" or "Start" and "End" dates.
 - `EmailAnswer` An email address. Supports multiple emails that are comma separated.
+- `LicenseSearch` A license name and URL identifier
+- `MetadataStandardSearch` An array of names and URL identifiers for metadata standards
 - `MultiselectAnswer` An array of `option` objects each containing the value of a selected entry.
 - `NumberAnswer` A numeric field. Supports both integers and floats.
 - `DateRangeAnswer` A series of 2 numbers. Meant to capture "From" and "To" or "Start" and "End".
 - `RadioButtonsAnswer` A answer type that supports an array of `option` objects. The user may "select" a single option.
+- `RepositorySearch` An array of names and URL identifiers for a repositories
+- `ResearchOutputsTable` A table/collection of answers to allow for users to define title, description, repositories, license, etc. for multiple research outputs.
 - `SelectBoxAnswer` The value the user selected.
 - `TableAnswer` A table answer type. Each column in the table can be any one of the `AnyTableColumnAnswer` types.
 - `TextAnswer` A simple text field

package/dist/answers/__tests__/answers.spec.js

@@ -54,12 +54,6 @@ const questions_1 = require("../../questions");
         const invalidData = { type: 'email', answer: 12345 };
         (0, globals_1.expect)(() => textAnswers_1.EmailAnswerSchema.parse(invalidData)).toThrow();
     });
-    (0, globals_1.it)('should validate FilteredSearchAnswer', () => {
-        const validData = { type: 'filteredSearch', answer: ['item1', 'item2'], meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
-        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswerSchema.parse(validData)).not.toThrow();
-        const invalidData = { type: 'filteredSearch', answer: 'item1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
-        (0, globals_1.expect)(() => graphQLAnswers_1.FilteredSearchAnswerSchema.parse(invalidData)).toThrow();
-    });
     (0, globals_1.it)('should validate NumberAnswer', () => {
         const validData = { type: 'number', answer: 42, meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => numberAnswers_1.NumberAnswerSchema.parse(validData)).not.toThrow();
@@ -98,6 +92,128 @@ const questions_1 = require("../../questions");
         const invalidData = { type: 'multiselectBox', answer: 'option1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => optionBasedAnswers_1.MultiselectBoxAnswerSchema.parse(invalidData)).toThrow();
     });
+    (0, globals_1.it)('should validate LicenseSearchAnswerSchema', () => {
+        const validData = {
+            type: 'licenseSearch',
+            answer: [
+                { licenseId: 'license1', licenseName: 'License One' },
+                { licenseId: 'license2', licenseName: 'License Two' }
+            ],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => graphQLAnswers_1.LicenseSearchAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'licenseSearch', answer: 'license1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.LicenseSearchAnswerSchema.parse(invalidData)).toThrow();
+    });
+    (0, globals_1.it)('should validate MetadataStandardSearchAnswerSchema', () => {
+        const validData = {
+            type: 'metadataStandardSearch',
+            answer: [
+                { metadataStandardId: 'standard1', metadataStandardName: 'Standard Two' },
+                { metadataStandardId: 'standard2', metadataStandardName: 'Standard Two' }
+            ],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => graphQLAnswers_1.MetadataStandardSearchAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'metadataStandardSearch', answer: 'standard1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.MetadataStandardSearchAnswerSchema.parse(invalidData)).toThrow();
+    });
+    (0, globals_1.it)('should validate RepositorySearchAnswerSchema', () => {
+        const validData = {
+            type: 'repositorySearch',
+            answer: [
+                { repositoryId: 'repo1', repositoryName: 'Repository One' },
+                { repositoryId: 'repo2', repositoryName: 'Repository Two' }
+            ],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => graphQLAnswers_1.RepositorySearchAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = { type: 'repositorySearch', answer: 'repo1', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
+        (0, globals_1.expect)(() => graphQLAnswers_1.RepositorySearchAnswerSchema.parse(invalidData)).toThrow();
+    });
+    (0, globals_1.it)('should validate ResearchOutputTableAnswerSchema', () => {
+        const validData = {
+            type: 'researchOutputTable',
+            answer: [{
+                    columns: [
+                        {
+                            type: 'text',
+                            answer: 'This is a test',
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'textArea',
+                            answer: 'This is a longer text answer',
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'selectBox',
+                            answer: 'dataset',
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'checkBoxes',
+                            answer: ['sensitive'],
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'selectBox',
+                            answer: 'open',
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'date',
+                            answer: '2025-11-13',
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'numberWithContext',
+                            answer: { value: 12345, context: 'gb' },
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'repositorySearch',
+                            answer: [{ repositoryId: 'repo1', repositoryName: 'Repository One' }],
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'metadataStandardSearch',
+                            answer: [
+                                { metadataStandardId: 'standard1', metadataStandardName: 'Standard One' },
+                                { metadataStandardId: 'standard2', metadataStandardName: 'Standard Two' }
+                            ],
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        },
+                        {
+                            type: 'licenseSearch',
+                            answer: [{ licenseId: 'license1', licenseName: 'License One' }],
+                            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                        }
+                    ],
+                }],
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => tableAnswers_1.ResearchOutputTableAnswerSchema.parse(validData)).not.toThrow();
+        const invalidData = {
+            type: 'researchOutputTable',
+            answer: {
+                columns: [
+                    {
+                        type: 'text',
+                        answer: 12345,
+                        meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                    },
+                    {
+                        type: 'selectBox',
+                        answer: 'dataset',
+                        meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+                    }
+                ],
+            },
+            meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION }
+        };
+        (0, globals_1.expect)(() => tableAnswers_1.ResearchOutputTableAnswerSchema.parse(invalidData)).toThrow();
+    });
     (0, globals_1.it)('should validate TextAnswer', () => {
         const validData = { type: 'text', answer: 'Some text', meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION } };
         (0, globals_1.expect)(() => textAnswers_1.TextAnswerSchema.parse(validData)).not.toThrow();

package/dist/answers/answer.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 export declare const AnswerSchema: z.ZodObject<{
-    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
+    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "licenseSearch", "metadataStandardSearch", "multiselectBox", "number", "numberRange", "numberWithContext", "radioButtons", "repositorySearch", "researchOutputTable", "selectBox", "table", "text", "textArea", "url"]>;
     meta: z.ZodDefault<z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
@@ -9,12 +9,12 @@ export declare const AnswerSchema: z.ZodObject<{
         schemaVersion?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "licenseSearch" | "metadataStandardSearch" | "multiselectBox" | "numberRange" | "numberWithContext" | "radioButtons" | "repositorySearch" | "researchOutputTable" | "selectBox" | "table" | "text" | "textArea" | "url";
     meta: {
         schemaVersion: string;
     };
 }, {
-    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "licenseSearch" | "metadataStandardSearch" | "multiselectBox" | "numberRange" | "numberWithContext" | "radioButtons" | "repositorySearch" | "researchOutputTable" | "selectBox" | "table" | "text" | "textArea" | "url";
     meta?: {
         schemaVersion?: string | undefined;
     } | undefined;

package/dist/answers/graphQLAnswers.d.ts

@@ -1,28 +1,4 @@
 import { z } from 'zod';
-export declare const FilteredSearchAnswerSchema: z.ZodObject<{
-    meta: z.ZodDefault<z.ZodObject<{
-        schemaVersion: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        schemaVersion: string;
-    }, {
-        schemaVersion?: string | undefined;
-    }>>;
-} & {
-    type: z.ZodLiteral<"filteredSearch">;
-    answer: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodTypeAny, {
-    type: "filteredSearch";
-    meta: {
-        schemaVersion: string;
-    };
-    answer: string[];
-}, {
-    type: "filteredSearch";
-    meta?: {
-        schemaVersion?: string | undefined;
-    } | undefined;
-    answer?: string[] | undefined;
-}>;
 export declare const AffiliationSearchAnswerSchema: z.ZodObject<{
     meta: z.ZodDefault<z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
@@ -62,5 +38,124 @@ export declare const AffiliationSearchAnswerSchema: z.ZodObject<{
         affiliationName?: string | undefined;
     } | undefined;
 }>;
-export type FilteredSearchAnswerType = z.infer<typeof FilteredSearchAnswerSchema>;
+export declare const LicenseSearchAnswerSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+    }, {
+        schemaVersion?: string | undefined;
+    }>>;
+} & {
+    type: z.ZodLiteral<"licenseSearch">;
+    answer: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodObject<{
+        licenseId: z.ZodDefault<z.ZodString>;
+        licenseName: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        licenseId: string;
+        licenseName: string;
+    }, {
+        licenseId?: string | undefined;
+        licenseName?: string | undefined;
+    }>>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "licenseSearch";
+    meta: {
+        schemaVersion: string;
+    };
+    answer: {
+        licenseId: string;
+        licenseName: string;
+    }[];
+}, {
+    type: "licenseSearch";
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: ({
+        licenseId?: string | undefined;
+        licenseName?: string | undefined;
+    } | undefined)[] | undefined;
+}>;
+export declare const MetadataStandardSearchAnswerSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+    }, {
+        schemaVersion?: string | undefined;
+    }>>;
+} & {
+    type: z.ZodLiteral<"metadataStandardSearch">;
+    answer: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodObject<{
+        metadataStandardId: z.ZodDefault<z.ZodString>;
+        metadataStandardName: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        metadataStandardId: string;
+        metadataStandardName: string;
+    }, {
+        metadataStandardId?: string | undefined;
+        metadataStandardName?: string | undefined;
+    }>>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "metadataStandardSearch";
+    meta: {
+        schemaVersion: string;
+    };
+    answer: {
+        metadataStandardId: string;
+        metadataStandardName: string;
+    }[];
+}, {
+    type: "metadataStandardSearch";
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: ({
+        metadataStandardId?: string | undefined;
+        metadataStandardName?: string | undefined;
+    } | undefined)[] | undefined;
+}>;
+export declare const RepositorySearchAnswerSchema: z.ZodObject<{
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: string;
+    }, {
+        schemaVersion?: string | undefined;
+    }>>;
+} & {
+    type: z.ZodLiteral<"repositorySearch">;
+    answer: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodObject<{
+        repositoryId: z.ZodDefault<z.ZodString>;
+        repositoryName: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        repositoryId: string;
+        repositoryName: string;
+    }, {
+        repositoryId?: string | undefined;
+        repositoryName?: string | undefined;
+    }>>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "repositorySearch";
+    meta: {
+        schemaVersion: string;
+    };
+    answer: {
+        repositoryId: string;
+        repositoryName: string;
+    }[];
+}, {
+    type: "repositorySearch";
+    meta?: {
+        schemaVersion?: string | undefined;
+    } | undefined;
+    answer?: ({
+        repositoryId?: string | undefined;
+        repositoryName?: string | undefined;
+    } | undefined)[] | undefined;
+}>;
 export type AffiliationSearchAnswerType = z.infer<typeof AffiliationSearchAnswerSchema>;
+export type LicenseSearchAnswerType = z.infer<typeof LicenseSearchAnswerSchema>;
+export type MetadataStandardSearchAnswerType = z.infer<typeof MetadataStandardSearchAnswerSchema>;
+export type RepositorySearchAnswerType = z.infer<typeof RepositorySearchAnswerSchema>;

package/dist/answers/graphQLAnswers.js

@@ -1,13 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AffiliationSearchAnswerSchema = exports.FilteredSearchAnswerSchema = void 0;
+exports.RepositorySearchAnswerSchema = exports.MetadataStandardSearchAnswerSchema = exports.LicenseSearchAnswerSchema = exports.AffiliationSearchAnswerSchema = void 0;
 const zod_1 = require("zod");
 const answer_1 = require("./answer");
 // Answers to GraphQL Question Types
-exports.FilteredSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('filteredSearch'),
-    answer: zod_1.z.array(zod_1.z.string()).default(['']) // The answer to the filtered search
-}));
 exports.AffiliationSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('affiliationSearch'),
     answer: zod_1.z.object({
@@ -15,3 +11,24 @@ exports.AffiliationSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.obje
         affiliationName: zod_1.z.string().default('') // The name of the affiliation
     }).default({})
 }));
+exports.LicenseSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('licenseSearch'),
+    answer: zod_1.z.array(zod_1.z.object({
+        licenseId: zod_1.z.string().default(''), // The unique id of the license
+        licenseName: zod_1.z.string().default('') // The name of the license
+    }).default({})).default([])
+}));
+exports.MetadataStandardSearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('metadataStandardSearch'),
+    answer: zod_1.z.array(zod_1.z.object({
+        metadataStandardId: zod_1.z.string().default(''), // The unique id of the metadata standard
+        metadataStandardName: zod_1.z.string().default('') // The name of the metadata standard
+    }).default({})).default([])
+}));
+exports.RepositorySearchAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('repositorySearch'),
+    answer: zod_1.z.array(zod_1.z.object({
+        repositoryId: zod_1.z.string().default(''), // The unique id of the repository
+        repositoryName: zod_1.z.string().default('') // The name of the repository
+    }).default({})).default([])
+}));