@sitecore-content-sdk/react 1.2.0-canary.9 → 1.2.0

package/types/components/FEaaS/FEaaSWrapper.d.ts

@@ -0,0 +1,7 @@
+import { JSX } from 'react';
+import { FEaaSComponentProps } from './models';
+/**
+ * @param {FEaaSComponentProps} props component props
+ */
+export declare const FEaaSComponent: (props: FEaaSComponentProps) => JSX.Element;
+export declare const FEaaSWrapper: (props: FEaaSComponentProps) => JSX.Element;

package/types/components/FEaaS/feaas-utils.d.ts

@@ -0,0 +1,21 @@
+import { BYOCComponentParams, BYOCServerProps, FEaaSComponentParams, FEaaSComponentServerProps, RevisionType } from './models';
+/**
+ * Fetches server component props required for server rendering, based on rendering params.
+ * @param {BYOCComponentParams} params component params
+ */
+export declare function fetchBYOCComponentServerProps(params: BYOCComponentParams): Promise<BYOCServerProps>;
+/**
+ * Fetches server component props required for server rendering, based on rendering params.
+ * Component endpoint will either be retrieved from params or from endpointOverride
+ * @param {FEaaSComponentParams} params component params
+ * @param {boolean} [isPageStateNormal] whether page is in normal mode
+ * @param {string} [endpointOverride] optional override for component endpoint
+ */
+export declare function fetchFEaaSComponentServerProps(params: FEaaSComponentParams, isPageStateNormal?: boolean, endpointOverride?: string): Promise<FEaaSComponentServerProps>;
+/**
+ * Build component endpoint URL from component's params
+ * @param {FEaaSComponentParams} params rendering parameters for FEAAS component
+ * @param {RevisionType} revisionFallback fallback revision to fetch if revision is absent in params
+ * @returns component endpoint URL
+ */
+export declare const composeComponentEndpoint: (params: FEaaSComponentParams, revisionFallback: RevisionType) => string;

package/types/components/FEaaS/index.d.ts

@@ -0,0 +1,6 @@
+export { FEaaSWrapper, FEaaSComponent } from './FEaaSWrapper';
+export { BYOCWrapper, BYOCComponent } from './BYOCWrapper';
+export { FEaaSComponentClientProps, FEaaSComponentParams, FEaaSComponentProps, FEaaSServerWrapperProps, BYOCComponentParams, BYOCComponentProps, BYOCServerWrapperProps, FEAAS_COMPONENT_RENDERING_NAME, BYOC_COMPONENT_RENDERING_NAME, FEAAS_WRAPPER_RENDERING_NAME, BYOC_WRAPPER_RENDERING_NAME, } from './models';
+export { FEaaSServerWrapper } from './FEaaSSeverWrapper';
+export { BYOCServerWrapper } from './BYOCServerWrapper';
+export { fetchFEaaSComponentServerProps, fetchBYOCComponentServerProps } from './feaas-utils';

package/types/components/FEaaS/models.d.ts

@@ -0,0 +1,125 @@
+import * as FEAAS from '@sitecore-feaas/clientside/react';
+import { ComponentFields, ComponentRendering } from '@sitecore-content-sdk/core/layout';
+import { Page } from '@sitecore-content-sdk/core/client';
+import { MissingComponentProps } from '../MissingComponent';
+export declare const FEAAS_WRAPPER_RENDERING_NAME = "FEaaSWrapper";
+export declare const FEAAS_COMPONENT_RENDERING_NAME = "FEaaSComponent";
+export declare const BYOC_WRAPPER_RENDERING_NAME = "BYOCWrapper";
+export declare const BYOC_COMPONENT_RENDERING_NAME = "BYOCComponent";
+/**
+ * FEaaS props for server rendering.
+ */
+export type BYOCServerProps = {
+    /**
+     * Fetched data from server component props for server rendering, based on rendering params.
+     */
+    fetchedData?: FEAAS.DataScopes;
+};
+/**
+ * Data from rendering params on Sitecore's BYOC rendering
+ */
+export type BYOCComponentParams = {
+    /**
+     * Name of the component to render
+     */
+    ComponentName?: string;
+    /**
+     * JSON props to pass into rendered component
+     */
+    ComponentProps?: string;
+    /**
+     * A JSON object with data sources to be fetched and passed to the component
+     */
+    ComponentDataOverride?: string;
+    /**
+     * A string with classes that can be used to apply themes, via SXA functionality
+     */
+    styles?: string;
+    RenderingIdentifier?: string;
+};
+/**
+ * Props for BYOCComponent. Includes components list to load external components from.
+ */
+export type BYOCComponentClientProps = {
+    /**
+     * rendering data
+     */
+    rendering: ComponentRendering;
+    /**
+     * rendering params
+     */
+    params?: BYOCComponentParams;
+    /**
+     * fields from datasource items to be passed as rendered child component props
+     */
+    fields?: ComponentFields;
+    /**
+     * Error component override. To be shown when Renderer or underlying component throws
+     */
+    errorComponent?: React.ComponentClass<ErrorComponentProps> | React.FC<ErrorComponentProps>;
+    /**
+     * Override to indicate missing component situations. Would be shown when BYOC component is not registered
+     * or ComponentName is missing
+     */
+    missingComponentComponent?: React.ComponentClass<MissingComponentProps> | React.FC<MissingComponentProps>;
+};
+export type BYOCServerWrapperProps = BYOCComponentProps & {
+    rendering: ComponentRendering;
+};
+export type BYOCComponentProps = BYOCComponentClientProps & BYOCServerProps;
+export type ErrorComponentProps = {
+    [prop: string]: unknown;
+    error?: Error;
+};
+/**
+ * Params from a Sitecore FEaaS rendering
+ */
+export type FEaaSComponentParams = {
+    LibraryId?: string;
+    ComponentId?: string;
+    ComponentVersion?: string;
+    ComponentRevision?: RevisionType;
+    ComponentHostName?: string;
+    ComponentInstanceId?: string;
+    ComponentDataOverride?: string;
+    ComponentHTMLOverride?: string;
+    styles?: string;
+    RenderingIdentifier?: string;
+};
+export type RevisionType = number | 'staged' | 'published' | 'saved';
+export type FEaaSServerWrapperProps = FEaaSComponentProps & {
+    rendering?: ComponentRendering;
+    page?: Page;
+};
+export type FEaaSComponentProps = FEaaSComponentServerProps & FEaaSComponentClientProps;
+/**
+ * FEaaS props for server rendering.
+ */
+export type FEaaSComponentServerProps = {
+    /**
+     * HTML template for presentation rendered inside the component
+     */
+    template?: string;
+    /**
+     * Default revision to be fetched. Should be 'staged' for editing/preview. Can be overriden by params.ComponentRevision
+     */
+    revisionFallback?: RevisionType;
+    /**
+     * Fetched data from server component props for server rendering, based on rendering params.
+     */
+    fetchedData?: FEAAS.DataScopes;
+};
+/**
+ * FEaaS props for client side component. Should be used as fallback when server props are not provided.
+ * Would also be passed on server to avoid hydration issues
+ */
+export type FEaaSComponentClientProps = {
+    /**
+     * parameters from Sitecore's FEAAS component
+     */
+    params?: FEaaSComponentParams;
+    /**
+     * field data from component's datasource
+     */
+    fields?: ComponentFields;
+};

package/types/components/Image.d.ts

@@ -25,7 +25,7 @@ export interface ImageSizeParameters {
     /** Image scale. Defaults to 1.0 */
     sc?: number;
 }
-export interface ImageProps extends EditableFieldProps {
+export interface ImageProps extends EditableFieldProps<ImageProps> {
     [attributeName: string]: unknown;
     /** Image field data (consistent with other field types) */
     field?: (ImageField | ImageFieldValue) & FieldMetadata;

package/types/components/Link.d.ts

@@ -16,7 +16,7 @@ export interface LinkFieldValue {
 export interface LinkField {
     value: LinkFieldValue;
 }
-export type LinkProps = EditableFieldProps & React.AnchorHTMLAttributes<HTMLAnchorElement> & RefAttributes<HTMLAnchorElement> & {
+export type LinkProps = EditableFieldProps<LinkProps> & React.AnchorHTMLAttributes<HTMLAnchorElement> & RefAttributes<HTMLAnchorElement> & {
     /** The link field data. */
     field: (LinkField | LinkFieldValue) & FieldMetadata;
     /**

package/types/components/Placeholder/AppPlaceholder.d.ts

@@ -0,0 +1,10 @@
+import { AppPlaceholderProps } from './models';
+import React from 'react';
+/**
+ * The implemention of placeholder compatible with React Server Components.
+ * Renders components from the layout data for the given placeholder name, with consideration for page edit mode.
+ * Pulls components from the provided component map.
+ * @param {AppPlaceholderProps} props Placeholder props
+ * @returns {React.ReactNode | React.ReactElement[]} rendered component(s)
+ */
+export declare const AppPlaceholder: (props: AppPlaceholderProps) => string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>> | React.JSX.Element | (string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>> | React.JSX.Element)[];

package/types/components/Placeholder/ClientComponentWrapper.d.ts

@@ -0,0 +1,9 @@
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+import React from 'react';
+import { AppComponentProps } from './models';
+export interface ClientComponentWrapperProps {
+    rendering: ComponentRendering;
+    componentProps: AppComponentProps;
+    placeholderName: string;
+}
+export declare const ClientComponentWrapper: (props: ClientComponentWrapperProps) => React.JSX.Element;

package/types/components/Placeholder/Placeholder.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import { PlaceholderProps } from './models';
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+export declare class PlaceholderComponent extends React.Component<PlaceholderProps> {
+    isEmpty: boolean;
+    state: Readonly<{
+        error?: Error;
+    }>;
+    constructor(props: PlaceholderProps);
+    /**
+     * Renders the components for the placeholder based on the provided rendering data.
+     * @param {PlaceholderProps} props placeholder component props
+     * @param {ComponentRendering[]} placeholderRenderings renderings within placeholder
+     * @returns {React.ReactNode | React.ReactElement[]} rendered components
+     */
+    static getRenderedComponents: (props: PlaceholderProps, placeholderRenderings: ComponentRendering[]) => React.JSX.Element[];
+    componentDidMount(): void;
+    componentDidCatch(error: Error): void;
+    /**
+     * Renders the placeholder when it is empty. The required CSS styles are applied to the placeholder in edit mode.
+     * @param {React.ReactNode | React.ReactElement[]} node react node
+     * @returns react node
+     * @deprecated use renderEmptyPlaceholder from react/nextjs import instead
+     */
+    renderEmptyPlaceholder(node: React.ReactNode | React.ReactElement[]): React.JSX.Element;
+    render(): string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>> | React.JSX.Element | (string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>> | React.JSX.Element)[];
+}
+export declare const Placeholder: (props: import("@sitecore-content-sdk/core/utils").EnhancedOmit<PlaceholderProps, keyof import("../../enhancers/withSitecore").WithSitecoreProps>) => React.JSX.Element;

package/types/components/Placeholder/index.d.ts

@@ -0,0 +1,5 @@
+export { Placeholder, PlaceholderComponent } from './Placeholder';
+export { PlaceholderMetadata } from './PlaceholderMetadata';
+export { PlaceholderProps, AppPlaceholderProps } from './models';
+export { AppPlaceholder } from './AppPlaceholder';
+export * from './placeholder-utils';

package/types/components/Placeholder/models.d.ts

@@ -0,0 +1,140 @@
+import { Page } from '@sitecore-content-sdk/core/client';
+import { ComponentRendering, Field, Item, RouteData } from '@sitecore-content-sdk/core/layout';
+import { ComponentType } from '@sitecore-content-sdk/core/tools';
+import { ComponentMap } from '../sharedTypes';
+export type { ComponentType };
+type ErrorComponentProps = {
+    [prop: string]: unknown;
+};
+/** Provided for the component which represents rendering data */
+export type ComponentProps = {
+    [key: string]: unknown;
+    rendering: ComponentRendering;
+};
+export interface AppComponentProps {
+    fields: {
+        [name: string]: Field | Item | Item[];
+    };
+    params: {
+        [name: string]: string;
+    };
+    rendering: ComponentRendering;
+}
+export interface BasePlaceholderProps {
+    /** Name of the placeholder to render. */
+    name: string;
+    /** Rendering data to be used when rendering the placeholder. */
+    rendering: ComponentRendering | RouteData;
+    /**
+     * An object of field names/values that are aggregated and propagated through the component tree created by a placeholder.
+     * Any component or placeholder rendered by a placeholder will have access to this data via `props.fields`.
+     */
+    fields?: {
+        [name: string]: Field | Item | Item[];
+    };
+    /**
+     * An object of rendering parameter names/values that are aggregated and propagated through the component tree created by a placeholder.
+     * Any component or placeholder rendered by a placeholder will have access to this data via `props.params`.
+     */
+    params?: {
+        [name: string]: string;
+    };
+    /**
+     * A component that is rendered in place of any components that are in this placeholder,
+     * but do not have a definition in the componentMap (i.e. don't have a React implementation)
+     */
+    missingComponentComponent?: React.ComponentClass<unknown> | React.FC<unknown>;
+    /**
+     * A component that is rendered in place of any components that are hidden
+     */
+    hiddenRenderingComponent?: React.ComponentClass<unknown> | React.FC<unknown>;
+    /**
+     * A component that is rendered in place of the placeholder when an error occurs rendering
+     * the placeholder
+     */
+    errorComponent?: React.ComponentClass<ErrorComponentProps> | React.FC<ErrorComponentProps>;
+    /**
+     * Page data.
+     * This data is passed by the SitecoreProvider.
+     */
+    page: Page;
+    /**
+     * The message that gets displayed while component is loading
+     */
+    componentLoadingMessage?: string;
+    /**
+     * If true, disables Suspense in ErrorBoundary for the placeholder.
+     * @default false
+     */
+    disableSuspense?: boolean;
+    /**
+     * Render props function that is called when the placeholder contains no content components.
+     */
+    renderEmpty?: (components: React.ReactNode[]) => React.ReactNode;
+    /**
+     * Render props function that is called for each non-system component added to the placeholder.
+     * Mutually exclusive with `render`.
+     */
+    renderEach?: (component: React.ReactNode, index: number) => React.ReactNode;
+}
+export interface PlaceholderProps extends BasePlaceholderProps {
+    [key: string]: unknown;
+    /**
+     * Component Map will be used to map Sitecore component names to app implementation
+     * When rendered within a <SitecoreProvider> component, defaults to the context componentMap.
+     * When rendered as a server placeholder, this prop must be provided. This prop is not used in AppPlaceholder.
+     */
+    componentMap?: ComponentMap;
+    /**
+     * Modify final props of component (before render) provided by rendering data.
+     * Can be used in case when you need to insert additional data into the component.
+     * @param {ComponentProps} componentProps component props to be modified
+     * @returns {ComponentProps} modified or initial props
+     */
+    modifyComponentProps?: (componentProps: ComponentProps) => ComponentProps;
+    /**
+     * Render props function that enables control over the rendering of the components in the placeholder.
+     * Useful for techniques like wrapping each child in a wrapper component.
+     */
+    render?: (components: React.ReactNode[], data: ComponentRendering[], props: PlaceholderProps) => React.ReactNode;
+}
+export interface AppPlaceholderProps extends BasePlaceholderProps {
+    /**
+     * Component Map will be used to map Sitecore component names to app implementation
+     * When rendered within a <SitecoreProvider> component, defaults to the context componentMap.
+     * When rendered as a server placeholder, this prop must be provided. This prop is not used in AppPlaceholder.
+     */
+    componentMap: ComponentMap;
+    /**
+     * Modify final props of component (before render) provided by rendering data.
+     * Can be used in case when you need to insert additional data into the component.
+     * @param {AppComponentProps} componentProps component props to be modified
+     * @returns {AppComponentProps} modified or initial props
+     */
+    modifyComponentProps?: (componentProps: AppComponentProps) => AppComponentProps;
+    /**
+     * Render props function that enables control over the rendering of the components in the placeholder.
+     * Useful for techniques like wrapping each child in a wrapper component.
+     */
+    render?: (components: React.ReactNode[], data: ComponentRendering[], props: AppPlaceholderProps) => React.ReactNode;
+}
+export type RenderedProps = Omit<PlaceholderProps, 'fields' | 'params'> & {
+    key: string;
+    fields: {
+        [field: string]: unknown;
+    };
+    params: {
+        [param: string]: unknown;
+    };
+    rendering: ComponentRendering;
+};
+export interface ComponentForRendering {
+    component: React.ComponentType<any>;
+    isEmpty: boolean;
+    dynamic?: boolean;
+    componentType?: ComponentType;
+}
+/**
+ * Prop names from placeholder that cannot be serialized and passed from server to client side components
+ */
+export declare const nonSerializedPlaceholderProps: ["renderEmpty", "render", "renderEach", "errorComponent", "componentLoadingMessage", "modifyComponentProps", "componentMap", "page", "missingComponentComponent", "hiddenRenderingComponent"];

package/types/components/Placeholder/placeholder-utils.d.ts

@@ -0,0 +1,53 @@
+import React from 'react';
+import { ComponentMap } from '../sharedTypes';
+import { ComponentRendering, RouteData } from '@sitecore-content-sdk/core/layout';
+import { AppComponentProps, BasePlaceholderProps, ComponentForRendering, PlaceholderProps, RenderedProps } from './models';
+/**
+ * Get the renderings for the specified placeholder from the rendering data.
+ * @param {ComponentRendering | RouteData } rendering rendering data
+ * @param {string} name placeholder name
+ * @param {boolean} isEditing whether components should be rendered in editing mode
+ * @returns {ComponentRendering[]} array of component renderings
+ */
+export declare const getPlaceholderRenderings: (rendering: ComponentRendering | RouteData, name: string, isEditing: boolean) => ComponentRendering<import("@sitecore-content-sdk/core/layout").ComponentFields>[];
+/**
+ * Get SXA specific params from Sitecore rendering params
+ * @param {ComponentRendering} rendering rendering object
+ * @returns {object} converted SXA params
+ */
+export declare const getSXAParams: (rendering: ComponentRendering) => {
+    styles?: undefined;
+} | {
+    styles: string;
+};
+/**
+ * Renders the placeholder when it is empty. The required CSS styles are applied to the placeholder in edit mode.
+ * @param {React.ReactNode | React.ReactElement[]} node react node
+ * @returns react node
+ */
+export declare const renderEmptyPlaceholder: (node: React.ReactNode | React.ReactElement[]) => React.JSX.Element;
+/**
+ * Get component props to be passed to the rendered component.
+ * @param {PlaceholderProps} placeholderProps current placeholder props
+ * @param {ComponentRendering} componentRendering rendering to be rendered
+ * @param {string} renderingKey unique key to pass over to rendering props
+ * @returns {RenderedProps} props to be passed to the rendered component
+ */
+export declare const getRenderedComponentProps: (placeholderProps: PlaceholderProps, componentRendering: ComponentRendering, renderingKey: string) => RenderedProps;
+/**
+ * Merge placeholder and component field and params content props.
+ * @param {BasePlaceholderProps} placeholderProps placeholder props
+ * @param {ComponentRendering} componentRendering component rendering
+ * @returns {ComponentProps} merged props
+ */
+export declare function getAppComponentProps<T extends BasePlaceholderProps>(placeholderProps: T, componentRendering: ComponentRendering): AppComponentProps;
+/**
+ * Get component implemenation from the component map based on the rendering definition.
+ * @param {ComponentRendering} renderingDefinition rendering data
+ * @param {string} placeholderName name of current placeholder
+ * @param {ComponentMap} componentMap component map for the current app
+ * @param {React.ComponentClass} [hiddenRenderingComponent] fallback implementation in to be rendered if the rendering is hidden
+ * @param {React.ComponentClass} [missingComponentComponent] fallback implementation in case no component is found in the component map
+ * @returns {ContentSDKComponet | null} component implementation or null if no component map is provided
+ */
+export declare const getComponentForRendering: (renderingDefinition: ComponentRendering, placeholderName: string, componentMap?: ComponentMap, hiddenRenderingComponent?: React.ComponentClass | React.FC, missingComponentComponent?: React.ComponentClass | React.FC) => ComponentForRendering;

package/types/components/RichText.d.ts

@@ -4,7 +4,7 @@ import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
 export interface RichTextField extends FieldMetadata {
     value?: string;
 }
-export interface RichTextProps extends EditableFieldProps {
+export interface RichTextProps extends EditableFieldProps<RichTextProps> {
     [htmlAttributes: string]: unknown;
     /** The rich text field data. */
     field?: RichTextField;

package/types/components/Text.d.ts

@@ -4,7 +4,7 @@ import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
 export interface TextField extends FieldMetadata {
     value?: string | number;
 }
-export interface TextProps extends EditableFieldProps {
+export interface TextProps extends EditableFieldProps<TextProps> {
     [htmlAttributes: string]: unknown;
     /** The text field data. */
     field?: TextField;

package/types/components/sharedTypes/components.d.ts

@@ -1,4 +1,10 @@
 import { ComponentType } from 'react';
+/**
+ * React component import with account for custom exports
+ */
+export type ReactJssComponent = (ComponentType | ReactModule) & {
+    isClient?: boolean;
+};
 /**
  * SXA uses custom default export name
  */

package/types/components/sharedTypes/props.d.ts

@@ -1,7 +1,7 @@
 /**
  * Shared editing field props
  */
-export interface EditableFieldProps {
+export interface EditableFieldProps<EmptyFieldEditingComponentProps = unknown> {
     /**
      * Can be used to explicitly disable inline editing.
      * @default true
@@ -10,5 +10,5 @@ export interface EditableFieldProps {
     /**
      * Custom element to render in Pages in edit mode if field value is empty
      */
-    emptyFieldEditingComponent?: React.ComponentClass<unknown> | React.FC<unknown>;
+    emptyFieldEditingComponent?: React.ComponentClass<EmptyFieldEditingComponentProps> | React.FC<EmptyFieldEditingComponentProps>;
 }

package/types/enhancers/withAppPlaceholder.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { ComponentType } from 'react';
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+import { Page } from '@sitecore-content-sdk/core/client';
+import { ComponentMap } from '../components/sharedTypes';
+export type ComponentProps = {
+    rendering: ComponentRendering;
+    placeholders: Record<string, React.ReactNode>;
+};
+export type WrapperProps = {
+    rendering: ComponentRendering;
+    page: Page;
+    componentMap: ComponentMap;
+};
+export declare const withAppPlaceholder: <T extends ComponentProps, W extends T & WrapperProps>(Component: ComponentType<T>) => (props: W) => React.JSX.Element;

package/types/enhancers/withEmptyFieldEditingComponent.d.ts

@@ -13,15 +13,15 @@ export interface WithEmptyFieldEditingComponentOptions {
      */
     isForwardRef?: boolean;
 }
-interface WithEmptyFieldEditingComponentProps {
+interface WithEmptyFieldEditingComponentProps<Props> {
     field?: (Partial<Field> | GenericFieldValue) & FieldMetadata;
     editable?: boolean;
-    emptyFieldEditingComponent?: React.ComponentClass | React.FC;
+    emptyFieldEditingComponent?: React.ComponentClass<Props> | React.FC<Props>;
 }
 /**
  * Returns the passed field component or default component in case field value is empty and edit mode is 'metadata'
  * @param {ComponentType<FieldComponentProps>} FieldComponent the field component
  * @param {WithEmptyFieldEditingComponentProps} options the options of the HOC;
  */
-export declare function withEmptyFieldEditingComponent<FieldComponentProps extends WithEmptyFieldEditingComponentProps, RefElementType = HTMLElement>(FieldComponent: ComponentType<FieldComponentProps>, options: WithEmptyFieldEditingComponentOptions): React.ForwardRefExoticComponent<React.PropsWithoutRef<FieldComponentProps> & React.RefAttributes<RefElementType>> | ((props: FieldComponentProps) => React.JSX.Element);
+export declare function withEmptyFieldEditingComponent<FieldComponentProps extends WithEmptyFieldEditingComponentProps<FieldComponentProps>, RefElementType = HTMLElement>(FieldComponent: ComponentType<FieldComponentProps>, options: WithEmptyFieldEditingComponentOptions): React.ForwardRefExoticComponent<React.PropsWithoutRef<FieldComponentProps> & React.RefAttributes<RefElementType>> | ((props: FieldComponentProps) => React.JSX.Element);
 export {};

package/types/enhancers/withPlaceholder.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { ComponentRendering, RouteData } from '@sitecore-content-sdk/core/layout';
-import { PlaceholderProps } from '../components/PlaceholderCommon';
+import { PlaceholderProps } from '../components/Placeholder';
 export interface WithPlaceholderOptions {
     /**
      * Function to map incoming placeholder props into rendering data to use for the placeholder data.
@@ -28,6 +28,7 @@ export interface PlaceholderToPropMapping {
 }
 export type WithPlaceholderSpec = (string | PlaceholderToPropMapping) | (string | PlaceholderToPropMapping)[];
 /**
+ * HOC to provide client-side placeholder functionality to a component.
  * @param {WithPlaceholderSpec} placeholders
  * @param {WithPlaceholderOptions} [options]
  */

package/types/index.d.ts

@@ -7,16 +7,14 @@ export { GraphQLClientError, RetryStrategy, DefaultRetryStrategy, GraphQLRequest
 export { mediaApi } from '@sitecore-content-sdk/core/media';
 export { Form } from './components/Form';
 export { ReactContentSdkComponent, ComponentMap, ReactModule } from './components/sharedTypes';
-export { Placeholder, PlaceholderComponentProps } from './components/Placeholder';
+export { Placeholder, PlaceholderProps, PlaceholderProps as PlaceholderComponentProps, AppPlaceholder, AppPlaceholderProps, } from './components/Placeholder';
 export { Image, ImageProps, ImageField, ImageFieldValue, ImageSizeParameters, } from './components/Image';
 export { RichText, RichTextProps, RichTextField } from './components/RichText';
 export { Text, TextField } from './components/Text';
 export { DateField, DateFieldProps } from './components/Date';
-export { FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, } from './components/FEaaSComponent';
-export { FEaaSWrapper } from './components/FEaaSWrapper';
+export { FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponent, BYOCComponentParams, BYOCComponentProps, fetchBYOCComponentServerProps, BYOCWrapper, BYOCWrapper as BYOCClientWrapper, FEaaSWrapper, FEaaSWrapper as FEaaSClientWrapper, FEaaSServerWrapper, BYOCServerWrapper, } from './components/FEaaS';
 export { DesignLibrary } from './components/DesignLibrary';
-export { BYOCComponent, BYOCComponentParams, BYOCComponentProps, fetchBYOCComponentServerProps, } from './components/BYOCComponent';
-export { BYOCWrapper } from './components/BYOCWrapper';
+export {} from './components/FEaaS/BYOCComponent';
 export { Link, LinkField, LinkFieldValue, LinkProps } from './components/Link';
 export { File, FileField } from './components/File';
 export { SitecoreProvider, SitecoreProviderState, SitecoreProviderReactContext, } from './components/SitecoreProvider';
@@ -28,4 +26,5 @@ export { withFieldMetadata } from './enhancers/withFieldMetadata';
 export { withEmptyFieldEditingComponent } from './enhancers/withEmptyFieldEditingComponent';
 export { EditingScripts } from './components/EditingScripts';
 export { DefaultEmptyFieldEditingComponentText, DefaultEmptyFieldEditingComponentImage, } from './components/DefaultEmptyFieldEditingComponents';
+export { ClientEditingChromesUpdate } from './components/ClientEditingChromesUpdate';
 export { SitePathService, SitePathServiceConfig } from '@sitecore-content-sdk/core/site';

package/types/rsc-utils/no-rsc.d.ts

@@ -0,0 +1 @@
+export declare const rsc = false;

package/types/rsc-utils/rsc.d.ts

@@ -0,0 +1 @@
+export declare const rsc = true;

package/dist/cjs/components/BYOCWrapper.js

@@ -1,22 +0,0 @@
-"use strict";
-'use client';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BYOCWrapper = exports.BYOC_WRAPPER_RENDERING_NAME = void 0;
-const BYOCComponent_1 = require("./BYOCComponent");
-const react_1 = __importDefault(require("react"));
-exports.BYOC_WRAPPER_RENDERING_NAME = 'BYOCWrapper';
-/**
- * TODO: remove when framework agnostic forms implemented
- */
-const BYOCWrapper = (props) => {
-    var _a, _b, _c;
-    const styles = (_b = (_a = props.params) === null || _a === void 0 ? void 0 : _a.styles) === null || _b === void 0 ? void 0 : _b.trimEnd();
-    const id = (_c = props.params) === null || _c === void 0 ? void 0 : _c.RenderingIdentifier;
-    return (react_1.default.createElement("div", { className: styles ? styles : undefined, id: id ? id : undefined },
-        react_1.default.createElement("div", { className: "component-content" },
-            react_1.default.createElement(BYOCComponent_1.BYOCComponent, Object.assign({}, props)))));
-};
-exports.BYOCWrapper = BYOCWrapper;

package/dist/cjs/components/FEaaSWrapper.js

@@ -1,19 +0,0 @@
-"use strict";
-'use client';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FEaaSWrapper = exports.FEAAS_WRAPPER_RENDERING_NAME = void 0;
-const FEaaSComponent_1 = require("./FEaaSComponent");
-const react_1 = __importDefault(require("react"));
-exports.FEAAS_WRAPPER_RENDERING_NAME = 'FEaaSWrapper';
-const FEaaSWrapper = (props) => {
-    var _a, _b;
-    const styles = `component feaas ${(_a = props.params) === null || _a === void 0 ? void 0 : _a.styles}`.trimEnd();
-    const id = (_b = props.params) === null || _b === void 0 ? void 0 : _b.RenderingIdentifier;
-    return (react_1.default.createElement("div", { className: styles, id: id ? id : undefined },
-        react_1.default.createElement("div", { className: "component-content" },
-            react_1.default.createElement(FEaaSComponent_1.FEaaSComponent, Object.assign({}, props)))));
-};
-exports.FEaaSWrapper = FEaaSWrapper;