@sitecore-content-sdk/react 1.0.0-canary.8 → 1.0.0

package/types/components/PlaceholderCommon.d.ts

@@ -1,7 +1,7 @@
 import React, { ComponentType } from 'react';
 import { ComponentMap } from './sharedTypes';
 import { ComponentRendering, RouteData, Field, Item } from '@sitecore-content-sdk/core/layout';
-import { SitecoreProviderPageContext } from './SitecoreProvider';
+import { Page } from '@sitecore-content-sdk/core/client';
 type ErrorComponentProps = {
     [prop: string]: unknown;
 };
@@ -57,10 +57,10 @@ export interface PlaceholderProps {
      */
     errorComponent?: React.ComponentClass<ErrorComponentProps> | React.FC<ErrorComponentProps>;
     /**
-     * Page context data.
+     * Page data.
      * This data is passed by the SitecoreProvider.
      */
-    pageContext: SitecoreProviderPageContext;
+    page: Page;
     /**
      * The message that gets displayed while component is loading
      */

package/types/components/SitecoreProvider.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
+import { Page } from '@sitecore-content-sdk/core/client';
 import { SitecoreConfig } from '@sitecore-content-sdk/core/config';
-import { LayoutServiceContext, LayoutServiceData, RouteData } from '../index';
 import { ComponentMap } from './sharedTypes';
 export interface SitecoreProviderProps {
     /**
@@ -12,22 +12,22 @@ export interface SitecoreProviderProps {
      */
     componentMap: ComponentMap;
     /**
-     * The Sitecore Layout data.
+     * The page data.
      */
-    layoutData?: LayoutServiceData;
+    page: Page;
     children: React.ReactNode;
 }
 export interface SitecoreProviderState {
     /**
-     * Method to set the page context.
-     * @param {SitecoreProviderPageContext | LayoutServiceData} value New page context value.
+     * Method to set the page.
+     * @param {Page} value New page  value.
      * @returns {void}
      */
-    setContext: (value: SitecoreProviderPageContext | LayoutServiceData) => void;
+    setPage: (value: Page) => void;
     /**
-     * The current page context.
+     * The current page.
      */
-    pageContext: SitecoreProviderPageContext;
+    page: Page;
     /**
      * The API configuration defined in the `SitecoreConfig`.
      */
@@ -35,23 +35,14 @@ export interface SitecoreProviderState {
 }
 export declare const SitecoreProviderReactContext: React.Context<SitecoreProviderState>;
 export declare const ComponentMapReactContext: React.Context<ComponentMap>;
-/**
- * The page context provided by the SitecoreProvider.
- */
-export type SitecoreProviderPageContext = LayoutServiceContext & {
-    itemId?: string;
-    route?: RouteData;
-};
 export declare class SitecoreProvider extends React.Component<SitecoreProviderProps, SitecoreProviderState> {
     static displayName: string;
     constructor(props: SitecoreProviderProps);
-    constructContext(layoutData?: LayoutServiceData): SitecoreProviderPageContext;
     componentDidUpdate(prevProps: SitecoreProviderProps): void;
     /**
-     * Update context state. Value can be @type {LayoutServiceData} which will be automatically transformed
-     * or you can provide exact @type {SitecoreProviderPageContext}
-     * @param {SitecoreProviderPageContext | LayoutServiceData} value New context value
+     * Update page state.
+     * @param {Page} value New page value
      */
-    setContext: (value: SitecoreProviderPageContext | LayoutServiceData) => void;
+    setPage: (value: Page) => void;
     render(): React.JSX.Element;
 }

package/types/enhancers/withSitecore.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
 import { EnhancedOmit } from '@sitecore-content-sdk/core/utils';
-import { SitecoreProviderState, SitecoreProviderPageContext } from '../components/SitecoreProvider';
+import { SitecoreProviderState } from '../components/SitecoreProvider';
+import { Page } from '@sitecore-content-sdk/core/client';
 export interface WithSitecoreOptions {
     /**
      * If set to true, the `updateContext` method will be injected into the component props.
@@ -11,17 +12,17 @@ export interface WithSitecoreProps {
     /**
      * The current page context.
      */
-    pageContext: SitecoreProviderPageContext;
+    page: Page;
     /**
      * The API configuration defined in the `SitecoreConfig`.
      */
     api?: SitecoreProviderState['api'];
     /**
-     * Method to update the page context. This is only available if `updatable` is set to true.
-     * @param {SitecoreProviderPageContext} value New page context value.
+     * Method to update the page. This is only available if `updatable` is set to true.
+     * @param {Page} value New page value.
      * @returns {void}
      */
-    updateContext?: ((value: SitecoreProviderPageContext) => void) | false;
+    updatePage?: ((value: Page) => void) | false;
 }
 export type WithSitecoreHocProps<ComponentProps> = EnhancedOmit<ComponentProps, keyof WithSitecoreProps>;
 /**
@@ -29,23 +30,19 @@ export type WithSitecoreHocProps<ComponentProps> = EnhancedOmit<ComponentProps,
  */
 export declare function withSitecore(options?: WithSitecoreOptions): <ComponentProps extends WithSitecoreProps>(Component: React.ComponentType<ComponentProps>) => (props: WithSitecoreHocProps<ComponentProps>) => React.JSX.Element;
 /**
- * This hook grants acсess to the current Sitecore page context and api.
- * by default Content SDK includes the following properties in this context:
- * - pageEditing - Provided by Layout Service, a boolean indicating whether the route is being accessed via the Sitecore Editor.
- * - pageState - Like pageEditing, but a string: normal, preview or edit.
- * - site - Provided by Layout Service, an object containing the name of the current Sitecore site context.
+ * This hook grants acсess to the current Sitecore page and api.
  * @param {WithSitecoreOptions} [options] hook options
  * @example
  * const EditMode = () => {
- *    const { pageContext } = useSitecore();
- *    return <span>Edit Mode is {pageContext.pageEditing ? 'active' : 'inactive'}</span>
+ *    const { page } = useSitecore();
+ *    return <span>Edit Mode is {page.mode.isEditing ? 'active' : 'inactive'}</span>
  * }
  * @example
  * const EditMode = () => {
- *    const { pageContext, updateContext } = useSitecore({ updatable: true });
- *    const onClick = () => updateContext({ pageEditing: true });
- *    return <span onClick={onClick}>Edit Mode is {pageContext.pageEditing ? 'active' : 'inactive'}</span>
+ *    const { page, updatePage } = useSitecore({ updatable: true });
+ *    const onClick = () => updatePage({ itemId: '123' });
+ *    return <span onClick={onClick}>Item id is {page.itemId}</span>
  * }
- * @returns {object} { api, pageContext, updateContext }
+ * @returns {object} { api, page, updatePage }
  */
 export declare function useSitecore(options?: WithSitecoreOptions): WithSitecoreProps;

package/types/index.d.ts

@@ -3,7 +3,7 @@ export { EnhancedOmit } from '@sitecore-content-sdk/core/utils';
 export { isEditorActive, resetEditorChromes } from '@sitecore-content-sdk/core/editing';
 export { getContentStylesheetLink, getDesignLibraryStylesheetLinks, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, LayoutService, RouteData, Field, Item, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, EditMode, } from '@sitecore-content-sdk/core/layout';
 export { DictionaryPhrases, DictionaryService } from '@sitecore-content-sdk/core/i18n';
-export { GraphQLClientError, RetryStrategy, DefaultRetryStrategy, GraphQLRequestClientFactoryConfig, GraphQLRequestClient, } from '@sitecore-content-sdk/core/client';
+export { GraphQLClientError, RetryStrategy, DefaultRetryStrategy, GraphQLRequestClientFactoryConfig, GraphQLRequestClient, PageMode, ErrorPage, Page, } from '@sitecore-content-sdk/core/client';
 export { mediaApi } from '@sitecore-content-sdk/core/media';
 export { Form } from './components/Form';
 export { ReactContentSdkComponent, ComponentMap, ReactModule } from './components/sharedTypes';
@@ -19,7 +19,7 @@ export { BYOCComponent, BYOCComponentParams, BYOCComponentProps, fetchBYOCCompon
 export { BYOCWrapper } from './components/BYOCWrapper';
 export { Link, LinkField, LinkFieldValue, LinkProps } from './components/Link';
 export { File, FileField } from './components/File';
-export { SitecoreProvider, SitecoreProviderState, SitecoreProviderPageContext, SitecoreProviderReactContext, } from './components/SitecoreProvider';
+export { SitecoreProvider, SitecoreProviderState, SitecoreProviderReactContext, } from './components/SitecoreProvider';
 export { withSitecore, useSitecore, WithSitecoreOptions, WithSitecoreProps, WithSitecoreHocProps, } from './enhancers/withSitecore';
 export { withEditorChromes } from './enhancers/withEditorChromes';
 export { withPlaceholder } from './enhancers/withPlaceholder';