@contentful/experiences-core 1.8.1-dev-20240620T1559-0ebee62.0 → 1.8.1-dev-20240624T0806-08e6902.0

package/dist/types.d.ts

@@ -250,5 +250,179 @@ type BackgroundImageOptions = {
     quality?: string;
     targetSize: string;
 };
+type ConnectedPayload = undefined | {
+    sdkVersion: string;
+    definitions: ComponentDefinition[];
+};
+type DesignTokensPayload = {
+    designTokens: DesignTokensDefinition;
+    resolvedCssVariables: Record<string, string>;
+};
+type RegisteredBreakpointsPayload = {
+    breakpoints: Breakpoint[];
+};
+type MouseMovePayload = {
+    clientX: number;
+    clientY: number;
+};
+type NewHoveredElementPayload = {
+    nodeId?: string;
+};
+type ComponentSelectedPayload = {
+    nodeId: string;
+    assembly?: {
+        id: string;
+        componentId: string;
+        nodeLocation: string | null;
+    };
+};
+type RegisteredComponentsPayload = {
+    definitions: ComponentDefinition[];
+};
+type RequestComponentTreeUpdatePayload = undefined;
+type ComponentDragCanceledPayload = undefined;
+type ComponentDroppedPayload = {
+    node: ExperienceTreeNode;
+    index: number;
+    parentNode: {
+        type?: ExperienceTreeNode['type'] | 'root';
+        data: {
+            blockId?: string;
+            id?: string;
+        };
+    };
+};
+type ComponentMovedPayload = {
+    nodeId: string;
+    sourceParentId: string;
+    destinationParentId: string;
+    sourceIndex: number;
+    destinationIndex: number;
+};
+type CanvasReloadPayload = undefined;
+type CanvasErrorPayload = Error;
+type UpdateSelectedComponentCoordinatesPayload = {
+    selectedNodeCoordinates: DOMRect;
+    selectedAssemblyChildCoordinates?: DOMRect;
+    parentCoordinates?: DOMRect;
+};
+type CanvasScrollPayload = (typeof SCROLL_STATES)[keyof typeof SCROLL_STATES];
+type ComponentMoveStartedPayload = undefined;
+type ComponentMoveEndedPayload = undefined;
+type OutsideCanvasClickPayload = {
+    outsideCanvasClick: boolean;
+};
+type SDKFeaturesPayload = Record<string, unknown>;
+type RequestEntitiesPayload = {
+    entityIds: string[];
+    entityType: 'Entry' | 'Asset';
+    locale: string;
+};
+type OUTGOING_EVENT_PAYLOADS = {
+    connected: ConnectedPayload;
+    registerDesignTokens: DesignTokensPayload;
+    registeredBreakpoints: RegisteredBreakpointsPayload;
+    mouseMove: MouseMovePayload;
+    newHoveredElement: NewHoveredElementPayload;
+    componentSelected: ComponentSelectedPayload;
+    registeredComponents: RegisteredComponentsPayload;
+    requestComponentTreeUpdate: RequestComponentTreeUpdatePayload;
+    componentDragCanceled: ComponentDragCanceledPayload;
+    componentDropped: ComponentDroppedPayload;
+    componentMoved: ComponentMovedPayload;
+    canvasReload: CanvasReloadPayload;
+    canvasError: CanvasErrorPayload;
+    updateSelectedComponentCoordinates: UpdateSelectedComponentCoordinatesPayload;
+    canvasScrolling: CanvasScrollPayload;
+    componentMoveStarted: ComponentMoveStartedPayload;
+    componentMoveEnded: ComponentMoveEndedPayload;
+    outsideCanvasClick: OutsideCanvasClickPayload;
+    sdkFeatures: SDKFeaturesPayload;
+    REQUEST_ENTITIES: RequestEntitiesPayload;
+};
+type SendMessageParams = <T extends OutgoingEvent>(eventType: T, data: OUTGOING_EVENT_PAYLOADS[T]) => void;
+type OutgoingMessage = {
+    [K in keyof OUTGOING_EVENT_PAYLOADS]: {
+        source: 'customer-app';
+        eventType: K;
+        payload: OUTGOING_EVENT_PAYLOADS[K];
+    };
+}[keyof OUTGOING_EVENT_PAYLOADS];
+type Filter<T, U> = T extends U ? T : never;
+type SelectedValueTypes = Filter<ComponentPropertyValue['type'], 'UnboundValue' | 'BoundValue'>;
+type RequestEditorModePayload = undefined;
+type ExperienceUpdatedPayload = {
+    tree: ExperienceTree;
+    /** @deprecated in favor of assemblies */
+    designComponents?: ExperienceUsedComponents;
+    assemblies?: ExperienceUsedComponents;
+    locale: string;
+    /** @deprecated maybe? */
+    defaultLocaleCode?: string;
+    changedNode?: ExperienceTreeNode;
+    changedValueType?: SelectedValueTypes;
+};
+type ComponentDraggingChangedPayload = {
+    isDragging: boolean;
+};
+type IncomingComponentDragCanceledPayload = undefined;
+type ComponentDragStartedPayload = {
+    id: string;
+};
+type ComponentDragEndedPayload = undefined;
+type IncomingComponentMoveEndedPayload = {
+    mouseX: number;
+    mouseY: number;
+};
+type CanvasResizedPayload = {
+    selectedNodeId: string;
+};
+type SelectComponentPayload = {
+    selectedNodeId: string;
+};
+type HoverComponentPayload = {
+    hoveredNodeId: string;
+};
+type UpdatedEntityPayload = {
+    entity: ManagementEntity;
+    shouldRerender?: boolean;
+};
+type AssembliesAddedPayload = {
+    assembly: ManagementEntity;
+    assemblyDefinition: ComponentDefinition;
+};
+type AssembliesRegisteredPayload = {
+    assemblies: ComponentDefinition[];
+};
+type IncomingMouseMovePayload = {
+    mouseX: number;
+    mouseY: number;
+};
+type RequestedEntitiesPayload = {
+    entities: ManagementEntity[];
+};
+type INCOMING_EVENT_PAYLOADS = {
+    requestEditorMode: RequestEditorModePayload;
+    componentTreeUpdated: ExperienceUpdatedPayload;
+    componentDraggingChanged: ComponentDraggingChangedPayload;
+    componentDragCanceled: IncomingComponentDragCanceledPayload;
+    componentDragStarted: ComponentDragStartedPayload;
+    componentDragEnded: ComponentDragEndedPayload;
+    componentMoveEnded: IncomingComponentMoveEndedPayload;
+    canvasResized: CanvasResizedPayload;
+    selectComponent: SelectComponentPayload;
+    hoverComponent: HoverComponentPayload;
+    updatedEntity: UpdatedEntityPayload;
+    assembliesAdded: AssembliesAddedPayload;
+    assembliesRegistered: AssembliesRegisteredPayload;
+    mouseMove: IncomingMouseMovePayload;
+    REQUESTED_ENTITIES: RequestedEntitiesPayload;
+};
+type IncomingMessage = {
+    [K in keyof INCOMING_EVENT_PAYLOADS]: {
+        eventType: K;
+        payload: INCOMING_EVENT_PAYLOADS[K];
+    };
+}[keyof INCOMING_EVENT_PAYLOADS];
 
-export type { BackgroundImageAlignmentOption, BackgroundImageOptions, BackgroundImageScalingOption, Binding, BindingMap, BindingMapByBlockId, BoundComponentPropertyTypes, CSSProperties, ComponentBinding, ComponentDefinition, ComponentDefinitionVariable, ComponentDefinitionVariableBase, ComponentDefinitionVariableValidation, ComponentRegistration, ComponentRegistrationOptions, ContainerStyleVariableName, Coordinates, DataSourceEntryValueType, DesignTokensDefinition, Experience, ExperienceEntry, ExperienceFields, ExperienceTree, ExperienceTreeNode, ExternalSDKMode, HoveredElement, ImageLoadingOption, ImageObjectFitOption, ImageObjectPositionOption, ImageOptions, IncomingEvent, InternalEvent, InternalSDKMode, Link, ManagementEntity, OptimizedBackgroundImageAsset, OptimizedImageAsset, OutgoingEvent, RawCoordinates, RecursiveDesignTokenDefinition, RequestEntitiesMessage, RequestedEntitiesMessage, ResolveDesignValueType, ScrollState, StyleProps, ValidationOption, VariableFormats };
+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, Experience, ExperienceEntry, ExperienceFields, ExperienceTree, ExperienceTreeNode, ExperienceUpdatedPayload, ExternalSDKMode, HoverComponentPayload, HoveredElement, ImageLoadingOption, ImageObjectFitOption, ImageObjectPositionOption, ImageOptions, IncomingComponentDragCanceledPayload, IncomingComponentMoveEndedPayload, IncomingEvent, IncomingMessage, IncomingMouseMovePayload, InternalEvent, InternalSDKMode, Link, ManagementEntity, MouseMovePayload, NewHoveredElementPayload, OptimizedBackgroundImageAsset, OptimizedImageAsset, OutgoingEvent, OutgoingMessage, OutsideCanvasClickPayload, RawCoordinates, RecursiveDesignTokenDefinition, RegisteredBreakpointsPayload, RegisteredComponentsPayload, RequestComponentTreeUpdatePayload, RequestEditorModePayload, RequestEntitiesMessage, RequestEntitiesPayload, RequestedEntitiesMessage, RequestedEntitiesPayload, ResolveDesignValueType, SDKFeaturesPayload, ScrollState, SelectComponentPayload, SendMessageParams, StyleProps, UpdateSelectedComponentCoordinatesPayload, UpdatedEntityPayload, ValidationOption, VariableFormats };

package/dist/utils/validations.d.ts

@@ -1,15 +1,10 @@
-import { IncomingEvent } from '../types.js';
+import { IncomingMessage } from '../types.js';
 
-type VisualEditorMessagePayload = {
-    source: string;
-    eventType: IncomingEvent;
-    payload: any;
-};
 declare const doesMismatchMessageSchema: (event: MessageEvent) => false | string;
-declare const tryParseMessage: (event: MessageEvent) => VisualEditorMessagePayload;
+declare const tryParseMessage: (event: MessageEvent) => IncomingMessage;
 declare const validateExperienceBuilderConfig: ({ locale, isEditorMode, }: {
     locale: string;
     isEditorMode: boolean;
 }) => void;
 
-export { type VisualEditorMessagePayload, doesMismatchMessageSchema, tryParseMessage, validateExperienceBuilderConfig };
+export { doesMismatchMessageSchema, tryParseMessage, validateExperienceBuilderConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-core",
-  "version": "1.8.1-dev-20240620T1559-0ebee62.0",
+  "version": "1.8.1-dev-20240624T0806-08e6902.0",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -65,11 +65,11 @@
     "vitest": "^1.0.4"
   },
   "dependencies": {
-    "@contentful/experiences-validators": "1.8.1-dev-20240620T1559-0ebee62.0",
+    "@contentful/experiences-validators": "1.8.1-dev-20240624T0806-08e6902.0",
     "@contentful/rich-text-types": "^16.3.0"
   },
   "peerDependencies": {
     "contentful": ">=10.6.0"
   },
-  "gitHead": "b442579d8c6f18279e382eb90cd2cdc790a6c2fd"
+  "gitHead": "e51697f0075a04bcc7bc676a916cc311a4807eb4"
 }