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

package/types/components/FEaaSComponent.d.ts

@@ -1,72 +0,0 @@
-import { JSX } from 'react';
-import * as FEAAS from '@sitecore-feaas/clientside/react';
-import { ComponentFields, LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
-export declare const FEAAS_COMPONENT_RENDERING_NAME = "FEaaSComponent";
-/**
- * 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;
-};
-type RevisionType = number | 'staged' | 'published' | 'saved';
-/**
- * FEaaS props for server rendering.
- */
-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
- */
-type FEaaSComponentClientProps = {
-    /**
-     * parameters from Sitecore's FEAAS component
-     */
-    params?: FEaaSComponentParams;
-    /**
-     * field data from component's datasource
-     */
-    fields?: ComponentFields;
-};
-export type FEaaSComponentProps = FEaaSComponentServerProps & FEaaSComponentClientProps;
-/**
- * @param {FEaaSComponentProps} props component props
- */
-export declare const FEaaSComponent: (props: FEaaSComponentProps) => JSX.Element;
-/**
- * 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 {LayoutServicePageState} [pageState] page state to determine which component variant to use
- * @param {string} [endpointOverride] optional override for component endpoint
- */
-export declare function fetchFEaaSComponentServerProps(params: FEaaSComponentParams, pageState?: LayoutServicePageState, endpointOverride?: string): Promise<FEaaSComponentProps>;
-/**
- * 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;
-export {};

package/types/components/FEaaSWrapper.d.ts

@@ -1,4 +0,0 @@
-import { FEaaSComponentProps } from './FEaaSComponent';
-import { JSX } from 'react';
-export declare const FEAAS_WRAPPER_RENDERING_NAME = "FEaaSWrapper";
-export declare const FEaaSWrapper: (props: FEaaSComponentProps) => JSX.Element;

package/types/components/Placeholder.d.ts

@@ -1,20 +0,0 @@
-import React from 'react';
-import { PlaceholderProps } from './PlaceholderCommon';
-import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
-export interface PlaceholderComponentProps extends PlaceholderProps {
-    /**
-     * Render props function that is called when the placeholder contains no content components.
-     */
-    renderEmpty?: (components: React.ReactNode[]) => React.ReactNode;
-    /**
-     * 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;
-    /**
-     * 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 declare const Placeholder: (props: import("@sitecore-content-sdk/core/utils").EnhancedOmit<PlaceholderComponentProps, keyof import("../enhancers/withSitecore").WithSitecoreProps>) => React.JSX.Element;

package/types/components/PlaceholderCommon.d.ts

@@ -1,89 +0,0 @@
-import React, { ComponentType } from 'react';
-import { ComponentMap } from './sharedTypes';
-import { ComponentRendering, RouteData, Field, Item } from '@sitecore-content-sdk/core/layout';
-import { Page } from '@sitecore-content-sdk/core/client';
-type ErrorComponentProps = {
-    [prop: string]: unknown;
-};
-/** Provided for the component which represents rendering data */
-export type ComponentProps = {
-    [key: string]: unknown;
-    rendering: ComponentRendering;
-};
-export interface PlaceholderProps {
-    [key: string]: unknown;
-    /** Name of the placeholder to render. */
-    name: string;
-    /** Rendering data to be used when rendering the placeholder. */
-    rendering: ComponentRendering | RouteData;
-    /**
-     * Component Map will be used to map Sitecore component names to app implementation
-     * When rendered within a <SitecoreProvider> component, defaults to the context componentMap.
-     */
-    componentMap?: ComponentMap;
-    /**
-     * 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;
-    };
-    /**
-     * 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;
-    /**
-     * 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;
-}
-export declare class PlaceholderCommon<T extends PlaceholderProps> extends React.Component<T> {
-    state: Readonly<{
-        error?: Error;
-    }>;
-    constructor(props: T);
-    static getPlaceholderDataFromRenderingData(rendering: ComponentRendering | RouteData, name: string, isEditing: boolean): ComponentRendering<import("@sitecore-content-sdk/core/layout").ComponentFields>[];
-    componentDidCatch(error: Error): void;
-    getSXAParams(rendering: ComponentRendering): {
-        styles?: undefined;
-    } | {
-        styles: string;
-    };
-    getComponentsForRenderingData(placeholderData: ComponentRendering[]): React.JSX.Element[];
-    getComponentForRendering(renderingDefinition: ComponentRendering): ComponentType | null;
-}
-export {};