@dmptool/types 1.0.1 → 1.0.3

package/dist/questions/primitiveQuestions.js

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.URLQuestion = exports.TextQuestion = exports.TextAreaQuestion = exports.EmailQuestion = exports.CurrencyQuestion = exports.NumberQuestion = exports.BooleanQuestion = void 0;
+exports.URLQuestionSchema = exports.TextQuestionSchema = exports.TextAreaQuestionSchema = exports.EmailQuestionSchema = exports.CurrencyQuestionSchema = exports.NumberQuestionSchema = exports.BooleanQuestionSchema = void 0;
 const zod_1 = require("zod");
 const question_1 = require("./question");
 // A Yes/No True/False question and answer
-exports.BooleanQuestion = question_1.Question.merge(zod_1.z.object({
+exports.BooleanQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('boolean'), // The type of question
     attributes: zod_1.z.object({
         checked: zod_1.z.boolean().optional() // If it is checked by default when rendered (default is false)
     })
 }));
 // A number question and answer
-exports.NumberQuestion = question_1.Question.merge(zod_1.z.object({
+exports.NumberQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('number'), // The type of question
     attributes: zod_1.z.object({
         max: zod_1.z.number().optional(), // The maximum value (no default)
@@ -20,14 +20,14 @@ exports.NumberQuestion = question_1.Question.merge(zod_1.z.object({
     })
 }));
 // Currency question and answer
-exports.CurrencyQuestion = exports.NumberQuestion.merge(zod_1.z.object({
+exports.CurrencyQuestionSchema = exports.NumberQuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('currency'), // The type of question
     meta: zod_1.z.object({
         denomination: zod_1.z.string().optional() // The currency denomination (default is USD)
     })
 }));
 // Email question and answer
-exports.EmailQuestion = question_1.Question.merge(zod_1.z.object({
+exports.EmailQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('email'), // The type of question
     attributes: zod_1.z.object({
         maxLength: zod_1.z.number().optional(), // The maximum length of the email (no default)
@@ -37,7 +37,7 @@ exports.EmailQuestion = question_1.Question.merge(zod_1.z.object({
     })
 }));
 // Text area question and answer
-exports.TextAreaQuestion = question_1.Question.merge(zod_1.z.object({
+exports.TextAreaQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('textArea'), // The type of question
     attributes: zod_1.z.object({
         cols: zod_1.z.number().optional(), // The number of columns (default is 20)
@@ -50,7 +50,7 @@ exports.TextAreaQuestion = question_1.Question.merge(zod_1.z.object({
     })
 }));
 // Text question and answer
-exports.TextQuestion = question_1.Question.merge(zod_1.z.object({
+exports.TextQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('text'), // The type of question
     attributes: zod_1.z.object({
         maxLength: zod_1.z.number().optional(), // The maximum length of the text (no default)
@@ -59,7 +59,7 @@ exports.TextQuestion = question_1.Question.merge(zod_1.z.object({
     }),
 }));
 // URL question and answer
-exports.URLQuestion = question_1.Question.merge(zod_1.z.object({
+exports.URLQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('url'), // The type of question
     attributes: zod_1.z.object({
         maxLength: zod_1.z.number().optional(), // The maximum length of the URL (no default)

package/dist/questions/question.d.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 export declare const CURRENT_SCHEMA_VERSION = "1.0";
 export declare const QuestionTypesEnum: z.ZodEnum<["boolean", "checkBoxes", "currency", "datePicker", "dateRange", "email", "filteredSearch", "number", "option", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
-export declare const Question: z.ZodObject<{
+export declare const QuestionSchema: z.ZodObject<{
     type: z.ZodEnum<["boolean", "checkBoxes", "currency", "datePicker", "dateRange", "email", "filteredSearch", "number", "option", "radioButtons", "selectBox", "table", "text", "textArea", "typeaheadSearch", "url"]>;
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
@@ -26,4 +26,4 @@ export declare const Question: z.ZodObject<{
         labelTranslationKey?: string | undefined;
     };
 }>;
-export type QuestionType = z.infer<typeof Question>;
+export type QuestionType = z.infer<typeof QuestionSchema>;

package/dist/questions/question.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Question = exports.QuestionTypesEnum = exports.CURRENT_SCHEMA_VERSION = void 0;
+exports.QuestionSchema = exports.QuestionTypesEnum = 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
@@ -23,7 +23,7 @@ exports.QuestionTypesEnum = zod_1.z.enum([
     'url'
 ]);
 // Base abstract type for all questions
-exports.Question = zod_1.z.object({
+exports.QuestionSchema = zod_1.z.object({
     type: exports.QuestionTypesEnum, // The type of question
     meta: zod_1.z.object({
         schemaVersion: zod_1.z.literal(exports.CURRENT_SCHEMA_VERSION), // The schema version (default is CURRENT_SCHEMA_VERSION)

package/dist/questions/tableQuestions.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const AnyTableColumnQuestion: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+export declare const AnyTableColumnQuestionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -1076,7 +1076,7 @@ export declare const AnyTableColumnQuestion: z.ZodDiscriminatedUnion<"type", [z.
         pattern?: string | undefined;
     };
 }>]>;
-export declare const TableQuestion: z.ZodObject<{
+export declare const TableQuestionSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodLiteral<"1.0">;
         labelTranslationKey: z.ZodOptional<z.ZodString>;
@@ -2634,5 +2634,5 @@ export declare const TableQuestion: z.ZodObject<{
         };
     })[];
 }>;
-export type TableQuestionType = z.infer<typeof TableQuestion>;
-export type AnyTableColumnQuestionType = z.infer<typeof AnyTableColumnQuestion>;
+export type TableQuestionType = z.infer<typeof TableQuestionSchema>;
+export type AnyTableColumnQuestionType = z.infer<typeof AnyTableColumnQuestionSchema>;

package/dist/questions/tableQuestions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableQuestion = exports.AnyTableColumnQuestion = void 0;
+exports.TableQuestionSchema = exports.AnyTableColumnQuestionSchema = void 0;
 const zod_1 = require("zod");
 const primitiveQuestions_1 = require("./primitiveQuestions");
 const dateQuestions_1 = require("./dateQuestions");
@@ -8,26 +8,26 @@ const optionBasedQuestions_1 = require("./optionBasedQuestions");
 const graphQLQuestions_1 = require("./graphQLQuestions");
 const question_1 = require("./question");
 // Union types for all questions and answers (tables cannot be nested so no TableQuestion here!)
-exports.AnyTableColumnQuestion = zod_1.z.discriminatedUnion('type', [
-    primitiveQuestions_1.BooleanQuestion,
-    optionBasedQuestions_1.CheckboxesQuestion,
-    primitiveQuestions_1.CurrencyQuestion,
-    dateQuestions_1.DatePickerQuestion,
-    dateQuestions_1.DateRangeQuestion,
-    primitiveQuestions_1.EmailQuestion,
-    graphQLQuestions_1.FilteredSearchQuestion,
-    primitiveQuestions_1.NumberQuestion,
-    optionBasedQuestions_1.RadioButtonsQuestion,
-    optionBasedQuestions_1.SelectBoxQuestion,
-    primitiveQuestions_1.TextAreaQuestion,
-    primitiveQuestions_1.TextQuestion,
-    graphQLQuestions_1.TypeaheadSearchQuestion,
-    primitiveQuestions_1.URLQuestion
+exports.AnyTableColumnQuestionSchema = zod_1.z.discriminatedUnion('type', [
+    primitiveQuestions_1.BooleanQuestionSchema,
+    optionBasedQuestions_1.CheckboxesQuestionSchema,
+    primitiveQuestions_1.CurrencyQuestionSchema,
+    dateQuestions_1.DatePickerQuestionSchema,
+    dateQuestions_1.DateRangeQuestionSchema,
+    primitiveQuestions_1.EmailQuestionSchema,
+    graphQLQuestions_1.FilteredSearchQuestionSchema,
+    primitiveQuestions_1.NumberQuestionSchema,
+    optionBasedQuestions_1.RadioButtonsQuestionSchema,
+    optionBasedQuestions_1.SelectBoxQuestionSchema,
+    primitiveQuestions_1.TextAreaQuestionSchema,
+    primitiveQuestions_1.TextQuestionSchema,
+    graphQLQuestions_1.TypeaheadSearchQuestionSchema,
+    primitiveQuestions_1.URLQuestionSchema
 ]);
 // Table question and answer
-exports.TableQuestion = question_1.Question.merge(zod_1.z.object({
+exports.TableQuestionSchema = question_1.QuestionSchema.merge(zod_1.z.object({
     type: zod_1.z.literal('table'), // The type of question
-    columns: zod_1.z.array(exports.AnyTableColumnQuestion), // The columns of the table (note: tables cannot be nested)
+    columns: zod_1.z.array(exports.AnyTableColumnQuestionSchema), // The columns of the table (note: tables cannot be nested)
     attributes: zod_1.z.object({
         canAddRows: zod_1.z.boolean().optional(), // Whether to allow adding rows (default is true)
         canRemoveRows: zod_1.z.boolean().optional(), // Whether to allow removing rows (default is true)

package/dist/schemas/anyAnswer.schema.json

@@ -12,11 +12,25 @@
             },
             "answer": {
               "type": "boolean"
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "schemaVersion": {
+                  "type": "string",
+                  "const": "1.0"
+                }
+              },
+              "required": [
+                "schemaVersion"
+              ],
+              "additionalProperties": false
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -32,11 +46,15 @@
               "items": {
                 "type": "string"
               }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -49,11 +67,15 @@
             },
             "answer": {
               "type": "number"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -66,11 +88,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -96,11 +122,15 @@
                 "end"
               ],
               "additionalProperties": false
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -113,11 +143,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -133,11 +167,15 @@
               "items": {
                 "type": "string"
               }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -150,11 +188,15 @@
             },
             "answer": {
               "type": "number"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -167,11 +209,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -183,12 +229,19 @@
               "const": "selectBox"
             },
             "answer": {
-              "type": "string"
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -242,11 +295,15 @@
                       },
                       "answer": {
                         "type": "string"
+                      },
+                      "meta": {
+                        "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
                       }
                     },
                     "required": [
                       "type",
-                      "answer"
+                      "answer",
+                      "meta"
                     ],
                     "additionalProperties": false
                   },
@@ -259,11 +316,15 @@
                       },
                       "answer": {
                         "type": "string"
+                      },
+                      "meta": {
+                        "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
                       }
                     },
                     "required": [
                       "type",
-                      "answer"
+                      "answer",
+                      "meta"
                     ],
                     "additionalProperties": false
                   },
@@ -276,11 +337,15 @@
                       },
                       "answer": {
                         "type": "string"
+                      },
+                      "meta": {
+                        "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
                       }
                     },
                     "required": [
                       "type",
-                      "answer"
+                      "answer",
+                      "meta"
                     ],
                     "additionalProperties": false
                   },
@@ -293,21 +358,29 @@
                       },
                       "answer": {
                         "type": "string"
+                      },
+                      "meta": {
+                        "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
                       }
                     },
                     "required": [
                       "type",
-                      "answer"
+                      "answer",
+                      "meta"
                     ],
                     "additionalProperties": false
                   }
                 ]
               }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },

package/dist/schemas/anyTableColumnAnswer.schema.json

@@ -12,11 +12,25 @@
             },
             "answer": {
               "type": "boolean"
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "schemaVersion": {
+                  "type": "string",
+                  "const": "1.0"
+                }
+              },
+              "required": [
+                "schemaVersion"
+              ],
+              "additionalProperties": false
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -32,11 +46,15 @@
               "items": {
                 "type": "string"
               }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -49,11 +67,15 @@
             },
             "answer": {
               "type": "number"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -66,11 +88,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -96,11 +122,15 @@
                 "end"
               ],
               "additionalProperties": false
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -113,11 +143,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -133,11 +167,15 @@
               "items": {
                 "type": "string"
               }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -150,11 +188,15 @@
             },
             "answer": {
               "type": "number"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -167,11 +209,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -183,12 +229,19 @@
               "const": "selectBox"
             },
             "answer": {
-              "type": "string"
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -201,11 +254,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -218,11 +275,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -235,11 +296,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         },
@@ -252,11 +317,15 @@
             },
             "answer": {
               "type": "string"
+            },
+            "meta": {
+              "$ref": "#/definitions/AnyTableColumnAnswer/anyOf/0/properties/meta"
             }
           },
           "required": [
             "type",
-            "answer"
+            "answer",
+            "meta"
           ],
           "additionalProperties": false
         }