@dmptool/types 1.2.6 → 2.1.0

package/dist/questions/question.d.ts

@@ -1,35 +1,84 @@
 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", "licenseSearch", "metadataStandardSearch", "multiselectBox", "number", "numberRange", "numberWithContext", "radioButtons", "repositorySearch", "researchOutputTable", "selectBox", "table", "text", "textArea", "url"]>;
+export declare const QuestionFormatsEnum: z.ZodEnum<{
+    number: "number";
+    boolean: "boolean";
+    affiliationSearch: "affiliationSearch";
+    checkBoxes: "checkBoxes";
+    currency: "currency";
+    date: "date";
+    dateRange: "dateRange";
+    email: "email";
+    licenseSearch: "licenseSearch";
+    metadataStandardSearch: "metadataStandardSearch";
+    multiselectBox: "multiselectBox";
+    numberRange: "numberRange";
+    numberWithContext: "numberWithContext";
+    radioButtons: "radioButtons";
+    repositorySearch: "repositorySearch";
+    researchOutputTable: "researchOutputTable";
+    selectBox: "selectBox";
+    table: "table";
+    text: "text";
+    textArea: "textArea";
+    url: "url";
+}>;
+export declare const BaseMetaSchema: z.ZodObject<{
+    schemaVersion: z.ZodDefault<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    usageDescription: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const DefaultMeta: {
+    schemaVersion: string;
+    title?: string | undefined;
+    usageDescription?: string | undefined;
+};
+export declare const BaseAttributesSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    help: z.ZodOptional<z.ZodString>;
+    labelTranslationKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const DefaultAttributes: {
+    label?: string | undefined;
+    help?: string | undefined;
+    labelTranslationKey?: string | undefined;
+};
 export declare const QuestionSchema: z.ZodObject<{
-    type: z.ZodEnum<["affiliationSearch", "boolean", "checkBoxes", "currency", "date", "dateRange", "email", "licenseSearch", "metadataStandardSearch", "multiselectBox", "number", "numberRange", "numberWithContext", "radioButtons", "repositorySearch", "researchOutputTable", "selectBox", "table", "text", "textArea", "url"]>;
+    type: z.ZodEnum<{
+        number: "number";
+        boolean: "boolean";
+        affiliationSearch: "affiliationSearch";
+        checkBoxes: "checkBoxes";
+        currency: "currency";
+        date: "date";
+        dateRange: "dateRange";
+        email: "email";
+        licenseSearch: "licenseSearch";
+        metadataStandardSearch: "metadataStandardSearch";
+        multiselectBox: "multiselectBox";
+        numberRange: "numberRange";
+        numberWithContext: "numberWithContext";
+        radioButtons: "radioButtons";
+        repositorySearch: "repositorySearch";
+        researchOutputTable: "researchOutputTable";
+        selectBox: "selectBox";
+        table: "table";
+        text: "text";
+        textArea: "textArea";
+        url: "url";
+    }>;
     attributes: 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;
-    }>;
-    meta: z.ZodDefault<z.ZodObject<{
+    }, z.core.$strip>;
+    meta: 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;
-    }>>;
-}, "strip", z.ZodTypeAny, {
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DefaultQuestionSchema: {
     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;
@@ -41,19 +90,7 @@ export declare const QuestionSchema: z.ZodObject<{
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
-}, {
-    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;
-        labelTranslationKey?: string | undefined;
-    };
-    meta?: {
-        schemaVersion?: string | undefined;
-        title?: string | undefined;
-        usageDescription?: string | undefined;
-    } | undefined;
-}>;
+};
 export type QuestionType = z.infer<typeof QuestionFormatsEnum>;
 export interface QuestionFormatsUsageInterface {
     title: string;

package/dist/questions/question.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionFormatsUsage = exports.QuestionSchema = exports.QuestionFormatsEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
+exports.QuestionFormatsUsage = exports.DefaultQuestionSchema = exports.QuestionSchema = exports.DefaultAttributes = exports.BaseAttributesSchema = exports.DefaultMeta = exports.BaseMetaSchema = exports.QuestionFormatsEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
 const zod_1 = require("zod");
 exports.CURRENT_SCHEMA_VERSION = '1.0'; // The current schema version
 // The available question formats
@@ -27,21 +27,30 @@ exports.QuestionFormatsEnum = zod_1.z.enum([
     'textArea',
     'url'
 ]);
-const DefaultMetaSchema = zod_1.z.object({
+exports.BaseMetaSchema = zod_1.z.object({
     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({
+// Calling Zod's `parse` on a schema creates an object that uses all the defaults defined,
+// so, for example with this schema we get `{ schemaVersion: "1.0" }`
+exports.DefaultMeta = exports.BaseMetaSchema.parse({});
+exports.BaseAttributesSchema = 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 local translation key for the label
 });
+exports.DefaultAttributes = exports.BaseAttributesSchema.parse({});
 // Base abstract type for all questions
 exports.QuestionSchema = zod_1.z.object({
     type: exports.QuestionFormatsEnum, // The type of question
-    attributes: DefaultAttributesSchema, // Field attributes
-    meta: DefaultMetaSchema.default({}), // Meta information for the field
+    attributes: exports.BaseAttributesSchema, // Field attributes
+    meta: exports.BaseMetaSchema, // Information for the field
+});
+exports.DefaultQuestionSchema = exports.QuestionSchema.parse({
+    type: 'textArea',
+    attributes: exports.DefaultAttributes,
+    meta: exports.DefaultMeta
 });
 exports.QuestionFormatsUsage = {
     affiliationSearch: {