@sitecore-content-sdk/react 1.3.0-canary.9 → 1.4.0-canary.2

package/types/components/MissingComponent.d.ts

@@ -1,8 +1,9 @@
-import React from 'react';
-export interface MissingComponentProps {
-    rendering?: {
-        componentName?: string;
-    };
-    errorOverride?: string;
-}
-export declare const MissingComponent: React.FC<MissingComponentProps>;
+import React from 'react';
+export interface MissingComponentProps {
+    rendering?: {
+        componentName?: string;
+    };
+    errorOverride?: string;
+}
+export declare const MissingComponent: React.FC<MissingComponentProps>;
+//# sourceMappingURL=MissingComponent.d.ts.map

package/types/components/MissingComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MissingComponent.d.ts","sourceRoot":"","sources":["../../src/components/MissingComponent.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,WAAW,qBAAqB;IACpC,SAAS,CAAC,EAAE;QACV,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CA0B5D,CAAC"}

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

@@ -1,10 +1,12 @@
-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)[];
+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)
+ * @public
+ */
+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> | null | undefined> | 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> | null | undefined> | React.JSX.Element | null | undefined)[] | null | undefined;
+//# sourceMappingURL=AppPlaceholder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AppPlaceholder.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/AppPlaceholder.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAO/C,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,mBAAmB,0kBAyHxD,CAAC"}

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

@@ -1,9 +1,10 @@
-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;
+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;
+//# sourceMappingURL=ClientComponentWrapper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClientComponentWrapper.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/ClientComponentWrapper.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAG7C,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,cAAc,EAAE,iBAAiB,CAAC;IAClC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,sBAAsB,GAAI,OAAO,2BAA2B,sBAexE,CAAC"}

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

@@ -1,28 +1,33 @@
-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;
+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> | null | undefined> | 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> | null | undefined> | React.JSX.Element | null | undefined)[] | null | undefined;
+}
+/**
+ * The Placeholder component.
+ * @public
+ */
+export declare const Placeholder: (props: import("@sitecore-content-sdk/core/utils").EnhancedOmit<PlaceholderProps, keyof import("../../enhancers/withSitecore").WithSitecoreProps>) => React.JSX.Element;
+//# sourceMappingURL=Placeholder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Placeholder.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/Placeholder.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAU5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAIvE,qBAAa,oBAAqB,SAAQ,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC;IACzE,OAAO,UAAS;IAChB,KAAK,EAAE,QAAQ,CAAC;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC,CAAC;gBAEvB,KAAK,EAAE,gBAAgB;IAKnC;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,GAC1B,OAAO,gBAAgB,EACvB,uBAAuB,kBAAkB,EAAE,yBAoE3C;IAEF,iBAAiB;IAMjB,iBAAiB,CAAC,KAAK,EAAE,KAAK;IAI9B;;;;;OAKG;IACH,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE;IAInE,MAAM;CAkDP;AAID;;;GAGG;AACH,eAAO,MAAM,WAAW,yKAA8C,CAAC"}

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

@@ -1,28 +1,35 @@
-import { ReactNode, JSX } from 'react';
-import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
-/**
- *  Props containing the component data to render.
- */
-export interface PlaceholderMetadataProps {
-    rendering: ComponentRendering;
-    placeholderName?: string;
-    children?: ReactNode;
-}
-export type CodeBlockAttributes = {
-    type: string;
-    chrometype: string;
-    className: string;
-    kind: string;
-    id?: string;
-};
-/**
- * A React component to generate metadata blocks for a placeholder or rendering.
- * It utilizes dynamic attributes based on whether the component acts as a placeholder
- * or as a rendering to properly render the surrounding code blocks.
- * @param {object} props The properties passed to the component.
- * @param {ComponentRendering} props.rendering The rendering data.
- * @param {string} [props.placeholderName] The name of the placeholder.
- * @param {JSX.Element} props.children The child components or elements to be wrapped by the metadata code blocks.
- * @returns {JSX.Element} A React fragment containing open and close code blocks surrounding the children elements.
- */
-export declare const PlaceholderMetadata: ({ rendering, placeholderName, children, }: PlaceholderMetadataProps) => JSX.Element;
+import { ReactNode, JSX } from 'react';
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+/**
+ *  Props containing the component data to render.
+ */
+export interface PlaceholderMetadataProps {
+    rendering: ComponentRendering;
+    placeholderName?: string;
+    children?: ReactNode;
+    /**
+     * Component runtime type. Used to add data-csdk-component-runtime attribute to rendering chromes
+     */
+    componentRuntime?: 'server' | 'client';
+}
+export type CodeBlockAttributes = {
+    type: string;
+    chrometype: string;
+    className: string;
+    kind: string;
+    id?: string;
+    'data-csdk-component-runtime'?: 'server' | 'client';
+};
+/**
+ * A React component to generate metadata blocks for a placeholder or rendering.
+ * It utilizes dynamic attributes based on whether the component acts as a placeholder
+ * or as a rendering to properly render the surrounding code blocks.
+ * @param {object} props The properties passed to the component.
+ * @param {ComponentRendering} props.rendering The rendering data.
+ * @param {string} [props.placeholderName] The name of the placeholder.
+ * @param {'server' | 'client'} [props.componentRuntime] Component runtime type. Used to add data-csdk-component-runtime attribute to rendering chromes.
+ * @param {JSX.Element} props.children The child components or elements to be wrapped by the metadata code blocks.
+ * @returns {JSX.Element} A React fragment containing open and close code blocks surrounding the children elements.
+ */
+export declare const PlaceholderMetadata: ({ rendering, placeholderName, children, componentRuntime, }: PlaceholderMetadataProps) => JSX.Element;
+//# sourceMappingURL=PlaceholderMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlaceholderMetadata.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/PlaceholderMetadata.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EACL,kBAAkB,EAGnB,MAAM,mCAAmC,CAAC;AAG3C;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACxC;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,6BAA6B,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACrD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAAI,6DAKjC,wBAAwB,KAAG,GAAG,CAAC,OAkEjC,CAAC"}

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

@@ -1,5 +1,6 @@
-export { Placeholder, PlaceholderComponent } from './Placeholder';
-export { PlaceholderMetadata } from './PlaceholderMetadata';
-export { PlaceholderProps, AppPlaceholderProps } from './models';
-export { AppPlaceholder } from './AppPlaceholder';
-export * from './placeholder-utils';
+export { Placeholder, PlaceholderComponent } from './Placeholder';
+export { PlaceholderMetadata } from './PlaceholderMetadata';
+export { PlaceholderProps, AppPlaceholderProps } from './models';
+export { AppPlaceholder } from './AppPlaceholder';
+export * from './placeholder-utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,cAAc,qBAAqB,CAAC"}

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

@@ -1,140 +1,149 @@
-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"];
+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;
+}
+/**
+ * The interface for the Placeholder component props.
+ * @public
+ */
+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;
+}
+/**
+ * The interface for the AppPlaceholder component props.
+ * @public
+ */
+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' | 'name'> & {
+    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"];
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/components/Placeholder/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B,KAAK,mBAAmB,GAAG;IACzB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACzB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,SAAS,EAAE,kBAAkB,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;KACvC,CAAC;IACF,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,SAAS,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;KACvC,CAAC;IACF;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAE9E;;OAEG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAE7E;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC3F;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC;IAEjE;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC;CAC7E;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,cAAc,CAAC;IAE1E;;;OAGG;IACH,MAAM,CAAC,EAAE,CACP,UAAU,EAAE,KAAK,CAAC,SAAS,EAAE,EAC7B,IAAI,EAAE,kBAAkB,EAAE,EAC1B,KAAK,EAAE,gBAAgB,KACpB,KAAK,CAAC,SAAS,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;;;OAIG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,CAAC,cAAc,EAAE,iBAAiB,KAAK,iBAAiB,CAAC;IAEhF;;;OAGG;IACH,MAAM,CAAC,EAAE,CACP,UAAU,EAAE,KAAK,CAAC,SAAS,EAAE,EAC7B,IAAI,EAAE,kBAAkB,EAAE,EAC1B,KAAK,EAAE,mBAAmB,KACvB,KAAK,CAAC,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GAAG;IACjF,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACrC,MAAM,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACrC,SAAS,EAAE,kBAAkB,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B,+LAWK,CAAC"}