@dmptool/types 1.0.8 → 1.1.0

package/dist/schemas/textAreaQuestion.schema.json

@@ -8,28 +8,18 @@
           "type": "string",
           "const": "textArea"
         },
-        "meta": {
+        "attributes": {
           "type": "object",
           "properties": {
-            "schemaVersion": {
-              "type": "string",
-              "const": "1.0"
+            "label": {
+              "type": "string"
+            },
+            "help": {
+              "type": "string"
             },
             "labelTranslationKey": {
               "type": "string"
             },
-            "asRichText": {
-              "type": "boolean"
-            }
-          },
-          "required": [
-            "schemaVersion"
-          ],
-          "additionalProperties": false
-        },
-        "attributes": {
-          "type": "object",
-          "properties": {
             "cols": {
               "type": "number"
             },
@@ -44,6 +34,22 @@
             }
           },
           "additionalProperties": false
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": {
+              "type": "string",
+              "const": "1.0"
+            },
+            "asRichText": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "schemaVersion"
+          ],
+          "additionalProperties": false
         }
       },
       "required": [

package/dist/schemas/textQuestion.schema.json

@@ -8,25 +8,18 @@
           "type": "string",
           "const": "text"
         },
-        "meta": {
+        "attributes": {
           "type": "object",
           "properties": {
-            "schemaVersion": {
-              "type": "string",
-              "const": "1.0"
+            "label": {
+              "type": "string"
+            },
+            "help": {
+              "type": "string"
             },
             "labelTranslationKey": {
               "type": "string"
-            }
-          },
-          "required": [
-            "schemaVersion"
-          ],
-          "additionalProperties": false
-        },
-        "attributes": {
-          "type": "object",
-          "properties": {
+            },
             "maxLength": {
               "type": "number"
             },
@@ -38,11 +31,23 @@
             }
           },
           "additionalProperties": false
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": {
+              "type": "string",
+              "const": "1.0"
+            }
+          },
+          "required": [
+            "schemaVersion"
+          ],
+          "additionalProperties": false
         }
       },
       "required": [
-        "type",
-        "meta"
+        "type"
       ],
       "additionalProperties": false
     }

package/dist/schemas/typeaheadSearchQuestion.schema.json

@@ -8,15 +8,27 @@
           "type": "string",
           "const": "typeaheadSearch"
         },
+        "attributes": {
+          "type": "object",
+          "properties": {
+            "label": {
+              "type": "string"
+            },
+            "help": {
+              "type": "string"
+            },
+            "labelTranslationKey": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
         "meta": {
           "type": "object",
           "properties": {
             "schemaVersion": {
               "type": "string",
               "const": "1.0"
-            },
-            "labelTranslationKey": {
-              "type": "string"
             }
           },
           "required": [
@@ -99,7 +111,6 @@
       },
       "required": [
         "type",
-        "meta",
         "graphQL"
       ],
       "additionalProperties": false

package/dist/schemas/urlQuestion.schema.json

@@ -8,25 +8,18 @@
           "type": "string",
           "const": "url"
         },
-        "meta": {
+        "attributes": {
           "type": "object",
           "properties": {
-            "schemaVersion": {
-              "type": "string",
-              "const": "1.0"
+            "label": {
+              "type": "string"
+            },
+            "help": {
+              "type": "string"
             },
             "labelTranslationKey": {
               "type": "string"
-            }
-          },
-          "required": [
-            "schemaVersion"
-          ],
-          "additionalProperties": false
-        },
-        "attributes": {
-          "type": "object",
-          "properties": {
+            },
             "maxLength": {
               "type": "number"
             },
@@ -38,11 +31,23 @@
             }
           },
           "additionalProperties": false
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "schemaVersion": {
+              "type": "string",
+              "const": "1.0"
+            }
+          },
+          "required": [
+            "schemaVersion"
+          ],
+          "additionalProperties": false
         }
       },
       "required": [
-        "type",
-        "meta"
+        "type"
       ],
       "additionalProperties": false
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/types",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "TypeScript types for DMPTool",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/answers/primitiveAnswers.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.URLAnswerSchema = exports.TextAreaAnswerSchema = exports.TextAnswerSchema = exports.NumberRangeAnswerSchema = exports.NumberAnswerSchema = exports.EmailAnswerSchema = exports.CurrencyAnswerSchema = exports.BooleanAnswerSchema = void 0;
-const zod_1 = require("zod");
-const answer_1 = require("./answer");
-// Answers to Primitive Question Types
-exports.BooleanAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('boolean'), // The type of answer
-    answer: zod_1.z.boolean() // The answer to the question (true/false)
-}));
-exports.CurrencyAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('currency'), // The type of answer
-    answer: zod_1.z.number() // The answer to the question (number)
-}));
-exports.EmailAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('email'), // The type of question
-    answer: zod_1.z.string() // The answer to the question (string)
-}));
-exports.NumberAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('number'), // The type of answer
-    answer: zod_1.z.number() // The answer to the question (number)
-}));
-exports.NumberRangeAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('numberRange'), // The type of answer
-    answer: zod_1.z.object({
-        start: zod_1.z.number(), // The start number (number)
-        end: zod_1.z.number() // The end number (number)
-    })
-}));
-exports.TextAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('text'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
-}));
-exports.TextAreaAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('textArea'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
-}));
-exports.URLAnswerSchema = answer_1.AnswerSchema.merge(zod_1.z.object({
-    type: zod_1.z.literal('url'), // The type of answer
-    answer: zod_1.z.string() // The answer to the question (string)
-}));

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

@@ -1,281 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const primitiveQuestions_1 = require("../primitiveQuestions");
-describe("Primitive Questions Zod Schemas", () => {
-    it('optional fields should not throw an error if the value is undefined', () => {
-        const validBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: undefined, // Valid value
-            },
-        };
-        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
-    });
-    it('optional fields should throw an error if the value is null', () => {
-        const invalidBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: null, // Invalid value
-            },
-        };
-        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(invalidBooleanQuestion)).toThrow();
-    });
-    it("should validate a valid BooleanQuestion", () => {
-        const validBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: true,
-            },
-        };
-        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(validBooleanQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid BooleanQuestion", () => {
-        const invalidBooleanQuestion = {
-            type: "boolean",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                checked: "true", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.BooleanQuestionSchema.parse(invalidBooleanQuestion)).toThrow();
-    });
-    it("should validate a valid CurrencyQuestion", () => {
-        const validCurrencyQuestion = {
-            type: "currency",
-            meta: {
-                schemaVersion: "1.0",
-                denomination: "USD",
-            },
-            attributes: {
-                max: 100,
-                min: 1,
-                step: 0.01,
-            },
-        };
-        expect(() => primitiveQuestions_1.CurrencyQuestionSchema.parse(validCurrencyQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid CurrencyQuestion", () => {
-        const invalidCurrencyQuestion = {
-            type: "currency",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                max: "100", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.CurrencyQuestionSchema.parse(invalidCurrencyQuestion)).toThrow();
-    });
-    it("should validate a valid EmailQuestion", () => {
-        const validEmailQuestion = {
-            type: "email",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: 50,
-                minLength: 5,
-                multiple: true,
-                pattern: "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
-            },
-        };
-        expect(() => primitiveQuestions_1.EmailQuestionSchema.parse(validEmailQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid EmailQuestion", () => {
-        const invalidEmailQuestion = {
-            type: "email",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: "50", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.EmailQuestionSchema.parse(invalidEmailQuestion)).toThrow();
-    });
-    it("should validate a valid NumberQuestion", () => {
-        const validNumberQuestion = {
-            type: "number",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                max: 100,
-                min: 0,
-                step: 1,
-            },
-        };
-        expect(() => primitiveQuestions_1.NumberQuestionSchema.parse(validNumberQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid NumberQuestion", () => {
-        const invalidNumberQuestion = {
-            type: "number",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                step: "1", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.NumberQuestionSchema.parse(invalidNumberQuestion)).toThrow();
-    });
-    it("should validate a valid NumberRangeQuestion", () => {
-        const validNumberRangeQuestion = {
-            type: "numberRange",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            columns: {
-                start: {
-                    type: "number",
-                    attributes: {
-                        label: "Start",
-                        min: 0,
-                        max: 50,
-                        step: 1,
-                    },
-                    meta: {
-                        schemaVersion: "1.0",
-                    },
-                },
-                end: {
-                    type: "number",
-                    attributes: {
-                        label: "End",
-                        min: 50,
-                        max: 100,
-                        step: 1,
-                    },
-                    meta: {
-                        schemaVersion: "1.0",
-                    },
-                },
-            },
-        };
-        expect(() => primitiveQuestions_1.NumberRangeQuestionSchema.parse(validNumberRangeQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid NumberRangeQuestion", () => {
-        const invalidNumberRangeQuestion = {
-            type: "numberRange",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            columns: {
-                start: {
-                    type: "number",
-                    attributes: {
-                        min: 0,
-                        max: 50,
-                    },
-                    meta: {
-                        schemaVersion: "1.0",
-                    },
-                },
-                end: {
-                    type: "number",
-                    attributes: {
-                        label: "End",
-                        min: 50,
-                        max: 100,
-                        step: 1,
-                    },
-                    meta: {
-                        schemaVersion: "1.0",
-                    },
-                },
-            },
-        };
-        expect(() => primitiveQuestions_1.NumberRangeQuestionSchema.parse(invalidNumberRangeQuestion)).toThrow();
-    });
-    it("should validate a valid TextAreaQuestion", () => {
-        const validTextAreaQuestion = {
-            type: "textArea",
-            meta: {
-                schemaVersion: "1.0",
-                asRichText: true,
-            },
-            attributes: {
-                cols: 30,
-                rows: 5,
-                maxLength: 500,
-                minLength: 10,
-            },
-        };
-        expect(() => primitiveQuestions_1.TextAreaQuestionSchema.parse(validTextAreaQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid TextAreaQuestion", () => {
-        const invalidTextAreaQuestion = {
-            type: "textArea",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                cols: "30", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.TextAreaQuestionSchema.parse(invalidTextAreaQuestion)).toThrow();
-    });
-    it("should validate a valid TextQuestion", () => {
-        const validTextQuestion = {
-            type: "text",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: 100,
-                minLength: 1,
-                pattern: "^[a-zA-Z]+$",
-            },
-        };
-        expect(() => primitiveQuestions_1.TextQuestionSchema.parse(validTextQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid TextQuestion", () => {
-        const invalidTextQuestion = {
-            type: "text",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: "100", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.TextQuestionSchema.parse(invalidTextQuestion)).toThrow();
-    });
-    it("should validate a valid URLQuestion", () => {
-        const validURLQuestion = {
-            type: "url",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: 200,
-                minLength: 10,
-                pattern: "https?://.+",
-            },
-        };
-        expect(() => primitiveQuestions_1.URLQuestionSchema.parse(validURLQuestion)).not.toThrow();
-    });
-    it("should invalidate an invalid URLQuestion", () => {
-        const invalidURLQuestion = {
-            type: "url",
-            meta: {
-                schemaVersion: "1.0",
-            },
-            attributes: {
-                maxLength: "200", // Invalid type
-            },
-        };
-        expect(() => primitiveQuestions_1.URLQuestionSchema.parse(invalidURLQuestion)).toThrow();
-    });
-});