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

package/dist/esm/components/DesignLibrary.js

@@ -1,57 +1,44 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 /* eslint-disable jsdoc/require-param */
 /* eslint-disable prefer-const */
-import React, { useEffect, useMemo, useState } from 'react';
+import React, { useEffect, useState } from 'react';
 import { Placeholder } from './Placeholder';
 import { EDITING_COMPONENT_ID, EDITING_COMPONENT_PLACEHOLDER, } from '@sitecore-content-sdk/core/layout';
 import { DesignLibraryStatus, getDesignLibraryStatusEvent, addComponentUpdateHandler, } from '@sitecore-content-sdk/core/editing';
 import * as codegen from '@sitecore-content-sdk/core/codegen';
 import { useSitecore } from '../enhancers/withSitecore';
+import { PlaceholderMetadata } from './PlaceholderMetadata';
 let { getDesignLibraryImportMapEvent, getDesignLibraryComponentPropsEvent, addComponentPreviewHandler, } = codegen;
 export const __mockDependencies = (mocks) => {
     addComponentPreviewHandler = mocks.addComponentPreviewHandler;
 };
-/**
- * This component is used to render the component in preview mode.
- * It is used to send the rendered event to the parent window and render the component.
- * Reacts on the update event from the parent window and re-renders the component.
- */
-const Preview = () => {
-    const { page } = useSitecore();
-    const { layout: { sitecore: { route }, }, } = page;
-    const [renderKey, setRenderKey] = useState(0);
-    const [rootUpdate, setRootUpdate] = useState(null);
-    const rootComponent = route === null || route === void 0 ? void 0 : route.placeholders[EDITING_COMPONENT_PLACEHOLDER][0];
-    // useEffect may execute multiple times on single render (i.e. in dev) - but we only want to fire ready event once
-    let componentReady = false;
-    // have an up-to-date layout state between re-renders (SSR re-render excluded)
-    const persistedRoot = useMemo(() => (Object.assign(Object.assign({}, (rootComponent || {})), rootUpdate)), [
-        rootComponent,
-        rootUpdate,
-    ]);
-    route.placeholders[EDITING_COMPONENT_PLACEHOLDER][0] = persistedRoot;
-    useEffect(() => {
-        // useEffect will fire when components are ready - and we inform the whole wide world of it too
-        if (!componentReady) {
-            componentReady = true;
-            window.top.postMessage(getDesignLibraryStatusEvent(DesignLibraryStatus.READY, rootComponent.uid), '*');
-        }
-        const unsubscribe = addComponentUpdateHandler(persistedRoot, (updatedRoot) => {
-            setRootUpdate(Object.assign({}, updatedRoot));
-            setRenderKey((key) => key + 1);
-        });
-        // useEffect will cleanup event handler on re-render
-        return unsubscribe;
-    }, []);
-    useEffect(() => {
-        // Send a rendered event only as effect of a component update command
-        if (renderKey === 0) {
-            return;
-        }
-        window.top.postMessage(getDesignLibraryStatusEvent(DesignLibraryStatus.RENDERED, rootComponent.uid), '*');
-    }, [renderKey, rootComponent.uid]);
-    return (React.createElement(React.Fragment, null,
-        React.createElement("main", null,
-            React.createElement("div", { id: EDITING_COMPONENT_ID }, route && (React.createElement(Placeholder, { name: EDITING_COMPONENT_PLACEHOLDER, rendering: route, key: renderKey }))))));
+const sendErrorEvent = (uid, error, type) => {
+    const errorEvent = codegen.getDesignLibraryComponentPreviewErrorEvent(uid, error, type);
+    console.error('Component Library: sending error event', errorEvent);
+    if (typeof window !== 'undefined') {
+        const target = window.parent && window.parent !== window ? window.parent : window;
+        target.postMessage(errorEvent, '*');
+    }
+};
+const postToDL = (evt) => {
+    if (typeof window === 'undefined')
+        return;
+    const target = window.parent && window.parent !== window ? window.parent : window;
+    try {
+        console.log('Component Library: sending event', evt === null || evt === void 0 ? void 0 : evt.name, evt);
+        target.postMessage(evt, '*');
+    }
+    catch (err) {
+        console.error('Component Library: postMessage failed', err, evt);
+    }
 };
 class ErrorBoundary extends React.Component {
     constructor() {
@@ -69,9 +56,7 @@ class ErrorBoundary extends React.Component {
         }
     }
     componentDidCatch(error) {
-        const errorEvent = codegen.getDesignLibraryComponentPreviewErrorEvent(this.props.uid, error, codegen.DesignLibraryPreviewError.Render);
-        console.debug('Component Library: sending error event', errorEvent);
-        window.top.postMessage(errorEvent, '*');
+        sendErrorEvent(this.props.uid, error, codegen.DesignLibraryPreviewError.Render);
     }
     render() {
         if (this.state.hasError) {
@@ -81,56 +66,98 @@ class ErrorBoundary extends React.Component {
     }
 }
 /**
- * This component is used to render the component in variant generation mode.
- * It is used to send the import-map and component-props events to the parent window and render the dynamic component.
+ * Design Library component.
+ *
+ * Renders the **real** Sitecore component for `library` / `library-metadata` modes and,
+ * when generation is enabled (`page.mode.designLibrary.isVariantGeneration === true`),
+ * wires the **variant generation** handshake so the parent (DL Studio) can send
+ * generated code to preview and iterate on.
+ * @param {DesignLibraryProps} props
+ * @param {() => Promise<{ default: import('../codegen').ImportEntry[] }>} [props.loadImportMap] Optional async loader that resolves to the import-map used to resolve the generated component’s imports. Required when `isVariantGeneration` is true.
+ * @returns {JSX.Element} The preview surface, or `null` when not in Design Library mode.
  */
-export const VariantGeneration = (props) => {
+export const DesignLibrary = ({ loadImportMap }) => {
+    var _a, _b;
     const { page } = useSitecore();
-    const { layout: { sitecore: { route }, }, } = page;
-    const rendering = route === null || route === void 0 ? void 0 : route.placeholders[EDITING_COMPONENT_PLACEHOLDER][0];
+    const route = page.layout.sitecore.route;
+    const rendering = (_a = route === null || route === void 0 ? void 0 : route.placeholders[EDITING_COMPONENT_PLACEHOLDER]) === null || _a === void 0 ? void 0 : _a[0];
+    const { isDesignLibrary } = page.mode;
+    const isVariantGeneration = (_b = page.mode.designLibrary) === null || _b === void 0 ? void 0 : _b.isVariantGeneration;
+    const [propsState, setPropsState] = useState({
+        fields: rendering === null || rendering === void 0 ? void 0 : rendering.fields,
+        params: rendering === null || rendering === void 0 ? void 0 : rendering.params,
+    });
     const [renderKey, setRenderKey] = useState(0);
-    const [initError, setInitError] = useState(false);
     const [Component, setComponent] = useState(null);
-    if (!props.importMap) {
-        return React.createElement("div", null, "No import map found. Please check your import map.");
-    }
-    if (!rendering) {
-        return React.createElement("div", null, "No component found in layout data. Please check your layout data.");
-    }
+    const isGeneratedComponentActive = !!Component;
+    if (!isDesignLibrary)
+        return null;
+    // eslint-disable-next-line react-hooks/rules-of-hooks
     useEffect(() => {
-        const unsubscribe = addComponentPreviewHandler(props.importMap, (error, Component) => {
-            setRenderKey((key) => key + 1);
-            if (error) {
-                setInitError(true);
+        postToDL(getDesignLibraryStatusEvent(DesignLibraryStatus.READY, rendering.uid));
+        if (!isVariantGeneration) {
+            requestAnimationFrame(() => {
+                setRenderKey((k) => (k === 0 ? k + 1 : k));
+            });
+        }
+        const unsubUpdate = addComponentUpdateHandler(rendering, (updated) => {
+            setPropsState({ fields: updated.fields, params: updated.params });
+            setRenderKey((k) => k + 1);
+        });
+        // useEffect will cleanup event handler on re-render
+        return () => unsubUpdate && unsubUpdate();
+    }, [isVariantGeneration, rendering]);
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+        // Send a rendered event only as effect of a component update command
+        if (renderKey === 0)
+            return;
+        postToDL(getDesignLibraryStatusEvent(DesignLibraryStatus.RENDERED, rendering.uid));
+    }, [renderKey, rendering]);
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+        if (!isDesignLibrary || !isVariantGeneration)
+            return undefined;
+        let cancelled = false;
+        // since import map is loaded lazily, we only need to add preview event handler once the import map is loaded
+        // unsubscribe function for useEffect cleanup will also be returned once importMap promise has been resolved or rejected
+        let unsubscribe;
+        (() => __awaiter(void 0, void 0, void 0, function* () {
+            if (!loadImportMap) {
+                sendErrorEvent(rendering.uid, 'No loadImportMap provided', codegen.DesignLibraryPreviewError.RenderInit);
                 return;
             }
-            setInitError(false);
-            setComponent(() => Component);
-        });
-        const importMapEvent = getDesignLibraryImportMapEvent(rendering.uid, props.importMap);
-        console.debug('Component Library: sending event', importMapEvent);
-        window.parent.postMessage(importMapEvent, '*');
-        const componentPropsEvent = getDesignLibraryComponentPropsEvent(rendering.uid, rendering.fields, rendering.params);
-        console.debug('Component Library: sending event', componentPropsEvent);
-        window.top.postMessage(componentPropsEvent, '*');
-        return unsubscribe;
-    }, []);
-    if (initError) {
-        return React.createElement("div", { key: renderKey }, "Error during component initialization");
-    }
-    return (React.createElement("main", null, Component ? (React.createElement(ErrorBoundary, { uid: rendering.uid, renderKey: renderKey },
-        React.createElement(Component, { fields: rendering.fields, params: rendering.params, key: renderKey }))) : (React.createElement("div", null, "Loading preview..."))));
-};
-export const DesignLibrary = ({ importMap }) => {
-    var _a;
-    const { page } = useSitecore();
-    const { isDesignLibrary } = page.mode;
-    const isVariantGeneration = (_a = page.mode.designLibrary) === null || _a === void 0 ? void 0 : _a.isVariantGeneration;
-    if (!isDesignLibrary) {
-        return null;
-    }
-    if (isVariantGeneration) {
-        return React.createElement(VariantGeneration, { importMap: importMap });
-    }
-    return React.createElement(Preview, null);
+            let importMap;
+            try {
+                const mod = yield loadImportMap();
+                importMap = mod.default;
+            }
+            catch (e) {
+                sendErrorEvent(rendering.uid, `Error loading import map: ${e}`, codegen.DesignLibraryPreviewError.RenderInit);
+                return;
+            }
+            // account for component being unmounted while resolving async import map
+            if (cancelled)
+                return;
+            unsubscribe = addComponentPreviewHandler(importMap, (error, Component) => {
+                // Error event is already sent in the addComponentPreviewHandler
+                if (error)
+                    return;
+                setComponent(() => Component);
+                setRenderKey((k) => k + 1);
+            });
+            const importMapEvent = getDesignLibraryImportMapEvent(rendering.uid, importMap);
+            postToDL(importMapEvent);
+            const propsEvent = getDesignLibraryComponentPropsEvent(rendering.uid, propsState.fields, propsState.params);
+            postToDL(propsEvent);
+        }))();
+        // return function that calls unsubscribe - if the component was mounted correctly
+        return () => {
+            cancelled = true;
+            unsubscribe && unsubscribe();
+        };
+    }, [isVariantGeneration, rendering]);
+    return (React.createElement("main", null, isGeneratedComponentActive ? (React.createElement(ErrorBoundary, { uid: rendering.uid, renderKey: renderKey },
+        React.createElement(PlaceholderMetadata, { rendering: rendering },
+            React.createElement(Component, { fields: propsState.fields, params: propsState.params, key: renderKey })))) : (React.createElement("div", { id: EDITING_COMPONENT_ID }, route && (React.createElement(Placeholder, { name: EDITING_COMPONENT_PLACEHOLDER, rendering: route, key: renderKey }))))));
 };

package/dist/esm/components/EditingScripts.js

@@ -17,8 +17,14 @@ export const EditingScripts = () => {
     }
     // In case of Design Library - render only the script for Design Library
     if (mode.isDesignLibrary) {
-        // Add cache buster to the script URL
-        const scriptUrl = `${getDesignLibraryScriptLink((_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.edgeUrl)}?cb=${Date.now()}`;
+        // Add cache buster to the script URL (format hh-dd-mm-yyyy, UTC)
+        const now = new Date();
+        const hour = String(now.getUTCHours()).padStart(2, '0');
+        const day = String(now.getUTCDate()).padStart(2, '0');
+        const month = String(now.getUTCMonth() + 1).padStart(2, '0');
+        const year = String(now.getUTCFullYear());
+        const cacheTimestamp = `${hour}-${day}-${month}-${year}`;
+        const scriptUrl = `${getDesignLibraryScriptLink((_a = api === null || api === void 0 ? void 0 : api.edge) === null || _a === void 0 ? void 0 : _a.edgeUrl)}?cb=${cacheTimestamp}`;
         return (React.createElement(React.Fragment, null,
             React.createElement("script", { src: scriptUrl, suppressHydrationWarning: true })));
     }

package/dist/esm/components/FEaaSComponent.js

@@ -78,8 +78,7 @@ function fetchComponentTemplate(src, params, revisionFallback) {
             return template;
         }
         catch (error) {
-            console.error(`Fetch FEAAS component from ${src} failed. Ensure the component revision "${params.ComponentRevision ||
-                revisionFallback}" is present`);
+            console.error(`Fetch FEAAS component from ${src} failed. Ensure the component revision "${params.ComponentRevision || revisionFallback}" is present`);
             throw error;
         }
     });

package/dist/esm/components/File.js

@@ -18,9 +18,7 @@ export const File = (_a) => {
         return null;
     }
     // handle link directly on field for forgetful devs
-    const file = (dynamicField.src
-        ? field
-        : dynamicField.value);
+    const file = (dynamicField.src ? field : dynamicField.value);
     if (!file) {
         return null;
     }

package/dist/esm/components/Image.js

@@ -9,6 +9,7 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+/* eslint-disable no-unused-vars */
 import { mediaApi } from '@sitecore-content-sdk/core/media';
 import React from 'react';
 import { addClassName } from '../utils';

package/dist/esm/components/Link.js

@@ -9,14 +9,15 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+/* eslint-disable no-unused-expressions, @typescript-eslint/no-unused-expressions */
 import React, { forwardRef } from 'react';
 import { isFieldValueEmpty } from '@sitecore-content-sdk/core/layout';
 import { withFieldMetadata } from '../enhancers/withFieldMetadata';
 import { withEmptyFieldEditingComponent } from '../enhancers/withEmptyFieldEditingComponent';
 import { DefaultEmptyFieldEditingComponentText } from './DefaultEmptyFieldEditingComponents';
-export const Link = withFieldMetadata(withEmptyFieldEditingComponent(
-// eslint-disable-next-line react/display-name
-forwardRef((_a, ref) => {
+export const Link = withFieldMetadata(withEmptyFieldEditingComponent(forwardRef(
+// eslint-disable-next-line no-unused-vars
+(_a, ref) => {
     var { field, editable = true, showLinkTextWithChildrenPresent } = _a, otherProps = __rest(_a, ["field", "editable", "showLinkTextWithChildrenPresent"]);
     const children = otherProps.children;
     const dynamicField = field;

package/dist/esm/components/RichText.js

@@ -14,10 +14,14 @@ import { withFieldMetadata } from '../enhancers/withFieldMetadata';
 import { withEmptyFieldEditingComponent } from '../enhancers/withEmptyFieldEditingComponent';
 import { DefaultEmptyFieldEditingComponentText } from './DefaultEmptyFieldEditingComponents';
 import { isFieldValueEmpty } from '@sitecore-content-sdk/core/layout';
-export const RichText = withFieldMetadata(withEmptyFieldEditingComponent(
-// eslint-disable-next-line react/display-name
-forwardRef((_a, ref) => {
-    var { field, tag = 'div', editable = true } = _a, otherProps = __rest(_a, ["field", "tag", "editable"]);
+export const RichText = withFieldMetadata(withEmptyFieldEditingComponent(forwardRef((
+// eslint-disable-next-line no-unused-vars
+_a, ref) => {
+    var 
+    // eslint-disable-next-line no-unused-vars
+    { field, tag = 'div', editable = true } = _a, otherProps = __rest(_a, 
+    // eslint-disable-next-line no-unused-vars
+    ["field", "tag", "editable"]);
     if (isFieldValueEmpty(field)) {
         return null;
     }

package/dist/esm/components/Text.js

@@ -21,7 +21,7 @@ export const Text = withFieldMetadata(withEmptyFieldEditingComponent((_a) => {
     }
     // can't use editable value if we want to output unencoded
     if (!encode) {
-        // eslint-disable-next-line no-param-reassign
+        // eslint-disable-next-line no-param-reassign, no-unused-vars
         editable = false;
     }
     let output = field.value === undefined ? '' : field.value;

package/dist/esm/enhancers/withComponentMap.js

@@ -13,8 +13,6 @@ export function withComponentMap(Component) {
         const context = useContext(ComponentMapReactContext);
         return React.createElement(Component, Object.assign({}, props, { componentMap: props.componentMap || context }));
     }
-    WithComponentMap.displayName = `withComponentMap(${Component.displayName ||
-        Component.name ||
-        'Anonymous'})`;
+    WithComponentMap.displayName = `withComponentMap(${Component.displayName || Component.name || 'Anonymous'})`;
     return WithComponentMap;
 }

package/dist/esm/enhancers/withEmptyFieldEditingComponent.js

@@ -10,20 +10,25 @@ export function withEmptyFieldEditingComponent(FieldComponent, options) {
         var _a;
         const { editable = true } = props;
         if (((_a = props.field) === null || _a === void 0 ? void 0 : _a.metadata) && editable && isFieldValueEmpty(props.field)) {
-            return props.emptyFieldEditingComponent || options.defaultEmptyFieldEditingComponent;
+            const Component = props.emptyFieldEditingComponent || options.defaultEmptyFieldEditingComponent;
+            let resolvedProps = props;
+            // If no custom empty field editing component is provided, we can omit unnecessary props
+            // to do not insert them to html
+            if (!props.emptyFieldEditingComponent) {
+                resolvedProps = Object.assign(Object.assign({}, props), { editable: undefined, field: undefined });
+            }
+            return React.createElement(Component, Object.assign({}, resolvedProps));
         }
         return null;
     };
     if (options.isForwardRef) {
-        // eslint-disable-next-line react/display-name
         return forwardRef((props, ref) => {
-            const EmptyFieldEditingComponent = getEmptyFieldEditingComponent(props);
-            return (React.createElement(React.Fragment, null, (EmptyFieldEditingComponent && React.createElement(EmptyFieldEditingComponent, null)) || (React.createElement(FieldComponent, Object.assign({}, props, { ref: ref })))));
+            const emptyFieldEditingComponent = getEmptyFieldEditingComponent(props);
+            return (emptyFieldEditingComponent || (React.createElement(FieldComponent, Object.assign({}, props, { ref: ref }))));
         });
     }
-    // eslint-disable-next-line react/display-name
     return (props) => {
-        const EmptyFieldEditingComponent = getEmptyFieldEditingComponent(props);
-        return (React.createElement(React.Fragment, null, (EmptyFieldEditingComponent && React.createElement(EmptyFieldEditingComponent, null)) || (React.createElement(FieldComponent, Object.assign({}, props)))));
+        const emptyFieldEditingComponent = getEmptyFieldEditingComponent(props);
+        return emptyFieldEditingComponent || React.createElement(FieldComponent, Object.assign({}, props));
     };
 }

package/dist/esm/enhancers/withFieldMetadata.js

@@ -7,7 +7,6 @@ import { FieldMetadata } from '../components/FieldMetadata';
  */
 export function withFieldMetadata(FieldComponent, isForwardRef = false) {
     if (isForwardRef) {
-        // eslint-disable-next-line react/display-name
         return forwardRef((props, ref) => {
             var _a;
             const { editable = true } = props;
@@ -19,7 +18,6 @@ export function withFieldMetadata(FieldComponent, isForwardRef = false) {
                 React.createElement(FieldComponent, Object.assign({}, props, { ref: ref }))));
         });
     }
-    // eslint-disable-next-line react/display-name
     return (props) => {
         var _a;
         const { editable = true } = props;

package/dist/esm/enhancers/withPlaceholder.js

@@ -44,7 +44,8 @@ export function withPlaceholder(placeholders, options) {
                     else {
                         placeholderData = PlaceholderCommon.getPlaceholderDataFromRenderingData(renderingData, placeholder, childProps.page.mode.isEditing);
                         if (placeholderData) {
-                            childProps[placeholder] = this.getComponentsForRenderingData(placeholderData);
+                            childProps[placeholder] =
+                                this.getComponentsForRenderingData(placeholderData);
                         }
                     }
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/react",
-  "version": "1.1.0-canary.9",
+  "version": "1.1.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -31,6 +31,7 @@
   },
   "devDependencies": {
     "@sitecore-feaas/clientside": "^0.6.0",
+    "@stylistic/eslint-plugin": "^5.2.2",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.3.0",
     "@types/chai": "^5.2.2",
@@ -41,14 +42,22 @@
     "@types/react-dom": "^19.1.3",
     "@types/sinon": "^17.0.4",
     "@types/sinon-chai": "^4.0.0",
+    "@typescript-eslint/eslint-plugin": "8.39.0",
+    "@typescript-eslint/parser": "8.39.0",
     "chai": "^4.3.7",
     "chai-string": "^1.6.0",
     "del-cli": "^6.0.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-react": "^7.37.5",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-jsdoc": "52.0.3",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "5.2.0",
     "jsdom": "^26.1.0",
     "mocha": "^11.2.2",
     "nyc": "^17.1.0",
+    "prettier": "^2.8.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "sinon": "^20.0.0",
@@ -63,12 +72,12 @@
     "react-dom": "^19.1.0"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "1.1.0-canary.9",
+    "@sitecore-content-sdk/core": "1.1.0",
     "fast-deep-equal": "^3.1.3"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "54df7000124edba59ce0224618bbcd5aa7d48c55",
+  "gitHead": "0e6485c5849123ad20a7562750b2fe6cb44ae617",
   "files": [
     "dist",
     "types"

package/types/components/Date.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { EditableFieldProps } from './sharedTypes';
 import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
-export interface DateFieldProps extends EditableFieldProps {
+export interface DateFieldProps extends EditableFieldProps<DateFieldProps> {
     /** The date field data. */
     [htmlAttributes: string]: unknown;
     field: FieldMetadata & {

package/types/components/DefaultEmptyFieldEditingComponents.d.ts

@@ -1,3 +1,9 @@
 import React from 'react';
-export declare const DefaultEmptyFieldEditingComponentText: React.FC;
-export declare const DefaultEmptyFieldEditingComponentImage: React.FC;
+export declare const DefaultEmptyFieldEditingComponentText: React.FC<{
+    [key: string]: unknown;
+    tag?: string;
+}>;
+export declare const DefaultEmptyFieldEditingComponentImage: React.FC<{
+    [key: string]: unknown;
+    className?: string;
+}>;

package/types/components/DesignLibrary.d.ts

@@ -1,23 +1,26 @@
-import { JSX } from 'react';
+import React from 'react';
 import * as codegen from '@sitecore-content-sdk/core/codegen';
 export declare const __mockDependencies: (mocks: any) => void;
-type VariantGenerationProps = {
-    /**
-     * The import map to be used in variant generation mode.
-     */
-    importMap?: codegen.ImportEntry[];
+export type ImportMapImport = {
+    default: codegen.ImportEntry[];
 };
-/**
- * This component is used to render the component in variant generation mode.
- * It is used to send the import-map and component-props events to the parent window and render the dynamic component.
- */
-export declare const VariantGeneration: (props: VariantGenerationProps) => JSX.Element;
 type DesignLibraryProps = {
     /**
-     * The import map to be used in variant generation mode.
+     * The dynamic import for import map to be used in variant generation mode.
      * Currently it's optional but it will be required in the next major version.
      */
-    importMap?: codegen.ImportEntry[];
+    loadImportMap?: () => Promise<ImportMapImport>;
 };
-export declare const DesignLibrary: ({ importMap }: DesignLibraryProps) => JSX.Element;
+/**
+ * Design Library component.
+ *
+ * Renders the **real** Sitecore component for `library` / `library-metadata` modes and,
+ * when generation is enabled (`page.mode.designLibrary.isVariantGeneration === true`),
+ * wires the **variant generation** handshake so the parent (DL Studio) can send
+ * generated code to preview and iterate on.
+ * @param {DesignLibraryProps} props
+ * @param {() => Promise<{ default: import('../codegen').ImportEntry[] }>} [props.loadImportMap] Optional async loader that resolves to the import-map used to resolve the generated component’s imports. Required when `isVariantGeneration` is true.
+ * @returns {JSX.Element} The preview surface, or `null` when not in Design Library mode.
+ */
+export declare const DesignLibrary: ({ loadImportMap }: DesignLibraryProps) => React.JSX.Element;
 export {};

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/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/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/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 {};