@contentful/experiences-core 1.11.0-dev-20240718T1445-7c1c865.0 → 1.11.0-prerelease-20240723T1849-cedcf84.0

package/dist/index.js

@@ -972,21 +972,7 @@ let designTokensRegistry = {};
 // Therefore only border and in the future text related design tokens are/will be checked in this funciton.
 // Ensuring values for simple key-value design tokens are not neccessary since they are required via typescript.
 const ensureValidCompositeValues = (designTokenDefinition) => {
-    // Text token validation
-    if (designTokenDefinition.text) {
-        for (const textKey in designTokenDefinition.text) {
-            const textValue = designTokenDefinition.text[textKey];
-            designTokenDefinition.text[textKey] = {
-                emphasis: textValue.emphasis || 'none',
-                fontSize: textValue.fontSize || '16px',
-                case: textValue.case || 'normal',
-                fontWeight: textValue.fontWeight || '400',
-                lineHeight: textValue.lineHeight || '20px',
-                letterSpacing: textValue.letterSpacing || '0px',
-                color: textValue.color || '#000000',
-            };
-        }
-    }
+    // TODO: add validation logic when text related design tokens are added
     // Border validation
     if (designTokenDefinition.border) {
         for (const borderKey in designTokenDefinition.border) {
@@ -1055,6 +1041,13 @@ 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',
@@ -1073,12 +1066,117 @@ const DefinitionPropertyKeySchema = z
     .regex(/^[a-zA-Z0-9-_]{1,32}$/, { message: 'Property needs to match: /^[a-zA-Z0-9-_]{1,32}$/' });
 z.object({
     id: DefinitionPropertyKeySchema,
-    variables: z.record(DefinitionPropertyKeySchema, z.object({
+    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;
+        }
     })),
 });
 
@@ -1100,13 +1198,6 @@ const DataSourceSchema = z.record(uuidKeySchema, z.object({
         linkType: z.enum(['Entry', 'Asset']),
     }),
 }));
-const PrimitiveValueSchema = z.union([
-    z.string(),
-    z.boolean(),
-    z.number(),
-    z.record(z.any(), z.any()),
-    z.undefined(),
-]);
 const ValuesByBreakpointSchema = z.record(z.lazy(() => PrimitiveValueSchema));
 const DesignValueSchema = z
     .object({
@@ -1367,6 +1458,7 @@ const zodToContentfulError = (issue) => {
             return defaultConversion(issue);
     }
 };
+
 const validateBreakpointsDefinition = (breakpoints) => {
     const result = z
         .array(BreakpointSchema)