@contentful/experiences-core 1.23.0-dev-20241202T2137-2facc0f.0 → 1.23.0-dev-20241203T1624-e015e2b.0

package/dist/types.d.ts

@@ -5,6 +5,22 @@ import { Document } from '@contentful/rich-text-types';
 import { ComponentDefinitionPropertyType, ComponentPropertyValue, ExperienceDataSource, ExperienceUnboundValues, Breakpoint, ExperienceComponentTree, ExperienceUsedComponents, ExperienceComponentSettings, ValuesByBreakpoint, PrimitiveValue } from '@contentful/experiences-validators';
 export { BoundValue, Breakpoint, ComponentDefinitionPropertyType as ComponentDefinitionVariableType, ComponentPropertyValue, ComponentTreeNode, ComponentValue, DesignValue, ExperienceComponentSettings, ExperienceDataSource, ExperienceUnboundValues, PrimitiveValue, SchemaVersions, UnboundValue, ValuesByBreakpoint } from '@contentful/experiences-validators';
 
+type ComponentDefinitionVariableTypeMap = {
+    Array: unknown[];
+    Boolean: boolean;
+    Date: string;
+    Hyperlink: string;
+    Link: Record<string, unknown>;
+    Location: {
+        lon: number;
+        lat: number;
+    };
+    Media: Record<string, unknown> | string;
+    Number: number;
+    Object: Record<string, unknown>;
+    RichText: string;
+    Text: string;
+};
 type ScrollStateKey = keyof typeof SCROLL_STATES;
 type ScrollState = (typeof SCROLL_STATES)[ScrollStateKey];
 type OutgoingEventKey = keyof typeof OUTGOING_EVENTS;
@@ -22,7 +38,7 @@ interface Link<T extends string> {
 }
 type VariableFormats = 'URL';
 type ValidationOption<T extends ComponentDefinitionPropertyType> = {
-    value: T extends 'Text' ? string : T extends 'Number' ? number : never;
+    value: ComponentDefinitionVariableTypeMap[T];
     displayName?: string;
 };
 type ComponentDefinitionVariableValidation<T extends ComponentDefinitionPropertyType> = {
@@ -36,7 +52,7 @@ interface ComponentDefinitionVariableBase<T extends ComponentDefinitionPropertyT
     group?: 'style' | 'content';
     description?: string;
     displayName?: string;
-    defaultValue?: string | boolean | number | Record<any, any>;
+    defaultValue?: ComponentDefinitionVariableTypeMap[T];
 }
 type ComponentDefinitionVariable<T extends ComponentDefinitionPropertyType = ComponentDefinitionPropertyType> = ComponentDefinitionVariableBase<T>;
 type ComponentDefinition<T extends ComponentDefinitionPropertyType = ComponentDefinitionPropertyType> = {
@@ -45,7 +61,7 @@ type ComponentDefinition<T extends ComponentDefinitionPropertyType = ComponentDe
     category?: string;
     thumbnailUrl?: string;
     hyperlinkPattern?: string;
-    variables: Partial<Record<ContainerStyleVariableName, ComponentDefinitionVariable<T>>> & Record<string, ComponentDefinitionVariable<T>>;
+    variables: Partial<DesignVariableMap> & Record<string, ComponentDefinitionVariable<T>>;
     slots?: Record<string, {
         displayName: string;
     }>;
@@ -158,6 +174,50 @@ type StyleProps = {
     cfWrapColumns: boolean;
     cfWrapColumnsCount: string;
 };
+/**
+ * Internally defined style variables mapped to each variable type
+ */
+type DesignVariableTypes = {
+    cfVisibility: 'Boolean';
+    cfHorizontalAlignment: 'Text';
+    cfVerticalAlignment: 'Text';
+    cfMargin: 'Text';
+    cfPadding: 'Text';
+    cfBackgroundColor: 'Text';
+    cfWidth: 'Text';
+    cfMaxWidth: 'Text';
+    cfHeight: 'Text';
+    cfFlexDirection: 'Text';
+    cfFlexWrap: 'Text';
+    cfFlexReverse: 'Boolean';
+    cfBorder: 'Text';
+    cfBorderRadius: 'Text';
+    cfGap: 'Text';
+    cfHyperlink: 'Hyperlink';
+    cfImageAsset: 'Media';
+    cfImageOptions: 'Object';
+    cfBackgroundImageUrl: 'Media';
+    cfBackgroundImageOptions: 'Object';
+    cfOpenInNewTab: 'Boolean';
+    cfFontSize: 'Text';
+    cfFontWeight: 'Text';
+    cfLineHeight: 'Text';
+    cfLetterSpacing: 'Text';
+    cfTextColor: 'Text';
+    cfTextAlign: 'Text';
+    cfTextTransform: 'Text';
+    cfTextBold: 'Boolean';
+    cfTextItalic: 'Boolean';
+    cfTextUnderline: 'Boolean';
+    cfColumns: 'Text';
+    cfColumnSpan: 'Text';
+    cfColumnSpanLock: 'Boolean';
+    cfWrapColumns: 'Boolean';
+    cfWrapColumnsCount: 'Text';
+};
+type DesignVariableMap = {
+    [K in keyof DesignVariableTypes]: ComponentDefinitionVariable<DesignVariableTypes[K]>;
+};
 type CSSProperties = React.CSSProperties;
 type ContainerStyleVariableName = keyof StyleProps;
 type ExperienceFields = {
@@ -477,4 +537,4 @@ type IncomingMessage = {
     };
 }[keyof INCOMING_EVENT_PAYLOADS];
 
-export type { AssembliesAddedPayload, AssembliesRegisteredPayload, BackgroundImageAlignmentOption, BackgroundImageOptions, BackgroundImageScalingOption, Binding, BindingMap, BindingMapByBlockId, BoundComponentPropertyTypes, CSSProperties, CanvasErrorPayload, CanvasReloadPayload, CanvasResizedPayload, CanvasScrollPayload, ComponentBinding, ComponentDefinition, ComponentDefinitionVariable, ComponentDefinitionVariableBase, ComponentDefinitionVariableValidation, ComponentDragCanceledPayload, ComponentDragEndedPayload, ComponentDragStartedPayload, ComponentDraggingChangedPayload, ComponentDroppedPayload, ComponentMoveEndedPayload, ComponentMoveStartedPayload, ComponentMovedPayload, ComponentRegistration, ComponentRegistrationOptions, ComponentSelectedPayload, ConnectedPayload, ContainerStyleVariableName, Coordinates, DataSourceEntryValueType, DesignTokensDefinition, DesignTokensPayload, DragWrapperProps, Experience, ExperienceEntry, ExperienceFields, ExperienceTree, ExperienceTreeNode, ExperienceUpdatedPayload, HoverComponentPayload, HoveredElement, ImageLoadingOption, ImageObjectFitOption, ImageObjectPositionOption, ImageOptions, IncomingComponentDragCanceledPayload, IncomingComponentMoveEndedPayload, IncomingEvent, IncomingMessage, IncomingMouseMovePayload, InternalEvent, Link, ManagementEntity, MouseMovePayload, NewHoveredElementPayload, OptimizedBackgroundImageAsset, OptimizedImageAsset, OutgoingEvent, OutgoingMessage, OutsideCanvasClickPayload, RawCoordinates, RecursiveDesignTokenDefinition, RegisteredBreakpointsPayload, RegisteredComponentsPayload, RequestComponentTreeUpdatePayload, RequestEditorModePayload, RequestEntitiesMessage, RequestEntitiesPayload, RequestReadOnlyModePayload, RequestedEntitiesMessage, RequestedEntitiesPayload, ResolveDesignValueType, SDKFeaturesPayload, ScrollState, SelectComponentPayload, SendMessageParams, StyleProps, UpdateSelectedComponentCoordinatesPayload, UpdatedEntityPayload, ValidationOption, VariableFormats, WrapperTags };
+export type { AssembliesAddedPayload, AssembliesRegisteredPayload, BackgroundImageAlignmentOption, BackgroundImageOptions, BackgroundImageScalingOption, Binding, BindingMap, BindingMapByBlockId, BoundComponentPropertyTypes, CSSProperties, CanvasErrorPayload, CanvasReloadPayload, CanvasResizedPayload, CanvasScrollPayload, ComponentBinding, ComponentDefinition, ComponentDefinitionVariable, ComponentDefinitionVariableBase, ComponentDefinitionVariableValidation, ComponentDragCanceledPayload, ComponentDragEndedPayload, ComponentDragStartedPayload, ComponentDraggingChangedPayload, ComponentDroppedPayload, ComponentMoveEndedPayload, ComponentMoveStartedPayload, ComponentMovedPayload, ComponentRegistration, ComponentRegistrationOptions, ComponentSelectedPayload, ConnectedPayload, ContainerStyleVariableName, Coordinates, DataSourceEntryValueType, DesignTokensDefinition, DesignTokensPayload, DesignVariableMap, DesignVariableTypes, DragWrapperProps, Experience, ExperienceEntry, ExperienceFields, ExperienceTree, ExperienceTreeNode, ExperienceUpdatedPayload, HoverComponentPayload, HoveredElement, ImageLoadingOption, ImageObjectFitOption, ImageObjectPositionOption, ImageOptions, IncomingComponentDragCanceledPayload, IncomingComponentMoveEndedPayload, IncomingEvent, IncomingMessage, IncomingMouseMovePayload, InternalEvent, Link, ManagementEntity, MouseMovePayload, NewHoveredElementPayload, OptimizedBackgroundImageAsset, OptimizedImageAsset, OutgoingEvent, OutgoingMessage, OutsideCanvasClickPayload, RawCoordinates, RecursiveDesignTokenDefinition, RegisteredBreakpointsPayload, RegisteredComponentsPayload, RequestComponentTreeUpdatePayload, RequestEditorModePayload, RequestEntitiesMessage, RequestEntitiesPayload, RequestReadOnlyModePayload, RequestedEntitiesMessage, RequestedEntitiesPayload, ResolveDesignValueType, SDKFeaturesPayload, ScrollState, SelectComponentPayload, SendMessageParams, StyleProps, UpdateSelectedComponentCoordinatesPayload, UpdatedEntityPayload, ValidationOption, VariableFormats, WrapperTags };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-core",
-  "version": "1.23.0-dev-20241202T2137-2facc0f.0",
+  "version": "1.23.0-dev-20241203T1624-e015e2b.0",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -69,11 +69,11 @@
     "vitest": "^2.1.1"
   },
   "dependencies": {
-    "@contentful/experiences-validators": "1.23.0-dev-20241202T2137-2facc0f.0",
+    "@contentful/experiences-validators": "1.23.0-dev-20241203T1624-e015e2b.0",
     "@contentful/rich-text-types": "^16.3.0"
   },
   "peerDependencies": {
     "contentful": ">=10.6.0"
   },
-  "gitHead": "0474cc543f07b66e66210797aeb3da4e1a8aac24"
+  "gitHead": "60a791235c37a9450cd7e84c9e5767f8c438ae2a"
 }