@dmptool/types 1.1.3 → 1.2.0

package/dist/questions/question.d.ts

@@ -1,37 +1,9 @@
 import { z } from "zod";
 export declare const CURRENT_SCHEMA_VERSION = "1.0";
-export declare const QuestionTypesEnum: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
-export declare const defaultMeta: z.infer<typeof DefaultMetaSchema>;
-export declare const defaultAttributes: z.infer<typeof DefaultAttributesSchema>;
-declare const DefaultMetaSchema: z.ZodObject<{
-    schemaVersion: z.ZodLiteral<"1.0">;
-    title: z.ZodOptional<z.ZodString>;
-    usageDescription: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    schemaVersion: "1.0";
-    title?: string | undefined;
-    usageDescription?: string | undefined;
-}, {
-    schemaVersion: "1.0";
-    title?: string | undefined;
-    usageDescription?: string | undefined;
-}>;
-declare const DefaultAttributesSchema: z.ZodObject<{
-    label: z.ZodOptional<z.ZodString>;
-    help: z.ZodOptional<z.ZodString>;
-    labelTranslationKey: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    label?: string | undefined;
-    help?: string | undefined;
-    labelTranslationKey?: string | undefined;
-}, {
-    label?: string | undefined;
-    help?: string | undefined;
-    labelTranslationKey?: string | undefined;
-}>;
+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 QuestionSchema: z.ZodObject<{
-    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "filteredSearch", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
-    attributes: z.ZodOptional<z.ZodObject<{
+    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "multiselectBox", "number", "numberRange", "radioButtons", "selectBox", "table", "text", "textArea", "url"]>;
+    attributes: z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         help: z.ZodOptional<z.ZodString>;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -43,44 +15,48 @@ export declare const QuestionSchema: z.ZodObject<{
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    }>>;
-    meta: z.ZodOptional<z.ZodObject<{
-        schemaVersion: z.ZodLiteral<"1.0">;
+    }>;
+    meta: z.ZodDefault<z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
         title: z.ZodOptional<z.ZodString>;
         usageDescription: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        schemaVersion: "1.0";
+        schemaVersion: string;
         title?: string | undefined;
         usageDescription?: string | undefined;
     }, {
-        schemaVersion: "1.0";
+        schemaVersion?: string | undefined;
         title?: string | undefined;
         usageDescription?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
-    attributes?: {
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
+    attributes: {
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion: "1.0";
+    };
+    meta: {
+        schemaVersion: string;
         title?: string | undefined;
         usageDescription?: string | undefined;
-    } | undefined;
+    };
 }, {
-    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "filteredSearch" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
-    attributes?: {
+    type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "multiselectBox" | "numberRange" | "radioButtons" | "selectBox" | "table" | "text" | "textArea" | "url";
+    attributes: {
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-    } | undefined;
+    };
     meta?: {
-        schemaVersion: "1.0";
+        schemaVersion?: string | undefined;
         title?: string | undefined;
         usageDescription?: string | undefined;
     } | undefined;
 }>;
-export type QuestionType = z.infer<typeof QuestionSchema>;
-export {};
+export type QuestionType = z.infer<typeof QuestionFormatsEnum>;
+export interface QuestionFormatsUsageInterface {
+    title: string;
+    usageDescription: string;
+}
+export declare const QuestionFormatsUsage: Record<QuestionType, QuestionFormatsUsageInterface>;

package/dist/questions/question.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionSchema = exports.defaultAttributes = exports.defaultMeta = exports.QuestionTypesEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
+exports.QuestionFormatsUsage = exports.QuestionSchema = exports.QuestionFormatsEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
 const zod_1 = require("zod");
 exports.CURRENT_SCHEMA_VERSION = '1.0'; // The current schema version
-// The type of question
-exports.QuestionTypesEnum = zod_1.z.enum([
+// The available question formats
+exports.QuestionFormatsEnum = zod_1.z.enum([
     'affiliationSearch',
     'boolean',
     'checkBoxes',
@@ -12,7 +12,7 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'date',
     'dateRange',
     'email',
-    'filteredSearch',
+    // 'filteredSearch',
     'multiselectBox',
     'number',
     'numberRange',
@@ -23,27 +23,88 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'textArea',
     'url'
 ]);
-exports.defaultMeta = {
-    schemaVersion: exports.CURRENT_SCHEMA_VERSION,
-};
-exports.defaultAttributes = {
-    label: undefined,
-    help: undefined,
-    labelTranslationKey: undefined,
-};
 const DefaultMetaSchema = zod_1.z.object({
-    schemaVersion: zod_1.z.literal(exports.CURRENT_SCHEMA_VERSION), // The schema version (default is CURRENT_SCHEMA_VERSION)
+    schemaVersion: zod_1.z.string().default(exports.CURRENT_SCHEMA_VERSION), // The schema version
     title: zod_1.z.string().optional(), // The title of the question type
     usageDescription: zod_1.z.string().optional(), // A description of when to use the question type
 });
 const DefaultAttributesSchema = zod_1.z.object({
     label: zod_1.z.string().optional(), // UI label for the field
     help: zod_1.z.string().optional(), // Help/tooltip text for the field
-    labelTranslationKey: zod_1.z.string().optional() // The translation key for the label (DMP Tool only)
+    labelTranslationKey: zod_1.z.string().optional() // The local translation key for the label
 });
 // Base abstract type for all questions
 exports.QuestionSchema = zod_1.z.object({
-    type: exports.QuestionTypesEnum, // The type of question
-    attributes: DefaultAttributesSchema.optional(), // Field attributes
-    meta: DefaultMetaSchema.optional(), // Meta information for the field
+    type: exports.QuestionFormatsEnum, // The type of question
+    attributes: DefaultAttributesSchema, // Field attributes
+    meta: DefaultMetaSchema.default({}), // Meta information for the field
 });
+exports.QuestionFormatsUsage = {
+    affiliationSearch: {
+        title: 'Affiliation Search',
+        usageDescription: 'For questions that require the user to select from a controlled list of institutions.',
+    },
+    boolean: {
+        title: 'Yes/No Field',
+        usageDescription: 'For questions that require a simple Yes/No response.',
+    },
+    checkBoxes: {
+        title: 'Check Boxes',
+        usageDescription: 'For multiple choice questions where users can select multiple options.',
+    },
+    currency: {
+        title: 'Currency Field',
+        usageDescription: 'For questions that require a monetary amount (e.g. Cost or Budget).',
+    },
+    date: {
+        title: 'Date Field',
+        usageDescription: 'For questions that require a date.',
+    },
+    dateRange: {
+        title: 'Date Range',
+        usageDescription: 'For questions that require a date range (e.g. From/To, Start/End)',
+    },
+    email: {
+        title: 'Email Field',
+        usageDescription: 'For questions that require require email address(es).',
+    },
+    // filteredSearch: {
+    //   title: 'Not yet implemented',
+    // },
+    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.',
+    },
+    number: {
+        title: 'Number Field',
+        usageDescription: 'For questions that require a single numeric value.',
+    },
+    numberRange: {
+        title: 'Number Range',
+        usageDescription: 'For questions that require a numerical range (e.g. From/To, Min/Max).',
+    },
+    radioButtons: {
+        title: 'Radio Buttons',
+        usageDescription: 'For multiple choice questions where users select just one option.',
+    },
+    selectBox: {
+        title: 'Select Box',
+        usageDescription: 'For questions where users select one option from a list.',
+    },
+    table: {
+        title: 'Table',
+        usageDescription: 'For questions that require a tabular format.',
+    },
+    text: {
+        title: 'Text Field',
+        usageDescription: 'For questions that require short, simple answers.',
+    },
+    textArea: {
+        title: 'Text Area',
+        usageDescription: 'For questions that require longer answers, you can select formatting options too.',
+    },
+    url: {
+        title: 'URL Field',
+        usageDescription: 'For questions that require a website, DOI or other URL.',
+    }
+};