@sitecore-content-sdk/core 0.3.0-canary.2 → 0.3.0-canary.20

package/dist/esm/config/define-config.js

@@ -53,17 +53,45 @@ export const getFallbackConfig = () => ({
     },
 });
 /**
- * Merges two SitecoreConfig objects
+ * Deep merge utility that skips undefined or empty string values in the override.
+ * @param {T} base base value
+ * @param {DeepPartial<T>} [override] override value
+ */
+export function deepMerge(base, override) {
+    if (!override)
+        return base;
+    const result = Object.assign({}, base);
+    for (const key in override) {
+        if (!Object.prototype.hasOwnProperty.call(override, key))
+            continue;
+        const typedKey = key;
+        const baseValue = base[typedKey];
+        const overrideValue = override[typedKey];
+        // Skip undefined and empty string overrides
+        if (overrideValue === undefined || overrideValue === '') {
+            continue;
+        }
+        if (typeof overrideValue === 'object' &&
+            overrideValue !== null &&
+            !Array.isArray(overrideValue) &&
+            Object.getPrototypeOf(overrideValue) === Object.prototype) {
+            result[typedKey] = deepMerge(baseValue, overrideValue);
+        }
+        else {
+            result[typedKey] = overrideValue;
+        }
+    }
+    return result;
+}
+/**
+ * Resolves sitecore config based on base config and overrides
  * @param {SitecoreConfig} base base sitecore config object
  * @param {SitecoreConfig} override override sitecore config object
- * @returns merged SitecoreConfig object
+ * @returns resolved SitecoreConfig object
  */
-const deepMerge = (base, override) => {
-    var _a, _b, _c, _d, _e;
-    const result = Object.assign(Object.assign(Object.assign({}, base), override), { api: {
-            edge: Object.assign(Object.assign({}, (_a = base.api) === null || _a === void 0 ? void 0 : _a.edge), (_b = override.api) === null || _b === void 0 ? void 0 : _b.edge),
-            local: Object.assign(Object.assign({}, (_c = base.api) === null || _c === void 0 ? void 0 : _c.local), (_d = override.api) === null || _d === void 0 ? void 0 : _d.local),
-        }, retries: Object.assign(Object.assign({}, base.retries), override.retries), layout: Object.assign(Object.assign({}, base.layout), override.layout), multisite: Object.assign(Object.assign({}, base.multisite), override.multisite), personalize: Object.assign(Object.assign({}, base.personalize), override.personalize), redirects: Object.assign(Object.assign({}, base.redirects), override.redirects), dictionary: Object.assign(Object.assign({}, base.dictionary), override.dictionary) });
+const resolveConfig = (base, override) => {
+    var _a;
+    const result = deepMerge(base, override);
     if (Number.isNaN(result.personalize.cdpTimeout) || !result.personalize.cdpTimeout) {
         result.personalize.cdpTimeout = base.personalize.cdpTimeout;
     }
@@ -71,19 +99,29 @@ const deepMerge = (base, override) => {
         result.personalize.edgeTimeout = base.personalize.edgeTimeout;
     }
     // fallback in case only one context provided
-    if (((_e = result.api.edge) === null || _e === void 0 ? void 0 : _e.clientContextId) && !result.api.edge.contextId) {
+    if (((_a = result.api.edge) === null || _a === void 0 ? void 0 : _a.clientContextId) && !result.api.edge.contextId) {
         result.api.edge.contextId = result.api.edge.clientContextId;
     }
     return result;
 };
 const validateConfig = (config) => {
     var _a, _b, _c, _d, _e, _f, _g, _h;
-    if (!((_b = (_a = config.api) === null || _a === void 0 ? void 0 : _a.edge) === null || _b === void 0 ? void 0 : _b.contextId) &&
-        (!((_d = (_c = config === null || config === void 0 ? void 0 : config.api) === null || _c === void 0 ? void 0 : _c.local) === null || _d === void 0 ? void 0 : _d.apiHost) || !((_f = (_e = config === null || config === void 0 ? void 0 : config.api) === null || _e === void 0 ? void 0 : _e.local) === null || _f === void 0 ? void 0 : _f.apiKey))) {
-        // consider client-side usecase
-        if (!((_h = (_g = config.api) === null || _g === void 0 ? void 0 : _g.edge) === null || _h === void 0 ? void 0 : _h.clientContextId)) {
-            throw new Error('Configuration error: either context ID or API key and host must be specified in sitecore.config');
-        }
+    // Skip validation in browser - only validate on server side
+    if (typeof window !== 'undefined') {
+        return; // We're in the browser, skip validation
+    }
+    const hasEdgeContextId = !!((_b = (_a = config.api) === null || _a === void 0 ? void 0 : _a.edge) === null || _b === void 0 ? void 0 : _b.contextId);
+    const hasLocalApi = !!(((_d = (_c = config === null || config === void 0 ? void 0 : config.api) === null || _c === void 0 ? void 0 : _c.local) === null || _d === void 0 ? void 0 : _d.apiHost) && ((_f = (_e = config === null || config === void 0 ? void 0 : config.api) === null || _e === void 0 ? void 0 : _e.local) === null || _f === void 0 ? void 0 : _f.apiKey));
+    const hasClientContextId = !!((_h = (_g = config.api) === null || _g === void 0 ? void 0 : _g.edge) === null || _h === void 0 ? void 0 : _h.clientContextId);
+    // Only validate on server-side where we have access to server env vars
+    if (!hasEdgeContextId && !hasLocalApi && !hasClientContextId) {
+        throw new Error('Configuration error: at least one API configuration must be specified: ' +
+            'contextId (server-side), clientContextId (client-side), or local API settings (apiHost + apiKey)');
+    }
+    // Warn if middleware features might not work
+    if (!hasEdgeContextId && !hasClientContextId && hasLocalApi) {
+        console.warn('Warning: Redirects and Personalization middleware require Edge API configuration. ' +
+            'Please ensure that either an Edge context ID (for server-side) or a client context ID (for client-side) is provided in your configuration');
     }
 };
 /**
@@ -92,6 +130,7 @@ const validateConfig = (config) => {
  * @returns {SitecoreConfig} full sitecore configuration to use in application
  */
 export const defineConfig = (config) => {
-    validateConfig(config);
-    return deepMerge(getFallbackConfig(), config);
+    const resolvedConfig = resolveConfig(getFallbackConfig(), config);
+    validateConfig(resolvedConfig);
+    return resolvedConfig;
 };

package/dist/esm/config/index.js

@@ -1,3 +1,2 @@
 export { ComponentTemplateType, } from './models';
 export { defineConfig } from './define-config';
-export { defineCliConfig } from './define-cli-config';

package/dist/esm/config-cli/index.js

@@ -0,0 +1 @@
+export { defineCliConfig } from './define-cli-config';

package/dist/esm/editing/design-library.js

@@ -1,5 +1,6 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
 import { normalizeUrl } from '../utils/normalize-url';
+import { DesignLibraryMode } from './models';
 /**
  * Event to be sent when report status to design library
  */
@@ -106,3 +107,11 @@ export function getDesignLibraryStatusEvent(status, uid) {
 export function getDesignLibraryScriptLink(sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) {
     return `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/designlibrary/lib/rh-lib-script.js`;
 }
+/**
+ * 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.
+ */
+export function isDesignLibraryMode(mode) {
+    return mode === DesignLibraryMode.Normal || mode === DesignLibraryMode.Metadata;
+}

package/dist/esm/editing/index.js

@@ -1,5 +1,5 @@
 export { GraphQLEditingService } from './graphql-editing-service';
 export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, PREVIEW_KEY, } from './utils';
 export { RestComponentLayoutService, } from './rest-component-layout-service';
-export { LayoutKind, MetadataKind, } from './models';
-export { addComponentUpdateHandler, DesignLibraryStatus, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, } from './design-library';
+export { LayoutKind, MetadataKind, DesignLibraryMode, } from './models';
+export { addComponentUpdateHandler, DesignLibraryStatus, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, isDesignLibraryMode, } from './design-library';

package/dist/esm/editing/models.js

@@ -18,3 +18,11 @@ export var 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 = {}));

package/dist/esm/editing/rest-component-layout-service.js

@@ -1,44 +1,29 @@
-import { debug, NativeDataFetcher } from '..';
-import { fetchData } from '../data-fetcher';
+import { NativeDataFetcher } from '../native-fetcher';
+import debug from '../debug';
+import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { resolveUrl } from '../utils';
+import { DesignLibraryMode } from './models';
 /**
- * REST service that enables Design Library functioality
- * Makes a request to /sitecore/api/layout/component in 'library' mode in Pages.
+ * REST service that enables design Library functionality
  * Returns layoutData for one single rendered component
  */
 export class RestComponentLayoutService {
     constructor(config) {
         this.config = config;
-        this.getFetcher = (req, res) => {
-            return this.config.dataFetcherResolver
-                ? this.config.dataFetcherResolver(req, res)
-                : this.getDefaultFetcher(req);
-        };
-        /**
-         * Provides default @see NativeDataFetcher data fetcher
-         * @param {IncomingMessage} [req] Request instance
-         * @returns default fetcher
-         */
-        this.getDefaultFetcher = (req) => {
-            var _a;
-            const config = {
-                debugger: debug.editing,
-            };
-            const nativeFetcher = new NativeDataFetcher(config);
-            const headers = req && Object.assign(Object.assign({}, req.headers), (((_a = req.socket) === null || _a === void 0 ? void 0 : _a.remoteAddress) ? { 'X-Forwarded-For': req.socket.remoteAddress } : {}));
-            const fetcher = (url, data) => {
-                data = Object.assign(Object.assign({}, data), { headers: headers });
-                return nativeFetcher.fetch(url, data);
-            };
-            return fetcher;
-        };
     }
-    fetchComponentData(params, req, res) {
-        params.siteName = params.siteName || this.config.siteName;
-        const querystringParams = this.getComponentFetchParams(params);
-        debug.layout('fetching component with uid %s for %s %s %s', params.componentUid, params.itemId, params.language, params.siteName);
-        const fetcher = this.getFetcher(req, res);
-        const fetchUrl = this.resolveLayoutServiceUrl('component');
-        return fetchData(fetchUrl, fetcher, querystringParams).catch((error) => {
+    fetchComponentData(params) {
+        const config = { debugger: debug.layout };
+        const fetcher = new NativeDataFetcher(config);
+        debug.layout('fetching component with uid %s for %s %s %s %s', params.componentUid, params.itemId, params.language, params.siteName, params.dataSourceId);
+        const fetchUrl = this.getFetchUrl(params);
+        return fetcher
+            .get(fetchUrl, {
+            headers: {
+                sc_editMode: `${params.mode === DesignLibraryMode.Metadata}`,
+            },
+        })
+            .then((response) => response.data)
+            .catch((error) => {
             var _a;
             if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
                 return error.response.data;
@@ -46,19 +31,10 @@ export class RestComponentLayoutService {
             throw error;
         });
     }
-    /**
-     * Resolves layout service url
-     * @param {string} apiType which layout service API to call ('render' or 'placeholder')
-     * @returns the layout service url
-     */
-    resolveLayoutServiceUrl(apiType) {
-        const { apiHost = '', configurationName = 'jss' } = this.config;
-        return `${apiHost}/sitecore/api/layout/${apiType}/${configurationName}`;
-    }
     getComponentFetchParams(params) {
         // exclude undefined params with this one simple trick
         return JSON.parse(JSON.stringify({
-            sc_apikey: this.config.apiKey,
+            sitecoreContextId: this.config.contextId,
             item: params.itemId,
             uid: params.componentUid,
             dataSourceId: params.dataSourceId,
@@ -66,7 +42,14 @@ export class RestComponentLayoutService {
             version: params.version,
             sc_site: params.siteName,
             sc_lang: params.language || 'en',
-            sc_mode: params.editMode,
         }));
     }
+    /**
+     * 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
+     */
+    getFetchUrl(params) {
+        return resolveUrl(`${this.config.edgeUrl || SITECORE_EDGE_URL_DEFAULT}/layout/component`, this.getComponentFetchParams(params));
+    }
 }

package/dist/esm/site/graphql-robots-service.js

@@ -27,6 +27,7 @@ export class GraphQLRobotsService {
     }
     /**
      * Fetch a data of robots.txt from API
+     * @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
      * @returns text of robots.txt
      * @throws {Error} if the siteName is empty.
      */

package/dist/esm/tools/generate-map.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/tools/templating/components.js

@@ -1,4 +1,6 @@
-import { getItems } from './utils';
+import * as glob from 'glob';
+const componentNamePattern = /^[\/]*(.+[\/\\])*(.+)\.[jt]sx?$/;
+const componentPathPattern = /^([\/]*.+[\/\\].+)\..+$/;
 /**
  * Get list of components from @var path
  * Returns a list of components in the following format:
@@ -7,17 +9,23 @@ import { getItems } from './utils';
  *  componentName: 'ComponentName',
  *  moduleName: 'ComponentName'
  * }
- * @param {string} path path to search
+ * @param {string[]} paths paths to search
+ * @param {string[]} [exclude] paths and glob patterns to exclude from final result
  */
-export function getComponentList(path) {
-    const components = getItems({
-        path,
-        resolveItem: (path, name) => ({
-            path: `${path}/${name}`,
-            componentName: name,
-            moduleName: name.replace(/[^\w]+/g, ''),
-        }),
-        cb: (name) => console.debug(`Registering Content SDK component ${name}`),
-    });
+export function getComponentList(paths, exclude) {
+    const components = paths.reduce((result, path) => {
+        const globPath = glob.hasMagic(path, { magicalBraces: true }) || path.match(componentNamePattern)
+            ? path
+            : path.replace(/\/$/, '').concat('/*.{js,jsx,ts,tsx}');
+        return result.concat(...glob.sync(globPath, { ignore: exclude }).map((filePath) => {
+            const name = filePath.match(componentNamePattern)[2];
+            console.debug(`Registering Content SDK component ${name}`);
+            return {
+                path: filePath.match(componentPathPattern)[1].replace(/\\/g, '/'), // use forward slashes for consistency
+                componentName: name,
+                moduleName: name.replace(/[^\w]+/g, ''),
+            };
+        }));
+    }, []);
     return components;
 }

package/dist/esm/tools/templating/index.js

@@ -1,2 +1,3 @@
 export { getComponentList } from './components';
 export { generatePlugins, ModuleType } from './plugins';
+export { matchPath } from './utils';

package/dist/esm/tools/templating/utils.js

@@ -1,4 +1,20 @@
 import fs from 'fs';
+import path from 'path';
+/**
+ * Compares two paths to determine if they match.
+ * @param {string} itemPath base path to compare against, can be absolute or relative
+ * @param {string} compare comparer, can be relate, absolute or regex string
+ * @returns true if paths match, false otherwise
+ */
+export const matchPath = (itemPath, compare) => {
+    if (compare === itemPath ||
+        path.join(process.cwd(), itemPath) === compare ||
+        itemPath === path.join(process.cwd(), compare) ||
+        new RegExp(compare).test(itemPath)) {
+        return true;
+    }
+    return false;
+};
 /**
  * Using @var path find all files and generate output using @var resolveItem function for each file
  * Can be used to generate list of components, templates, etc.
@@ -6,11 +22,17 @@ import fs from 'fs';
  * @returns {Item[]} list of items
  */
 export function getItems(settings) {
-    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), exclude, } = settings;
     const items = [];
     const folders = [];
     if (!fs.existsSync(path))
         return [];
+    if (exclude) {
+        for (const exclusion of exclude) {
+            if (matchPath(path, exclusion))
+                return [];
+        }
+    }
     fs.readdirSync(path, { withFileTypes: true }).forEach((item) => {
         if (item.isDirectory()) {
             folders.push(item);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.3.0-canary.2",
+  "version": "0.3.0-canary.20",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -69,6 +69,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "debug": "^4.4.0",
+    "glob": "^11.0.2",
     "graphql": "^16.11.0",
     "graphql-request": "^6.1.0",
     "memory-cache": "^0.2.0",
@@ -77,7 +78,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "8243c78fad6aa9456ac8cb726ac0a90c72589506",
+  "gitHead": "9e6d00a485580af695ac93b4403d84b9eda6c0fe",
   "files": [
     "dist",
     "types",

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

@@ -1,9 +1,15 @@
-import { SitecoreConfig, SitecoreConfigInput } from './models';
+import { DeepPartial, SitecoreConfig, SitecoreConfigInput } from './models';
 /**
  * Provides default initial values for SitecoreConfig
  * @returns default config
  */
 export declare const getFallbackConfig: () => SitecoreConfig;
+/**
+ * Deep merge utility that skips undefined or empty string values in the override.
+ * @param {T} base base value
+ * @param {DeepPartial<T>} [override] override value
+ */
+export declare function deepMerge<T>(base: T, override?: DeepPartial<T>): T;
 /**
  * Accepts a SitecoreConfigInput object and returns full sitecore configuration
  * @param {SitecoreConfigInput} config override values to be written over default config settings

package/types/config/index.d.ts

@@ -1,3 +1,2 @@
 export { SitecoreConfig, SitecoreConfigInput, SitecoreCliConfig, SitecoreCliConfigInput, ScaffoldTemplate, ComponentTemplateType, DeepRequired, } from './models';
 export { defineConfig } from './define-config';
-export { defineCliConfig } from './define-cli-config';

package/types/config/models.d.ts

@@ -1,10 +1,17 @@
 import { RetryStrategy } from '../models';
+import { GenerateMapFunction, GenerateMapArgs } from '../tools';
 /**
  * Utility type to make every property in a type required
  */
 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.
+ */
+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
  */
@@ -199,6 +206,15 @@ export type SitecoreCliConfigInput = {
          */
         templates?: ScaffoldTemplate[];
     };
+    /**
+     * Configuration for the `sitecore-tools component generate-map` cli command
+     */
+    componentMap?: GenerateMapArgs & {
+        /**
+         * Function implementationt for generating a component map.
+         */
+        generator?: GenerateMapFunction;
+    };
 };
 /**
  * Final sitecore cli config type used required by the cli

package/types/{config → config-cli}/define-cli-config.d.ts

@@ -1,4 +1,4 @@
-import { SitecoreCliConfig, SitecoreCliConfigInput } from './models';
+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

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

@@ -0,0 +1 @@
+export { defineCliConfig } from './define-cli-config';

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

@@ -1,4 +1,5 @@
 import { ComponentRendering, Field, GenericFieldValue } from '../layout/models';
+import { DesignLibraryMode } from './models';
 /**
  * Event to be sent when report status to design library
  */
@@ -52,3 +53,9 @@ export declare function getDesignLibraryStatusEvent(status: DesignLibraryStatus,
  * @returns The full URL to the design library script.
  */
 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.
+ */
+export declare function isDesignLibraryMode(mode: unknown): mode is DesignLibraryMode;

package/types/editing/index.d.ts

@@ -2,5 +2,5 @@ export { GraphQLEditingService } from './graphql-editing-service';
 export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, Metadata, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, PREVIEW_KEY, } from './utils';
 export { RestComponentLayoutService, ComponentLayoutRequestParams, } from './rest-component-layout-service';
 export { EditingRenderQueryParams, RenderComponentQueryParams } from './models';
-export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, } from './models';
-export { addComponentUpdateHandler, DesignLibraryStatus, DesignLibraryStatusEvent, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, } from './design-library';
+export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, DesignLibraryMode, } from './models';
+export { addComponentUpdateHandler, DesignLibraryStatus, DesignLibraryStatusEvent, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, isDesignLibraryMode, } from './design-library';

package/types/editing/models.d.ts

@@ -11,7 +11,7 @@ export interface EditingRenderQueryParams {
     sc_itemid: string;
     sc_site: string;
     route: string;
-    mode: Exclude<LayoutServicePageState, 'normal'> | 'library';
+    mode: Exclude<LayoutServicePageState, 'normal'> | DesignLibraryMode;
     sc_layoutKind?: LayoutKind;
     sc_variant?: string;
     sc_version?: string;
@@ -28,7 +28,7 @@ export interface RenderComponentQueryParams {
     sc_renderingId: string;
     sc_uid: string;
     sc_site: string;
-    mode: 'library';
+    mode: DesignLibraryMode;
     sc_variant?: string;
     sc_version?: string;
 }
@@ -62,6 +62,13 @@ export type EditingPreviewData = {
     version?: string;
     layoutKind?: LayoutKind;
 };
+/** Represents the mode of the Design Library */
+export declare enum DesignLibraryMode {
+    /** Normal mode */
+    Normal = "library",
+    /** Metadata mode */
+    Metadata = "library-metadata"
+}
 /**
  * Data for Design Library rendering mode
  */
@@ -71,7 +78,7 @@ export interface DesignLibraryRenderPreviewData {
     renderingId: string;
     componentUid: string;
     language: string;
-    mode?: 'library';
+    mode?: DesignLibraryMode;
     variant?: string;
     version?: string;
     dataSourceId?: string;

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

@@ -1,41 +1,5 @@
-import { LayoutServiceData, EditMode } from '../layout/models';
-import { IncomingMessage, ServerResponse } from 'http';
-import { HttpDataFetcher } from '../data-fetcher';
-/**
- * Data fetcher resolver in order to provide custom data fetcher
- * @param {IncomingMessage} [req] Request instance
- * @param {ServerResponse} [res] Response instance
- */
-export type DataFetcherResolver = <T>(req?: IncomingMessage, res?: ServerResponse) => HttpDataFetcher<T>;
-export type RestLayoutServiceConfig = {
-    /**
-     * Your Sitecore instance hostname that is the backend for JSS
-     */
-    apiHost: string;
-    /**
-     * The Sitecore SSC API key your app uses
-     */
-    apiKey: string;
-    /**
-     * The JSS application name
-     */
-    siteName: string;
-    /**
-     * Enables/disables analytics tracking for the Layout Service invocation (default is true).
-     * More than likely, this would be set to false for SSG/hybrid implementations, and the
-     * JSS tracker would instead be used on the client-side
-     * @default true
-     */
-    tracking?: boolean;
-    /**
-     * Function that handles fetching API data
-     */
-    dataFetcherResolver?: DataFetcherResolver;
-    /**
-     * Layout Service "named" configuration
-     */
-    configurationName?: string;
-};
+import { LayoutServiceData } from '../layout/models';
+import { DesignLibraryMode } from './models';
 /**
  * Params for requesting component data from service in Design Library mode
  */
@@ -66,35 +30,41 @@ export interface ComponentLayoutRequestParams {
      */
     version?: string;
     /**
-     * edit mode to be rendered component in. Component is rendered in normal mode by default
+     * site name to be used as context for rendering the component
      */
-    editMode?: EditMode;
+    siteName: string;
     /**
-     * site name to be used as context for rendering the component
+     * mode to be used for rendering the component
      */
-    siteName?: string;
+    mode?: DesignLibraryMode;
 }
 /**
- * REST service that enables Design Library functioality
- * Makes a request to /sitecore/api/layout/component in 'library' mode in Pages.
- * Returns layoutData for one single rendered component
+ * Config for the RestComponentLayoutService
  */
-export declare class RestComponentLayoutService {
-    private config;
-    constructor(config: RestLayoutServiceConfig);
-    fetchComponentData(params: ComponentLayoutRequestParams, req?: IncomingMessage, res?: ServerResponse): Promise<LayoutServiceData>;
-    protected getFetcher: (req?: IncomingMessage, res?: ServerResponse) => HttpDataFetcher<LayoutServiceData> | ((url: string, data?: RequestInit) => Promise<import("..").NativeDataFetcherResponse<LayoutServiceData>>);
+export interface RestComponentLayoutServiceConfig {
     /**
-     * Resolves layout service url
-     * @param {string} apiType which layout service API to call ('render' or 'placeholder')
-     * @returns the layout service url
+     * A unified identifier used to connect and retrieve data from XM Cloud instance
      */
-    protected resolveLayoutServiceUrl(apiType: string): string;
+    contextId: string;
     /**
-     * Provides default @see NativeDataFetcher data fetcher
-     * @param {IncomingMessage} [req] Request instance
-     * @returns default fetcher
+     * XM Cloud endpoint that the app will communicate and retrieve data from
+     * @default https://edge-platform.sitecorecloud.io
      */
-    protected getDefaultFetcher: <T>(req?: IncomingMessage) => (url: string, data?: RequestInit) => Promise<import("..").NativeDataFetcherResponse<T>>;
+    edgeUrl?: string;
+}
+/**
+ * REST service that enables design Library functionality
+ * Returns layoutData for one single rendered component
+ */
+export declare class RestComponentLayoutService {
+    private config;
+    constructor(config: RestComponentLayoutServiceConfig);
+    fetchComponentData(params: ComponentLayoutRequestParams): 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;
 }

package/types/native-fetcher.d.ts

@@ -33,13 +33,6 @@ export interface NativeDataFetcherResponse<T> {
 export type NativeDataFetcherError = Error & {
     response: NativeDataFetcherResponse<unknown>;
 };
-/**
- * A function that fetches data from a given URL and returns a `NativeDataFetcherResponse`.
- * @param {string} url The URL to request (can include query string parameters).
- * @param {unknown} [data] Optional data to send with the request (e.g., for POST or PUT requests).
- * @returns {Promise<NativeDataFetcherResponse<T>>} A promise that resolves to a `NativeDataFetcherResponse<T>`,
- */
-export type NativeDataFetcherFunction<T> = (url: string, data?: RequestInit) => Promise<NativeDataFetcherResponse<T>>;
 export type NativeDataFetcherConfig = NativeDataFetcherOptions & RequestInit;
 export declare class NativeDataFetcher {
     protected config: NativeDataFetcherConfig;

package/types/site/graphql-robots-service.d.ts

@@ -35,6 +35,7 @@ export declare class GraphQLRobotsService {
     protected get query(): string;
     /**
      * Fetch a data of robots.txt from API
+     * @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
      * @returns text of robots.txt
      * @throws {Error} if the siteName is empty.
      */