@contentful/experiences-validators 1.11.0-prerelease-20240723T1849-cedcf84.0 → 1.11.0-prerelease-20240726T1510-9e11672.0

package/dist/index.d.ts

@@ -1,61 +1,7 @@
 import { z } from 'zod';
 
-declare const PrimitiveValueSchema: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
 declare const DefinitionPropertyTypeSchema: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink", "Array", "Link"]>;
-declare const ComponentDefinitionSchema: z.ZodObject<{
-    id: z.ZodString;
-    variables: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
-        displayName: z.ZodOptional<z.ZodString>;
-        type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink", "Array", "Link"]>;
-        description: z.ZodOptional<z.ZodString>;
-        group: z.ZodOptional<z.ZodString>;
-        defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>;
-    }, "strip", z.ZodTypeAny, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }>, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    variables: Record<string, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }>;
-}, {
-    id: string;
-    variables: Record<string, {
-        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
-        displayName?: string | undefined;
-        description?: string | undefined;
-        group?: string | undefined;
-        defaultValue?: string | number | boolean | Record<any, any> | undefined;
-    }>;
-}>;
-type ComponentDefinitionPropertyType = z.infer<typeof DefinitionPropertyTypeSchema>;
-
+declare const PrimitiveValueSchema: z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>;
 declare const DataSourceSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     sys: z.ZodObject<{
         type: z.ZodLiteral<"Link">;
@@ -182,15 +128,15 @@ declare const BreakpointSchema: z.ZodObject<{
     displayIcon: z.ZodOptional<z.ZodEnum<["desktop", "tablet", "mobile"]>>;
 }, "strict", z.ZodTypeAny, {
     id: string;
-    displayName: string;
     query: string;
     previewSize: string;
+    displayName: string;
     displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
 }, {
     id: string;
-    displayName: string;
     query: string;
     previewSize: string;
+    displayName: string;
     displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
 }>;
 declare const UnboundValuesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -254,6 +200,7 @@ declare const BaseComponentTreeNodeSchema: z.ZodObject<{
         key: string;
     }>]>>;
 }, "strip", z.ZodTypeAny, {
+    definitionId: string;
     variables: Record<string, {
         type: "DesignValue";
         valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
@@ -271,10 +218,10 @@ declare const BaseComponentTreeNodeSchema: z.ZodObject<{
         type: "ComponentValue";
         key: string;
     }>;
-    definitionId: string;
     displayName?: string | undefined;
     slotId?: string | undefined;
 }, {
+    definitionId: string;
     variables: Record<string, {
         type: "DesignValue";
         valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
@@ -292,7 +239,6 @@ declare const BaseComponentTreeNodeSchema: z.ZodObject<{
         type: "ComponentValue";
         key: string;
     }>;
-    definitionId: string;
     displayName?: string | undefined;
     slotId?: string | undefined;
 }>;
@@ -303,6 +249,8 @@ declare const ComponentSettingsSchema: z.ZodObject<{
     variableDefinitions: z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodOptional<z.ZodString>;
         type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink", "Array", "Link"]>;
+        description: z.ZodOptional<z.ZodString>;
+        group: z.ZodOptional<z.ZodString>;
         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<{
             type: z.ZodLiteral<"DesignValue">;
             valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
@@ -352,8 +300,6 @@ declare const ComponentSettingsSchema: z.ZodObject<{
             type: "ComponentValue";
             key: string;
         }>]>]>>;
-        description: z.ZodOptional<z.ZodString>;
-        group: z.ZodOptional<z.ZodString>;
         validations: z.ZodOptional<z.ZodObject<{
             required: z.ZodOptional<z.ZodBoolean>;
             format: z.ZodOptional<z.ZodLiteral<"URL">>;
@@ -544,27 +490,27 @@ declare const ComponentTreeSchema: z.ZodObject<{
         displayIcon: z.ZodOptional<z.ZodEnum<["desktop", "tablet", "mobile"]>>;
     }, "strict", z.ZodTypeAny, {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }, {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }>, "many">, {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }[], {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }[]>;
     children: z.ZodArray<z.ZodType<ComponentTreeNode, z.ZodTypeDef, ComponentTreeNode>, "many">;
@@ -573,9 +519,9 @@ declare const ComponentTreeSchema: z.ZodObject<{
     children: ComponentTreeNode[];
     breakpoints: {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }[];
     schemaVersion: "2023-09-28";
@@ -583,9 +529,9 @@ declare const ComponentTreeSchema: z.ZodObject<{
     children: ComponentTreeNode[];
     breakpoints: {
         id: string;
-        displayName: string;
         query: string;
         previewSize: string;
+        displayName: string;
         displayIcon?: "desktop" | "tablet" | "mobile" | undefined;
     }[];
     schemaVersion: "2023-09-28";
@@ -635,6 +581,186 @@ type BoundValue = z.infer<typeof BoundValueSchema>;
 type UnboundValue = z.infer<typeof UnboundValueSchema>;
 type ComponentValue = z.infer<typeof ComponentValueSchema>;
 
+declare const ComponentDefinitionSchema: z.ZodObject<{
+    id: z.ZodString;
+    variables: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
+        displayName: z.ZodOptional<z.ZodString>;
+        type: z.ZodEnum<["Text", "RichText", "Number", "Date", "Boolean", "Location", "Media", "Object", "Hyperlink", "Array", "Link"]>;
+        description: z.ZodOptional<z.ZodString>;
+        group: z.ZodOptional<z.ZodString>;
+        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<{
+            type: z.ZodLiteral<"DesignValue">;
+            valuesByBreakpoint: z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>>;
+        }, "strict", z.ZodTypeAny, {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        }, {
+            type: "DesignValue";
+            valuesByBreakpoint: Record<string, string | number | boolean | Record<any, any> | undefined>;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"BoundValue">;
+            path: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            path: string;
+            type: "BoundValue";
+        }, {
+            path: string;
+            type: "BoundValue";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"UnboundValue">;
+            key: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            type: "UnboundValue";
+            key: string;
+        }, {
+            type: "UnboundValue";
+            key: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"HyperlinkValue">;
+            linkTargetKey: z.ZodString;
+            overrides: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+        }, "strict", z.ZodTypeAny, {
+            type: "HyperlinkValue";
+            linkTargetKey: string;
+            overrides?: {} | undefined;
+        }, {
+            type: "HyperlinkValue";
+            linkTargetKey: string;
+            overrides?: {} | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"ComponentValue">;
+            key: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            type: "ComponentValue";
+            key: string;
+        }, {
+            type: "ComponentValue";
+            key: string;
+        }>]>]>>;
+        validations: z.ZodOptional<z.ZodObject<{
+            required: z.ZodOptional<z.ZodBoolean>;
+            format: z.ZodOptional<z.ZodLiteral<"URL">>;
+            in: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                value: string | number;
+                displayName?: string | undefined;
+            }, {
+                value: string | number;
+                displayName?: string | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        }, {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        }>>;
+    }, {
+        defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodRecord<z.ZodAny, z.ZodAny>, z.ZodUndefined]>>;
+    }>, "strip", z.ZodTypeAny, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    variables: Record<string, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+}, {
+    id: string;
+    variables: Record<string, {
+        type: "Text" | "RichText" | "Number" | "Date" | "Boolean" | "Location" | "Media" | "Object" | "Hyperlink" | "Array" | "Link";
+        displayName?: string | undefined;
+        description?: string | undefined;
+        group?: string | undefined;
+        defaultValue?: string | number | boolean | Record<any, any> | undefined;
+        validations?: {
+            required?: boolean | undefined;
+            format?: "URL" | undefined;
+            in?: {
+                value: string | number;
+                displayName?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+}>;
+type ComponentDefinitionPropertyType = z.infer<typeof DefinitionPropertyTypeSchema>;
+
 declare const SchemaVersions: z.ZodLiteral<"2023-09-28">;
 type SchemaVersions = z.infer<typeof SchemaVersions>;
 

package/dist/index.js

@@ -9,13 +9,6 @@ z.union([
     z.literal('2023-06-27'),
 ]);
 
-const PrimitiveValueSchema = z.union([
-    z.string(),
-    z.boolean(),
-    z.number(),
-    z.record(z.any(), z.any()),
-    z.undefined(),
-]);
 const DefinitionPropertyTypeSchema = z.enum([
     'Text',
     'RichText',
@@ -32,122 +25,13 @@ const DefinitionPropertyTypeSchema = z.enum([
 const DefinitionPropertyKeySchema = z
     .string()
     .regex(/^[a-zA-Z0-9-_]{1,32}$/, { message: 'Property needs to match: /^[a-zA-Z0-9-_]{1,32}$/' });
-const ComponentDefinitionSchema = z.object({
-    id: DefinitionPropertyKeySchema,
-    variables: z.record(DefinitionPropertyKeySchema, z
-        .object({
-        // TODO - extend with definition of validations and defaultValue
-        displayName: z.string().optional(),
-        type: DefinitionPropertyTypeSchema,
-        description: z.string().optional(),
-        group: z.string().optional(),
-        defaultValue: PrimitiveValueSchema.optional(),
-    })
-        .superRefine((val, ctx) => {
-        switch (val.type) {
-            case 'Array':
-                if (typeof val.defaultValue !== 'undefined') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue is not supported for "Array" type for ${ctx.path.join('.')}`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Boolean':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'boolean') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a boolean when type is "Boolean" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Date':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a string when type is "Date" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Hyperlink':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a string when type is "Hyperlink" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Link':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue is not supported for "Link" type for ${ctx.path.join('.')}`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Location':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be an object when type is "Location" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Media':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a string when type is "Media" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Number':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'number') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a number when type is "Number" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Object':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be an object when type is "Object" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'RichText':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be an object when type is "RichText" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-            case 'Text':
-                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
-                    ctx.addIssue({
-                        code: z.ZodIssueCode.custom,
-                        message: `defaultValue must be a string when type is "Text" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
-                        fatal: false,
-                    });
-                }
-                break;
-        }
-    })),
-});
-
+const PrimitiveValueSchema = z.union([
+    z.string(),
+    z.boolean(),
+    z.number(),
+    z.record(z.any(), z.any()),
+    z.undefined(),
+]);
 const uuidKeySchema = z
     .string()
     .regex(/^[a-zA-Z0-9-_]{1,21}$/, { message: 'Does not match /^[a-zA-Z0-9-_]{1,21}$/' });
@@ -227,27 +111,29 @@ const BaseComponentTreeNodeSchema = z.object({
 const ComponentTreeNodeSchema = BaseComponentTreeNodeSchema.extend({
     children: z.lazy(() => ComponentTreeNodeSchema.array()),
 });
-const ComponentSettingsSchema = z.object({
-    variableDefinitions: z.record(z.string().regex(/^[a-zA-Z0-9-_]{1,54}$/), // Here the key is <variableName>_<nanoidId> so we need to allow for a longer length
-    z.object({
-        displayName: z.string().optional(),
-        type: DefinitionPropertyTypeSchema,
-        defaultValue: PrimitiveValueSchema.or(ComponentPropertyValueSchema).optional(),
-        description: z.string().optional(),
-        group: z.string().optional(),
-        validations: z
-            .object({
-            required: z.boolean().optional(),
-            format: z.literal('URL').optional(),
-            in: z
-                .array(z.object({
-                value: z.union([z.string(), z.number()]),
-                displayName: z.string().optional(),
-            }))
-                .optional(),
-        })
+const ComponentVariableSchema = z.object({
+    displayName: z.string().optional(),
+    type: DefinitionPropertyTypeSchema,
+    description: z.string().optional(),
+    group: z.string().optional(),
+    defaultValue: PrimitiveValueSchema.or(ComponentPropertyValueSchema).optional(),
+    validations: z
+        .object({
+        required: z.boolean().optional(),
+        format: z.literal('URL').optional(),
+        in: z
+            .array(z.object({
+            value: z.union([z.string(), z.number()]),
+            displayName: z.string().optional(),
+        }))
             .optional(),
-    })),
+    })
+        .optional(),
+});
+const ComponentVariablesSchema = z.record(z.string().regex(/^[a-zA-Z0-9-_]{1,54}$/), // Here the key is <variableName>_<nanoidId> so we need to allow for a longer length
+ComponentVariableSchema);
+const ComponentSettingsSchema = z.object({
+    variableDefinitions: ComponentVariablesSchema,
 });
 const UsedComponentsSchema = z.array(z.object({
     sys: z.object({
@@ -326,6 +212,115 @@ const ExperienceFieldsCMAShapeSchema = z
 })
     .superRefine(componentSettingsRefinement);
 
+const ComponentDefinitionSchema = z.object({
+    id: DefinitionPropertyKeySchema,
+    variables: z.record(DefinitionPropertyKeySchema, ComponentVariableSchema.extend({
+        defaultValue: PrimitiveValueSchema.optional(),
+    }).superRefine((val, ctx) => {
+        switch (val.type) {
+            case 'Array':
+                if (typeof val.defaultValue !== 'undefined') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue is not supported for "Array" type for ${ctx.path.join('.')}`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Boolean':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'boolean') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a boolean when type is "Boolean" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Date':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a string when type is "Date" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Hyperlink':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a string when type is "Hyperlink" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Link':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue is not supported for "Link" type for ${ctx.path.join('.')}`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Location':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be an object when type is "Location" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Media':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a string when type is "Media" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Number':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'number') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a number when type is "Number" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Object':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be an object when type is "Object" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'RichText':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'object') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be an object when type is "RichText" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+            case 'Text':
+                if (typeof val.defaultValue !== 'undefined' && typeof val.defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: `defaultValue must be a string when type is "Text" for ${ctx.path.join('.')}, got ${typeof val.defaultValue} instead`,
+                        fatal: false,
+                    });
+                }
+                break;
+        }
+    })),
+});
+
 var CodeNames;
 (function (CodeNames) {
     CodeNames["Type"] = "type";