@encatch/schema 1.0.0-beta.1 → 1.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,270 +1,317 @@
1
1
  import { z } from "zod";
2
2
  export declare const translationEntrySchema: z.ZodString;
3
+ export declare const baseQuestionTranslationFieldsSchema: z.ZodObject<{
4
+ title: z.ZodString;
5
+ description: z.ZodOptional<z.ZodString>;
6
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
7
+ errorMessage: z.ZodOptional<z.ZodString>;
8
+ }, z.core.$strip>;
9
+ export declare const BASE_QUESTION_TRANSLATION_KEYS: readonly ["type", "title", "description", "descriptionMarkdown", "errorMessage"];
3
10
  export declare const ratingQuestionTranslationSchema: z.ZodObject<{
4
- type: z.ZodLiteral<"rating">;
5
11
  title: z.ZodString;
6
12
  description: z.ZodOptional<z.ZodString>;
13
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
7
14
  errorMessage: z.ZodOptional<z.ZodString>;
15
+ type: z.ZodLiteral<"rating">;
8
16
  minLabel: z.ZodOptional<z.ZodString>;
9
17
  maxLabel: z.ZodOptional<z.ZodString>;
10
18
  }, z.core.$strip>;
11
19
  export declare const singleChoiceQuestionTranslationSchema: z.ZodObject<{
12
- type: z.ZodLiteral<"single_choice">;
13
20
  title: z.ZodString;
14
21
  description: z.ZodOptional<z.ZodString>;
22
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
15
23
  errorMessage: z.ZodOptional<z.ZodString>;
24
+ type: z.ZodLiteral<"single_choice">;
16
25
  placeholder: z.ZodOptional<z.ZodString>;
17
26
  }, z.core.$catchall<z.ZodString>>;
18
27
  export declare const multipleChoiceQuestionTranslationSchema: z.ZodObject<{
19
- type: z.ZodLiteral<"multiple_choice_multiple">;
20
28
  title: z.ZodString;
21
29
  description: z.ZodOptional<z.ZodString>;
30
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
22
31
  errorMessage: z.ZodOptional<z.ZodString>;
32
+ type: z.ZodLiteral<"multiple_choice_multiple">;
23
33
  placeholder: z.ZodOptional<z.ZodString>;
24
34
  }, z.core.$catchall<z.ZodString>>;
25
35
  export declare const npsQuestionTranslationSchema: z.ZodObject<{
26
- type: z.ZodLiteral<"nps">;
27
36
  title: z.ZodString;
28
37
  description: z.ZodOptional<z.ZodString>;
38
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
29
39
  errorMessage: z.ZodOptional<z.ZodString>;
40
+ type: z.ZodLiteral<"nps">;
30
41
  minLabel: z.ZodOptional<z.ZodString>;
31
42
  maxLabel: z.ZodOptional<z.ZodString>;
32
43
  }, z.core.$catchall<z.ZodString>>;
33
44
  export declare const shortAnswerQuestionTranslationSchema: z.ZodObject<{
34
- type: z.ZodLiteral<"short_answer">;
35
45
  title: z.ZodString;
36
46
  description: z.ZodOptional<z.ZodString>;
47
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
37
48
  errorMessage: z.ZodOptional<z.ZodString>;
49
+ type: z.ZodLiteral<"short_answer">;
38
50
  placeholder: z.ZodOptional<z.ZodString>;
39
51
  }, z.core.$strip>;
40
52
  export declare const longAnswerQuestionTranslationSchema: z.ZodObject<{
41
- type: z.ZodLiteral<"long_text">;
42
53
  title: z.ZodString;
43
54
  description: z.ZodOptional<z.ZodString>;
55
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
44
56
  errorMessage: z.ZodOptional<z.ZodString>;
57
+ type: z.ZodLiteral<"long_text">;
45
58
  placeholder: z.ZodOptional<z.ZodString>;
46
59
  }, z.core.$strip>;
47
60
  export declare const nestedSelectionQuestionTranslationSchema: z.ZodObject<{
48
- type: z.ZodLiteral<"nested_selection">;
49
61
  title: z.ZodString;
50
62
  description: z.ZodOptional<z.ZodString>;
63
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
51
64
  errorMessage: z.ZodOptional<z.ZodString>;
65
+ type: z.ZodLiteral<"nested_selection">;
52
66
  placeholder: z.ZodOptional<z.ZodString>;
53
67
  }, z.core.$catchall<z.ZodString>>;
54
68
  export declare const annotationQuestionTranslationSchema: z.ZodObject<{
55
- type: z.ZodLiteral<"annotation">;
56
69
  title: z.ZodString;
57
70
  description: z.ZodOptional<z.ZodString>;
71
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
58
72
  errorMessage: z.ZodOptional<z.ZodString>;
73
+ type: z.ZodLiteral<"annotation">;
59
74
  annotationText: z.ZodOptional<z.ZodString>;
60
75
  noAnnotationText: z.ZodOptional<z.ZodString>;
61
76
  }, z.core.$strip>;
62
77
  export declare const questionTranslationSchema: z.ZodUnion<readonly [z.ZodObject<{
63
- type: z.ZodLiteral<"rating">;
64
78
  title: z.ZodString;
65
79
  description: z.ZodOptional<z.ZodString>;
80
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
66
81
  errorMessage: z.ZodOptional<z.ZodString>;
82
+ type: z.ZodLiteral<"rating">;
67
83
  minLabel: z.ZodOptional<z.ZodString>;
68
84
  maxLabel: z.ZodOptional<z.ZodString>;
69
85
  }, z.core.$strip>, z.ZodObject<{
70
- type: z.ZodLiteral<"single_choice">;
71
86
  title: z.ZodString;
72
87
  description: z.ZodOptional<z.ZodString>;
88
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
73
89
  errorMessage: z.ZodOptional<z.ZodString>;
90
+ type: z.ZodLiteral<"single_choice">;
74
91
  placeholder: z.ZodOptional<z.ZodString>;
75
92
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
76
- type: z.ZodLiteral<"multiple_choice_multiple">;
77
93
  title: z.ZodString;
78
94
  description: z.ZodOptional<z.ZodString>;
95
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
79
96
  errorMessage: z.ZodOptional<z.ZodString>;
97
+ type: z.ZodLiteral<"multiple_choice_multiple">;
80
98
  placeholder: z.ZodOptional<z.ZodString>;
81
99
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
82
- type: z.ZodLiteral<"nps">;
83
100
  title: z.ZodString;
84
101
  description: z.ZodOptional<z.ZodString>;
102
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
85
103
  errorMessage: z.ZodOptional<z.ZodString>;
104
+ type: z.ZodLiteral<"nps">;
86
105
  minLabel: z.ZodOptional<z.ZodString>;
87
106
  maxLabel: z.ZodOptional<z.ZodString>;
88
107
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
89
- type: z.ZodLiteral<"short_answer">;
90
108
  title: z.ZodString;
91
109
  description: z.ZodOptional<z.ZodString>;
110
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
92
111
  errorMessage: z.ZodOptional<z.ZodString>;
112
+ type: z.ZodLiteral<"short_answer">;
93
113
  placeholder: z.ZodOptional<z.ZodString>;
94
114
  }, z.core.$strip>, z.ZodObject<{
95
- type: z.ZodLiteral<"long_text">;
96
115
  title: z.ZodString;
97
116
  description: z.ZodOptional<z.ZodString>;
117
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
98
118
  errorMessage: z.ZodOptional<z.ZodString>;
119
+ type: z.ZodLiteral<"long_text">;
99
120
  placeholder: z.ZodOptional<z.ZodString>;
100
121
  }, z.core.$strip>, z.ZodObject<{
101
- type: z.ZodLiteral<"nested_selection">;
102
122
  title: z.ZodString;
103
123
  description: z.ZodOptional<z.ZodString>;
124
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
104
125
  errorMessage: z.ZodOptional<z.ZodString>;
126
+ type: z.ZodLiteral<"nested_selection">;
105
127
  placeholder: z.ZodOptional<z.ZodString>;
106
128
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
107
- type: z.ZodLiteral<"annotation">;
108
129
  title: z.ZodString;
109
130
  description: z.ZodOptional<z.ZodString>;
131
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
110
132
  errorMessage: z.ZodOptional<z.ZodString>;
133
+ type: z.ZodLiteral<"annotation">;
111
134
  annotationText: z.ZodOptional<z.ZodString>;
112
135
  noAnnotationText: z.ZodOptional<z.ZodString>;
113
136
  }, z.core.$strip>]>;
114
137
  export declare const languageCodeSchema: z.ZodString;
115
138
  export declare const questionTranslationsByLanguageSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
116
- type: z.ZodLiteral<"rating">;
117
139
  title: z.ZodString;
118
140
  description: z.ZodOptional<z.ZodString>;
141
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
119
142
  errorMessage: z.ZodOptional<z.ZodString>;
143
+ type: z.ZodLiteral<"rating">;
120
144
  minLabel: z.ZodOptional<z.ZodString>;
121
145
  maxLabel: z.ZodOptional<z.ZodString>;
122
146
  }, z.core.$strip>, z.ZodObject<{
123
- type: z.ZodLiteral<"single_choice">;
124
147
  title: z.ZodString;
125
148
  description: z.ZodOptional<z.ZodString>;
149
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
126
150
  errorMessage: z.ZodOptional<z.ZodString>;
151
+ type: z.ZodLiteral<"single_choice">;
127
152
  placeholder: z.ZodOptional<z.ZodString>;
128
153
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
129
- type: z.ZodLiteral<"multiple_choice_multiple">;
130
154
  title: z.ZodString;
131
155
  description: z.ZodOptional<z.ZodString>;
156
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
132
157
  errorMessage: z.ZodOptional<z.ZodString>;
158
+ type: z.ZodLiteral<"multiple_choice_multiple">;
133
159
  placeholder: z.ZodOptional<z.ZodString>;
134
160
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
135
- type: z.ZodLiteral<"nps">;
136
161
  title: z.ZodString;
137
162
  description: z.ZodOptional<z.ZodString>;
163
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
138
164
  errorMessage: z.ZodOptional<z.ZodString>;
165
+ type: z.ZodLiteral<"nps">;
139
166
  minLabel: z.ZodOptional<z.ZodString>;
140
167
  maxLabel: z.ZodOptional<z.ZodString>;
141
168
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
142
- type: z.ZodLiteral<"short_answer">;
143
169
  title: z.ZodString;
144
170
  description: z.ZodOptional<z.ZodString>;
171
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
145
172
  errorMessage: z.ZodOptional<z.ZodString>;
173
+ type: z.ZodLiteral<"short_answer">;
146
174
  placeholder: z.ZodOptional<z.ZodString>;
147
175
  }, z.core.$strip>, z.ZodObject<{
148
- type: z.ZodLiteral<"long_text">;
149
176
  title: z.ZodString;
150
177
  description: z.ZodOptional<z.ZodString>;
178
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
151
179
  errorMessage: z.ZodOptional<z.ZodString>;
180
+ type: z.ZodLiteral<"long_text">;
152
181
  placeholder: z.ZodOptional<z.ZodString>;
153
182
  }, z.core.$strip>, z.ZodObject<{
154
- type: z.ZodLiteral<"nested_selection">;
155
183
  title: z.ZodString;
156
184
  description: z.ZodOptional<z.ZodString>;
185
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
157
186
  errorMessage: z.ZodOptional<z.ZodString>;
187
+ type: z.ZodLiteral<"nested_selection">;
158
188
  placeholder: z.ZodOptional<z.ZodString>;
159
189
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
160
- type: z.ZodLiteral<"annotation">;
161
190
  title: z.ZodString;
162
191
  description: z.ZodOptional<z.ZodString>;
192
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
163
193
  errorMessage: z.ZodOptional<z.ZodString>;
194
+ type: z.ZodLiteral<"annotation">;
164
195
  annotationText: z.ZodOptional<z.ZodString>;
165
196
  noAnnotationText: z.ZodOptional<z.ZodString>;
166
197
  }, z.core.$strip>]>>;
167
198
  export declare const questionCentricTranslationsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
168
- type: z.ZodLiteral<"rating">;
169
199
  title: z.ZodString;
170
200
  description: z.ZodOptional<z.ZodString>;
201
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
171
202
  errorMessage: z.ZodOptional<z.ZodString>;
203
+ type: z.ZodLiteral<"rating">;
172
204
  minLabel: z.ZodOptional<z.ZodString>;
173
205
  maxLabel: z.ZodOptional<z.ZodString>;
174
206
  }, z.core.$strip>, z.ZodObject<{
175
- type: z.ZodLiteral<"single_choice">;
176
207
  title: z.ZodString;
177
208
  description: z.ZodOptional<z.ZodString>;
209
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
178
210
  errorMessage: z.ZodOptional<z.ZodString>;
211
+ type: z.ZodLiteral<"single_choice">;
179
212
  placeholder: z.ZodOptional<z.ZodString>;
180
213
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
181
- type: z.ZodLiteral<"multiple_choice_multiple">;
182
214
  title: z.ZodString;
183
215
  description: z.ZodOptional<z.ZodString>;
216
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
184
217
  errorMessage: z.ZodOptional<z.ZodString>;
218
+ type: z.ZodLiteral<"multiple_choice_multiple">;
185
219
  placeholder: z.ZodOptional<z.ZodString>;
186
220
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
187
- type: z.ZodLiteral<"nps">;
188
221
  title: z.ZodString;
189
222
  description: z.ZodOptional<z.ZodString>;
223
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
190
224
  errorMessage: z.ZodOptional<z.ZodString>;
225
+ type: z.ZodLiteral<"nps">;
191
226
  minLabel: z.ZodOptional<z.ZodString>;
192
227
  maxLabel: z.ZodOptional<z.ZodString>;
193
228
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
194
- type: z.ZodLiteral<"short_answer">;
195
229
  title: z.ZodString;
196
230
  description: z.ZodOptional<z.ZodString>;
231
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
197
232
  errorMessage: z.ZodOptional<z.ZodString>;
233
+ type: z.ZodLiteral<"short_answer">;
198
234
  placeholder: z.ZodOptional<z.ZodString>;
199
235
  }, z.core.$strip>, z.ZodObject<{
200
- type: z.ZodLiteral<"long_text">;
201
236
  title: z.ZodString;
202
237
  description: z.ZodOptional<z.ZodString>;
238
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
203
239
  errorMessage: z.ZodOptional<z.ZodString>;
240
+ type: z.ZodLiteral<"long_text">;
204
241
  placeholder: z.ZodOptional<z.ZodString>;
205
242
  }, z.core.$strip>, z.ZodObject<{
206
- type: z.ZodLiteral<"nested_selection">;
207
243
  title: z.ZodString;
208
244
  description: z.ZodOptional<z.ZodString>;
245
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
209
246
  errorMessage: z.ZodOptional<z.ZodString>;
247
+ type: z.ZodLiteral<"nested_selection">;
210
248
  placeholder: z.ZodOptional<z.ZodString>;
211
249
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
212
- type: z.ZodLiteral<"annotation">;
213
250
  title: z.ZodString;
214
251
  description: z.ZodOptional<z.ZodString>;
252
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
215
253
  errorMessage: z.ZodOptional<z.ZodString>;
254
+ type: z.ZodLiteral<"annotation">;
216
255
  annotationText: z.ZodOptional<z.ZodString>;
217
256
  noAnnotationText: z.ZodOptional<z.ZodString>;
218
257
  }, z.core.$strip>]>>>;
219
258
  export declare const translationsSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
220
- type: z.ZodLiteral<"rating">;
221
259
  title: z.ZodString;
222
260
  description: z.ZodOptional<z.ZodString>;
261
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
223
262
  errorMessage: z.ZodOptional<z.ZodString>;
263
+ type: z.ZodLiteral<"rating">;
224
264
  minLabel: z.ZodOptional<z.ZodString>;
225
265
  maxLabel: z.ZodOptional<z.ZodString>;
226
266
  }, z.core.$strip>, z.ZodObject<{
227
- type: z.ZodLiteral<"single_choice">;
228
267
  title: z.ZodString;
229
268
  description: z.ZodOptional<z.ZodString>;
269
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
230
270
  errorMessage: z.ZodOptional<z.ZodString>;
271
+ type: z.ZodLiteral<"single_choice">;
231
272
  placeholder: z.ZodOptional<z.ZodString>;
232
273
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
233
- type: z.ZodLiteral<"multiple_choice_multiple">;
234
274
  title: z.ZodString;
235
275
  description: z.ZodOptional<z.ZodString>;
276
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
236
277
  errorMessage: z.ZodOptional<z.ZodString>;
278
+ type: z.ZodLiteral<"multiple_choice_multiple">;
237
279
  placeholder: z.ZodOptional<z.ZodString>;
238
280
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
239
- type: z.ZodLiteral<"nps">;
240
281
  title: z.ZodString;
241
282
  description: z.ZodOptional<z.ZodString>;
283
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
242
284
  errorMessage: z.ZodOptional<z.ZodString>;
285
+ type: z.ZodLiteral<"nps">;
243
286
  minLabel: z.ZodOptional<z.ZodString>;
244
287
  maxLabel: z.ZodOptional<z.ZodString>;
245
288
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
246
- type: z.ZodLiteral<"short_answer">;
247
289
  title: z.ZodString;
248
290
  description: z.ZodOptional<z.ZodString>;
291
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
249
292
  errorMessage: z.ZodOptional<z.ZodString>;
293
+ type: z.ZodLiteral<"short_answer">;
250
294
  placeholder: z.ZodOptional<z.ZodString>;
251
295
  }, z.core.$strip>, z.ZodObject<{
252
- type: z.ZodLiteral<"long_text">;
253
296
  title: z.ZodString;
254
297
  description: z.ZodOptional<z.ZodString>;
298
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
255
299
  errorMessage: z.ZodOptional<z.ZodString>;
300
+ type: z.ZodLiteral<"long_text">;
256
301
  placeholder: z.ZodOptional<z.ZodString>;
257
302
  }, z.core.$strip>, z.ZodObject<{
258
- type: z.ZodLiteral<"nested_selection">;
259
303
  title: z.ZodString;
260
304
  description: z.ZodOptional<z.ZodString>;
305
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
261
306
  errorMessage: z.ZodOptional<z.ZodString>;
307
+ type: z.ZodLiteral<"nested_selection">;
262
308
  placeholder: z.ZodOptional<z.ZodString>;
263
309
  }, z.core.$catchall<z.ZodString>>, z.ZodObject<{
264
- type: z.ZodLiteral<"annotation">;
265
310
  title: z.ZodString;
266
311
  description: z.ZodOptional<z.ZodString>;
312
+ descriptionMarkdown: z.ZodOptional<z.ZodString>;
267
313
  errorMessage: z.ZodOptional<z.ZodString>;
314
+ type: z.ZodLiteral<"annotation">;
268
315
  annotationText: z.ZodOptional<z.ZodString>;
269
316
  noAnnotationText: z.ZodOptional<z.ZodString>;
270
317
  }, z.core.$strip>]>>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@encatch/schema",
3
- "version": "1.0.0-beta.1",
3
+ "version": "1.0.1-beta.0",
4
4
  "description": "TypeScript schema definitions using Zod for validation and type inference of encatch product",
5
5
  "homepage": "https://encatch.com",
6
6
  "type": "module",