@sitecore-content-sdk/core 0.2.0-beta.6 → 0.2.0-beta.7

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

@@ -9,6 +9,7 @@ const layout_personalizer_1 = require("../personalize/layout-personalizer");
 const site_1 = require("../site");
 const utils_2 = require("./utils");
 const native_fetcher_1 = require("../native-fetcher");
+const graphql_robots_service_1 = require("../site/graphql-robots-service");
 /**
  * This is a generic content client that can be used by any framework.
  * Use it to retrieve pages, preview data, dictionary and other data
@@ -19,16 +20,19 @@ class SitecoreClient {
      * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
      */
     constructor(initOptions) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         this.initOptions = initOptions;
         this.clientFactory = this.getClientFactory();
-        this.siteResolver = this.getSiteResolver();
+        this.siteResolver = (_b = (_a = initOptions.custom) === null || _a === void 0 ? void 0 : _a.siteResolver) !== null && _b !== void 0 ? _b : this.getSiteResolver();
         const baseServiceOptions = this.getBaseServiceOptions();
-        this.layoutService = this.getLayoutService(baseServiceOptions);
-        this.dictionaryService = this.getDictionaryService(baseServiceOptions);
-        this.editingService = this.getEditingService();
-        this.errorPagesService = this.getErrorPagesService();
+        this.layoutService =
+            (_d = (_c = initOptions.custom) === null || _c === void 0 ? void 0 : _c.layoutService) !== null && _d !== void 0 ? _d : this.getLayoutService(baseServiceOptions);
+        this.dictionaryService =
+            (_f = (_e = initOptions.custom) === null || _e === void 0 ? void 0 : _e.dictionaryService) !== null && _f !== void 0 ? _f : this.getDictionaryService(baseServiceOptions);
+        this.editingService = (_h = (_g = initOptions.custom) === null || _g === void 0 ? void 0 : _g.editingService) !== null && _h !== void 0 ? _h : this.getEditingService();
+        this.errorPagesService = (_k = (_j = initOptions.custom) === null || _j === void 0 ? void 0 : _j.errorPagesService) !== null && _k !== void 0 ? _k : this.getErrorPagesService();
+        this.sitePathService = (_m = (_l = initOptions.custom) === null || _l === void 0 ? void 0 : _l.sitePathService) !== null && _m !== void 0 ? _m : this.getSitePathService();
         this.componentService = this.getComponentService();
-        this.sitePathService = this.getSitePathService();
     }
     /**
      * Resolve site by hostname
@@ -59,7 +63,7 @@ class SitecoreClient {
      * Get page details for a route, with layout and other details
      * @param {string} path route path
      * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page | null} page details
      */
     async getPage(path, pageOptions, fetchOptions) {
@@ -115,7 +119,7 @@ class SitecoreClient {
     /**
      * Retrieves dictionary phrases for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
     async getDictionary(routeOptions, fetchOptions) {
@@ -126,7 +130,7 @@ class SitecoreClient {
     /**
      * Retrieves error pages for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
      */
     async getErrorPages(routeOptions, fetchOptions) {
@@ -137,7 +141,7 @@ class SitecoreClient {
     /**
      * Retrieves preview page and layout details
      * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page details
      */
     async getPreview(previewData, fetchOptions) {
@@ -171,7 +175,7 @@ class SitecoreClient {
     /**
      * Get design library page details for Design Library mode of your app
      * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page for Design Library
      */
     async getDesignLibraryData(designLibData, fetchOptions) {
@@ -256,6 +260,18 @@ class SitecoreClient {
             .join('')}
       </sitemapindex>`;
     }
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
+     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
+     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
+     * or null if no content is found.
+     */
+    async getRobots(siteName, fetchOptions) {
+        const robotsService = this.getRobotsService(siteName || this.initOptions.defaultSite);
+        const content = await robotsService.fetchRobots(fetchOptions);
+        return content || null;
+    }
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
@@ -266,6 +282,12 @@ class SitecoreClient {
             siteName,
         });
     }
+    getRobotsService(siteName) {
+        return new graphql_robots_service_1.GraphQLRobotsService({
+            clientFactory: this.clientFactory,
+            siteName,
+        });
+    }
     getBaseServiceOptions() {
         return {
             defaultSite: this.initOptions.defaultSite,

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

@@ -10,9 +10,9 @@ const retries_1 = require("../retries");
 const getFallbackConfig = () => ({
     api: {
         edge: {
-            contextId: '',
+            contextId: process.env.SITECORE_EDGE_CONTEXT_ID || '',
             clientContextId: '',
-            edgeUrl: constants_1.SITECORE_EDGE_URL_DEFAULT,
+            edgeUrl: process.env.SITECORE_EDGE_URL || constants_1.SITECORE_EDGE_URL_DEFAULT,
         },
         local: {
             apiKey: '',
@@ -20,7 +20,7 @@ const getFallbackConfig = () => ({
             path: '/sitecore/api/graph/edge',
         },
     },
-    editingSecret: 'editing-secret-missing',
+    editingSecret: process.env.JSS_EDITING_SECRET || 'editing-secret-missing',
     retries: {
         count: 3,
         retryStrategy: new retries_1.DefaultRetryStrategy({
@@ -37,8 +37,8 @@ const getFallbackConfig = () => ({
     },
     personalize: {
         enabled: process.env.NODE_ENV !== 'development',
-        edgeTimeout: 400,
-        cdpTimeout: 400,
+        edgeTimeout: parseInt(process.env.PERSONALIZE_MIDDLEWARE_EDGE_TIMEOUT, 10) || 400,
+        cdpTimeout: parseInt(process.env.PERSONALIZE_MIDDLEWARE_CDP_TIMEOUT, 10) || 400,
         scope: '',
         channel: 'WEB',
         currency: 'USD',

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

@@ -66,8 +66,7 @@ class ContentClient {
     }
     /**
      * Retrieves the locale information for a given locale ID.
-     *
-     * @param id - The unique identifier of the locale item.
+     * @param {string} id - The unique identifier of the locale item.
      * @returns A promise that resolves to the locale information associated with the specified locale ID.
      */
     async getLocale(id) {
@@ -77,7 +76,6 @@ class ContentClient {
     }
     /**
      * Retrieves all available locales from the content service.
-     *
      * @returns A promise that resolves to an array of locales.
      */
     async getLocales() {

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

@@ -36,14 +36,14 @@ class GraphQLRobotsService {
      * @returns text of robots.txt
      * @throws {Error} if the siteName is empty.
      */
-    async fetchRobots() {
+    async fetchRobots(fetchOptions) {
         const siteName = this.options.siteName;
         if (!siteName) {
             throw new Error(constants_1.siteNameError);
         }
         const robotsResult = this.graphQLClient.request(this.query, {
             siteName,
-        });
+        }, fetchOptions);
         try {
             return robotsResult.then((result) => {
                 var _a, _b;

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

@@ -6,6 +6,7 @@ import { personalizeLayout } from '../personalize/layout-personalizer';
 import { SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService, GraphQLSitemapXmlService, } from '../site';
 import { createGraphQLClientFactory } from './utils';
 import { NativeDataFetcher } from '../native-fetcher';
+import { GraphQLRobotsService } from '../site/graphql-robots-service';
 /**
  * This is a generic content client that can be used by any framework.
  * Use it to retrieve pages, preview data, dictionary and other data
@@ -16,16 +17,19 @@ export class SitecoreClient {
      * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
      */
     constructor(initOptions) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         this.initOptions = initOptions;
         this.clientFactory = this.getClientFactory();
-        this.siteResolver = this.getSiteResolver();
+        this.siteResolver = (_b = (_a = initOptions.custom) === null || _a === void 0 ? void 0 : _a.siteResolver) !== null && _b !== void 0 ? _b : this.getSiteResolver();
         const baseServiceOptions = this.getBaseServiceOptions();
-        this.layoutService = this.getLayoutService(baseServiceOptions);
-        this.dictionaryService = this.getDictionaryService(baseServiceOptions);
-        this.editingService = this.getEditingService();
-        this.errorPagesService = this.getErrorPagesService();
+        this.layoutService =
+            (_d = (_c = initOptions.custom) === null || _c === void 0 ? void 0 : _c.layoutService) !== null && _d !== void 0 ? _d : this.getLayoutService(baseServiceOptions);
+        this.dictionaryService =
+            (_f = (_e = initOptions.custom) === null || _e === void 0 ? void 0 : _e.dictionaryService) !== null && _f !== void 0 ? _f : this.getDictionaryService(baseServiceOptions);
+        this.editingService = (_h = (_g = initOptions.custom) === null || _g === void 0 ? void 0 : _g.editingService) !== null && _h !== void 0 ? _h : this.getEditingService();
+        this.errorPagesService = (_k = (_j = initOptions.custom) === null || _j === void 0 ? void 0 : _j.errorPagesService) !== null && _k !== void 0 ? _k : this.getErrorPagesService();
+        this.sitePathService = (_m = (_l = initOptions.custom) === null || _l === void 0 ? void 0 : _l.sitePathService) !== null && _m !== void 0 ? _m : this.getSitePathService();
         this.componentService = this.getComponentService();
-        this.sitePathService = this.getSitePathService();
     }
     /**
      * Resolve site by hostname
@@ -56,7 +60,7 @@ export class SitecoreClient {
      * Get page details for a route, with layout and other details
      * @param {string} path route path
      * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page | null} page details
      */
     async getPage(path, pageOptions, fetchOptions) {
@@ -112,7 +116,7 @@ export class SitecoreClient {
     /**
      * Retrieves dictionary phrases for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
     async getDictionary(routeOptions, fetchOptions) {
@@ -123,7 +127,7 @@ export class SitecoreClient {
     /**
      * Retrieves error pages for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
      */
     async getErrorPages(routeOptions, fetchOptions) {
@@ -134,7 +138,7 @@ export class SitecoreClient {
     /**
      * Retrieves preview page and layout details
      * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page details
      */
     async getPreview(previewData, fetchOptions) {
@@ -168,7 +172,7 @@ export class SitecoreClient {
     /**
      * Get design library page details for Design Library mode of your app
      * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page for Design Library
      */
     async getDesignLibraryData(designLibData, fetchOptions) {
@@ -253,6 +257,18 @@ export class SitecoreClient {
             .join('')}
       </sitemapindex>`;
     }
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
+     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
+     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
+     * or null if no content is found.
+     */
+    async getRobots(siteName, fetchOptions) {
+        const robotsService = this.getRobotsService(siteName || this.initOptions.defaultSite);
+        const content = await robotsService.fetchRobots(fetchOptions);
+        return content || null;
+    }
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
@@ -263,6 +279,12 @@ export class SitecoreClient {
             siteName,
         });
     }
+    getRobotsService(siteName) {
+        return new GraphQLRobotsService({
+            clientFactory: this.clientFactory,
+            siteName,
+        });
+    }
     getBaseServiceOptions() {
         return {
             defaultSite: this.initOptions.defaultSite,

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

@@ -7,9 +7,9 @@ import { DefaultRetryStrategy } from '../retries';
 export const getFallbackConfig = () => ({
     api: {
         edge: {
-            contextId: '',
+            contextId: process.env.SITECORE_EDGE_CONTEXT_ID || '',
             clientContextId: '',
-            edgeUrl: SITECORE_EDGE_URL_DEFAULT,
+            edgeUrl: process.env.SITECORE_EDGE_URL || SITECORE_EDGE_URL_DEFAULT,
         },
         local: {
             apiKey: '',
@@ -17,7 +17,7 @@ export const getFallbackConfig = () => ({
             path: '/sitecore/api/graph/edge',
         },
     },
-    editingSecret: 'editing-secret-missing',
+    editingSecret: process.env.JSS_EDITING_SECRET || 'editing-secret-missing',
     retries: {
         count: 3,
         retryStrategy: new DefaultRetryStrategy({
@@ -34,8 +34,8 @@ export const getFallbackConfig = () => ({
     },
     personalize: {
         enabled: process.env.NODE_ENV !== 'development',
-        edgeTimeout: 400,
-        cdpTimeout: 400,
+        edgeTimeout: parseInt(process.env.PERSONALIZE_MIDDLEWARE_EDGE_TIMEOUT, 10) || 400,
+        cdpTimeout: parseInt(process.env.PERSONALIZE_MIDDLEWARE_CDP_TIMEOUT, 10) || 400,
         scope: '',
         channel: 'WEB',
         currency: 'USD',

package/dist/esm/content/content-client.js

@@ -60,8 +60,7 @@ export class ContentClient {
     }
     /**
      * Retrieves the locale information for a given locale ID.
-     *
-     * @param id - The unique identifier of the locale item.
+     * @param {string} id - The unique identifier of the locale item.
      * @returns A promise that resolves to the locale information associated with the specified locale ID.
      */
     async getLocale(id) {
@@ -71,7 +70,6 @@ export class ContentClient {
     }
     /**
      * Retrieves all available locales from the content service.
-     *
      * @returns A promise that resolves to an array of locales.
      */
     async getLocales() {

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

@@ -30,14 +30,14 @@ export class GraphQLRobotsService {
      * @returns text of robots.txt
      * @throws {Error} if the siteName is empty.
      */
-    async fetchRobots() {
+    async fetchRobots(fetchOptions) {
         const siteName = this.options.siteName;
         if (!siteName) {
             throw new Error(siteNameError);
         }
         const robotsResult = this.graphQLClient.request(this.query, {
             siteName,
-        });
+        }, fetchOptions);
         try {
             return robotsResult.then((result) => {
                 var _a, _b;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.2.0-beta.6",
+  "version": "0.2.0-beta.7",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -34,42 +34,42 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/events": "^0.5.0",
-    "@types/chai": "^5.0.1",
+    "@sitecore-cloudsdk/events": "^0.5.1",
+    "@types/chai": "^5.2.2",
     "@types/chai-spies": "^1.0.6",
     "@types/chai-string": "^1.4.5",
     "@types/debug": "^4.1.12",
     "@types/jsdom": "^21.1.7",
     "@types/memory-cache": "^0.2.6",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^22.12.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.15.14",
     "@types/proxyquire": "^1.3.31",
-    "@types/sinon": "^17.0.3",
+    "@types/sinon": "^17.0.4",
     "@types/sinon-chai": "^4.0.0",
     "@types/url-parse": "1.4.11",
-    "chai": "^4.2.0",
+    "chai": "^4.4.1",
     "chai-spies": "^1.1.0",
-    "chai-string": "^1.5.0",
+    "chai-string": "^1.6.0",
     "del-cli": "^6.0.0",
     "eslint": "^8.56.0",
-    "eslint-plugin-jsdoc": "48.7.0",
-    "jsdom": "^26.0.0",
-    "mocha": "^11.1.0",
+    "eslint-plugin-jsdoc": "50.6.11",
+    "jsdom": "^26.1.0",
+    "mocha": "^11.2.2",
     "nock": "14.0.0-beta.7",
     "nyc": "^17.1.0",
     "proxyquire": "^2.1.3",
     "sinon": "^20.0.0",
     "tslib": "^2.8.1",
-    "tsx": "^4.19.2",
-    "typescript": "~5.7.3"
+    "tsx": "^4.19.4",
+    "typescript": "~5.8.3"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/events": "^0.5.0"
+    "@sitecore-cloudsdk/events": "^0.5.1"
   },
   "dependencies": {
     "chalk": "^4.1.2",
     "debug": "^4.4.0",
-    "graphql": "^16.10.0",
+    "graphql": "^16.11.0",
     "graphql-request": "^6.1.0",
     "memory-cache": "^0.2.0",
     "sinon-chai": "^4.0.0",
@@ -77,7 +77,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "a56ee0c0a3897b5f9915329e20469fa427ee13a8",
+  "gitHead": "72e0db1a8d4142e567d6849f3d98e39b7826e6d9",
   "files": [
     "dist",
     "types",

package/types/client/index.d.ts

@@ -4,4 +4,4 @@ export { RetryStrategy, PageInfo, FetchOptions } from '../models';
 export { getEdgeProxyContentUrl, getEdgeProxyFormsUrl } from './graphql-edge-proxy';
 export { SitecoreClient, Page, PageOptions, SitemapXmlOptions } from './sitecore-client';
 export { SitecoreClientInit } from './models';
-export { createGraphQLClientFactory } from './utils';
+export { createGraphQLClientFactory, GraphQLClientOptions } from './utils';

package/types/client/models.d.ts

@@ -1,5 +1,21 @@
 import { SitecoreConfig } from '../config';
-import { SiteInfo } from '../site';
+import { GraphQLEditingService } from '../editing/graphql-editing-service';
+import { RestComponentLayoutService } from '../editing/rest-component-layout-service';
+import { GraphQLDictionaryService } from '../i18n/graphql-dictionary-service';
+import { GraphQLLayoutService } from '../layout/graphql-layout-service';
+import { GraphQLErrorPagesService, GraphQLSitePathService, SiteInfo, SiteResolver } from '../site';
+/**
+ * Init options for Sitecore Client that allows you to override services too
+ */
 export type SitecoreClientInit = Omit<SitecoreConfig, 'multisite' | 'redirects' | 'personalize'> & {
     sites: SiteInfo[];
+    custom?: {
+        layoutService?: GraphQLLayoutService;
+        dictionaryService?: GraphQLDictionaryService;
+        siteResolver?: SiteResolver;
+        editingService?: GraphQLEditingService;
+        errorPagesService?: GraphQLErrorPagesService;
+        componentService?: RestComponentLayoutService;
+        sitePathService?: GraphQLSitePathService;
+    };
 };

package/types/client/sitecore-client.d.ts

@@ -6,6 +6,7 @@ import { HTMLLink, FetchOptions, StaticPath, RetryStrategy } from '../models';
 import { PersonalizedRewriteData } from '../personalize/utils';
 import { ErrorPages, SiteInfo, SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService, GraphQLSitemapXmlService } from '../site';
 import { SitecoreClientInit } from './models';
+import { GraphQLRobotsService } from '../site/graphql-robots-service';
 /**
  * Represent a Page model returned from Edge endpoint
  */
@@ -39,6 +40,15 @@ export type SitemapXmlOptions = {
     /** The site name to resolve the sitemap for */
     siteName?: string;
 };
+/**
+ * Options for fetching robots.txt content.
+ */
+export type RobotsOptions = {
+    /**
+     * The name of the site for which to fetch robots.txt content.
+     */
+    siteName: string;
+};
 /**
  * Contract for the Sitecore Client implementations
  */
@@ -53,33 +63,34 @@ export interface BaseSitecoreClient {
      * Retrieves page layoutData and returns page details like language, layoutData and site info for current request
      * @param {string} path current request path
      * @param {PageOptions} pageOptions additional overrides like language, site name and personalization variants
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page | null} page details when page layout is found and null when not
      */
     getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
     /**
-     * Get dictionary data for a given site and locale.
-     * Can retrieve dictionary phrases for default site and language when page options not provided
-     * @param {RouteOptions} [routeOptions] language and site to load dictionary data for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
      */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
     getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
     /**
      * Get error pages configured by SXA for a given site and locale
      * @param {RouteOptions} [routeOptions] language and site to load error pages for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      */
     getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
     /**
      * Get preview layout details based on details from EditingPreviewData input
      * @param {EditingPreviewData | undefined} previewData preview details like route, site, language etc used to retrieve preview page and layout
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      */
     getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
     /**
      * Get route paths for all pages in the site. Can be used for static site generation.
      * @param {string[]} [languages] languages to fetch routes in
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      */
     getPagePaths(languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
     /**
@@ -97,9 +108,17 @@ export interface BaseSitecoreClient {
     /**
      * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
      * @param { SitemapRequestConfig} reqOptions - Configuration for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetchOptions Additional fetch options to override GraphQL requests
      * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
      */
-    getSiteMap(reqOptions: SitemapXmlOptions): Promise<string>;
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} fetchOptions Additional fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
 }
 export interface BaseServiceOptions {
     defaultSite: string;
@@ -144,7 +163,7 @@ export declare class SitecoreClient implements BaseSitecoreClient {
      * Get page details for a route, with layout and other details
      * @param {string} path route path
      * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page | null} page details
      */
     getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
@@ -163,28 +182,28 @@ export declare class SitecoreClient implements BaseSitecoreClient {
     /**
      * Retrieves dictionary phrases for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
     getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
     /**
      * Retrieves error pages for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
      */
     getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
     /**
      * Retrieves preview page and layout details
      * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page details
      */
     getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
     /**
      * Get design library page details for Design Library mode of your app
      * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
      * @returns {Page} preview page for Design Library
      */
     getDesignLibraryData(designLibData: DesignLibraryRenderPreviewData, fetchOptions?: FetchOptions): Promise<Page>;
@@ -203,18 +222,27 @@ export declare class SitecoreClient implements BaseSitecoreClient {
      * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
      */
     getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
+     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
+     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
+     * or null if no content is found.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
      */
     protected getGraphqlSitemapXMLService(siteName: string): GraphQLSitemapXmlService;
+    protected getRobotsService(siteName: string): GraphQLRobotsService;
     protected getBaseServiceOptions(): BaseServiceOptions;
-    protected getClientFactory(): GraphQLRequestClientFactory;
-    protected getSiteResolver(): SiteResolver;
-    protected getLayoutService(baseOptions: BaseServiceOptions): GraphQLLayoutService;
-    protected getDictionaryService(baseOptions: BaseServiceOptions): GraphQLDictionaryService;
-    protected getEditingService(): GraphQLEditingService;
-    protected getErrorPagesService(): GraphQLErrorPagesService;
-    protected getComponentService(): RestComponentLayoutService;
-    protected getSitePathService(): GraphQLSitePathService;
+    private getClientFactory;
+    private getSiteResolver;
+    private getLayoutService;
+    private getDictionaryService;
+    private getEditingService;
+    private getErrorPagesService;
+    private getComponentService;
+    private getSitePathService;
 }

package/types/config/index.d.ts

@@ -1,3 +1,3 @@
-export { SitecoreConfig, SitecoreConfigInput, SitecoreCliConfig, SitecoreCliConfigInput, ScaffoldTemplate, ComponentTemplateType, } from './models';
+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

@@ -13,7 +13,7 @@ export type SitecoreConfigInput = {
      * API settings required to connect to Sitecore.
      * Both edge and local set can be specified as JSS app will use API Key for component library
      */
-    api: {
+    api?: {
         /**
          * Edge endpoint credentials for Sitecore connection. Will be used to connect to SaaS XMCloud instance
          */
@@ -55,7 +55,7 @@ export type SitecoreConfigInput = {
      * The default and fallback locale for your site.
      * Ensure it aligns with the framework-specific settings used in your application.
      */
-    defaultLanguage: string;
+    defaultLanguage?: string;
     /**
      * Your default site name. When using the multisite feature this variable defines the fallback site.
      * @default empty string
@@ -63,6 +63,7 @@ export type SitecoreConfigInput = {
     defaultSite?: string;
     /**
      * Editing secret required to support Sitecore editing and preview functionality.
+     * by default set by the JSS_EDITING_SECRET environment variable
      */
     editingSecret?: string;
     /**
@@ -132,10 +133,14 @@ export type SitecoreConfigInput = {
         enabled?: boolean;
         /**
          * Configuration for your Sitecore Experience Edge endpoint
+         * by default set by the PERSONALIZE_MIDDLEWARE_EDGE_TIMEOUT environment variable
+         * if not set, will use the default value of 400ms
          */
         edgeTimeout?: number;
         /**
          * Configuration for your Sitecore CDP endpoint
+         * by default set by the PERSONALIZE_MIDDLEWARE_CDP_TIMEOUT environment variable
+         * if not set, will use the default value of 400ms
          */
         cdpTimeout?: number;
         /**

package/types/content/content-client.d.ts

@@ -45,14 +45,12 @@ export declare class ContentClient {
     get<T>(query: string | DocumentNode, variables?: Record<string, unknown>, options?: FetchOptions): Promise<T>;
     /**
      * Retrieves the locale information for a given locale ID.
-     *
-     * @param id - The unique identifier of the locale item.
+     * @param {string} id - The unique identifier of the locale item.
      * @returns A promise that resolves to the locale information associated with the specified locale ID.
      */
     getLocale(id: string): Promise<import("./locales").Locale | null>;
     /**
      * Retrieves all available locales from the content service.
-     *
      * @returns A promise that resolves to an array of locales.
      */
     getLocales(): Promise<import("./locales").Locale[]>;

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

@@ -1,4 +1,4 @@
-import { GraphQLClient } from '../client';
+import { FetchOptions, GraphQLClient } from '../client';
 import { GraphQLRequestClientFactory } from '../graphql-request-client';
 export type GraphQLRobotsServiceConfig = {
     /**
@@ -38,7 +38,7 @@ export declare class GraphQLRobotsService {
      * @returns text of robots.txt
      * @throws {Error} if the siteName is empty.
      */
-    fetchRobots(): Promise<string>;
+    fetchRobots(fetchOptions?: FetchOptions): Promise<string>;
     /**
      * 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