@dmptool/types 1.2.6 → 2.0.0

package/dist/questions/__tests__/tableQuestion.spec.js

@@ -5,14 +5,16 @@ describe("TableQuestionSchema", () => {
     it("should validate a valid TableQuestion object", () => {
         const validTableQuestion = {
             type: "table",
+            attributes: {
+                label: "Table",
+            },
             columns: [
                 {
                     heading: "Name",
                     content: {
                         type: "text",
-                        meta: {
-                            schemaVersion: "1.0"
-                        }
+                        attributes: { maxLength: 100 },
+                        meta: { schemaVersion: "1.0" }
                     }
                 },
                 {
@@ -26,15 +28,11 @@ describe("TableQuestionSchema", () => {
                             max: 65,
                             step: 1,
                         },
-                        meta: {
-                            schemaVersion: "1.0"
-                        }
+                        meta: { schemaVersion: "1.0" }
                     }
                 }
             ],
-            meta: {
-                schemaVersion: "1.0"
-            }
+            meta: { schemaVersion: "1.0" }
         };
         expect(() => tableQuestions_1.TableQuestionSchema.parse(validTableQuestion)).not.toThrow();
     });
@@ -84,9 +82,8 @@ describe("ResearchOutputTableQuestionSchema", () => {
                     enabled: true,
                     content: {
                         type: "text",
-                        meta: {
-                            schemaVersion: "1.0"
-                        }
+                        attributes: { maxLength: 255 },
+                        meta: { schemaVersion: "1.0" }
                     }
                 },
                 {
@@ -117,12 +114,8 @@ describe("ResearchOutputTableQuestionSchema", () => {
                             min: 0,
                             step: 1,
                             context: [
-                                { label: 'bytes', value: 'bytes' },
                                 { label: 'KB (kilobytes)', value: 'kb' },
-                                { label: 'MB (megabytes)', value: 'mb' },
-                                { label: 'GB (gigabytes)', value: 'gb' },
-                                { label: 'TB (terabytes)', value: 'tb' },
-                                { label: 'PB (petabytes)', value: 'pb' }
+                                { label: 'MB (megabytes)', value: 'mb' }
                             ]
                         },
                         meta: {
@@ -130,6 +123,16 @@ describe("ResearchOutputTableQuestionSchema", () => {
                         }
                     }
                 },
+                {
+                    heading: "My Custom Field",
+                    required: false,
+                    enabled: true,
+                    content: {
+                        type: "text",
+                        attributes: { maxLength: 255 },
+                        meta: { schemaVersion: "1.0" }
+                    }
+                },
                 {
                     heading: "Repositories",
                     required: false,
@@ -185,15 +188,11 @@ describe("ResearchOutputTableQuestionSchema", () => {
                                 }
                             ],
                         },
-                        meta: {
-                            schemaVersion: "1.0"
-                        }
+                        meta: { schemaVersion: "1.0" }
                     }
                 }
             ],
-            meta: {
-                schemaVersion: "1.0"
-            }
+            meta: { schemaVersion: "1.0" }
         };
         expect(() => tableQuestions_1.ResearchOutputTableQuestionSchema.parse(validResearchOutputTableQuestion)).not.toThrow();
     });

package/dist/questions/__tests__/textQuestions.spec.js

@@ -31,6 +31,14 @@ describe("Primitive Questions Zod Schemas", () => {
         };
         expect(() => textQuestions_1.EmailQuestionSchema.parse(invalidEmailQuestion)).toThrow();
     });
+    it('returns the expected default email', () => {
+        const expected = {
+            type: "email",
+            attributes: { maxLength: 255, multiple: false },
+            meta: { schemaVersion: "1.0" }
+        };
+        expect(textQuestions_1.DefaultEmailQuestion).toEqual(expected);
+    });
     it("should validate a valid TextAreaQuestion", () => {
         const validTextAreaQuestion = {
             type: "textArea",
@@ -61,6 +69,14 @@ describe("Primitive Questions Zod Schemas", () => {
         };
         expect(() => textQuestions_1.TextAreaQuestionSchema.parse(invalidTextAreaQuestion)).toThrow();
     });
+    it('returns the expected default textArea', () => {
+        const expected = {
+            type: "textArea",
+            attributes: { maxLength: 10000, asRichText: true, cols: 20, rows: 2 },
+            meta: { schemaVersion: "1.0" }
+        };
+        expect(textQuestions_1.DefaultTextAreaQuestion).toEqual(expected);
+    });
     it("should validate a valid TextQuestion", () => {
         const validTextQuestion = {
             type: "text",
@@ -89,6 +105,14 @@ describe("Primitive Questions Zod Schemas", () => {
         };
         expect(() => textQuestions_1.TextQuestionSchema.parse(invalidTextQuestion)).toThrow();
     });
+    it('returns the expected default text', () => {
+        const expected = {
+            type: "text",
+            attributes: { maxLength: 255 },
+            meta: { schemaVersion: "1.0" }
+        };
+        expect(textQuestions_1.DefaultTextQuestion).toEqual(expected);
+    });
     it("should validate a valid URLQuestion", () => {
         const validURLQuestion = {
             type: "url",
@@ -117,4 +141,12 @@ describe("Primitive Questions Zod Schemas", () => {
         };
         expect(() => textQuestions_1.URLQuestionSchema.parse(invalidURLQuestion)).toThrow();
     });
+    it('returns the expected default url', () => {
+        const expected = {
+            type: "url",
+            attributes: { maxLength: 255 },
+            meta: { schemaVersion: "1.0" }
+        };
+        expect(textQuestions_1.DefaultURLQuestion).toEqual(expected);
+    });
 });

package/dist/questions/dateQuestions.d.ts

@@ -1,187 +1,87 @@
 import { z } from "zod";
 export declare const DateQuestionSchema: 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<"date">;
-    attributes: z.ZodDefault<z.ZodObject<{
-        label: z.ZodOptional<z.ZodString>;
-        help: z.ZodOptional<z.ZodString>;
-        labelTranslationKey: z.ZodOptional<z.ZodString>;
-    } & {
+    attributes: z.ZodObject<{
         max: z.ZodOptional<z.ZodString>;
         min: z.ZodOptional<z.ZodString>;
         step: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        step: number;
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-        max?: string | undefined;
-        min?: string | undefined;
-    }, {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-        max?: string | undefined;
-        min?: string | undefined;
-        step?: number | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DefaultDateQuestion: {
     type: "date";
     attributes: {
         step: number;
+        max?: string | undefined;
+        min?: string | undefined;
         label?: string | undefined;
         help?: string | undefined;
         labelTranslationKey?: string | undefined;
-        max?: string | undefined;
-        min?: string | undefined;
     };
     meta: {
         schemaVersion: string;
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
-}, {
-    type: "date";
-    attributes?: {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-        max?: string | undefined;
-        min?: string | undefined;
-        step?: number | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion?: string | undefined;
-        title?: string | undefined;
-        usageDescription?: string | undefined;
-    } | undefined;
-}>;
+};
 export declare const DateRangeQuestionSchema: 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<"dateRange">;
-    attributes: z.ZodDefault<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;
-    }>>;
-    columns: z.ZodDefault<z.ZodObject<{
-        start: z.ZodDefault<z.ZodObject<{
-            help: z.ZodOptional<z.ZodString>;
-            labelTranslationKey: z.ZodOptional<z.ZodString>;
+    columns: z.ZodObject<{
+        start: z.ZodObject<{
+            label: z.ZodDefault<z.ZodString>;
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
             step: z.ZodDefault<z.ZodNumber>;
-        } & {
-            label: z.ZodDefault<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            label: string;
-            step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-        }, {
-            label?: string | undefined;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        }>>;
-        end: z.ZodDefault<z.ZodObject<{
             help: z.ZodOptional<z.ZodString>;
             labelTranslationKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            label: z.ZodDefault<z.ZodString>;
             max: z.ZodOptional<z.ZodString>;
             min: z.ZodOptional<z.ZodString>;
             step: z.ZodDefault<z.ZodNumber>;
-        } & {
-            label: z.ZodDefault<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
+            help: z.ZodOptional<z.ZodString>;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    attributes: z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodDefault<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        usageDescription: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DefaultDateRangeQuestion: {
+    type: "dateRange";
+    columns: {
+        start: {
             label: string;
             step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-        }, {
-            label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        start: {
-            label: string;
-            step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
         };
         end: {
             label: string;
             step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
             max?: string | undefined;
             min?: string | undefined;
-        };
-    }, {
-        start?: {
-            label?: string | undefined;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
-            label?: string | undefined;
             help?: string | undefined;
             labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    type: "dateRange";
+        };
+    };
     attributes: {
         label?: string | undefined;
         help?: string | undefined;
@@ -192,54 +92,8 @@ export declare const DateRangeQuestionSchema: z.ZodObject<{
         title?: string | undefined;
         usageDescription?: string | undefined;
     };
-    columns: {
-        start: {
-            label: string;
-            step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-        };
-        end: {
-            label: string;
-            step: number;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-        };
-    };
-}, {
-    type: "dateRange";
-    attributes?: {
-        label?: string | undefined;
-        help?: string | undefined;
-        labelTranslationKey?: string | undefined;
-    } | undefined;
-    meta?: {
-        schemaVersion?: string | undefined;
-        title?: string | undefined;
-        usageDescription?: string | undefined;
-    } | undefined;
-    columns?: {
-        start?: {
-            label?: string | undefined;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-        end?: {
-            label?: string | undefined;
-            help?: string | undefined;
-            labelTranslationKey?: string | undefined;
-            max?: string | undefined;
-            min?: string | undefined;
-            step?: number | undefined;
-        } | undefined;
-    } | undefined;
-}>;
+};
 export type DateQuestionType = z.infer<typeof DateQuestionSchema>;
 export type DateRangeQuestionType = z.infer<typeof DateRangeQuestionSchema>;
+export declare const DateQuestionJSONSchema: z.core.JSONSchema.JSONSchema;
+export declare const DateRangeQuestionJSONSchema: z.core.JSONSchema.JSONSchema;

package/dist/questions/dateQuestions.js

@@ -1,29 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateRangeQuestionSchema = exports.DateQuestionSchema = void 0;
+exports.DateRangeQuestionJSONSchema = exports.DateQuestionJSONSchema = exports.DefaultDateRangeQuestion = exports.DateRangeQuestionSchema = exports.DefaultDateQuestion = exports.DateQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
-const BaseAttributes = question_1.QuestionSchema.shape.attributes;
-const DateAttributesSchema = BaseAttributes.merge(zod_1.z.object({
-    max: zod_1.z.string().optional(),
-    min: zod_1.z.string().optional(),
-    step: zod_1.z.number().default(1),
-}));
+const DateAttributesSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.BaseAttributesSchema.shape), { max: zod_1.z.string().optional(), min: zod_1.z.string().optional(), step: zod_1.z.number().default(1) }));
+const DefaultDateAttributes = DateAttributesSchema.parse({});
 // Date question and answer
-exports.DateQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('date'),
-    attributes: DateAttributesSchema.default({})
-}));
+exports.DateQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('date'), attributes: DateAttributesSchema }));
+exports.DefaultDateQuestion = exports.DateQuestionSchema.parse({
+    type: 'date',
+    attributes: DefaultDateAttributes,
+    meta: question_1.DefaultMeta
+});
+const DateRangeStartColumnSchema = zod_1.z.object(Object.assign(Object.assign({}, DateAttributesSchema.shape), { label: zod_1.z.string().default('From') }));
+const DateRangeEndColumnSchema = zod_1.z.object(Object.assign(Object.assign({}, DateAttributesSchema.shape), { label: zod_1.z.string().default('To') }));
 // Date range question and answer
-exports.DateRangeQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('dateRange'),
-    attributes: BaseAttributes.default({}),
-    columns: zod_1.z.object({
-        start: DateAttributesSchema.merge(zod_1.z.object({
-            label: zod_1.z.string().default('From')
-        })).default({}),
-        end: DateAttributesSchema.merge(zod_1.z.object({
-            label: zod_1.z.string().default('To')
-        })).default({}),
-    }).default({})
-}));
+exports.DateRangeQuestionSchema = zod_1.z.object(Object.assign(Object.assign({}, question_1.QuestionSchema.shape), { type: zod_1.z.literal('dateRange'), columns: zod_1.z.object({
+        start: DateRangeStartColumnSchema,
+        end: DateRangeEndColumnSchema,
+    }) }));
+exports.DefaultDateRangeQuestion = exports.DateRangeQuestionSchema.parse({
+    type: 'dateRange',
+    attributes: question_1.BaseAttributesSchema.parse({}),
+    meta: question_1.DefaultMeta,
+    columns: {
+        start: DateRangeStartColumnSchema.parse({}),
+        end: DateRangeEndColumnSchema.parse({})
+    }
+});
+exports.DateQuestionJSONSchema = zod_1.z.toJSONSchema(exports.DateQuestionSchema);
+exports.DateRangeQuestionJSONSchema = zod_1.z.toJSONSchema(exports.DateRangeQuestionSchema);