@contentful/experiences-validators 1.9.0-dev-20240628T2235-7a4f71f.0 → 1.9.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.
- package/dist/index.cjs +402 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +657 -0
- package/dist/index.js +396 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +589 -0
- package/package.json +2 -2
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,657 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
|
|
3
|
+
declare const DataSourceSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
4
|
+
sys: z.ZodObject<{
|
|
5
|
+
type: z.ZodLiteral<"Link">;
|
|
6
|
+
id: z.ZodString;
|
|
7
|
+
linkType: z.ZodEnum<["Entry", "Asset"]>;
|
|
8
|
+
}, "strip", z.ZodTypeAny, {
|
|
9
|
+
type: "Link";
|
|
10
|
+
id: string;
|
|
11
|
+
linkType: "Entry" | "Asset";
|
|
12
|
+
}, {
|
|
13
|
+
type: "Link";
|
|
14
|
+
id: string;
|
|
15
|
+
linkType: "Entry" | "Asset";
|
|
16
|
+
}>;
|
|
17
|
+
}, "strip", z.ZodTypeAny, {
|
|
18
|
+
sys: {
|
|
19
|
+
type: "Link";
|
|
20
|
+
id: string;
|
|
21
|
+
linkType: "Entry" | "Asset";
|
|
22
|
+
};
|
|
23
|
+
}, {
|
|
24
|
+
sys: {
|
|
25
|
+
type: "Link";
|
|
26
|
+
id: string;
|
|
27
|
+
linkType: "Entry" | "Asset";
|
|
28
|
+
};
|
|
29
|
+
}>>;
|
|
30
|
+
declare const PrimitiveValueSchema: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
|
|
31
|
+
declare const ValuesByBreakpointSchema: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
|
|
32
|
+
declare const DesignValueSchema: z.ZodObject<{
|
|
33
|
+
type: z.ZodLiteral<"DesignValue">;
|
|
34
|
+
valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
|
|
35
|
+
}, "strict", z.ZodTypeAny, {
|
|
36
|
+
type: "DesignValue";
|
|
37
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
38
|
+
}, {
|
|
39
|
+
type: "DesignValue";
|
|
40
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
41
|
+
}>;
|
|
42
|
+
declare const BoundValueSchema: z.ZodObject<{
|
|
43
|
+
type: z.ZodLiteral<"BoundValue">;
|
|
44
|
+
path: z.ZodString;
|
|
45
|
+
}, "strict", z.ZodTypeAny, {
|
|
46
|
+
path: string;
|
|
47
|
+
type: "BoundValue";
|
|
48
|
+
}, {
|
|
49
|
+
path: string;
|
|
50
|
+
type: "BoundValue";
|
|
51
|
+
}>;
|
|
52
|
+
declare const UnboundValueSchema: z.ZodObject<{
|
|
53
|
+
type: z.ZodLiteral<"UnboundValue">;
|
|
54
|
+
key: z.ZodString;
|
|
55
|
+
}, "strict", z.ZodTypeAny, {
|
|
56
|
+
type: "UnboundValue";
|
|
57
|
+
key: string;
|
|
58
|
+
}, {
|
|
59
|
+
type: "UnboundValue";
|
|
60
|
+
key: string;
|
|
61
|
+
}>;
|
|
62
|
+
declare const ComponentValueSchema: z.ZodObject<{
|
|
63
|
+
type: z.ZodLiteral<"ComponentValue">;
|
|
64
|
+
key: z.ZodString;
|
|
65
|
+
}, "strict", z.ZodTypeAny, {
|
|
66
|
+
type: "ComponentValue";
|
|
67
|
+
key: string;
|
|
68
|
+
}, {
|
|
69
|
+
type: "ComponentValue";
|
|
70
|
+
key: string;
|
|
71
|
+
}>;
|
|
72
|
+
declare const ComponentPropertyValueSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
|
|
73
|
+
type: z.ZodLiteral<"DesignValue">;
|
|
74
|
+
valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
|
|
75
|
+
}, "strict", z.ZodTypeAny, {
|
|
76
|
+
type: "DesignValue";
|
|
77
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
78
|
+
}, {
|
|
79
|
+
type: "DesignValue";
|
|
80
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
81
|
+
}>, z.ZodObject<{
|
|
82
|
+
type: z.ZodLiteral<"BoundValue">;
|
|
83
|
+
path: z.ZodString;
|
|
84
|
+
}, "strict", z.ZodTypeAny, {
|
|
85
|
+
path: string;
|
|
86
|
+
type: "BoundValue";
|
|
87
|
+
}, {
|
|
88
|
+
path: string;
|
|
89
|
+
type: "BoundValue";
|
|
90
|
+
}>, z.ZodObject<{
|
|
91
|
+
type: z.ZodLiteral<"UnboundValue">;
|
|
92
|
+
key: z.ZodString;
|
|
93
|
+
}, "strict", z.ZodTypeAny, {
|
|
94
|
+
type: "UnboundValue";
|
|
95
|
+
key: string;
|
|
96
|
+
}, {
|
|
97
|
+
type: "UnboundValue";
|
|
98
|
+
key: string;
|
|
99
|
+
}>, z.ZodObject<{
|
|
100
|
+
type: z.ZodLiteral<"HyperlinkValue">;
|
|
101
|
+
linkTargetKey: z.ZodString;
|
|
102
|
+
overrides: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
|
|
103
|
+
}, "strict", z.ZodTypeAny, {
|
|
104
|
+
type: "HyperlinkValue";
|
|
105
|
+
linkTargetKey: string;
|
|
106
|
+
overrides?: {} | undefined;
|
|
107
|
+
}, {
|
|
108
|
+
type: "HyperlinkValue";
|
|
109
|
+
linkTargetKey: string;
|
|
110
|
+
overrides?: {} | undefined;
|
|
111
|
+
}>, z.ZodObject<{
|
|
112
|
+
type: z.ZodLiteral<"ComponentValue">;
|
|
113
|
+
key: z.ZodString;
|
|
114
|
+
}, "strict", z.ZodTypeAny, {
|
|
115
|
+
type: "ComponentValue";
|
|
116
|
+
key: string;
|
|
117
|
+
}, {
|
|
118
|
+
type: "ComponentValue";
|
|
119
|
+
key: string;
|
|
120
|
+
}>]>;
|
|
121
|
+
type ComponentPropertyValue = z.infer<typeof ComponentPropertyValueSchema>;
|
|
122
|
+
declare const BreakpointSchema: z.ZodObject<{
|
|
123
|
+
id: z.ZodString;
|
|
124
|
+
query: z.ZodString;
|
|
125
|
+
previewSize: z.ZodString;
|
|
126
|
+
displayName: z.ZodString;
|
|
127
|
+
displayIcon: z.ZodOptional<z.ZodEnum<["desktop", "tablet", "mobile"]>>;
|
|
128
|
+
}, "strict", z.ZodTypeAny, {
|
|
129
|
+
id: string;
|
|
130
|
+
displayName: string;
|
|
131
|
+
query: string;
|
|
132
|
+
previewSize: string;
|
|
133
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
134
|
+
}, {
|
|
135
|
+
id: string;
|
|
136
|
+
displayName: string;
|
|
137
|
+
query: string;
|
|
138
|
+
previewSize: string;
|
|
139
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
140
|
+
}>;
|
|
141
|
+
declare const UnboundValuesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
142
|
+
value: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
|
|
143
|
+
}, "strip", z.ZodTypeAny, {
|
|
144
|
+
value?: string | number | boolean | Record<any, any> | undefined;
|
|
145
|
+
}, {
|
|
146
|
+
value?: string | number | boolean | Record<any, any> | undefined;
|
|
147
|
+
}>>;
|
|
148
|
+
declare const BaseComponentTreeNodeSchema: z.ZodObject<{
|
|
149
|
+
definitionId: z.ZodString;
|
|
150
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
151
|
+
slotId: z.ZodOptional<z.ZodString>;
|
|
152
|
+
variables: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
|
|
153
|
+
type: z.ZodLiteral<"DesignValue">;
|
|
154
|
+
valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
|
|
155
|
+
}, "strict", z.ZodTypeAny, {
|
|
156
|
+
type: "DesignValue";
|
|
157
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
158
|
+
}, {
|
|
159
|
+
type: "DesignValue";
|
|
160
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
161
|
+
}>, z.ZodObject<{
|
|
162
|
+
type: z.ZodLiteral<"BoundValue">;
|
|
163
|
+
path: z.ZodString;
|
|
164
|
+
}, "strict", z.ZodTypeAny, {
|
|
165
|
+
path: string;
|
|
166
|
+
type: "BoundValue";
|
|
167
|
+
}, {
|
|
168
|
+
path: string;
|
|
169
|
+
type: "BoundValue";
|
|
170
|
+
}>, z.ZodObject<{
|
|
171
|
+
type: z.ZodLiteral<"UnboundValue">;
|
|
172
|
+
key: z.ZodString;
|
|
173
|
+
}, "strict", z.ZodTypeAny, {
|
|
174
|
+
type: "UnboundValue";
|
|
175
|
+
key: string;
|
|
176
|
+
}, {
|
|
177
|
+
type: "UnboundValue";
|
|
178
|
+
key: string;
|
|
179
|
+
}>, z.ZodObject<{
|
|
180
|
+
type: z.ZodLiteral<"HyperlinkValue">;
|
|
181
|
+
linkTargetKey: z.ZodString;
|
|
182
|
+
overrides: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
|
|
183
|
+
}, "strict", z.ZodTypeAny, {
|
|
184
|
+
type: "HyperlinkValue";
|
|
185
|
+
linkTargetKey: string;
|
|
186
|
+
overrides?: {} | undefined;
|
|
187
|
+
}, {
|
|
188
|
+
type: "HyperlinkValue";
|
|
189
|
+
linkTargetKey: string;
|
|
190
|
+
overrides?: {} | undefined;
|
|
191
|
+
}>, z.ZodObject<{
|
|
192
|
+
type: z.ZodLiteral<"ComponentValue">;
|
|
193
|
+
key: z.ZodString;
|
|
194
|
+
}, "strict", z.ZodTypeAny, {
|
|
195
|
+
type: "ComponentValue";
|
|
196
|
+
key: string;
|
|
197
|
+
}, {
|
|
198
|
+
type: "ComponentValue";
|
|
199
|
+
key: string;
|
|
200
|
+
}>]>>;
|
|
201
|
+
}, "strip", z.ZodTypeAny, {
|
|
202
|
+
variables: Record<string, {
|
|
203
|
+
type: "DesignValue";
|
|
204
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
205
|
+
} | {
|
|
206
|
+
path: string;
|
|
207
|
+
type: "BoundValue";
|
|
208
|
+
} | {
|
|
209
|
+
type: "HyperlinkValue";
|
|
210
|
+
linkTargetKey: string;
|
|
211
|
+
overrides?: {} | undefined;
|
|
212
|
+
} | {
|
|
213
|
+
type: "UnboundValue";
|
|
214
|
+
key: string;
|
|
215
|
+
} | {
|
|
216
|
+
type: "ComponentValue";
|
|
217
|
+
key: string;
|
|
218
|
+
}>;
|
|
219
|
+
definitionId: string;
|
|
220
|
+
displayName?: string | undefined;
|
|
221
|
+
slotId?: string | undefined;
|
|
222
|
+
}, {
|
|
223
|
+
variables: Record<string, {
|
|
224
|
+
type: "DesignValue";
|
|
225
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
226
|
+
} | {
|
|
227
|
+
path: string;
|
|
228
|
+
type: "BoundValue";
|
|
229
|
+
} | {
|
|
230
|
+
type: "HyperlinkValue";
|
|
231
|
+
linkTargetKey: string;
|
|
232
|
+
overrides?: {} | undefined;
|
|
233
|
+
} | {
|
|
234
|
+
type: "UnboundValue";
|
|
235
|
+
key: string;
|
|
236
|
+
} | {
|
|
237
|
+
type: "ComponentValue";
|
|
238
|
+
key: string;
|
|
239
|
+
}>;
|
|
240
|
+
definitionId: string;
|
|
241
|
+
displayName?: string | undefined;
|
|
242
|
+
slotId?: string | undefined;
|
|
243
|
+
}>;
|
|
244
|
+
type ComponentTreeNode = z.infer<typeof BaseComponentTreeNodeSchema> & {
|
|
245
|
+
children: ComponentTreeNode[];
|
|
246
|
+
};
|
|
247
|
+
declare const ComponentSettingsSchema: z.ZodObject<{
|
|
248
|
+
variableDefinitions: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
249
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
250
|
+
type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink"]>;
|
|
251
|
+
defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
|
|
252
|
+
type: z.ZodLiteral<"DesignValue">;
|
|
253
|
+
valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
|
|
254
|
+
}, "strict", z.ZodTypeAny, {
|
|
255
|
+
type: "DesignValue";
|
|
256
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
257
|
+
}, {
|
|
258
|
+
type: "DesignValue";
|
|
259
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
260
|
+
}>, z.ZodObject<{
|
|
261
|
+
type: z.ZodLiteral<"BoundValue">;
|
|
262
|
+
path: z.ZodString;
|
|
263
|
+
}, "strict", z.ZodTypeAny, {
|
|
264
|
+
path: string;
|
|
265
|
+
type: "BoundValue";
|
|
266
|
+
}, {
|
|
267
|
+
path: string;
|
|
268
|
+
type: "BoundValue";
|
|
269
|
+
}>, z.ZodObject<{
|
|
270
|
+
type: z.ZodLiteral<"UnboundValue">;
|
|
271
|
+
key: z.ZodString;
|
|
272
|
+
}, "strict", z.ZodTypeAny, {
|
|
273
|
+
type: "UnboundValue";
|
|
274
|
+
key: string;
|
|
275
|
+
}, {
|
|
276
|
+
type: "UnboundValue";
|
|
277
|
+
key: string;
|
|
278
|
+
}>, z.ZodObject<{
|
|
279
|
+
type: z.ZodLiteral<"HyperlinkValue">;
|
|
280
|
+
linkTargetKey: z.ZodString;
|
|
281
|
+
overrides: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
|
|
282
|
+
}, "strict", z.ZodTypeAny, {
|
|
283
|
+
type: "HyperlinkValue";
|
|
284
|
+
linkTargetKey: string;
|
|
285
|
+
overrides?: {} | undefined;
|
|
286
|
+
}, {
|
|
287
|
+
type: "HyperlinkValue";
|
|
288
|
+
linkTargetKey: string;
|
|
289
|
+
overrides?: {} | undefined;
|
|
290
|
+
}>, z.ZodObject<{
|
|
291
|
+
type: z.ZodLiteral<"ComponentValue">;
|
|
292
|
+
key: z.ZodString;
|
|
293
|
+
}, "strict", z.ZodTypeAny, {
|
|
294
|
+
type: "ComponentValue";
|
|
295
|
+
key: string;
|
|
296
|
+
}, {
|
|
297
|
+
type: "ComponentValue";
|
|
298
|
+
key: string;
|
|
299
|
+
}>]>]>>;
|
|
300
|
+
description: z.ZodOptional<z.ZodString>;
|
|
301
|
+
group: z.ZodOptional<z.ZodString>;
|
|
302
|
+
validations: z.ZodOptional<z.ZodObject<{
|
|
303
|
+
required: z.ZodOptional<z.ZodBoolean>;
|
|
304
|
+
format: z.ZodOptional<z.ZodLiteral<"URL">>;
|
|
305
|
+
in: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
306
|
+
value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
|
|
307
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
308
|
+
}, "strip", z.ZodTypeAny, {
|
|
309
|
+
value: string | number;
|
|
310
|
+
displayName?: string | undefined;
|
|
311
|
+
}, {
|
|
312
|
+
value: string | number;
|
|
313
|
+
displayName?: string | undefined;
|
|
314
|
+
}>, "many">>;
|
|
315
|
+
}, "strip", z.ZodTypeAny, {
|
|
316
|
+
required?: boolean | undefined;
|
|
317
|
+
format?: "URL" | undefined;
|
|
318
|
+
in?: {
|
|
319
|
+
value: string | number;
|
|
320
|
+
displayName?: string | undefined;
|
|
321
|
+
}[] | undefined;
|
|
322
|
+
}, {
|
|
323
|
+
required?: boolean | undefined;
|
|
324
|
+
format?: "URL" | undefined;
|
|
325
|
+
in?: {
|
|
326
|
+
value: string | number;
|
|
327
|
+
displayName?: string | undefined;
|
|
328
|
+
}[] | undefined;
|
|
329
|
+
}>>;
|
|
330
|
+
}, "strip", z.ZodTypeAny, {
|
|
331
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
332
|
+
displayName?: string | undefined;
|
|
333
|
+
description?: string | undefined;
|
|
334
|
+
group?: string | undefined;
|
|
335
|
+
defaultValue?: string | number | boolean | Record<any, any> | {
|
|
336
|
+
type: "DesignValue";
|
|
337
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
338
|
+
} | {
|
|
339
|
+
path: string;
|
|
340
|
+
type: "BoundValue";
|
|
341
|
+
} | {
|
|
342
|
+
type: "HyperlinkValue";
|
|
343
|
+
linkTargetKey: string;
|
|
344
|
+
overrides?: {} | undefined;
|
|
345
|
+
} | {
|
|
346
|
+
type: "UnboundValue";
|
|
347
|
+
key: string;
|
|
348
|
+
} | {
|
|
349
|
+
type: "ComponentValue";
|
|
350
|
+
key: string;
|
|
351
|
+
} | undefined;
|
|
352
|
+
validations?: {
|
|
353
|
+
required?: boolean | undefined;
|
|
354
|
+
format?: "URL" | undefined;
|
|
355
|
+
in?: {
|
|
356
|
+
value: string | number;
|
|
357
|
+
displayName?: string | undefined;
|
|
358
|
+
}[] | undefined;
|
|
359
|
+
} | undefined;
|
|
360
|
+
}, {
|
|
361
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
362
|
+
displayName?: string | undefined;
|
|
363
|
+
description?: string | undefined;
|
|
364
|
+
group?: string | undefined;
|
|
365
|
+
defaultValue?: string | number | boolean | Record<any, any> | {
|
|
366
|
+
type: "DesignValue";
|
|
367
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
368
|
+
} | {
|
|
369
|
+
path: string;
|
|
370
|
+
type: "BoundValue";
|
|
371
|
+
} | {
|
|
372
|
+
type: "HyperlinkValue";
|
|
373
|
+
linkTargetKey: string;
|
|
374
|
+
overrides?: {} | undefined;
|
|
375
|
+
} | {
|
|
376
|
+
type: "UnboundValue";
|
|
377
|
+
key: string;
|
|
378
|
+
} | {
|
|
379
|
+
type: "ComponentValue";
|
|
380
|
+
key: string;
|
|
381
|
+
} | undefined;
|
|
382
|
+
validations?: {
|
|
383
|
+
required?: boolean | undefined;
|
|
384
|
+
format?: "URL" | undefined;
|
|
385
|
+
in?: {
|
|
386
|
+
value: string | number;
|
|
387
|
+
displayName?: string | undefined;
|
|
388
|
+
}[] | undefined;
|
|
389
|
+
} | undefined;
|
|
390
|
+
}>>;
|
|
391
|
+
}, "strip", z.ZodTypeAny, {
|
|
392
|
+
variableDefinitions: Record<string, {
|
|
393
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
394
|
+
displayName?: string | undefined;
|
|
395
|
+
description?: string | undefined;
|
|
396
|
+
group?: string | undefined;
|
|
397
|
+
defaultValue?: string | number | boolean | Record<any, any> | {
|
|
398
|
+
type: "DesignValue";
|
|
399
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
400
|
+
} | {
|
|
401
|
+
path: string;
|
|
402
|
+
type: "BoundValue";
|
|
403
|
+
} | {
|
|
404
|
+
type: "HyperlinkValue";
|
|
405
|
+
linkTargetKey: string;
|
|
406
|
+
overrides?: {} | undefined;
|
|
407
|
+
} | {
|
|
408
|
+
type: "UnboundValue";
|
|
409
|
+
key: string;
|
|
410
|
+
} | {
|
|
411
|
+
type: "ComponentValue";
|
|
412
|
+
key: string;
|
|
413
|
+
} | undefined;
|
|
414
|
+
validations?: {
|
|
415
|
+
required?: boolean | undefined;
|
|
416
|
+
format?: "URL" | undefined;
|
|
417
|
+
in?: {
|
|
418
|
+
value: string | number;
|
|
419
|
+
displayName?: string | undefined;
|
|
420
|
+
}[] | undefined;
|
|
421
|
+
} | undefined;
|
|
422
|
+
}>;
|
|
423
|
+
}, {
|
|
424
|
+
variableDefinitions: Record<string, {
|
|
425
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
426
|
+
displayName?: string | undefined;
|
|
427
|
+
description?: string | undefined;
|
|
428
|
+
group?: string | undefined;
|
|
429
|
+
defaultValue?: string | number | boolean | Record<any, any> | {
|
|
430
|
+
type: "DesignValue";
|
|
431
|
+
valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
|
|
432
|
+
} | {
|
|
433
|
+
path: string;
|
|
434
|
+
type: "BoundValue";
|
|
435
|
+
} | {
|
|
436
|
+
type: "HyperlinkValue";
|
|
437
|
+
linkTargetKey: string;
|
|
438
|
+
overrides?: {} | undefined;
|
|
439
|
+
} | {
|
|
440
|
+
type: "UnboundValue";
|
|
441
|
+
key: string;
|
|
442
|
+
} | {
|
|
443
|
+
type: "ComponentValue";
|
|
444
|
+
key: string;
|
|
445
|
+
} | undefined;
|
|
446
|
+
validations?: {
|
|
447
|
+
required?: boolean | undefined;
|
|
448
|
+
format?: "URL" | undefined;
|
|
449
|
+
in?: {
|
|
450
|
+
value: string | number;
|
|
451
|
+
displayName?: string | undefined;
|
|
452
|
+
}[] | undefined;
|
|
453
|
+
} | undefined;
|
|
454
|
+
}>;
|
|
455
|
+
}>;
|
|
456
|
+
declare const UsedComponentsSchema: z.ZodArray<z.ZodObject<{
|
|
457
|
+
sys: z.ZodObject<{
|
|
458
|
+
type: z.ZodLiteral<"Link">;
|
|
459
|
+
id: z.ZodString;
|
|
460
|
+
linkType: z.ZodLiteral<"Entry">;
|
|
461
|
+
}, "strip", z.ZodTypeAny, {
|
|
462
|
+
type: "Link";
|
|
463
|
+
id: string;
|
|
464
|
+
linkType: "Entry";
|
|
465
|
+
}, {
|
|
466
|
+
type: "Link";
|
|
467
|
+
id: string;
|
|
468
|
+
linkType: "Entry";
|
|
469
|
+
}>;
|
|
470
|
+
}, "strip", z.ZodTypeAny, {
|
|
471
|
+
sys: {
|
|
472
|
+
type: "Link";
|
|
473
|
+
id: string;
|
|
474
|
+
linkType: "Entry";
|
|
475
|
+
};
|
|
476
|
+
}, {
|
|
477
|
+
sys: {
|
|
478
|
+
type: "Link";
|
|
479
|
+
id: string;
|
|
480
|
+
linkType: "Entry";
|
|
481
|
+
};
|
|
482
|
+
}>, "many">;
|
|
483
|
+
declare const ComponentTreeSchema: z.ZodObject<{
|
|
484
|
+
breakpoints: z.ZodEffects<z.ZodArray<z.ZodObject<{
|
|
485
|
+
id: z.ZodString;
|
|
486
|
+
query: z.ZodString;
|
|
487
|
+
previewSize: z.ZodString;
|
|
488
|
+
displayName: z.ZodString;
|
|
489
|
+
displayIcon: z.ZodOptional<z.ZodEnum<["desktop", "tablet", "mobile"]>>;
|
|
490
|
+
}, "strict", z.ZodTypeAny, {
|
|
491
|
+
id: string;
|
|
492
|
+
displayName: string;
|
|
493
|
+
query: string;
|
|
494
|
+
previewSize: string;
|
|
495
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
496
|
+
}, {
|
|
497
|
+
id: string;
|
|
498
|
+
displayName: string;
|
|
499
|
+
query: string;
|
|
500
|
+
previewSize: string;
|
|
501
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
502
|
+
}>, "many">, {
|
|
503
|
+
id: string;
|
|
504
|
+
displayName: string;
|
|
505
|
+
query: string;
|
|
506
|
+
previewSize: string;
|
|
507
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
508
|
+
}[], {
|
|
509
|
+
id: string;
|
|
510
|
+
displayName: string;
|
|
511
|
+
query: string;
|
|
512
|
+
previewSize: string;
|
|
513
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
514
|
+
}[]>;
|
|
515
|
+
children: z.ZodArray<z.ZodType<ComponentTreeNode, z.ZodTypeDef, ComponentTreeNode>, "many">;
|
|
516
|
+
schemaVersion: z.ZodLiteral<"2023-09-28">;
|
|
517
|
+
}, "strict", z.ZodTypeAny, {
|
|
518
|
+
children: ComponentTreeNode[];
|
|
519
|
+
breakpoints: {
|
|
520
|
+
id: string;
|
|
521
|
+
displayName: string;
|
|
522
|
+
query: string;
|
|
523
|
+
previewSize: string;
|
|
524
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
525
|
+
}[];
|
|
526
|
+
schemaVersion: "2023-09-28";
|
|
527
|
+
}, {
|
|
528
|
+
children: ComponentTreeNode[];
|
|
529
|
+
breakpoints: {
|
|
530
|
+
id: string;
|
|
531
|
+
displayName: string;
|
|
532
|
+
query: string;
|
|
533
|
+
previewSize: string;
|
|
534
|
+
displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
|
|
535
|
+
}[];
|
|
536
|
+
schemaVersion: "2023-09-28";
|
|
537
|
+
}>;
|
|
538
|
+
declare const ExperienceFieldsCMAShapeSchema: z.ZodEffects<z.ZodObject<{
|
|
539
|
+
componentTree: z.ZodRecord<z.ZodString, any>;
|
|
540
|
+
dataSource: z.ZodRecord<z.ZodString, any>;
|
|
541
|
+
unboundValues: z.ZodRecord<z.ZodString, any>;
|
|
542
|
+
usedComponents: z.ZodOptional<z.ZodRecord<z.ZodString, any>>;
|
|
543
|
+
componentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, any>>;
|
|
544
|
+
}, "strip", z.ZodTypeAny, {
|
|
545
|
+
componentTree: Record<string, any>;
|
|
546
|
+
dataSource: Record<string, any>;
|
|
547
|
+
unboundValues: Record<string, any>;
|
|
548
|
+
usedComponents?: Record<string, any> | undefined;
|
|
549
|
+
componentSettings?: Record<string, any> | undefined;
|
|
550
|
+
}, {
|
|
551
|
+
componentTree: Record<string, any>;
|
|
552
|
+
dataSource: Record<string, any>;
|
|
553
|
+
unboundValues: Record<string, any>;
|
|
554
|
+
usedComponents?: Record<string, any> | undefined;
|
|
555
|
+
componentSettings?: Record<string, any> | undefined;
|
|
556
|
+
}>, {
|
|
557
|
+
componentTree: Record<string, any>;
|
|
558
|
+
dataSource: Record<string, any>;
|
|
559
|
+
unboundValues: Record<string, any>;
|
|
560
|
+
usedComponents?: Record<string, any> | undefined;
|
|
561
|
+
componentSettings?: Record<string, any> | undefined;
|
|
562
|
+
}, {
|
|
563
|
+
componentTree: Record<string, any>;
|
|
564
|
+
dataSource: Record<string, any>;
|
|
565
|
+
unboundValues: Record<string, any>;
|
|
566
|
+
usedComponents?: Record<string, any> | undefined;
|
|
567
|
+
componentSettings?: Record<string, any> | undefined;
|
|
568
|
+
}>;
|
|
569
|
+
type ExperienceFields = z.infer<typeof ExperienceFieldsCMAShapeSchema>;
|
|
570
|
+
type ExperienceDataSource = z.infer<typeof DataSourceSchema>;
|
|
571
|
+
type ExperienceUnboundValues = z.infer<typeof UnboundValuesSchema>;
|
|
572
|
+
type ExperienceUsedComponents = z.infer<typeof UsedComponentsSchema>;
|
|
573
|
+
type ExperienceComponentSettings = z.infer<typeof ComponentSettingsSchema>;
|
|
574
|
+
type ExperienceComponentTree = z.infer<typeof ComponentTreeSchema>;
|
|
575
|
+
type ValuesByBreakpoint = z.infer<typeof ValuesByBreakpointSchema>;
|
|
576
|
+
type Breakpoint = z.infer<typeof BreakpointSchema>;
|
|
577
|
+
type PrimitiveValue = z.infer<typeof PrimitiveValueSchema>;
|
|
578
|
+
type DesignValue = z.infer<typeof DesignValueSchema>;
|
|
579
|
+
type BoundValue = z.infer<typeof BoundValueSchema>;
|
|
580
|
+
type UnboundValue = z.infer<typeof UnboundValueSchema>;
|
|
581
|
+
type ComponentValue = z.infer<typeof ComponentValueSchema>;
|
|
582
|
+
|
|
583
|
+
declare const DefinitionPropertyTypeSchema: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink"]>;
|
|
584
|
+
declare const ComponentDefinitionSchema: z.ZodObject<{
|
|
585
|
+
id: z.ZodString;
|
|
586
|
+
variables: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
587
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
588
|
+
type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink"]>;
|
|
589
|
+
description: z.ZodOptional<z.ZodString>;
|
|
590
|
+
group: z.ZodOptional<z.ZodString>;
|
|
591
|
+
}, "strip", z.ZodTypeAny, {
|
|
592
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
593
|
+
displayName?: string | undefined;
|
|
594
|
+
description?: string | undefined;
|
|
595
|
+
group?: string | undefined;
|
|
596
|
+
}, {
|
|
597
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
598
|
+
displayName?: string | undefined;
|
|
599
|
+
description?: string | undefined;
|
|
600
|
+
group?: string | undefined;
|
|
601
|
+
}>>;
|
|
602
|
+
}, "strip", z.ZodTypeAny, {
|
|
603
|
+
id: string;
|
|
604
|
+
variables: Record<string, {
|
|
605
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
606
|
+
displayName?: string | undefined;
|
|
607
|
+
description?: string | undefined;
|
|
608
|
+
group?: string | undefined;
|
|
609
|
+
}>;
|
|
610
|
+
}, {
|
|
611
|
+
id: string;
|
|
612
|
+
variables: Record<string, {
|
|
613
|
+
type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink";
|
|
614
|
+
displayName?: string | undefined;
|
|
615
|
+
description?: string | undefined;
|
|
616
|
+
group?: string | undefined;
|
|
617
|
+
}>;
|
|
618
|
+
}>;
|
|
619
|
+
type ComponentDefinitionPropertyType = z.infer<typeof DefinitionPropertyTypeSchema>;
|
|
620
|
+
|
|
621
|
+
declare const SchemaVersions: z.ZodLiteral<"2023-09-28">;
|
|
622
|
+
type SchemaVersions = z.infer<typeof SchemaVersions>;
|
|
623
|
+
|
|
624
|
+
declare enum CodeNames {
|
|
625
|
+
Type = "type",
|
|
626
|
+
Required = "required",
|
|
627
|
+
Unexpected = "unexpected",
|
|
628
|
+
Regex = "regex",
|
|
629
|
+
In = "in",
|
|
630
|
+
Size = "size",
|
|
631
|
+
Custom = "custom"
|
|
632
|
+
}
|
|
633
|
+
type ContentfulErrorDetails = {
|
|
634
|
+
details: string;
|
|
635
|
+
min?: number | bigint;
|
|
636
|
+
max?: number | bigint;
|
|
637
|
+
name: (typeof CodeNames)[keyof typeof CodeNames];
|
|
638
|
+
path: (string | number)[];
|
|
639
|
+
value?: string;
|
|
640
|
+
expected?: (string | number)[];
|
|
641
|
+
};
|
|
642
|
+
|
|
643
|
+
type ValidatorReturnValue = {
|
|
644
|
+
success: boolean;
|
|
645
|
+
errors?: ContentfulErrorDetails[];
|
|
646
|
+
};
|
|
647
|
+
/**
|
|
648
|
+
*
|
|
649
|
+
* @param experience The experience entry to validate
|
|
650
|
+
* @param schemaVersionOverride Optional override for the schema version to validate against. By default the schema version is read from the experience entry
|
|
651
|
+
* @returns object with success property and optional errors array
|
|
652
|
+
*/
|
|
653
|
+
declare const validateExperienceFields: (experience: any, schemaVersionOverride?: SchemaVersions) => ValidatorReturnValue;
|
|
654
|
+
declare const validateComponentDefinition: (definition: any) => ValidatorReturnValue;
|
|
655
|
+
declare const validateBreakpointsDefinition: (breakpoints: any) => ValidatorReturnValue;
|
|
656
|
+
|
|
657
|
+
export { type BoundValue, type Breakpoint, type ComponentDefinitionPropertyType, ComponentDefinitionSchema, type ComponentPropertyValue, type ComponentTreeNode, type ComponentValue, type DesignValue, type ExperienceComponentSettings, type ExperienceComponentTree, type ExperienceDataSource, type ExperienceFields, type ExperienceUnboundValues, type ExperienceUsedComponents, type PrimitiveValue, SchemaVersions, ExperienceFieldsCMAShapeSchema as Schema_2023_09_28, type UnboundValue, type ValuesByBreakpoint, validateBreakpointsDefinition, validateComponentDefinition, validateExperienceFields };
|