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

package/dist/index.js

@@ -180,6 +180,7 @@ const builtInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The vertical alignment of the section',
         defaultValue: 'center',
         displayName: 'Vertical alignment',
     },
@@ -206,6 +207,7 @@ const builtInStyles = {
         },
         type: 'Text',
         group: 'style',
+        description: 'The horizontal alignment of the section',
         defaultValue: 'center',
         displayName: 'Horizontal alignment',
     },
@@ -214,71 +216,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: {
@@ -289,6 +303,7 @@ const builtInStyles = {
             format: 'URL',
             bindingSourceType: ['entry', 'experience', 'manual'],
         },
+        description: 'hyperlink for section or container',
     },
     cfOpenInNewTab: {
         displayName: 'URL behaviour',
@@ -302,6 +317,7 @@ const optionalBuiltInStyles = {
         displayName: 'Font Size',
         type: 'Text',
         group: 'style',
+        description: 'The font size of the element',
         defaultValue: '16px',
     },
     cfFontWeight: {
@@ -324,11 +340,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'],
         },
@@ -347,11 +365,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'],
         },
@@ -370,24 +390,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: {
@@ -410,6 +434,7 @@ const optionalBuiltInStyles = {
         displayName: 'Text Align',
         type: 'Text',
         group: 'style',
+        description: 'The text alignment of the element',
         defaultValue: 'start',
     },
     cfTextTransform: {
@@ -436,24 +461,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,
     },
 };
@@ -766,6 +795,19 @@ const ComponentVariableSchema$1 = z.object({
 });
 const ComponentTreeNodeSchema$1 = BaseComponentTreeNodeSchema$1.extend({
     children: z.lazy(() => ComponentTreeNodeSchema$1.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$1 = z
     .object({
@@ -869,6 +911,7 @@ const ParameterDefinitionSchema$1 = z.object({
     passToNodes: z
         .array(PassToNodeSchema$1)
         .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$1 = z.record(propertyKeySchema$1, ParameterDefinitionSchema$1);
 const VariableMappingsSchema$1 = z.record(propertyKeySchema$1, VariableMappingSchema$1);
@@ -4003,6 +4046,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({
@@ -4106,6 +4162,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);