@dmptool/types 1.2.3 → 1.2.5

package/dist/questions/index.js

@@ -38,11 +38,14 @@ exports.AnyQuestionSchema = zod_1.z.discriminatedUnion('type', [
     dateQuestions_1.DateQuestionSchema,
     dateQuestions_1.DateRangeQuestionSchema,
     textQuestions_1.EmailQuestionSchema,
-    // FilteredSearchQuestionSchema,
+    graphQLQuestions_1.LicenseSearchQuestionSchema,
+    graphQLQuestions_1.MetadataStandardSearchQuestionSchema,
     optionBasedQuestions_1.MultiselectBoxQuestionSchema,
     numberQuestions_1.NumberQuestionSchema,
     numberQuestions_1.NumberRangeQuestionSchema,
     optionBasedQuestions_1.RadioButtonsQuestionSchema,
+    graphQLQuestions_1.RepositorySearchQuestionSchema,
+    tableQuestions_1.ResearchOutputTableQuestionSchema,
     optionBasedQuestions_1.SelectBoxQuestionSchema,
     tableQuestions_1.TableQuestionSchema,
     textQuestions_1.TextAreaQuestionSchema,
@@ -58,11 +61,15 @@ exports.QuestionSchemaMap = {
     date: dateQuestions_1.DateQuestionSchema,
     dateRange: dateQuestions_1.DateRangeQuestionSchema,
     email: textQuestions_1.EmailQuestionSchema,
-    // filteredSearch: FilteredSearchQuestionSchema,
+    licenseSearch: graphQLQuestions_1.LicenseSearchQuestionSchema,
+    metadataStandardSearch: graphQLQuestions_1.MetadataStandardSearchQuestionSchema,
     multiselectBox: optionBasedQuestions_1.MultiselectBoxQuestionSchema,
     number: numberQuestions_1.NumberQuestionSchema,
     numberRange: numberQuestions_1.NumberRangeQuestionSchema,
+    numberWithContext: numberQuestions_1.NumberWithContextQuestionSchema,
     radioButtons: optionBasedQuestions_1.RadioButtonsQuestionSchema,
+    repositorySearch: graphQLQuestions_1.RepositorySearchQuestionSchema,
+    researchOutputTable: tableQuestions_1.ResearchOutputTableQuestionSchema,
     selectBox: optionBasedQuestions_1.SelectBoxQuestionSchema,
     table: tableQuestions_1.TableQuestionSchema,
     text: textQuestions_1.TextQuestionSchema,

package/dist/questions/numberQuestions.d.ts

@@ -317,6 +317,111 @@ export declare const NumberRangeQuestionSchema: z.ZodObject<{
         } | undefined;
     } | undefined;
 }>;
+export declare const NumberWithContextQuestionSchema: 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<"numberWithContext">;
+    attributes: z.ZodDefault<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    } & {
+        max: z.ZodOptional<z.ZodNumber>;
+        min: z.ZodDefault<z.ZodNumber>;
+        step: z.ZodDefault<z.ZodNumber>;
+    } & {
+        context: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            label: z.ZodDefault<z.ZodString>;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: string;
+            labelTranslationKey?: string | undefined;
+        }, {
+            value?: string | undefined;
+            label?: string | undefined;
+            labelTranslationKey?: string | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        context: {
+            value: string;
+            label: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        min: number;
+        step: number;
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+    }, {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        context?: {
+            value?: string | undefined;
+            label?: string | undefined;
+            labelTranslationKey?: string | undefined;
+        }[] | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "numberWithContext";
+    attributes: {
+        context: {
+            value: string;
+            label: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        min: number;
+        step: number;
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        max?: number | undefined;
+    };
+    meta: {
+        schemaVersion: string;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    };
+}, {
+    type: "numberWithContext";
+    attributes?: {
+        label?: string | undefined;
+        help?: string | undefined;
+        labelTranslationKey?: string | undefined;
+        context?: {
+            value?: string | undefined;
+            label?: string | undefined;
+            labelTranslationKey?: string | undefined;
+        }[] | undefined;
+        max?: number | undefined;
+        min?: number | undefined;
+        step?: number | undefined;
+    } | undefined;
+    meta?: {
+        schemaVersion?: string | undefined;
+        title?: string | undefined;
+        usageDescription?: string | undefined;
+    } | undefined;
+}>;
 export type CurrencyQuestionType = z.infer<typeof CurrencyQuestionSchema>;
 export type NumberQuestionType = z.infer<typeof NumberQuestionSchema>;
 export type NumberRangeQuestionType = z.infer<typeof NumberRangeQuestionSchema>;
+export type NumberWithContextQuestionType = z.infer<typeof NumberWithContextQuestionSchema>;

package/dist/questions/numberQuestions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NumberRangeQuestionSchema = exports.NumberQuestionSchema = exports.CurrencyQuestionSchema = void 0;
+exports.NumberWithContextQuestionSchema = exports.NumberRangeQuestionSchema = exports.NumberQuestionSchema = exports.CurrencyQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 const BaseAttributes = question_1.QuestionSchema.shape.attributes;
@@ -27,3 +27,14 @@ exports.NumberRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.obje
         end: NumberAttributesSchema.default({ label: 'To' }),
     }).default({})
 }));
+exports.NumberWithContextQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
+    type: zod_1.z.literal('numberWithContext'),
+    attributes: NumberAttributesSchema.merge(zod_1.z.object({
+        // Additional context or description for the number input (e.g. units, explanation, etc.)
+        context: zod_1.z.array(zod_1.z.object({
+            label: zod_1.z.string().default(''),
+            labelTranslationKey: zod_1.z.string().optional(),
+            value: zod_1.z.string().default('')
+        })).default([])
+    })).default({})
+}));

package/dist/questions/question.d.ts

@@ -1,8 +1,8 @@
 import { z } from "zod";
 export declare const CURRENT_SCHEMA_VERSION = "1.0";
-export declare const QuestionFormatsEnum: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
+export declare const QuestionFormatsEnum: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "licenseSearch", "metadataStandardSearch", "multiselectBox", "number", "numberRange", "numberWithContext", "radioButtons", "repositorySearch", "researchOutputTable", "selectBox", "table", "text", "textArea", "url"]>;
 export declare const QuestionSchema: 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"]>;
     attributes: z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
@@ -30,7 +30,7 @@ export declare const QuestionSchema: z.ZodObject<{
         usageDescription?: 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";
     attributes: {
         label?: string | undefined;
         help?: string | undefined;
@@ -42,7 +42,7 @@ export declare const QuestionSchema: z.ZodObject<{
         usageDescription?: string | undefined;
     };
 }, {
-    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";
     attributes: {
         label?: string | undefined;
         help?: string | undefined;

package/dist/questions/question.js

@@ -12,11 +12,15 @@ exports.QuestionFormatsEnum = zod_1.z.enum([
     'date',
     'dateRange',
     'email',
-    // 'filteredSearch',
+    'licenseSearch',
+    'metadataStandardSearch',
     'multiselectBox',
     'number',
     'numberRange',
+    'numberWithContext',
     'radioButtons',
+    'repositorySearch',
+    'researchOutputTable',
     'selectBox',
     'table',
     'text',
@@ -68,9 +72,14 @@ exports.QuestionFormatsUsage = {
         title: 'Email Field',
         usageDescription: 'For questions that require require email address(es).',
     },
-    // filteredSearch: {
-    //   title: 'Not yet implemented',
-    // },
+    licenseSearch: {
+        title: 'License Search',
+        usageDescription: 'For questions that require the user to select from a controlled list of licenses (e.g. Creative Commons, GNU, etc.).',
+    },
+    metadataStandardSearch: {
+        title: 'Metadata Standard Search',
+        usageDescription: 'For questions that require the user to select from a controlled list of metadata standards (e.g. Dublin Core, DataCite, etc.).',
+    },
     multiselectBox: {
         title: 'Multi-select Box',
         usageDescription: 'For questions where multiple answers are valid. Allows users to select several options from a predefined list, providing flexibility in responses.',
@@ -83,10 +92,22 @@ exports.QuestionFormatsUsage = {
         title: 'Number Range',
         usageDescription: 'For questions that require a numerical range (e.g. From/To, Min/Max).',
     },
+    numberWithContext: {
+        title: 'Number with Context',
+        usageDescription: 'For questions that require a numeric value along with additional context or description (e.g. units, explanation, etc.).',
+    },
     radioButtons: {
         title: 'Radio Buttons',
         usageDescription: 'For multiple choice questions where users select just one option.',
     },
+    repositorySearch: {
+        title: 'Repository Search',
+        usageDescription: 'For questions that require the user to select from a controlled list of repositories (e.g. Zenodo, Figshare, Dryad, etc.).',
+    },
+    researchOutputTable: {
+        title: 'Research Output Table',
+        usageDescription: 'For questions that require users to provide structured information about research outputs in a tabular format.',
+    },
     selectBox: {
         title: 'Select Box',
         usageDescription: 'For questions where users select one option from a list.',