@sitecore-content-sdk/core 0.2.0 → 0.2.1-canary.2

package/dist/cjs/client/sitecore-client.js

@@ -319,12 +319,7 @@ class SitecoreClient {
         return new site_1.GraphQLErrorPagesService(Object.assign(Object.assign({}, this.initOptions), { language: this.initOptions.defaultLanguage, clientFactory: this.clientFactory }));
     }
     getComponentService() {
-        var _a, _b;
-        return new editing_1.RestComponentLayoutService({
-            apiHost: (_a = this.initOptions.api.local) === null || _a === void 0 ? void 0 : _a.apiHost,
-            apiKey: (_b = this.initOptions.api.local) === null || _b === void 0 ? void 0 : _b.apiKey,
-            siteName: this.initOptions.defaultSite,
-        });
+        return new editing_1.RestComponentLayoutService(this.initOptions.api.edge);
     }
     getSitePathService() {
         return new site_1.GraphQLSitePathService({

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

@@ -1,47 +1,30 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RestComponentLayoutService = void 0;
-const __1 = require("..");
-const data_fetcher_1 = require("../data-fetcher");
+const native_fetcher_1 = require("../native-fetcher");
+const debug_1 = __importDefault(require("../debug"));
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
 /**
- * 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
  */
 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: __1.debug.editing,
-            };
-            const nativeFetcher = new __1.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);
-        __1.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 (0, data_fetcher_1.fetchData)(fetchUrl, fetcher, querystringParams).catch((error) => {
+    fetchComponentData(params) {
+        const config = { debugger: debug_1.default.layout };
+        const fetcher = new native_fetcher_1.NativeDataFetcher(config);
+        debug_1.default.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)
+            .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;
@@ -49,19 +32,10 @@ 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,
@@ -69,8 +43,15 @@ 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 (0, utils_1.resolveUrl)(`${this.config.edgeUrl || constants_1.SITECORE_EDGE_URL_DEFAULT}/layout/component`, this.getComponentFetchParams(params));
+    }
 }
 exports.RestComponentLayoutService = RestComponentLayoutService;

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

@@ -33,6 +33,7 @@ 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/client/sitecore-client.js

@@ -316,12 +316,7 @@ export class SitecoreClient {
         return new GraphQLErrorPagesService(Object.assign(Object.assign({}, this.initOptions), { language: this.initOptions.defaultLanguage, clientFactory: this.clientFactory }));
     }
     getComponentService() {
-        var _a, _b;
-        return new RestComponentLayoutService({
-            apiHost: (_a = this.initOptions.api.local) === null || _a === void 0 ? void 0 : _a.apiHost,
-            apiKey: (_b = this.initOptions.api.local) === null || _b === void 0 ? void 0 : _b.apiKey,
-            siteName: this.initOptions.defaultSite,
-        });
+        return new RestComponentLayoutService(this.initOptions.api.edge);
     }
     getSitePathService() {
         return new GraphQLSitePathService({

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

@@ -1,44 +1,24 @@
-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';
 /**
- * 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)
+            .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 +26,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 +37,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.2.0",
+  "version": "0.2.1-canary.2",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -77,7 +77,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "0ea2d0d026c3be308ae018629020aa00442d6b42",
+  "gitHead": "d99cf177d6e14d8adfb0f2ae5f50a2563cebe679",
   "files": [
     "dist",
     "types",

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

@@ -1,41 +1,4 @@
-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';
 /**
  * Params for requesting component data from service in Design Library mode
  */
@@ -66,35 +29,37 @@ 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;
+}
+/**
+ * Config for the RestComponentLayoutService
+ */
+export interface RestComponentLayoutServiceConfig {
     /**
-     * site name to be used as context for rendering the component
+     * A unified identifier used to connect and retrieve data from XM Cloud instance
      */
-    siteName?: string;
+    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 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 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>>);
-    /**
-     * Resolves layout service url
-     * @param {string} apiType which layout service API to call ('render' or 'placeholder')
-     * @returns the layout service url
-     */
-    protected resolveLayoutServiceUrl(apiType: string): string;
+    constructor(config: RestComponentLayoutServiceConfig);
+    fetchComponentData(params: ComponentLayoutRequestParams): Promise<LayoutServiceData>;
+    protected getComponentFetchParams(params: ComponentLayoutRequestParams): any;
     /**
-     * Provides default @see NativeDataFetcher data fetcher
-     * @param {IncomingMessage} [req] Request instance
-     * @returns default fetcher
+     * 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
      */
-    protected getDefaultFetcher: <T>(req?: IncomingMessage) => (url: string, data?: RequestInit) => Promise<import("..").NativeDataFetcherResponse<T>>;
-    protected getComponentFetchParams(params: ComponentLayoutRequestParams): any;
+    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.
      */

package/dist/cjs/data-fetcher.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseError = void 0;
-exports.fetchData = fetchData;
-const utils_1 = require("./utils/utils");
-class ResponseError extends Error {
-    constructor(message, response) {
-        super(message);
-        Object.setPrototypeOf(this, ResponseError.prototype);
-        this.response = response;
-    }
-}
-exports.ResponseError = ResponseError;
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-async function fetchData(url, fetcher, params = {}) {
-    const response = await fetcher((0, utils_1.resolveUrl)(url, params));
-    return response.data;
-}

package/dist/esm/data-fetcher.js

@@ -1,17 +0,0 @@
-import { resolveUrl } from './utils/utils';
-export class ResponseError extends Error {
-    constructor(message, response) {
-        super(message);
-        Object.setPrototypeOf(this, ResponseError.prototype);
-        this.response = response;
-    }
-}
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-export async function fetchData(url, fetcher, params = {}) {
-    const response = await fetcher(resolveUrl(url, params));
-    return response.data;
-}

package/types/data-fetcher.d.ts

@@ -1,34 +0,0 @@
-import { NativeDataFetcherFunction } from './native-fetcher';
-import { ParsedUrlQueryInput } from 'querystring';
-/**
- * Response data for an HTTP request sent to an API
- * @template T the type of data model requested
- */
-export interface HttpResponse<T> {
-    /** HTTP status code of the response (i.e. 200, 404) */
-    status: number;
-    /** HTTP status text of the response (i.e. 'OK', 'Bad Request') */
-    statusText: string;
-    /** Response content */
-    data: T;
-}
-/**
- * Describes functions that fetch data asynchronously (i.e. from an API endpoint).
- * This interface conforms to 'fetch' public API, but is adaptable to other HTTP libraries and
- * fetch polyfills.
- * The interface implementation must:
- * - Support SSR
- * - Comply with the rules of REST by returning appropriate response status codes when there is an error instead of throwing exceptions.
- * - Send HTTP POST requests if `data` param is specified; GET is suggested but not required for data-less requests
- */
-export type HttpDataFetcher<T> = (url: string, data?: unknown) => Promise<HttpResponse<T>>;
-export declare class ResponseError extends Error {
-    response: HttpResponse<unknown>;
-    constructor(message: string, response: HttpResponse<unknown>);
-}
-/**
- * @param {string} url the URL to request; may include query string
- * @param {HttpDataFetcher<T> | NativeDataFetcherFunction<T>} fetcher the fetcher to use to perform the request
- * @param {ParsedUrlQueryInput} params the query string parameters to send with the request
- */
-export declare function fetchData<T>(url: string, fetcher: HttpDataFetcher<T> | NativeDataFetcherFunction<T>, params?: ParsedUrlQueryInput): Promise<T>;