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

package/dist/esm/editing/metadata.js

@@ -1,39 +1,39 @@
-import { execSync } from 'child_process';
-const trackedScopes = [
-    '@sitecore',
-    '@sitecore-cloudsdk',
-    '@sitecore-feaas',
-    '@sitecore-content-sdk',
-];
-/**
- * Get application metadata
- * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
- * @returns {Metadata} The generated metadata.
- */
-export function getMetadata(allowWorkspaces = false) {
-    const metadata = { packages: {} };
-    let queryResult = [];
-    try {
-        queryResult = JSON.parse(execSync(`npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`).toString());
-    }
-    catch (error) {
-        console.error('Failed to retrieve sitecore packages using npm query', error);
-        return metadata;
-    }
-    metadata.packages = getPackagesFromQueryResult(queryResult);
-    return metadata;
-}
-/**
- * Retrieve all packages of the tracked scopes with their exact versions
- * @param {Package[]} scPackages list of packages
- * @returns {Record<string, string>} an object with the packages with their exact versions
- */
-function getPackagesFromQueryResult(scPackages) {
-    const packages = {};
-    scPackages.forEach((scPackage) => {
-        if (trackedScopes.some((trackedScope) => scPackage.name.startsWith(trackedScope))) {
-            packages[scPackage.name] = scPackage.version;
-        }
-    });
-    return packages;
-}
+import { execSync } from 'child_process';
+const trackedScopes = [
+    '@sitecore',
+    '@sitecore-cloudsdk',
+    '@sitecore-feaas',
+    '@sitecore-content-sdk',
+];
+/**
+ * Get application metadata
+ * @param {boolean} allowWorkspaces - Whether to allow workspaces in the metadata generation.
+ * @returns {Metadata} The generated metadata.
+ */
+export function getMetadata(allowWorkspaces = false) {
+    const metadata = { packages: {} };
+    let queryResult = [];
+    try {
+        queryResult = JSON.parse(execSync(`npm query [name*=@sitecore] --workspaces ${allowWorkspaces}`).toString());
+    }
+    catch (error) {
+        console.error('Failed to retrieve sitecore packages using npm query', error);
+        return metadata;
+    }
+    metadata.packages = getPackagesFromQueryResult(queryResult);
+    return metadata;
+}
+/**
+ * Retrieve all packages of the tracked scopes with their exact versions
+ * @param {Package[]} scPackages list of packages
+ * @returns {Record<string, string>} an object with the packages with their exact versions
+ */
+function getPackagesFromQueryResult(scPackages) {
+    const packages = {};
+    scPackages.forEach((scPackage) => {
+        if (trackedScopes.some((trackedScope) => scPackage.name.startsWith(trackedScope))) {
+            packages[scPackage.name] = scPackage.version;
+        }
+    });
+    return packages;
+}

package/dist/esm/editing/models.js

@@ -1,35 +1,41 @@
-/**
- * Represents the Editing Layout variant.
- * - shared - shared layout
- * - final - final layout
- */
-export var LayoutKind;
-(function (LayoutKind) {
-    LayoutKind["Final"] = "final";
-    LayoutKind["Shared"] = "shared";
-})(LayoutKind || (LayoutKind = {}));
-/**
- * Represents the kind of metadata element.
- * - open - starting chrome element
- * - close - closing chrome element
- */
-export var MetadataKind;
-(function (MetadataKind) {
-    MetadataKind["Open"] = "open";
-    MetadataKind["Close"] = "close";
-})(MetadataKind || (MetadataKind = {}));
-/** Represents the mode of the Design Library */
-export var DesignLibraryMode;
-(function (DesignLibraryMode) {
-    /** Normal mode */
-    DesignLibraryMode["Normal"] = "library";
-    /** Metadata mode */
-    DesignLibraryMode["Metadata"] = "library-metadata";
-})(DesignLibraryMode || (DesignLibraryMode = {}));
-/**
- * Variant generation mode for Design Library
- */
-export var DesignLibraryVariantGeneration;
-(function (DesignLibraryVariantGeneration) {
-    DesignLibraryVariantGeneration["Variant"] = "variant";
-})(DesignLibraryVariantGeneration || (DesignLibraryVariantGeneration = {}));
+/**
+ * Represents the Editing Layout variant.
+ * - shared - shared layout
+ * - final - final layout
+ * @public
+ */
+export var LayoutKind;
+(function (LayoutKind) {
+    LayoutKind["Final"] = "final";
+    LayoutKind["Shared"] = "shared";
+})(LayoutKind || (LayoutKind = {}));
+/**
+ * Represents the kind of metadata element.
+ * - open - starting chrome element
+ * - close - closing chrome element
+ * @internal
+ */
+export var MetadataKind;
+(function (MetadataKind) {
+    MetadataKind["Open"] = "open";
+    MetadataKind["Close"] = "close";
+})(MetadataKind || (MetadataKind = {}));
+/**
+ * Represents the mode of the Design Library
+ * @public
+ */
+export var DesignLibraryMode;
+(function (DesignLibraryMode) {
+    /** Normal mode */
+    DesignLibraryMode["Normal"] = "library";
+    /** Metadata mode */
+    DesignLibraryMode["Metadata"] = "library-metadata";
+})(DesignLibraryMode || (DesignLibraryMode = {}));
+/**
+ * Variant generation mode for Design Library
+ * @public
+ */
+export var DesignLibraryVariantGeneration;
+(function (DesignLibraryVariantGeneration) {
+    DesignLibraryVariantGeneration["Variant"] = "variant";
+})(DesignLibraryVariantGeneration || (DesignLibraryVariantGeneration = {}));

package/dist/esm/editing/utils.js

@@ -1,80 +1,98 @@
-import isServer from '../utils/is-server';
-/**
- * Default value of uid for root placeholder when uid is not present.
- */
-export const DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
-/**
- * Query parameter for editing secret
- */
-export const QUERY_PARAM_EDITING_SECRET = 'secret';
-/**
- * Key to identify whether the app is running in Sitecore Preview mode
- */
-export 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 const PAGES_EDITING_MARKER = 'jss-hrz-editing';
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export const EDITING_ALLOWED_ORIGINS = ['https://pages.sitecorecloud.io'];
-/**
- * Copy of chrome rediscovery contract from Horizon (chrome-rediscovery.contract.ts)
- */
-export const ChromeRediscoveryGlobalFunctionName = {
-    name: 'Sitecore.Horizon.ResetChromes',
-};
-/**
- * Static utility class for Sitecore Pages Editor
- */
-export 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() {
-        if (isServer()) {
-            return false;
-        }
-        // Check for Chromes mode
-        const chromesCheck = window.location.search.indexOf('sc_headless_mode=edit') > -1;
-        // Content SDK will render a content-sdk-exclusive script element in Metadata mode to indicate edit mode in Pages
-        return chromesCheck || !!window.document.getElementById(PAGES_EDITING_MARKER);
-    }
-    static resetChromes() {
-        if (isServer()) {
-            return;
-        }
-        // Reset chromes in Pages
-        window[ChromeRediscoveryGlobalFunctionName.name] &&
-            window[ChromeRediscoveryGlobalFunctionName.name]();
-    }
-}
-/**
- * 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 const isEditorActive = () => {
-    return PagesEditor.isActive();
-};
-/**
- * Resets Sitecore editor "chromes"
- */
-export const resetEditorChromes = () => {
-    if (PagesEditor.isActive()) {
-        PagesEditor.resetChromes();
-    }
-};
-/**
- * Gets extra Content SDK clientData scripts to render in XMC Pages in addition to clientData from Pages itself
- * @returns {Record} collection of clientData
- */
-export const getContentSdkPagesClientData = () => {
-    const clientData = {};
-    clientData[PAGES_EDITING_MARKER] = {};
-    return clientData;
-};
+import isServer from '../utils/is-server';
+/**
+ * Default value of uid for root placeholder when uid is not present.
+ * @internal
+ */
+export const DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
+/**
+ * Query parameter for editing secret
+ * @internal
+ */
+export const QUERY_PARAM_EDITING_SECRET = 'secret';
+/**
+ * HTML returned for invalid or missing secret
+ * @internal
+ */
+export 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 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 const PAGES_EDITING_MARKER = 'jss-hrz-editing';
+/**
+ * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
+ * @internal
+ */
+export const EDITING_ALLOWED_ORIGINS = [
+    'https://pages.sitecorecloud.io',
+    'https://xmapps.sitecorecloud.io',
+    'https://designlibrary.sitecorecloud.io',
+];
+/**
+ * Copy of chrome rediscovery contract from Horizon (chrome-rediscovery.contract.ts)
+ */
+export const ChromeRediscoveryGlobalFunctionName = {
+    name: 'Sitecore.Horizon.ResetChromes',
+};
+/**
+ * Static utility class for Sitecore Pages Editor
+ * @public
+ */
+export 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() {
+        if (isServer()) {
+            return false;
+        }
+        // Check for Chromes mode
+        const chromesCheck = window.location.search.indexOf('sc_headless_mode=edit') > -1;
+        // Content SDK will render a content-sdk-exclusive script element in Metadata mode to indicate edit mode in Pages
+        return chromesCheck || !!window.document.getElementById(PAGES_EDITING_MARKER);
+    }
+    static resetChromes() {
+        if (isServer()) {
+            return;
+        }
+        // Reset chromes in Pages
+        window[ChromeRediscoveryGlobalFunctionName.name] &&
+            window[ChromeRediscoveryGlobalFunctionName.name]();
+    }
+}
+/**
+ * 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 const isEditorActive = () => {
+    return PagesEditor.isActive();
+};
+/**
+ * Resets Sitecore editor "chromes"
+ * @public
+ */
+export const resetEditorChromes = () => {
+    if (PagesEditor.isActive()) {
+        PagesEditor.resetChromes();
+    }
+};
+/**
+ * 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 const getContentSdkPagesClientData = () => {
+    const clientData = {};
+    clientData[PAGES_EDITING_MARKER] = {};
+    return clientData;
+};

package/dist/esm/form/form.js

@@ -1,69 +1,72 @@
-import { form } from '@sitecore-cloudsdk/events/browser';
-import { getEdgeProxyFormsUrl } from '../client';
-import debug from '../debug';
-/**
- * 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 const loadForm = async (contextId, formId, edgeUrl) => {
-    if (!contextId) {
-        debug.form('Form was not able to render since context id was not provided');
-        return '';
-    }
-    const url = getEdgeProxyFormsUrl(contextId, formId, edgeUrl);
-    try {
-        debug.form(`Fetching form data from ${url}`);
-        const rsp = await fetch(url, {
-            method: 'GET',
-            cache: 'no-cache',
-        });
-        if (rsp.status !== 200) {
-            throw new Error('Failed to fetch form data');
-        }
-        const content = await rsp.text();
-        debug.form(`Form data fetch response: ${content}`);
-        return content;
-    }
-    catch (error) {
-        debug.form(`Form '${formId}' was not able to render`, error);
-        throw error;
-    }
-};
-/**
- * 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 const executeScriptElements = (rootElement) => {
-    const scriptElements = rootElement.querySelectorAll('script');
-    if (!scriptElements) {
-        return;
-    }
-    Array.from(scriptElements).forEach((scriptElement) => {
-        var _a;
-        const clonedElement = document.createElement('script');
-        Array.from(scriptElement.attributes).forEach((attribute) => {
-            clonedElement.setAttribute(attribute.name, attribute.value);
-        });
-        clonedElement.text = scriptElement.text;
-        (_a = scriptElement === null || scriptElement === void 0 ? void 0 : scriptElement.parentNode) === null || _a === void 0 ? void 0 : _a.replaceChild(clonedElement, scriptElement);
-    });
-};
-/**
- * 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 const subscribeToFormSubmitEvent = (formElement, componentId) => {
-    formElement.addEventListener('form:engage', ((e) => {
-        const { formId, name } = e.detail;
-        if (formId && name) {
-            debug.form('Sending form event', formId, name);
-            form(formId, name, (componentId === null || componentId === void 0 ? void 0 : componentId.replace(/-/g, '')) || '');
-        }
-    }));
-};
+import { form } from '@sitecore-cloudsdk/events/browser';
+import { getEdgeProxyFormsUrl } from '../client';
+import debug from '../debug';
+/**
+ * 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 const loadForm = async (contextId, formId, edgeUrl) => {
+    if (!contextId) {
+        debug.form('Form was not able to render since context id was not provided');
+        return '';
+    }
+    const url = getEdgeProxyFormsUrl(contextId, formId, edgeUrl);
+    try {
+        debug.form(`Fetching form data from ${url}`);
+        const rsp = await fetch(url, {
+            method: 'GET',
+            cache: 'no-cache',
+        });
+        if (rsp.status !== 200) {
+            throw new Error('Failed to fetch form data');
+        }
+        const content = await rsp.text();
+        debug.form(`Form data fetch response: ${content}`);
+        return content;
+    }
+    catch (error) {
+        debug.form(`Form '${formId}' was not able to render`, error);
+        throw error;
+    }
+};
+/**
+ * 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 const executeScriptElements = (rootElement) => {
+    const scriptElements = rootElement.querySelectorAll('script');
+    if (!scriptElements) {
+        return;
+    }
+    Array.from(scriptElements).forEach((scriptElement) => {
+        var _a;
+        const clonedElement = document.createElement('script');
+        Array.from(scriptElement.attributes).forEach((attribute) => {
+            clonedElement.setAttribute(attribute.name, attribute.value);
+        });
+        clonedElement.text = scriptElement.text;
+        (_a = scriptElement === null || scriptElement === void 0 ? void 0 : scriptElement.parentNode) === null || _a === void 0 ? void 0 : _a.replaceChild(clonedElement, scriptElement);
+    });
+};
+/**
+ * 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 const subscribeToFormSubmitEvent = (formElement, componentId) => {
+    formElement.addEventListener('form:engage', ((e) => {
+        const { formId, name } = e.detail;
+        if (formId && name) {
+            debug.form('Sending form event', formId, name);
+            form(formId, name, (componentId === null || componentId === void 0 ? void 0 : componentId.replace(/-/g, '')) || '');
+        }
+    }));
+};

package/dist/esm/form/index.js

@@ -1 +1 @@
-export { executeScriptElements, loadForm, subscribeToFormSubmitEvent } from './form';
+export { executeScriptElements, loadForm, subscribeToFormSubmitEvent } from './form';