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

package/types/editing/component-layout-service.d.ts

@@ -0,0 +1,84 @@
+import { FetchOptions } from '@sitecore-content-sdk/core';
+import { LayoutServiceData } from '../layout/models';
+import { DesignLibraryMode, DesignLibraryVariantGeneration } from './models';
+/**
+ * Params for requesting component data in Design Library mode
+ * @public
+ */
+export interface ComponentLayoutRequestParams {
+    /**
+     * Item id to be used as context for rendering the component
+     */
+    itemId: string;
+    /**
+     * Component identifier. Can be either taken from item's layout details or
+     * an arbitrary one (component renderingId and datasource would be used for identification then)
+     */
+    componentUid: string;
+    /**
+     * site name to be used as context for rendering the component
+     */
+    siteName: string;
+    /**
+     * language to render component in
+     */
+    language?: string;
+    /**
+     * optional component datasource
+     */
+    dataSourceId?: string;
+    /**
+     * ID of the component definition rendering item in Sitecore
+     */
+    renderingId?: string;
+    /**
+     * version of the context item (latest by default)
+     */
+    version?: string;
+    /**
+     * mode to be used for rendering the component
+     */
+    mode?: DesignLibraryMode;
+    /**
+     * design library variant generation mode
+     */
+    generation?: DesignLibraryVariantGeneration;
+}
+/**
+ * Config for ComponentLayoutService.
+ * Provide contextId (server) and optionally clientContextId (browser).
+ * @public
+ */
+export interface ComponentLayoutServiceConfig {
+    /**
+     * A unified identifier used to connect and retrieve data from XM Cloud instance used on the client
+     */
+    clientContextId?: string;
+    /**
+     * A unified identifier used to connect and retrieve data from XM Cloud instance used on the server
+     */
+    contextId: string;
+    /**
+     * XM Cloud endpoint that the app will communicate and retrieve data from
+     * @default https://edge-platform.sitecorecloud.io
+     */
+    edgeUrl?: string;
+}
+/**
+ * REST service that enables Design Library functionality.
+ * Returns layout data for a single rendered component.
+ * @public
+ */
+export declare class ComponentLayoutService {
+    private config;
+    constructor(config: ComponentLayoutServiceConfig);
+    fetchComponentData(params: ComponentLayoutRequestParams, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
+    protected getComponentFetchParams(params: ComponentLayoutRequestParams): any;
+    /**
+     * Get the fetch URL for the partial layout data endpoint
+     * @param {ComponentLayoutRequestParams} params - The parameters for the request
+     * @returns {string} The fetch URL for the component data
+     */
+    private getFetchUrl;
+}
+//# sourceMappingURL=component-layout-service.d.ts.map

package/types/editing/component-layout-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-layout-service.d.ts","sourceRoot":"","sources":["../../src/editing/component-layout-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAExF,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAI7E;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,8BAA8B,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,sBAAsB;IACrB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,4BAA4B;IAExD,kBAAkB,CAChB,MAAM,EAAE,4BAA4B,EACpC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAwC7B,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,4BAA4B;IAetE;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAMpB"}

package/types/editing/design-library.d.ts

@@ -0,0 +1,111 @@
+import { ComponentFields, ComponentParams, ComponentRendering, Field, GenericFieldValue } from '../layout/models';
+import { DesignLibraryMode } from './models';
+/**
+ * Event to be sent when report status to design library
+ */
+declare const DESIGN_LIBRARY_STATUS_EVENT_NAME = "component:status";
+/**
+ * Prefix for component update cache keys
+ * @internal
+ */
+export declare const COMPONENT_UPDATE_CACHE_KEY_PREFIX = "component-update-";
+/**
+ * Base interface for all Design Library events.
+ */
+export interface DesignLibraryEvent {
+    /**
+     * The name of the event.
+     */
+    name: string;
+    /**
+     * The message payload for the event.
+     */
+    message: Record<string, unknown>;
+}
+/**
+ * Represents an event indicating the status of a component in the library.
+ * @internal
+ */
+export interface DesignLibraryStatusEvent extends DesignLibraryEvent {
+    name: typeof DESIGN_LIBRARY_STATUS_EVENT_NAME;
+    message: {
+        status: 'ready' | 'rendered';
+        uid: string;
+    };
+}
+/**
+ * Enumeration of statuses for the design library.
+ * @internal
+ */
+export declare enum DesignLibraryStatus {
+    READY = "ready",
+    RENDERED = "rendered"
+}
+/**
+ * Event args for Design Library `update` event
+ * @internal
+ */
+export interface ComponentUpdateEventArgs extends DesignLibraryEvent {
+    name: string;
+    details?: {
+        uid: string;
+        params?: Record<string, string>;
+        fields?: Record<string, Field<GenericFieldValue>>;
+    };
+}
+/**
+ * Adds the browser-side event handler for 'component:update' message used in Design Library
+ * The event should update a component on page by uid, with fields and params from event args
+ * @param {ComponentRendering} rootComponent root component displayed for Design Library page
+ * @param {Function} successCallback  callback to be called after successful component update
+ * @internal
+ */
+export declare const addComponentUpdateHandler: (rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => (() => void) | undefined;
+export declare const validateOrigin: (event: MessageEvent) => boolean;
+/**
+ * Validates that a MessageEvent has the expected event name and required data.
+ * Logs debug information when validation fails due to invalid origin.
+ * @param {MessageEvent} e - The message event to validate.
+ * @param {string} eventName - The expected event name to match against e.data.name.
+ * @returns {boolean} True if the event has a valid origin, data object, and matching event name; otherwise false.
+ */
+export declare const validateEvent: (e: MessageEvent, eventName: string) => boolean;
+export declare const updateComponentHandler: (e: MessageEvent, rootComponent: ComponentRendering, successCallback?: (updatedRootComponent: ComponentRendering) => void) => ComponentRendering<ComponentFields> | undefined;
+/**
+ * Updates a component's fields and params with the provided values.
+ * @param {ComponentRendering<ComponentFields>} component - The component to update.
+ * @param {ComponentFields | undefined} fields - The fields to merge into the component.
+ * @param {ComponentParams | undefined} params - The params to merge into the component.
+ * @internal
+ */
+export declare const updateComponent: (component: ComponentRendering<ComponentFields>, fields: ComponentFields | undefined, params: ComponentParams | undefined) => void;
+/**
+ * Generates a DesignLibraryStatusEvent with the given status and uid.
+ * @param {DesignLibraryStatus} status - The status of rendering.
+ * @param {string} uid - The unique identifier for the event.
+ * @returns An object representing the DesignLibraryStatusEvent.
+ * @internal
+ */
+export declare function getDesignLibraryStatusEvent(status: DesignLibraryStatus, uid: string): DesignLibraryStatusEvent;
+/**
+ * Generates the URL for the design library script link.
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
+ * @returns The full URL to the design library script.
+ * @internal
+ */
+export declare function getDesignLibraryScriptLink(sitecoreEdgeUrl?: string): string;
+/**
+ * Checks if the given mode is a Design Library mode.
+ * @param {unknown} mode - The mode to check.
+ * @returns {boolean} True if the mode is a Design Library mode, false otherwise.
+ * @internal
+ */
+export declare function isDesignLibraryMode(mode: unknown): mode is DesignLibraryMode;
+/**
+ * Sends an event to the Design Library
+ * @param {DesignLibraryEvent} evt - The event object to send.
+ * @internal
+ */
+export declare const postToDesignLibrary: (evt: DesignLibraryEvent) => void;
+export {};
+//# sourceMappingURL=design-library.d.ts.map

package/types/editing/design-library.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"design-library.d.ts","sourceRoot":"","sources":["../../src/editing/design-library.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,KAAK,EACL,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAI7C;;GAEG;AACH,QAAA,MAAM,gCAAgC,qBAAqB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,iCAAiC,sBAAsB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,OAAO,gCAAgC,CAAC;IAC9C,OAAO,EAAE;QACP,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;QAC7B,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;KACnD,CAAC;CACH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,GACpC,eAAe,kBAAkB,EACjC,kBAAkB,CAAC,oBAAoB,EAAE,kBAAkB,KAAK,IAAI,6BAUrE,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,YAAY,YASjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,GAAG,YAAY,EAAE,WAAW,MAAM,KAAG,OAelE,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,GAAG,YAAY,EACf,eAAe,kBAAkB,EACjC,kBAAkB,CAAC,oBAAoB,EAAE,kBAAkB,KAAK,IAAI,oDAkDrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,kBAAkB,CAAC,eAAe,CAAC,EAC9C,QAAQ,eAAe,GAAG,SAAS,EACnC,QAAQ,eAAe,GAAG,SAAS,SAQpC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,MAAM,GACV,wBAAwB,CAQ1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,eAAe,SAA4B,GAAG,MAAM,CAE9F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,iBAAiB,CAE5E;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,kBAAkB,SAW1D,CAAC"}

package/types/editing/editing-service.d.ts

@@ -0,0 +1,71 @@
+import { GraphQLClient, GraphQLRequestClientFactory, FetchOptions } from '@sitecore-content-sdk/core';
+import { LayoutServiceData, LayoutServicePageState } from '../layout';
+import { LayoutKind } from './models';
+/**
+ * GraphQL query for fetching editing data.
+ */
+export declare const query = "\n  query EditingQuery($itemId: String!, $language: String!, $version: String) {\n    item(path: $itemId, language: $language, version: $version) {\n      rendered\n    }\n  }\n";
+/**
+ * Response from the GraphQL Editing query.
+ */
+export type GraphQLEditingQueryResponse = {
+    item: {
+        rendered: LayoutServiceData;
+    };
+};
+/**
+ * Configuration for the EditingService
+ * @public
+ */
+export interface EditingServiceConfig {
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+}
+/**
+ * Options for fetching editing data
+ * @public
+ */
+export type EditingOptions = {
+    itemId: string;
+    language: string;
+    version?: string;
+    layoutKind?: LayoutKind;
+    mode: Exclude<LayoutServicePageState, 'Normal'>;
+};
+/**
+ * Service for fetching editing data from Sitecore using the Sitecore's GraphQL API.
+ * Expected to be used in XMCloud Pages preview (editing) Metadata Edit Mode.
+ * @public
+ */
+export declare class EditingService {
+    serviceConfig: EditingServiceConfig;
+    private graphQLClient;
+    /**
+     * Fetch layout data using the Sitecore GraphQL endpoint.
+     * @param {EditingServiceConfig} serviceConfig configuration
+     */
+    constructor(serviceConfig: EditingServiceConfig);
+    /**
+     * Fetches editing data. Provides the layout data and dictionary phrases
+     * @param {object} variables - The parameters for fetching editing data.
+     * @param {string} variables.itemId - The item id (path) to fetch layout data for.
+     * @param {string} variables.language - The language to fetch layout data for.
+     * @param {string} variables.mode - The editing mode to fetch layout data for.
+     * @param {string} [variables.version] - The version of the item (optional).
+     * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {Promise} The layout data and dictionary phrases.
+     */
+    fetchEditingData({ itemId, language, version, layoutKind, mode }: EditingOptions, fetchOptions?: FetchOptions): Promise<{
+        layoutData: LayoutServiceData;
+    }>;
+    /**
+     * Gets a GraphQL client that can make requests to the API.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+//# sourceMappingURL=editing-service.d.ts.map

package/types/editing/editing-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editing-service.d.ts","sourceRoot":"","sources":["../../src/editing/editing-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,2BAA2B,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAEtG,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,KAAK,sLAMjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE;QAAE,QAAQ,EAAE,iBAAiB,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,IAAI,EAAE,OAAO,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,cAAc;IAON,aAAa,EAAE,oBAAoB;IANtD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,aAAa,EAAE,oBAAoB;IAItD;;;;;;;;;;OAUG;IACG,gBAAgB,CACpB,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAA6B,EAAE,IAAI,EAAE,EAAE,cAAc,EAClF,YAAY,CAAC,EAAE,YAAY;;;IAoC7B;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}

package/types/editing/index.d.ts

@@ -0,0 +1,7 @@
+export { EditingService, EditingOptions, EditingServiceConfig } from './editing-service';
+export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, getContentSdkPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, INVALID_SECRET_HTML_MESSAGE, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, PREVIEW_KEY, } from './utils';
+export { ComponentLayoutService, ComponentLayoutRequestParams, ComponentLayoutServiceConfig, } from './component-layout-service';
+export { EditingRenderQueryParams, RenderComponentQueryParams, DesignLibraryVariantGeneration, } from './models';
+export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, DesignLibraryMode, } from './models';
+export { addComponentUpdateHandler, DesignLibraryStatus, DesignLibraryStatusEvent, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, isDesignLibraryMode, postToDesignLibrary, COMPONENT_UPDATE_CACHE_KEY_PREFIX, updateComponent, } from './design-library';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/editing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzF,OAAO,EACL,uBAAuB,EACvB,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,wBAAwB,EACxB,WAAW,GACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC1B,8BAA8B,GAC/B,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,8BAA8B,EAC9B,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,mBAAmB,EACnB,iCAAiC,EACjC,eAAe,GAChB,MAAM,kBAAkB,CAAC"}

package/types/editing/models.d.ts

@@ -0,0 +1,103 @@
+import { LayoutServicePageState } from '../layout';
+/**
+ * Query parameters appended to the page route URL
+ * Appended when XMCloud Pages preview (editing) mode is used
+ * `mode` is a special case as it serves editing and component library both
+ * @internal
+ */
+export interface EditingRenderQueryParams {
+    [key: string]: unknown;
+    secret: string;
+    sc_lang: string;
+    sc_itemid: string;
+    sc_site: string;
+    route: string;
+    mode: Exclude<LayoutServicePageState, 'normal'> | DesignLibraryMode;
+    sc_layoutKind?: LayoutKind;
+    sc_variant?: string;
+    sc_version?: string;
+}
+/**
+ * Query parameters appended for Component Library functionaity.
+ * Used when a single component is rendered in Pages.
+ * @internal
+ */
+export interface RenderComponentQueryParams {
+    [key: string]: unknown;
+    secret: string;
+    sc_lang: string;
+    sc_itemid: string;
+    sc_renderingId: string;
+    sc_uid: string;
+    sc_site: string;
+    mode: DesignLibraryMode;
+    sc_variant?: string;
+    sc_version?: string;
+}
+/**
+ * Represents the Editing Layout variant.
+ * - shared - shared layout
+ * - final - final layout
+ * @public
+ */
+export declare enum LayoutKind {
+    Final = "final",
+    Shared = "shared"
+}
+/**
+ * Represents the kind of metadata element.
+ * - open - starting chrome element
+ * - close - closing chrome element
+ * @internal
+ */
+export declare enum MetadataKind {
+    Open = "open",
+    Close = "close"
+}
+/**
+ * Data for Preview (Editing) Mode.
+ * @public
+ */
+export type EditingPreviewData = {
+    site: string;
+    itemId: string;
+    language: string;
+    mode: Exclude<LayoutServicePageState, 'Normal'>;
+    variantIds: string[] | string;
+    version?: string;
+    layoutKind?: LayoutKind;
+};
+/**
+ * Represents the mode of the Design Library
+ * @public
+ */
+export declare enum DesignLibraryMode {
+    /** Normal mode */
+    Normal = "library",
+    /** Metadata mode */
+    Metadata = "library-metadata"
+}
+/**
+ * Variant generation mode for Design Library
+ * @public
+ */
+export declare enum DesignLibraryVariantGeneration {
+    Variant = "variant"
+}
+/**
+ * Data for Design Library rendering mode
+ * @public
+ */
+export interface DesignLibraryRenderPreviewData {
+    site: string;
+    itemId: string;
+    renderingId: string;
+    componentUid: string;
+    language: string;
+    mode: DesignLibraryMode;
+    variant?: string;
+    version?: string;
+    dataSourceId?: string;
+    generation?: DesignLibraryVariantGeneration;
+}
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/editing/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC,sBAAsB,EAAE,QAAQ,CAAC,GAAG,iBAAiB,CAAC;IACpE,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,iBAAiB,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;;GAKG;AACH,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;IAChD,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,kBAAkB;IAClB,MAAM,YAAY;IAClB,oBAAoB;IACpB,QAAQ,qBAAqB;CAC9B;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC,OAAO,YAAY;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,8BAA8B,CAAC;CAC7C"}

package/types/editing/utils.d.ts

@@ -0,0 +1,82 @@
+import { Field, GenericFieldValue } from '../layout/models';
+/**
+ * Default value of uid for root placeholder when uid is not present.
+ * @internal
+ */
+export declare const DEFAULT_PLACEHOLDER_UID = "00000000-0000-0000-0000-000000000000";
+/**
+ * Query parameter for editing secret
+ * @internal
+ */
+export declare const QUERY_PARAM_EDITING_SECRET = "secret";
+/**
+ * HTML returned for invalid or missing secret
+ * @internal
+ */
+export declare const INVALID_SECRET_HTML_MESSAGE = "<html><body>Missing or invalid secret</body></html>";
+/**
+ * Key to identify whether the app is running in Sitecore Preview mode
+ * @internal
+ */
+export declare const PREVIEW_KEY = "sc_preview";
+/**
+ * ID to be used as a marker for a script rendered in XMC Pages
+ * Should identify app is in XM Cloud Pages editing mode
+ * @internal
+ */
+export declare const PAGES_EDITING_MARKER = "jss-hrz-editing";
+/**
+ * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
+ * @internal
+ */
+export declare const EDITING_ALLOWED_ORIGINS: string[];
+/**
+ * Event args for Design Library `update` event
+ * @internal
+ */
+export interface ComponentUpdateEventArgs {
+    name: string;
+    details?: {
+        uid: string;
+        params?: Record<string, string>;
+        fields?: Record<string, Field<GenericFieldValue>>;
+    };
+}
+/**
+ * Copy of chrome rediscovery contract from Horizon (chrome-rediscovery.contract.ts)
+ */
+export declare const ChromeRediscoveryGlobalFunctionName: {
+    name: string;
+};
+/**
+ * Static utility class for Sitecore Pages Editor
+ * @public
+ */
+export declare class PagesEditor {
+    /**
+     * Determines whether the current execution context is within a Pages Editor.
+     * Pages Editor environment can be identified only in the browser
+     * @returns true if executing within a Pages Editor
+     */
+    static isActive(): boolean;
+    static resetChromes(): void;
+}
+/**
+ * Determines whether the current execution context is within a Sitecore editor.
+ * Sitecore Editor environment can be identified only in the browser
+ * @returns true if executing within a Sitecore editor
+ * @public
+ */
+export declare const isEditorActive: () => boolean;
+/**
+ * Resets Sitecore editor "chromes"
+ * @public
+ */
+export declare const resetEditorChromes: () => void;
+/**
+ * Gets extra Content SDK clientData scripts to render in XMC Pages in addition to clientData from Pages itself
+ * @returns {Record} collection of clientData
+ * @internal
+ */
+export declare const getContentSdkPagesClientData: () => Record<string, Record<string, unknown>>;
+//# sourceMappingURL=utils.d.ts.map

package/types/editing/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/editing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAG5D;;;GAGG;AACH,eAAO,MAAM,uBAAuB,yCAAyC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,0BAA0B,WAAW,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,2BAA2B,wDAAwD,CAAC;AAEjG;;;GAGG;AACH,eAAO,MAAM,WAAW,eAAe,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,UAInC,CAAC;AAcF;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;KACnD,CAAC;CACH;AAED;;GAEG;AACH,eAAO,MAAM,mCAAmC;;CAE/C,CAAC;AAEF;;;GAGG;AACH,qBAAa,WAAW;IACtB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,IAAI,OAAO;IAS1B,MAAM,CAAC,YAAY,IAAI,IAAI;CAQ5B;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAO,OAEjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAO,IAIrC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,+CAKxC,CAAC"}

package/types/form/form.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Fetches the form markup from the Sitecore Edge service and renders it in the component's template.
+ * @param {string} contextId - The unique identifier of the current context
+ * @param {string} formId - The unique identifier of the form
+ * @param {string} [edgeUrl] - The URL of the Sitecore Edge Platform
+ * @internal
+ */
+export declare const loadForm: (contextId: string, formId: string, edgeUrl?: string) => Promise<string>;
+/**
+ * When you set the innerHTML property of an element, the browser does not execute any <script> tags included in the HTML string
+ * This method ensures that any <script> elements within the loaded HTML are executed.
+ * It re-creates the script elements and appends the to the component's template, then removes old script elements to avoid duplication.
+ * @param {HTMLElement} rootElement - The root element to execute script elements within
+ * @internal
+ */
+export declare const executeScriptElements: (rootElement: HTMLElement) => void;
+/**
+ * Subscribes to the Form event
+ * This listener captures interactions such as form views or submissions
+ * @param {HTMLElement} formElement - The form element to subscribe to events on
+ * @param {string} [componentId] - The unique identifier of the component
+ * @internal
+ */
+export declare const subscribeToFormSubmitEvent: (formElement: HTMLElement, componentId?: string) => void;
+//# sourceMappingURL=form.d.ts.map

package/types/form/form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/form/form.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAU,WAAW,MAAM,EAAE,QAAQ,MAAM,EAAE,UAAU,MAAM,oBA+BjF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,aAAa,WAAW,SAkB7D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GAAI,aAAa,WAAW,EAAE,cAAc,MAAM,SAYxF,CAAC"}

package/types/form/index.d.ts

@@ -0,0 +1,2 @@
+export { executeScriptElements, loadForm, subscribeToFormSubmitEvent } from './form';
+//# sourceMappingURL=index.d.ts.map

package/types/form/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/form/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,0BAA0B,EAAE,MAAM,QAAQ,CAAC"}

package/types/i18n/dictionary-service.d.ts

@@ -0,0 +1,133 @@
+import { FetchOptions, GraphQLClient, GraphQLRequestClientFactory, CacheClient, CacheOptions } from '@sitecore-content-sdk/core';
+import { PageInfo } from '../client';
+import { GraphQLServiceConfig } from '../sitecore-service-base';
+/** @private */
+export declare const queryError = "Valid value for rootItemId not provided and failed to auto-resolve app root item.";
+/**
+ * Query variables for dictionary graphql query
+ */
+export interface DictionaryQueryVariables {
+    /**
+     * Optional. The ID of the search root item. Fetch items that have this item as an ancestor.
+     */
+    rootItemId?: string;
+    /**
+     * Optional. Sitecore template ID(s). Fetch items that inherit from this template(s).
+     */
+    templates?: string;
+    /**
+     * common variable for all GraphQL queries
+     * it will be used for every type of query to regulate result batch size
+     * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
+     * @default 10
+     */
+    pageSize?: number;
+}
+/**
+ * Object model for Sitecore dictionary phrases
+ * @public
+ */
+export interface DictionaryPhrases {
+    [k: string]: string;
+}
+/**
+ * Configuration options for @see DictionaryService instances
+ * @public
+ */
+export interface DictionaryServiceConfig extends CacheOptions, GraphQLServiceConfig {
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+    /**
+     * Optional. The template ID to use when searching for dictionary entries.
+     * @default '6d1cd89719364a3aa511289a94c2a7b1' (/sitecore/templates/System/Dictionary/Dictionary entry)
+     */
+    dictionaryEntryTemplateId?: string;
+    /**
+     * common variable for all GraphQL queries
+     * it will be used for every type of query to regulate result batch size
+     * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
+     * @default 10
+     */
+    pageSize?: number;
+}
+/**
+ * The schema of data returned in response to a dictionary query request.
+ */
+export type DictionaryQueryResult = {
+    key: {
+        value: string;
+    };
+    phrase: {
+        value: string;
+    };
+};
+export type DictionarySiteQueryResponse = {
+    site: {
+        siteInfo: {
+            dictionary: {
+                results: {
+                    key: string;
+                    value: string;
+                }[];
+                pageInfo: PageInfo;
+            };
+        };
+    };
+};
+/**
+ * Service that fetch dictionary data using Sitecore's GraphQL API.
+ * @augments DictionaryServiceBase
+ * @mixes SearchQueryService<DictionaryQueryResult>
+ * @public
+ */
+export declare class DictionaryService implements CacheClient<DictionaryPhrases> {
+    options: DictionaryServiceConfig;
+    private graphQLClient;
+    private cache;
+    /**
+     * Creates an instance of graphQL dictionary service with the provided options
+     * @param {DictionaryService} options instance
+     */
+    constructor(options: DictionaryServiceConfig);
+    /**
+     * Fetches dictionary data for internalization. Uses search query by default
+     * @param {string} language the language to fetch
+     * @param {string} site site name to fetch data for.
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {Promise<DictionaryPhrases>} dictionary phrases
+     * @throws {Error} if the app root was not found for the specified site and language.
+     */
+    fetchDictionaryData(language: string, site: string, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    /**
+     * Caches a @see DictionaryPhrases value for the specified cache key.
+     * @param {string} key The cache key.
+     * @param {DictionaryPhrases} value The value to cache.
+     * @returns The value added to the cache.
+     * @mixes CacheClient<DictionaryPhrases>
+     */
+    setCacheValue(key: string, value: DictionaryPhrases): DictionaryPhrases;
+    /**
+     * Retrieves a @see DictionaryPhrases value from the cache.
+     * @param {string} key The cache key.
+     * @returns The @see DictionaryPhrases value, or null if the specified key is not found in the cache.
+     */
+    getCacheValue(key: string): DictionaryPhrases | null;
+    /**
+     * Gets a cache client that can cache data. Uses memory-cache as the default
+     * library for caching (@see MemoryCacheClient). Override this method if you
+     * want to use something else.
+     * @returns {CacheClient} implementation
+     */
+    protected getCacheClient(): CacheClient<DictionaryPhrases>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+//# sourceMappingURL=dictionary-service.d.ts.map

package/types/i18n/dictionary-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary-service.d.ts","sourceRoot":"","sources":["../../src/i18n/dictionary-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EACb,2BAA2B,EAC3B,WAAW,EACX,YAAY,EAEb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,eAAe;AACf,eAAO,MAAM,UAAU,sFAC8D,CAAC;AA2BtF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,YAAY,EAAE,oBAAoB;IACjF;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;IAE3C;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACvB,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE;QACJ,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,OAAO,EAAE;oBAAE,GAAG,EAAE,MAAM,CAAC;oBAAC,KAAK,EAAE,MAAM,CAAA;iBAAE,EAAE,CAAC;gBAC1C,QAAQ,EAAE,QAAQ,CAAC;aACpB,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,WAAW,CAAC,iBAAiB,CAAC;IAOnD,OAAO,EAAE,uBAAuB;IANnD,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAAiC;IAC9C;;;OAGG;gBACgB,OAAO,EAAE,uBAAuB;IAKnD;;;;;;;OAOG;IACG,mBAAmB,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAiD7B;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,iBAAiB;IAIvE;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAIpD;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,iBAAiB,CAAC;IAI1D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAU5C"}