@contentful/experiences-components-react 1.39.0-alpha-20250528T1342-e28bc3d.0 → 1.39.0-dev-20250528T1423-593ccdb.0

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { ComponentDefinition, OptimizedImageAsset, StructureComponentProps, StyleProps } from '@contentful/experiences-core/types';
-import React, { HTMLAttributes } from 'react';
+import { ComponentDefinition, OptimizedImageAsset, ExperienceTreeNode, ExperienceDataSource, ExperienceUnboundValues, StyleProps, DragWrapperProps, ResolveDesignValueType } from '@contentful/experiences-core/types';
+import React$1, { RefObject, CSSProperties, SyntheticEvent } from 'react';
 import { Document } from '@contentful/rich-text-types';
+import { EntityStore } from '@contentful/experiences-core';
 
-interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+interface ButtonProps extends React$1.ButtonHTMLAttributes<HTMLButtonElement> {
     /**
      * The URL to navigate to when the button is clicked. When provided, the button will be wrapped in an anchor tag.
      * @default undefined
@@ -59,13 +60,13 @@ interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
      * <Button>Go</Button>
      * ```
      */
-    children?: React.ReactNode;
+    children?: React$1.ReactNode;
 }
-declare const Button: React.FC<ButtonProps>;
+declare const Button: React$1.FC<ButtonProps>;
 
 declare const ButtonComponentDefinition: ComponentDefinition;
 
-interface HeadingProps extends React.HTMLAttributes<HTMLHeadingElement> {
+interface HeadingProps extends React$1.HTMLAttributes<HTMLHeadingElement> {
     /**
      * The text to display in the heading. If not provided, children will be used instead.
      * @default undefined
@@ -85,7 +86,7 @@ interface HeadingProps extends React.HTMLAttributes<HTMLHeadingElement> {
      * <Heading>My Heading</Heading>
      * ```
      */
-    children?: React.ReactNode;
+    children?: React$1.ReactNode;
     /**
      * The type of heading to render
      * @default h1
@@ -97,11 +98,11 @@ interface HeadingProps extends React.HTMLAttributes<HTMLHeadingElement> {
      */
     type?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
 }
-declare const Heading: React.FC<HeadingProps>;
+declare const Heading: React$1.FC<HeadingProps>;
 
 declare const HeadingComponentDefinition: ComponentDefinition;
 
-interface RichTextProps extends Omit<React.HTMLAttributes<HTMLElement>, 'value'> {
+interface RichTextProps extends Omit<React$1.HTMLAttributes<HTMLElement>, 'value'> {
     /**
      * Renders the text in a specific HTML tag.
      * @default p
@@ -131,11 +132,11 @@ interface RichTextProps extends Omit<React.HTMLAttributes<HTMLElement>, 'value'>
      */
     value: Document;
 }
-declare const RichText: React.FC<RichTextProps>;
+declare const RichText: React$1.FC<RichTextProps>;
 
 declare const RichTextComponentDefinition: ComponentDefinition;
 
-interface TextProps extends React.HTMLAttributes<HTMLElement> {
+interface TextProps extends React$1.HTMLAttributes<HTMLElement> {
     /**
      * The URL to navigate to when the text is clicked. When provided, the text will be wrapped in an anchor tag.
      * @default undefined
@@ -193,7 +194,7 @@ interface TextProps extends React.HTMLAttributes<HTMLElement> {
      * <Text>My Text</Text>
      * ```
      */
-    children?: React.ReactNode;
+    children?: React$1.ReactNode;
     /**
      * Renders the text in a specific HTML tag.
      * @default p
@@ -205,24 +206,38 @@ interface TextProps extends React.HTMLAttributes<HTMLElement> {
      */
     as?: 'p' | 'span' | 'div' | 'label' | 'caption' | 'small' | 'strong' | 'em';
 }
-declare const Text: React.FC<TextProps>;
+declare const Text: React$1.FC<TextProps>;
 
 declare const TextComponentDefinition: ComponentDefinition;
 
-interface ImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
+interface ImageProps extends React$1.ImgHTMLAttributes<HTMLImageElement> {
     cfImageAsset?: OptimizedImageAsset | string;
 }
-declare const Image: React.FC<ImageProps>;
+declare const Image: React$1.FC<ImageProps>;
 
 declare const ImageComponentDefinition: ComponentDefinition;
 
-type ContentfulContainerAsHyperlinkProps = StructureComponentProps<{
+type ContentfulContainerAsHyperlinkProps<EditorMode = boolean> = (EditorMode extends true ? {
+    editorMode?: EditorMode;
+    node: ExperienceTreeNode;
+    dataSource?: ExperienceDataSource;
+    unboundValues?: ExperienceUnboundValues;
+    resolveDesignValue?: any;
+    entityStore?: RefObject<EntityStore>;
+    areEntitiesFetched?: boolean;
+    renderDropzone: (node: ExperienceTreeNode, props?: Record<string, any>) => React$1.ReactNode;
+} : {
+    editorMode: EditorMode;
+}) & {
+    children?: React$1.ReactNode;
     className?: string;
     cfHyperlink?: StyleProps['cfHyperlink'];
     cfOpenInNewTab?: StyleProps['cfOpenInNewTab'];
-}>;
+    WrapperComponent?: React$1.ElementType;
+    dragProps?: DragWrapperProps;
+};
 
-declare const ContentfulContainer: React.FC<ContentfulContainerAsHyperlinkProps>;
+declare const ContentfulContainer: React$1.FC<ContentfulContainerAsHyperlinkProps>;
 
 declare const containerDefinition: ComponentDefinition;
 declare const sectionDefinition: ComponentDefinition;
@@ -231,31 +246,71 @@ type ContentfulDividerProps = {
     className?: string;
     dragProps?: unknown;
 };
-declare const ContentfulDivider: ({ className, dragProps: _, ...props }: ContentfulDividerProps) => React.JSX.Element;
+declare const ContentfulDivider: ({ className, dragProps: _, ...props }: ContentfulDividerProps) => React$1.JSX.Element;
 
 declare const dividerDefinition: ComponentDefinition;
 
-type ColumnsProps = StructureComponentProps<{
+interface ColumnsBaseProps {
+    editorMode: boolean;
     className?: string;
-}>;
-declare const Columns: ({ className, children, ...otherProps }: ColumnsProps) => React.JSX.Element;
+    children?: React.ReactNode;
+}
+interface ColumnsEditorModeProps extends ColumnsBaseProps {
+    editorMode: true;
+    cfColumns: string;
+    node: ExperienceTreeNode;
+    renderDropzone: (node: ExperienceTreeNode, props?: Record<string, unknown>) => React.ReactNode;
+    dragProps?: unknown;
+}
+interface ColumnsDeliveryModeProps extends ColumnsBaseProps {
+    editorMode: false;
+}
+interface SingleColumnEditorModeProps extends ColumnsBaseProps {
+    editorMode: true;
+    node: ExperienceTreeNode;
+    renderDropzone: (node: ExperienceTreeNode, props?: Record<string, unknown>) => React.ReactNode;
+    cfColumnSpan: string;
+    dragProps?: unknown;
+    ['data-ctfl-draggable-id']: string;
+    style?: CSSProperties;
+    className: string;
+    onMouseOver: (e: SyntheticEvent<Element, Event>) => void;
+    onMouseOut: (e: SyntheticEvent<Element, Event>) => void;
+    onMouseDown: (e: SyntheticEvent<Element, Event>) => void;
+    onMouseUp: (e: SyntheticEvent<Element, Event>) => void;
+    onClick: (e: SyntheticEvent<Element, Event>) => void;
+}
+interface SingleColumnDeliveryModeProps extends ColumnsBaseProps {
+    editorMode: false;
+}
+type ColumnsProps = ColumnsEditorModeProps | ColumnsDeliveryModeProps;
+type SingleColumnProps = SingleColumnEditorModeProps | SingleColumnDeliveryModeProps;
 
-type SingleColumnProps = StructureComponentProps<{
-    className?: string;
-}>;
-declare const SingleColumn: React.FC<SingleColumnProps>;
+declare const Columns: React$1.FC<ColumnsProps>;
+
+declare const SingleColumn: React$1.FC<SingleColumnProps>;
 
 declare const columnsDefinition: ComponentDefinition;
 declare const singleColumnDefinition: ComponentDefinition;
 
-type AssemblyProps = StructureComponentProps<HTMLAttributes<HTMLDivElement>>;
-declare const Assembly: React.FC<AssemblyProps>;
+type AssemblyProps<EditorMode = boolean> = EditorMode extends true ? {
+    children?: React$1.ReactNode;
+    className?: string;
+    cfHyperlink?: StyleProps['cfHyperlink'];
+    cfOpenInNewTab?: StyleProps['cfOpenInNewTab'];
+    editorMode?: EditorMode;
+    node: ExperienceTreeNode;
+    resolveDesignValue?: ResolveDesignValueType;
+    dragProps?: Record<string, any>;
+    renderDropzone: (node: ExperienceTreeNode, props?: Record<string, any>) => React$1.ReactNode;
+} : Record<string, any>;
+declare const Assembly: React$1.FC<AssemblyProps>;
 
 interface CarouselProps {
     className?: string;
-    children?: React.ReactNode;
+    children?: React$1.ReactNode;
 }
-declare const Carousel: React.FC<CarouselProps>;
+declare const Carousel: React$1.FC<CarouselProps>;
 
 declare const carouselDefinition: ComponentDefinition;