@contentful/experiences-components-react 3.8.0-beta.0 → 3.8.0-prerelease-20250922T2329-e132272.0

package/dist/index.js

@@ -602,6 +602,7 @@ const builtInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The vertical alignment of the section',
         defaultValue: 'center',
         displayName: 'Vertical alignment',
     },
@@ -628,6 +629,7 @@ const builtInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The horizontal alignment of the section',
         defaultValue: 'center',
         displayName: 'Horizontal alignment',
     },
@@ -636,71 +638,83 @@ const builtInStyles = {
         type: 'Boolean',
         group: 'style',
         defaultValue: true,
+        description: 'The visibility of the component',
     },
     cfMargin: {
         displayName: 'Margin',
         type: 'Text',
         group: 'style',
+        description: 'The margin of the section',
         defaultValue: '0 0 0 0',
     },
     cfPadding: {
         displayName: 'Padding',
         type: 'Text',
         group: 'style',
+        description: 'The padding of the section',
         defaultValue: '0 0 0 0',
     },
     cfBackgroundColor: {
         displayName: 'Background color',
         type: 'Text',
         group: 'style',
+        description: 'The background color of the section',
         defaultValue: 'rgba(0, 0, 0, 0)',
     },
     cfWidth: {
         displayName: 'Width',
         type: 'Text',
         group: 'style',
+        description: 'The width of the section',
         defaultValue: '100%',
     },
     cfHeight: {
         displayName: 'Height',
         type: 'Text',
         group: 'style',
+        description: 'The height of the section',
         defaultValue: 'fit-content',
     },
     cfMaxWidth: {
         displayName: 'Max width',
         type: 'Text',
         group: 'style',
+        description: 'The max-width of the section',
         defaultValue: 'none',
     },
     cfFlexDirection: {
         displayName: 'Direction',
         type: 'Text',
         group: 'style',
+        description: 'The orientation of the section',
         defaultValue: 'column',
     },
     cfFlexReverse: {
         displayName: 'Reverse Direction',
         type: 'Boolean',
         group: 'style',
+        description: 'Toggle the flex direction to be reversed',
         defaultValue: false,
     },
     cfFlexWrap: {
         displayName: 'Wrap objects',
         type: 'Text',
         group: 'style',
+        description: 'Wrap objects',
         defaultValue: 'nowrap',
     },
     cfBorder: {
         displayName: 'Border',
         type: 'Text',
         group: 'style',
+        description: 'The border of the section',
         defaultValue: '0px solid rgba(0, 0, 0, 0)',
     },
     cfGap: {
         displayName: 'Gap',
         type: 'Text',
         group: 'style',
+        description: 'The spacing between the elements of the section',
         defaultValue: '0px',
     },
     cfHyperlink: {
@@ -711,6 +725,7 @@ const builtInStyles = {
             format: 'URL',
             bindingSourceType: ['entry', 'experience', 'manual'],
         },
+        description: 'hyperlink for section or container',
     },
     cfOpenInNewTab: {
         displayName: 'URL behaviour',
@@ -724,6 +739,7 @@ const optionalBuiltInStyles = {
         displayName: 'Font Size',
         type: 'Text',
         group: 'style',
+        description: 'The font size of the element',
         defaultValue: '16px',
     },
     cfFontWeight: {
@@ -746,11 +762,13 @@ const optionalBuiltInStyles = {
         displayName: 'Font Weight',
         type: 'Text',
         group: 'style',
+        description: 'The font weight of the element',
         defaultValue: '400',
     },
     cfImageAsset: {
         displayName: 'Image',
         type: 'Media',
+        description: 'Image to display',
         validations: {
             bindingSourceType: ['asset', 'entry', 'manual'],
         },
@@ -769,11 +787,13 @@ const optionalBuiltInStyles = {
         displayName: 'Background color',
         type: 'Text',
         group: 'style',
+        description: 'The background color of the element',
         defaultValue: 'rgba(0, 0, 0, 0)',
     },
     cfBackgroundImageUrl: {
         displayName: 'Background image',
         type: 'Media',
+        description: 'Background image for component',
         validations: {
             bindingSourceType: ['asset', 'entry', 'manual'],
         },
@@ -792,24 +812,28 @@ const optionalBuiltInStyles = {
         displayName: 'Border Radius',
         type: 'Text',
         group: 'style',
+        description: 'The border radius of the section',
         defaultValue: '0px',
     },
     cfLineHeight: {
         displayName: 'Line Height',
         type: 'Text',
         group: 'style',
+        description: 'The line height of the element',
         defaultValue: '20px',
     },
     cfLetterSpacing: {
         displayName: 'Letter Spacing',
         type: 'Text',
         group: 'style',
+        description: 'The letter spacing of the element',
         defaultValue: '0px',
     },
     cfTextColor: {
         displayName: 'Text Color',
         type: 'Text',
         group: 'style',
+        description: 'The text color of the element',
         defaultValue: 'rgba(0, 0, 0, 1)',
     },
     cfTextAlign: {
@@ -832,6 +856,7 @@ const optionalBuiltInStyles = {
         displayName: 'Text Align',
         type: 'Text',
         group: 'style',
+        description: 'The text alignment of the element',
         defaultValue: 'start',
     },
     cfTextTransform: {
@@ -858,24 +883,28 @@ const optionalBuiltInStyles = {
         displayName: 'Text Transform',
         type: 'Text',
         group: 'style',
+        description: 'The text transform of the element',
         defaultValue: 'none',
     },
     cfTextBold: {
         displayName: 'Bold',
         type: 'Boolean',
         group: 'style',
+        description: 'The text bold of the element',
         defaultValue: false,
     },
     cfTextItalic: {
         displayName: 'Italic',
         type: 'Boolean',
         group: 'style',
+        description: 'The text italic of the element',
         defaultValue: false,
     },
     cfTextUnderline: {
         displayName: 'Underline',
         type: 'Boolean',
         group: 'style',
+        description: 'The text underline of the element',
         defaultValue: false,
     },
 };
@@ -894,6 +923,7 @@ const containerBuiltInStyles = {
         displayName: 'Margin',
         type: 'Text',
         group: 'style',
+        description: 'The margin of the container',
         // Note: The UI overwrites '0 Auto 0 Auto' as the default value for top-level containers
         defaultValue: '0 0 0 0',
     },
@@ -901,6 +931,7 @@ const containerBuiltInStyles = {
         displayName: 'Max Width',
         type: 'Text',
         group: 'style',
+        description: 'The max-width of the section',
         defaultValue: '1192px',
     },
 };
@@ -911,30 +942,35 @@ const dividerBuiltInStyles = {
         displayName: 'Margin',
         type: 'Text',
         group: 'style',
+        description: 'The margin of the divider',
         defaultValue: '20px 0px 20px 0px',
     },
     cfWidth: {
         displayName: 'Width',
         type: 'Text',
         group: 'style',
+        description: 'The width of the divider',
         defaultValue: '100%',
     },
     cfHeight: {
         displayName: 'Height',
         type: 'Text',
         group: 'style',
+        description: 'The height of the divider',
         defaultValue: '1px',
     },
     cfMaxWidth: {
         displayName: 'Max width',
         type: 'Text',
         group: 'style',
+        description: 'The max-width of the divider',
         defaultValue: 'none',
     },
     cfBackgroundColor: {
         displayName: 'Background color',
         type: 'Text',
         group: 'style',
+        description: 'The background color of the divider',
         defaultValue: 'rgba(204, 204, 204, 1)',
     },
 };
@@ -967,6 +1003,7 @@ const singleColumnBuiltInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The vertical alignment of the column',
         defaultValue: 'center',
         displayName: 'Vertical alignment',
     },
@@ -993,6 +1030,7 @@ const singleColumnBuiltInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The horizontal alignment of the column',
         defaultValue: 'center',
         displayName: 'Horizontal alignment',
     },
@@ -1000,30 +1038,35 @@ const singleColumnBuiltInStyles = {
         displayName: 'Padding',
         type: 'Text',
         group: 'style',
+        description: 'The padding of the column',
         defaultValue: '0 0 0 0',
     },
     cfFlexDirection: {
         displayName: 'Direction',
         type: 'Text',
         group: 'style',
+        description: 'The orientation of the column',
         defaultValue: 'column',
     },
     cfFlexWrap: {
         displayName: 'Wrap objects',
         type: 'Text',
         group: 'style',
+        description: 'Wrap objects',
         defaultValue: 'nowrap',
     },
     cfBorder: {
         displayName: 'Border',
         type: 'Text',
         group: 'style',
+        description: 'The border of the column',
         defaultValue: '0px solid rgba(0, 0, 0, 0)',
     },
     cfGap: {
         displayName: 'Gap',
         type: 'Text',
         group: 'style',
+        description: 'The spacing between the elements of the column',
         defaultValue: '0px',
     },
     cfColumnSpan: {
@@ -1047,6 +1090,7 @@ const columnsBuiltInStyles = {
         displayName: 'Margin',
         type: 'Text',
         group: 'style',
+        description: 'The margin of the columns',
         // Note: The UI overwrites '0 Auto 0 Auto' as the default value for top-level columns
         defaultValue: '0 0 0 0',
     },
@@ -1054,30 +1098,35 @@ const columnsBuiltInStyles = {
         displayName: 'Width',
         type: 'Text',
         group: 'style',
+        description: 'The width of the columns',
         defaultValue: '100%',
     },
     cfMaxWidth: {
         displayName: 'Max width',
         type: 'Text',
         group: 'style',
+        description: 'The max-width of the columns',
         defaultValue: '1192px',
     },
     cfPadding: {
         displayName: 'Padding',
         type: 'Text',
         group: 'style',
+        description: 'The padding of the columns',
         defaultValue: '10px 10px 10px 10px',
     },
     cfBorder: {
         displayName: 'Border',
         type: 'Text',
         group: 'style',
+        description: 'The border of the columns',
         defaultValue: '0px solid rgba(0, 0, 0, 0)',
     },
     cfGap: {
         displayName: 'Gap',
         type: 'Text',
         group: 'style',
+        description: 'The spacing between the elements of the columns',
         defaultValue: '10px 10px',
     },
     cfColumns: {
@@ -1327,6 +1376,19 @@ const ComponentVariableSchema = z.object({
 });
 const ComponentTreeNodeSchema = BaseComponentTreeNodeSchema.extend({
     children: z.lazy(() => ComponentTreeNodeSchema.array()),
+}).superRefine(({ id, prebindingId, parameters }, ctx) => {
+    if (prebindingId && !parameters) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Found "prebindingId" but no "parameters" for node with id: "${id}"`,
+        });
+    }
+    if (parameters && !prebindingId) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Found "parameters" but no "prebindingId" for node with id: "${id}"`,
+        });
+    }
 });
 const ComponentTreeSchema = z
     .object({
@@ -1430,6 +1492,7 @@ const ParameterDefinitionSchema = z.object({
     passToNodes: z
         .array(PassToNodeSchema)
         .max(1, 'At most one "passToNodes" element is allowed per parameter definition.'),
+    // we might change this to be empty array for native parameter definitions, that's why we don't use .length(1)
 });
 const ParameterDefinitionsSchema = z.record(propertyKeySchema, ParameterDefinitionSchema);
 const VariableMappingsSchema = z.record(propertyKeySchema, VariableMappingSchema);