@sitecore-content-sdk/content 1.5.0-canary.10

package/types/config/models.d.ts

@@ -0,0 +1,294 @@
+import { RetryStrategy } from '@sitecore-content-sdk/core';
+import { GenerateMapFunction, GenerateMapArgs } from '../tools';
+/**
+ * Utility type to make every property in a type required
+ * @public
+ */
+export type DeepRequired<T> = Required<{
+    [K in keyof T]: T[K] extends Required<T[K]> ? T[K] : DeepRequired<T[K]>;
+}>;
+/**
+ * Utility type to make all properties in a type optional, recursively
+ * @internal
+ */
+export type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+/**
+ * Type to be used as config input in sitecore.config
+ * @public
+ */
+export type SitecoreConfigInput = {
+    /**
+     * API settings required to connect to Sitecore.
+     * Both edge and local sets can be specified; the Content SDK app will choose
+     * the correct credentials (Edge or local) at runtime.
+     */
+    api?: {
+        /**
+         * Edge endpoint credentials for connecting to an XM Cloud instance.
+         */
+        edge?: {
+            /**
+             * A unified identifier used to connect and retrieve data from XM Cloud instance
+             * Must be provided together with `clientContextId` to support both server-
+             * side and browser-side data fetching.
+             */
+            contextId: string;
+            /**
+             * Optional identifier used to connect and retrieve data from XM Cloud instance in client-side functionality
+             */
+            clientContextId?: string;
+            /**
+             * XM Cloud endpoint that the app will communicate and retrieve data from
+             * @default https://edge-platform.sitecorecloud.io
+             */
+            edgeUrl?: string;
+        };
+        /**
+         * API endpoint credentials for connecting to a local Sitecore instance.
+         */
+        local?: {
+            /**
+             * Sitecore API key used to connect to the GraphQL endpoint
+             */
+            apiKey: string;
+            /**
+             * Sitecore API hostname that the app connects to
+             */
+            apiHost: string;
+            /**
+             * GraphQL endpoint path (appended to `apiHost` to form the full URL).
+             * @default /sitecore/api/graph/edge
+             */
+            path?: string;
+        };
+    };
+    /**
+     * The default and fallback locale for your site.
+     * Ensure it aligns with the framework-specific settings used in your application.
+     */
+    defaultLanguage?: string;
+    /**
+     * Your default site name. When using the multisite feature this variable defines the fallback site.
+     */
+    defaultSite?: string;
+    /**
+     * Editing secret required for Sitecore editing and preview functionality.
+     * Default comes from the SITECORE_EDITING_SECRET environment variable.
+     */
+    editingSecret?: string;
+    /**
+     * Retry configuration applied to Layout, Dictionary and ErrorPages services
+     */
+    retries?: {
+        /**
+         * Number of retries for the GraphQL client.
+         * @default 3
+         */
+        count?: number;
+        /**
+         * Retry strategy for the client. By default, uses exponential
+         * back-off factor of 2 for codes 429, 502, 503, 504, 520, 521, 522, 523, 524.
+         * @default DefaultRetryStrategy
+         */
+        retryStrategy?: RetryStrategy;
+    };
+    /**
+     * Settings for Layout Service
+     */
+    layout?: {
+        /**
+         * Override the first part of graphQL query for Layout Service (excluding the fields part)
+         * @param {string} siteName your site name
+         * @param {string} itemPath full path to Sitecore item/route
+         * @param {string} [locale] item/route language
+         * @returns {string} custom layout query
+         * @default 'layout(site:"${siteName}", routePath:"${itemPath}", language:"${language}")'
+         */
+        formatLayoutQuery?: ((siteName: string, itemPath: string, locale?: string) => string) | null;
+    };
+    /**
+     * Settings for Dictionary Service
+     */
+    dictionary?: {
+        /**
+         * Configure local memory caching for Dictionary Service requests
+         */
+        caching?: {
+            enabled?: boolean;
+            timeout?: number;
+        };
+    };
+    /**
+     * Settings for multisite functionality
+     */
+    multisite?: {
+        /**
+         * Enable multisite
+         *
+         * **WARNING: Do NOT disable multisite in App Router applications.**
+         *
+         * The App Router route structure requires the `[site]` segment in the path (`/[site]/[locale]/[[...path]]`).
+         * Disabling this will break routing and cause 404 errors for regular requests.
+         *
+         * Preview and Editing modes will still work (they bypass this check), but regular page requests will fail.
+         *
+         * **For single-site setups**: Keep `enabled: true` and configure only one site in your sites configuration.
+         * The middleware will always use that single site, achieving the desired single-site behavior.
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Function used to determine if site should be resolved from sc_site cookie when present
+         */
+        useCookieResolution?: (req?: RequestInit, res?: ResponseInit) => boolean;
+    };
+    /**
+     * Settings for Personalize functionality
+     */
+    personalize?: {
+        /**
+         * Enable personalize proxy
+         * @default process.env.NODE_ENV !== 'development'
+         */
+        enabled?: boolean;
+        /**
+         * Configuration for your Sitecore Experience Edge endpoint
+         * by default set by the PERSONALIZE_MIDDLEWARE_EDGE_TIMEOUT environment variable (for personalize proxy)
+         * if not set, will use the default value of 400ms
+         */
+        edgeTimeout?: number;
+        /**
+         * Configuration for your Sitecore CDP endpoint
+         * by default set by the PERSONALIZE_MIDDLEWARE_CDP_TIMEOUT environment variable (for personalize proxy)
+         * if not set, will use the default value of 400ms
+         */
+        cdpTimeout?: number;
+        /**
+         * Optional Sitecore Personalize scope ID (to isolate data between environments)
+         */
+        scope?: string;
+        /**
+         * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
+         */
+        channel?: string;
+        /**
+         * Currency for CDP requests
+         * @default 'USA'
+         */
+        currency?: string;
+    };
+    /**
+     * Settings for redirects functionality
+     */
+    redirects?: {
+        /**
+         * Enable redirects middleware
+         * @default process.env.NODE_ENV !== 'development'
+         */
+        enabled?: boolean;
+        /**
+         * These are all the locales you support in your application.
+         * These should match those in framework-specific configuration of your app.
+         */
+        locales?: string[];
+    };
+    /**
+     * Rewrite media/content URLs in layout (media fields, rich text img/src, href, etc.).
+     * - When `true`: use default rewriter (Edge hostnames -> custom hostname from env).
+     * - When a function: transform each string value; the SDK traverses the layout for you.
+     * @default false
+     */
+    rewriteMediaUrls?: boolean | ((value: string) => string);
+    /**
+     * Opt-out setting for code generation feature
+     * Disables code extraction procedure
+     */
+    disableCodeGeneration?: boolean;
+};
+/**
+ * Final Sitecore config type used at runtime.
+ * Every property is populated, either from sitecore.config or fallback values.
+ * @public
+ */
+export type SitecoreConfig = DeepRequired<SitecoreConfigInput>;
+/**
+ * Type used as CLI config input in sitecore.cli.config
+ * @public
+ */
+export type SitecoreCliConfigInput = {
+    /**
+     * Sitecore configuration (`sitecore.config` file)
+     */
+    config: SitecoreConfig;
+    /**
+     * Configuration for the `sitecore-tools build` CLI command
+     */
+    build?: {
+        /**
+         * Commands to run during the build process
+         */
+        commands?: Array<(args?: {
+            scConfig: SitecoreConfig;
+        }) => Promise<void>>;
+    };
+    /**
+     * Configuration for the `sitecore-tools scaffold` CLI command
+     */
+    scaffold?: {
+        /**
+         * Scaffold templates available for generating components
+         */
+        templates?: ScaffoldTemplate[];
+    };
+    /**
+     * Configuration for the `sitecore-tools component generate-map` CLI command
+     */
+    componentMap?: GenerateMapArgs & {
+        /**
+         * Function implementation for generating a component map
+         */
+        generator?: GenerateMapFunction;
+    };
+};
+/**
+ * Final Sitecore CLI config type required by the CLI
+ * @public
+ */
+export type SitecoreCliConfig = DeepRequired<SitecoreCliConfigInput>;
+/**
+ * Represents a scaffold template used for generating components
+ * @public
+ */
+export type ScaffoldTemplate = {
+    /**
+     * Name of the template
+     */
+    name: string;
+    /**
+     * File extension for the generated component
+     */
+    fileExtension: string;
+    /**
+     * Function to generate the component file contents based on the component name.
+     * @param componentName - The name of the component.
+     * @returns The generated content as a string.
+     */
+    generateTemplate: (componentName: string) => string;
+    /**
+     * Optional function to get the next steps to be shown by the cli after generating the component.
+     * @param componentOutputPath - The output path of the generated component.
+     * @returns An array of strings representing the next steps.
+     */
+    getNextSteps?: (componentOutputPath: string) => string[];
+};
+/**
+ * Enumeration of default component templates
+ * @internal
+ */
+export declare enum ComponentTemplateType {
+    BYOC = "byoc",
+    DEFAULT = "default"
+}
+//# sourceMappingURL=models.d.ts.map

package/types/config/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/config/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,QAAQ,CAAC;KACpC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxE,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,IAAI,CAAC,EAAE;YACL;;;;eAIG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;;WAEG;QACH,KAAK,CAAC,EAAE;YACN;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAChB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IAEF;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;;;;;WAOG;QACH,iBAAiB,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;KAC9F,CAAC;IAEF;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;;;;;;;;;;;;WAaG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;WAEG;QACH,mBAAmB,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC;KAC1E,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE;YAAE,QAAQ,EAAE,cAAc,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;KAC1E,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAChC,CAAC;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,GAAG;QAC/B;;WAEG;QACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;KACjC,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,MAAM,CAAC;IACpD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,oBAAY,qBAAqB;IAC/B,IAAI,SAAS;IACb,OAAO,YAAY;CACpB"}

package/types/config-cli/define-cli-config.d.ts

@@ -0,0 +1,9 @@
+import { SitecoreCliConfig, SitecoreCliConfigInput } from '../config/models';
+/**
+ * Accepts a `SitecoreCliConfigInput` object and returns Sitecore Content SDK CLI configuration, updated with required default values
+ * @param {SitecoreCliConfigInput} cliConfig the cli configuration provided by the application
+ * @returns {SitecoreCliConfig} full sitecore cli configuration to use with cli
+ * @public
+ */
+export declare const defineCliConfig: (cliConfig: SitecoreCliConfigInput) => SitecoreCliConfig;
+//# sourceMappingURL=define-cli-config.d.ts.map

package/types/config-cli/define-cli-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-cli-config.d.ts","sourceRoot":"","sources":["../../src/config-cli/define-cli-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAc7E;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,WAAW,sBAAsB,KAAG,iBAGnE,CAAC"}

package/types/config-cli/index.d.ts

@@ -0,0 +1,3 @@
+export { defineCliConfig } from './define-cli-config';
+export { SITECORE_CLI_MODE_ENV_VAR } from './models';
+//# sourceMappingURL=index.d.ts.map

package/types/config-cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config-cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC"}

package/types/config-cli/models.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Environment variable to indicate that the application is running in CLI mode
+ * @internal
+ */
+export declare const SITECORE_CLI_MODE_ENV_VAR = "SITECORE_CLI_MODE";
+//# sourceMappingURL=models.d.ts.map

package/types/config-cli/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/config-cli/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,yBAAyB,sBAAsB,CAAC"}

package/types/constants.d.ts

@@ -0,0 +1,10 @@
+/** @private */
+export declare const siteNameError = "The site name must be a non-empty string";
+/** @private */
+export declare const languageError = "The language must be a non-empty string";
+/**
+ * Hidden rendering name
+ * @internal
+ */
+export declare const HIDDEN_RENDERING_NAME = "Hidden Rendering";
+//# sourceMappingURL=constants.d.ts.map

package/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAe;AACf,eAAO,MAAM,aAAa,6CAA6C,CAAC;AACxE,eAAe;AACf,eAAO,MAAM,aAAa,4CAA4C,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC"}

package/types/debug.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Debug module for content package
+ * @public
+ */
+declare const debug: {
+    form: import("debug").Debugger;
+    layout: import("debug").Debugger;
+    dictionary: import("debug").Debugger;
+    editing: import("debug").Debugger;
+    sitemap: import("debug").Debugger;
+    multisite: import("debug").Debugger;
+    robots: import("debug").Debugger;
+    redirects: import("debug").Debugger;
+    personalize: import("debug").Debugger;
+    locale: import("debug").Debugger;
+    errorpages: import("debug").Debugger;
+};
+export default debug;
+//# sourceMappingURL=debug.d.ts.map

package/types/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,QAAA,MAAM,KAAK;;;;;;;;;;;;CAYV,CAAC;AAEF,eAAe,KAAK,CAAC"}

package/types/editing/codegen/index.d.ts

@@ -0,0 +1,2 @@
+export { addComponentPreviewHandler, addServerComponentPreviewHandler, getDesignLibraryComponentPreviewErrorEvent, getDesignLibraryComponentPropsEvent, getDesignLibraryImportMapEvent, getImportMapInfo, addStyleElement, createComponentInstance, sendErrorEvent, DesignLibraryPreviewError, ImportEntry, ImportEntryInfo, GeneratedComponentData, ComponentPreviewEventArgs, ServerComponentPreviewEventArgs, fetchGeneratedComponentFromCache, } from './preview';
+//# sourceMappingURL=index.d.ts.map

package/types/editing/codegen/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/editing/codegen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,gCAAgC,EAChC,0CAA0C,EAC1C,mCAAmC,EACnC,8BAA8B,EAC9B,gBAAgB,EAChB,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,yBAAyB,EACzB,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,yBAAyB,EACzB,+BAA+B,EAC/B,gCAAgC,GACjC,MAAM,WAAW,CAAC"}

package/types/editing/codegen/preview.d.ts

@@ -0,0 +1,289 @@
+import { ComponentFields, ComponentParams } from '../../layout/models';
+import { DesignLibraryEvent } from '../design-library';
+/**
+ * Event to send import map to design library
+ */
+declare const DESIGN_LIBRARY_IMPORT_MAP_EVENT_NAME = "component:generation:import-map";
+/**
+ * Event to send component props to design library
+ */
+declare const DESIGN_LIBRARY_COMPONENT_PROPS_EVENT_NAME = "component:generation:component-props";
+/**
+ * Event to receive component data from design library
+ */
+declare const DESIGN_LIBRARY_COMPONENT_PREVIEW_EVENT_NAME = "component:generation:component-preview";
+/**
+ * Event to send component error to design library
+ */
+declare const DESIGN_LIBRARY_COMPONENT_PREVIEW_ERROR_EVENT_NAME = "component:generation:component-preview-error";
+/**
+ * Represents an import map entry.
+ * @public
+ */
+export interface ImportEntry {
+    module: string;
+    exports: {
+        name: string | 'default' | '*';
+        value: unknown;
+    }[];
+}
+/**
+ * Represents the info for the import entry to be sent to design library.
+ * @internal
+ */
+export interface ImportEntryInfo {
+    module: string;
+    exports: string[];
+}
+/**
+ * Represents a component import.
+ */
+export type ComponentImport = {
+    /**
+     * The name of the module to be imported.
+     * e.g. 'react'
+     */
+    module: string;
+    /**
+     * The name of the export to be imported.
+     * e.g. 'useMemo'
+     */
+    export: string;
+    /**
+     * The alias of the import.
+     * e.g. 'useMemoFn'
+     */
+    alias: string;
+};
+/**
+ * Represents the data needed to render AI generated component.
+ * @internal
+ */
+export type GeneratedComponentData = {
+    /**
+     * The unique identifier for the component.
+     */
+    uid: string;
+    /**
+     * The code of the component.
+     */
+    code: {
+        type: 'function';
+        content: string;
+    };
+    /**
+     * The styles of the component.
+     */
+    styles: {
+        type: 'style-element';
+        /**
+         * The styles content to be attached to the DOM.
+         */
+        content: string;
+        /**
+         * The CSS module import
+         */
+        styleImport: {
+            /**
+             * The name of the style import.
+             */
+            name: string;
+            /**
+             * The value of the style import
+             */
+            content: unknown;
+        };
+    };
+    /**
+     * The imports of the component.
+     */
+    imports: ComponentImport[];
+};
+/**
+ * Represents a component preview event data sent from design library
+ * @internal
+ */
+export interface ComponentPreviewEventArgs extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_COMPONENT_PREVIEW_EVENT_NAME;
+    message: GeneratedComponentData;
+}
+/**
+ * Represents a server component preview event data sent from design library in variant generation mode.
+ * @internal
+ */
+export interface ServerComponentPreviewEventArgs extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_COMPONENT_PREVIEW_EVENT_NAME;
+    message: {
+        /**
+         * The cache information for the component preview, used for server components in Design Library variant generation mode.
+         */
+        cache: {
+            /** The unique identifier for the cache entry. */
+            id: string;
+            /** The jwt token for authentication when fetching the preview component from the cache. */
+            token: string;
+        };
+    };
+}
+/**
+ * Represents an event indicating the import map to be sent to design library
+ */
+export interface DesignLibraryImportMapEvent extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_IMPORT_MAP_EVENT_NAME;
+    message: {
+        uid: string;
+        importMap: {
+            module: string;
+            exports: string[];
+        }[];
+    };
+}
+/**
+ * Represents an event indicating the component props to be sent to design library
+ */
+export interface DesignLibraryComponentPropsEvent extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_COMPONENT_PROPS_EVENT_NAME;
+    message: {
+        uid: string;
+        fields: ComponentFields;
+        parameters: ComponentParams;
+    };
+}
+/**
+ * Represents an event indicating the preview error to be sent to design library.
+ */
+export interface DesignLibraryComponentPreviewErrorEvent extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_COMPONENT_PREVIEW_ERROR_EVENT_NAME;
+    message: {
+        uid: string;
+        error: unknown;
+        type: DesignLibraryPreviewError;
+    };
+}
+/**
+ * Enumeration of error types for the design library preview.
+ * @internal
+ */
+export declare enum DesignLibraryPreviewError {
+    /**
+     * Error occurred during component rendering.
+     */
+    Render = "render",
+    /**
+     * Error occurred during component and event handlers initialization.
+     */
+    RenderInit = "render-init"
+}
+/**
+ * Builds the component dependencies from the component imports and the import map.
+ * @param {ComponentImport[]} componentImports - The component imports.
+ * @param {ImportEntry[]} importMap - The import map to be used for the component.
+ * @returns {Array<{ name: string; value: unknown }>} The component dependencies.
+ */
+export declare function buildComponentDependencies(componentImports: ComponentImport[], importMap: ImportEntry[]): {
+    successful: {
+        name: string;
+        value: unknown;
+    }[];
+    missing: {
+        modules: {
+            module: string;
+            alias: string;
+        }[];
+        exports: {
+            alias: string;
+            export: string;
+            module: string;
+        }[];
+    };
+};
+/**
+ * Adds the browser-side event handler for 'component:generation:component-preview' message used in Design Library
+ * The event should contain the component code, styles and imports.
+ * @param {ImportEntry[]} importMap - The import map to be used for the component.
+ * @param {Function} callback callback to be called after component is received
+ * @internal
+ */
+export declare const addComponentPreviewHandler: (importMap: ImportEntry[], callback: (error: unknown | null, Component: unknown) => void) => (() => void) | undefined;
+/**
+ * Adds the browser-side event handler for 'component:generation:component-preview' message used in Design Library for server components
+ * The event should contain the cache id and token which will be used to fetch the component code, styles and imports from secured endpoint
+ * @param {Function} callback callback to be called after component is received
+ * @internal
+ */
+export declare const addServerComponentPreviewHandler: (callback: (eventArgs: ServerComponentPreviewEventArgs) => void) => () => void;
+/**
+ * Adds <style> element in the document head with the provided CSS.
+ * If an existing style element with the id "content-sdk-style-preview" is found, it is removed
+ * to prevent duplicates
+ * @param {string} stylesContent - The raw CSS text to inject into the style element.
+ * @internal
+ */
+export declare function addStyleElement(stylesContent: string): void;
+/**
+ * Dynamically creates a React component instance from provided importMap and from code, styles, and dependencies provided in the preview event.
+ * @param {ImportEntry[]} importMap - The import map containing module and export references that might be injected as dependencies in the provided code.
+ * @param {GeneratedComponentData} generatedComponentData - The generated component data received from design library.
+ * @returns The dynamically created React component instance.
+ * @throws If any required modules or exports are missing from the import map, an error is thrown describing the missing dependencies.
+ * @internal
+ */
+export declare const createComponentInstance: (importMap: ImportEntry[], generatedComponentData: GeneratedComponentData) => unknown;
+/**
+ * Generates a DesignLibraryComponentPreviewErrorEvent with the given uid and error.
+ * @param {string} uid - The unique identifier for the event.
+ * @param {unknown} error - The error to be sent.
+ * @param {DesignLibraryPreviewError} type - The type of error.
+ * @returns An object representing the DesignLibraryComponentPreviewErrorEvent.
+ * @internal
+ */
+export declare function getDesignLibraryComponentPreviewErrorEvent(uid: string, error: unknown, type: DesignLibraryPreviewError): DesignLibraryComponentPreviewErrorEvent;
+/**
+ * Generates a DesignLibraryComponentPropsEvent with the given uid, fields and parameters.
+ * @param {string} uid - The unique identifier for the event.
+ * @param {ComponentFields} fields - The fields of the component.
+ * @param {ComponentParams} parameters - The parameters of the component.
+ * @returns An object representing the DesignLibraryComponentPropsEvent.
+ * @internal
+ */
+export declare function getDesignLibraryComponentPropsEvent(uid: string, fields?: ComponentFields, parameters?: ComponentParams): DesignLibraryComponentPropsEvent;
+/**
+ * Generates a DesignLibraryImportMapEvent with the given uid and importMap.
+ * @param {string} uid - The unique identifier for the event.
+ * @param {ImportEntry[]} importMap - The imports map to be sent.
+ * @returns An object representing the DesignLibraryImportMapEvent.
+ * @internal
+ */
+export declare function getDesignLibraryImportMapEvent(uid: string, importMap: ImportEntry[] | ImportEntryInfo[]): DesignLibraryImportMapEvent;
+/**
+ * Generates the payload for the import map to be sent to design library.
+ * @param {ImportEntry[]} importMap - The imports map to be sent.
+ * @internal
+ */
+export declare function getImportMapInfo(importMap: ImportEntry[]): ImportEntryInfo[];
+/**
+ * Type guard for ImportEntryInfo[]
+ * @param {unknown} data import entry data to check
+ * @returns true if the data is ImportEntryInfo array
+ */
+export declare function isImportEntryInfoArray(data: unknown): data is ImportEntryInfo[];
+/**
+ * Sends a component preview error event to the design library
+ * @param {string} uid - The unique identifier of the component that's being edited.
+ * @param {unknown} error - The error object or message to be sent.
+ * @param {DesignLibraryPreviewError} type - The type of error, as defined in DesignLibraryPreviewError.
+ * @internal
+ */
+export declare const sendErrorEvent: (uid: string, error: unknown, type: DesignLibraryPreviewError) => void;
+/**
+ * Fetches generated component data from the authoring cache endpoint.
+ * This is used by the Design Studio Server to fetch the updated component data from the secured cache endpoint and render it in the Design Library Studio preview iframe.
+ * @param {string} id - The unique identifier of the component to fetch from cache.
+ * @param {string} token - The authorization token for authentication.
+ * @param {string} [edgeUrl] - The URL of the Sitecore Edge endpoint.
+ * @returns A Promise that resolves to the component rendering data, component generation data, or undefined if the fetch fails.
+ * @internal
+ */
+export declare function fetchGeneratedComponentFromCache(id: string, token: string, edgeUrl?: string): Promise<GeneratedComponentData>;
+export {};
+//# sourceMappingURL=preview.d.ts.map

package/types/editing/codegen/preview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../../../src/editing/codegen/preview.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAiB,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAItE;;GAEG;AACH,QAAA,MAAM,oCAAoC,oCAAoC,CAAC;AAE/E;;GAEG;AACH,QAAA,MAAM,yCAAyC,yCAAyC,CAAC;AAEzF;;GAEG;AACH,QAAA,MAAM,2CAA2C,2CAA2C,CAAC;AAE7F;;GAEG;AACH,QAAA,MAAM,iDAAiD,iDACP,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,GAAG,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE;QACJ,IAAI,EAAE,UAAU,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,eAAe,CAAC;QACtB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,WAAW,EAAE;YACX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YACb;;eAEG;YACH,OAAO,EAAE,OAAO,CAAC;SAClB,CAAC;KACH,CAAC;IACF;;OAEG;IACH,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE,IAAI,EAAE,OAAO,2CAA2C,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB;IACzE,IAAI,EAAE,OAAO,2CAA2C,CAAC;IACzD,OAAO,EAAE;QACP;;WAEG;QACH,KAAK,EAAE;YACL,iDAAiD;YACjD,EAAE,EAAE,MAAM,CAAC;YACX,2FAA2F;YAC3F,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB;IACrE,IAAI,EAAE,OAAO,oCAAoC,CAAC;IAClD,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE;YACT,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,EAAE,MAAM,EAAE,CAAC;SACnB,EAAE,CAAC;KACL,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,kBAAkB;IAC1E,IAAI,EAAE,OAAO,yCAAyC,CAAC;IACvD,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,eAAe,CAAC;QACxB,UAAU,EAAE,eAAe,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,kBAAkB;IACjF,IAAI,EAAE,OAAO,iDAAiD,CAAC;IAC/D,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,yBAAyB,CAAC;KACjC,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,yBAAyB;IACnC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,UAAU,gBAAgB;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,gBAAgB,EAAE,eAAe,EAAE,EACnC,SAAS,EAAE,WAAW,EAAE;;cAEQ,MAAM;eAAS,OAAO;;;iBAE3C;YACP,MAAM,EAAE,MAAM,CAAC;YACf,KAAK,EAAE,MAAM,CAAC;SACf,EAAE;iBACM;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,EAAE,MAAM,CAAC;SAChB,EAAE;;EAwCN;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GACrC,WAAW,WAAW,EAAE,EACxB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,6BA+B9D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,GAC3C,UAAU,CAAC,SAAS,EAAE,+BAA+B,KAAK,IAAI,eAmB/D,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,MAAM,QAcpD;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAClC,WAAW,WAAW,EAAE,EACxB,wBAAwB,sBAAsB,KAC7C,OAiCF,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,0CAA0C,CACxD,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,yBAAyB,GAC9B,uCAAuC,CAKzC;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,eAAoB,EAC5B,UAAU,GAAE,eAAoB,GAC/B,gCAAgC,CASlC;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAC3C,2BAA2B,CAY7B;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,CAK5E;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,eAAe,EAAE,CAQ/E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,MAAM,yBAAyB,SAO1F,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,gCAAgC,CACpD,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,MAA2C,GACnD,OAAO,CAAC,sBAAsB,CAAC,CAoBjC"}