@contentful/experiences-core 3.4.1-dev-20250901T1444-72c17a2.0 → 3.5.0-beta.0

package/dist/types.d.ts

@@ -95,15 +95,29 @@ type ComponentRegistration = {
          * If true, the component receives the optional boolean property `isInExpEditorMode` to
          * render different content between editor and delivery mode.
          *
-         * @deprecated this will be replaced by editorProperties in the next major version
+         * @deprecated this will be replaced by enableEditorProperties in the next major version
          */
         enableCustomEditorView?: boolean;
         /**
          * If set, the specified properties are passed to the component when rendered in the editor.
          */
-        editorProperties?: {
-            node?: boolean;
+        enableEditorProperties?: {
+            /**
+             * Enable the property `isEditorMode` which will be `true` if being rendered inside the Studio editor.
+             */
             isEditorMode?: boolean;
+            /**
+             * Enable the property `isEmpty` which will be `true` if the component has no children.
+             * This can be used to render a placeholder or label in the editor when the component is empty.
+             *
+             * @note This will be false if there are no direct children nor slot children.
+             */
+            isEmpty?: boolean;
+            /**
+             * Enable the string property `nodeBlockId` which is equal to the component ID
+             * passed during registration, i.e. `ComponentDefinition['id']`.
+             */
+            nodeBlockId?: boolean;
         };
         wrapComponent?: boolean;
         wrapContainer?: keyof JSX.IntrinsicElements;
@@ -113,6 +127,21 @@ type ComponentRegistration = {
         wrapContainerWidth?: React.CSSProperties['width'];
     };
 };
+/**
+ * Use this for type-safe access to editor properties in your custom components
+ * @example
+ * type MyCustomProps = { myValue: string }
+ * type MyComponentProps = EditorProperties<'isEmpty'> & MyCustomProps
+ */
+type EditorProperties<T extends EditorPropertyNames = EditorPropertyNames> = Pick<BaseEditorProperties, T>;
+type EditorPropertyNames = keyof BaseEditorProperties;
+type BaseEditorProperties = {
+    isEditorMode?: boolean;
+    isEmpty?: boolean;
+    nodeBlockId?: string;
+    /** @deprecated will be replaced by `isEditorMode` with the next major version of the SDK */
+    isInExpEditorMode?: boolean;
+};
 type ComponentRegistrationOptions = {
     /**
      * Restrict the list of built-in components to a defined set of IDs.
@@ -590,4 +619,4 @@ type IncomingMessage = {
     };
 }[keyof INCOMING_EVENT_PAYLOADS];
 
-export type { AssembliesAddedPayload, AssembliesRegisteredPayload, BackgroundImageAlignmentOption, BackgroundImageOptions, BackgroundImageScalingOption, Binding, BindingMap, BindingMapByBlockId, BoundComponentPropertyTypes, CSSProperties, CanvasErrorPayload, CanvasGeometryUpdateSourceEvent, CanvasReloadPayload, CanvasResizedPayload, CanvasScrollPayload, ComponentBinding, ComponentDefinition, ComponentDefinitionVariable, ComponentDefinitionVariableBase, ComponentDefinitionVariableTypeMap, ComponentDefinitionVariableValidation, ComponentDragCanceledPayload, ComponentDragEndedPayload, ComponentDragStartedPayload, ComponentDraggingChangedPayload, ComponentDroppedPayload, ComponentMoveEndedPayload, ComponentMoveStartedPayload, ComponentMovedPayload, ComponentRegistration, ComponentRegistrationOptions, ComponentSelectedPayload, ConnectedPayload, ContainerStyleVariableName, Coordinates, DataSourceEntryValueType, DesignTokensDefinition, DesignTokensPayload, DesignVariableMap, DesignVariableTypes, 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, SdkOptions, SelectComponentPayload, SendMessageParams, StyleProps, UpdateSelectedComponentCoordinatesPayload, UpdatedEntityPayload, ValidationOption, VariableFormats };
+export type { AssembliesAddedPayload, AssembliesRegisteredPayload, BackgroundImageAlignmentOption, BackgroundImageOptions, BackgroundImageScalingOption, Binding, BindingMap, BindingMapByBlockId, BoundComponentPropertyTypes, CSSProperties, CanvasErrorPayload, CanvasGeometryUpdateSourceEvent, CanvasReloadPayload, CanvasResizedPayload, CanvasScrollPayload, ComponentBinding, ComponentDefinition, ComponentDefinitionVariable, ComponentDefinitionVariableBase, ComponentDefinitionVariableTypeMap, ComponentDefinitionVariableValidation, ComponentDragCanceledPayload, ComponentDragEndedPayload, ComponentDragStartedPayload, ComponentDraggingChangedPayload, ComponentDroppedPayload, ComponentMoveEndedPayload, ComponentMoveStartedPayload, ComponentMovedPayload, ComponentRegistration, ComponentRegistrationOptions, ComponentSelectedPayload, ConnectedPayload, ContainerStyleVariableName, Coordinates, DataSourceEntryValueType, DesignTokensDefinition, DesignTokensPayload, DesignVariableMap, DesignVariableTypes, EditorProperties, EditorPropertyNames, 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, SdkOptions, SelectComponentPayload, SendMessageParams, StyleProps, UpdateSelectedComponentCoordinatesPayload, UpdatedEntityPayload, ValidationOption, VariableFormats };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-core",
-  "version": "3.4.1-dev-20250901T1444-72c17a2.0",
+  "version": "3.5.0-beta.0",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -70,7 +70,7 @@
     "vitest": "^2.1.1"
   },
   "dependencies": {
-    "@contentful/experiences-validators": "3.4.1-dev-20250901T1444-72c17a2.0",
+    "@contentful/experiences-validators": "3.5.0-beta.0",
     "@contentful/rich-text-types": "^17.0.0",
     "lodash-es": "^4.17.21",
     "zustand": "^4.4.7"
@@ -78,5 +78,5 @@
   "peerDependencies": {
     "contentful": ">=10.6.0"
   },
-  "gitHead": "8c214711ef9ba71855af89ee9c0da9479de92ea0"
+  "gitHead": "3167e75b248ffe537d4c030ee8f211f2f7b9690d"
 }