@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.2

package/types/editing/models.d.ts

@@ -1,92 +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
- */
-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.
- */
-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
- */
-export declare enum LayoutKind {
-    Final = "final",
-    Shared = "shared"
-}
-/**
- * Represents the kind of metadata element.
- * - open - starting chrome element
- * - close - closing chrome element
- */
-export declare enum MetadataKind {
-    Open = "open",
-    Close = "close"
-}
-/**
- * Data for Preview (Editing) Mode.
- */
-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 */
-export declare enum DesignLibraryMode {
-    /** Normal mode */
-    Normal = "library",
-    /** Metadata mode */
-    Metadata = "library-metadata"
-}
-/**
- * Variant generation mode for Design Library
- */
-export declare enum DesignLibraryVariantGeneration {
-    Variant = "variant"
-}
-/**
- * Data for Design Library rendering mode
- */
-export interface DesignLibraryRenderPreviewData {
-    site: string;
-    itemId: string;
-    renderingId: string;
-    componentUid: string;
-    language: string;
-    mode: DesignLibraryMode;
-    variant?: string;
-    version?: string;
-    dataSourceId?: string;
-    generation?: DesignLibraryVariantGeneration;
-}
+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

@@ -1,74 +1,91 @@
-import { Field, GenericFieldValue } from '../layout/models';
-/**
- * Default value of uid for root placeholder when uid is not present.
- */
-export declare const DEFAULT_PLACEHOLDER_UID = "00000000-0000-0000-0000-000000000000";
-/**
- * Query parameter for editing secret
- */
-export declare const QUERY_PARAM_EDITING_SECRET = "secret";
-/**
- * Key to identify whether the app is running in Sitecore Preview mode
- */
-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
- */
-export declare const PAGES_EDITING_MARKER = "jss-hrz-editing";
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export declare const EDITING_ALLOWED_ORIGINS: string[];
-/**
- * Event args for Design Library `update` event
- */
-export interface ComponentUpdateEventArgs {
-    name: string;
-    details?: {
-        uid: string;
-        params?: Record<string, string>;
-        fields?: Record<string, Field<GenericFieldValue>>;
-    };
-}
-/**
- * Application metadata
- */
-export interface Metadata {
-    packages: {
-        [key: string]: string;
-    };
-}
-/**
- * Copy of chrome rediscovery contract from Horizon (chrome-rediscovery.contract.ts)
- */
-export declare const ChromeRediscoveryGlobalFunctionName: {
-    name: string;
-};
-/**
- * Static utility class for Sitecore Pages Editor
- */
-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
- */
-export declare const isEditorActive: () => boolean;
-/**
- * Resets Sitecore editor "chromes"
- */
-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
- */
-export declare const getContentSdkPagesClientData: () => Record<string, Record<string, unknown>>;
+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>>;
+    };
+}
+/**
+ * Application metadata
+ * @public
+ */
+export interface Metadata {
+    packages: {
+        [key: string]: string;
+    };
+}
+/**
+ * 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;AACD;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;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

@@ -1,21 +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
- */
-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
- */
-export declare const executeScriptElements: (rootElement: HTMLElement) => void;
-/**
- * Subscribes to the Form event and then sends data to CloudSDK.
- * 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
- */
-export declare const subscribeToFormSubmitEvent: (formElement: HTMLElement, componentId?: string) => void;
+/**
+ * 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 and then sends data to CloudSDK.
+ * 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

@@ -1 +1,2 @@
-export { executeScriptElements, loadForm, subscribeToFormSubmitEvent } from './form';
+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"}