@sitecore-content-sdk/core 0.2.0-canary.3 → 0.2.0-canary.30

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

@@ -0,0 +1,80 @@
+import { GraphQLRequestClient } from '../graphql-request-client';
+import { getContentUrl } from './utils';
+import debug from '../debug';
+import { GET_LOCALE_QUERY, GET_LOCALES_QUERY, } from './locales';
+/**
+ * Class representing a client for interacting with the Content API.
+ */
+export class ContentClient {
+    constructor({ url, tenant, environment, preview = false, token }) {
+        this.endpoint = getContentUrl({
+            environment,
+            preview,
+            tenant,
+            url,
+        });
+        this.graphqlClient = new GraphQLRequestClient(this.endpoint, {
+            headers: {
+                Authorization: `Bearer ${token}`,
+            },
+            debugger: debug.content,
+        });
+    }
+    /**
+     * Factory method for creating a ContentClient instance. This method allows you to create a client with the values populated from environment variables or provided as arguments.
+     * @param {Partial<ContentClientOptions>} [options] - client configuration options
+     * @param {string} [options.url] - Content base graphql endpoint url. If not provided, it will be read from the SITECORE_CS_URL environment variable. Otherwise, it defaults to https://cs-graphqlapi-staging.sitecore-staging.cloud.
+     * @param {string} [options.tenant] - Tenant name. If not provided, it will be read from the SITECORE_CS_TENANT environment variable
+     * @param {string} [options.environment] - Environment name. If not provided, it will be read from the SITECORE_CS_ENVIRONMENT environment variable. Otherwise, it defaults to 'main'
+     * @param {boolean} [options.preview] - Indicates if preview mode is enabled. If not provided, it will be read from the SITECORE_CS_PREVIEW environment variable. Otherwise, it defaults to false
+     * @param {string} [options.token] - Token for authentication. If not provided, it will be read from the SITECORE_CS_TOKEN environment variable.
+     * @returns {ContentClient} ContentClient instance
+     * @throws {Error} If tenant or token is not provided
+     */
+    static createClient({ url, tenant, environment, preview, token, } = {}) {
+        const options = {
+            url: url || process.env.SITECORE_CS_URL,
+            tenant: tenant || process.env.SITECORE_CS_TENANT || '',
+            environment: environment || process.env.SITECORE_CS_ENVIRONMENT || 'main',
+            preview: preview || process.env.SITECORE_CS_PREVIEW === 'true',
+            token: token || process.env.SITECORE_CS_TOKEN || '',
+        };
+        if (!options.tenant) {
+            throw new Error('Tenant is required to be provided as an argument or as a SITECORE_CS_TENANT environment variable');
+        }
+        if (!options.token) {
+            throw new Error('Token is required to be provided as an argument or as a SITECORE_CS_TOKEN environment variable');
+        }
+        return new ContentClient(options);
+    }
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {object} variables variables for the query
+     * @param {FetchOptions} options options for configuring the request
+     * @returns {T} response data
+     */
+    async get(query, variables = {}, options = {}) {
+        debug.content('fetching content data');
+        return this.graphqlClient.request(query, variables, options);
+    }
+    /**
+     * Retrieves the locale information for a given locale ID.
+     * @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) {
+        debug.content('Getting locale for id: %s', id);
+        const response = await this.get(GET_LOCALE_QUERY, { id });
+        return response.locale;
+    }
+    /**
+     * Retrieves all available locales from the content service.
+     * @returns A promise that resolves to an array of locales.
+     */
+    async getLocales() {
+        debug.content('Getting all locales');
+        const response = await this.get(GET_LOCALES_QUERY);
+        return response.manyLocale;
+    }
+}

package/dist/esm/content/index.js

@@ -0,0 +1,3 @@
+export { ContentClient } from './content-client';
+export { GET_LOCALE_QUERY, GET_LOCALES_QUERY, } from './locales';
+export { getContentUrl } from './utils';

package/dist/esm/content/locales.js

@@ -0,0 +1,25 @@
+/**
+ * GraphQL query to retrieve a specific locale by its ID.
+ *
+ * Variables:
+ * - id: The ID of the locale to retrieve.
+ */
+export const GET_LOCALE_QUERY = `
+  query GetLocaleById ($id: ID!) {
+    locale(id: $id) {
+      id
+      label
+    }
+  }
+`;
+/**
+ * GraphQL query to retrieve all available locales.
+ */
+export const GET_LOCALES_QUERY = `
+  query GetAllLocales{
+    manyLocale {
+      id
+      label
+    }
+  }
+`;

package/dist/esm/content/utils.js

@@ -0,0 +1,13 @@
+import { normalizeUrl } from '../utils/normalize-url';
+/**
+ * Get the Content graphql endpoint url
+ * @param {object} params Parameters
+ * @param {string} [params.url] Content base graphql endpoint url
+ * @param {string} params.tenant Tenant name
+ * @param {string} params.environment Environment name
+ * @param {boolean} params.preview Indicates if preview mode is enabled
+ * @returns {string} Content graphql endpoint url
+ */
+export function getContentUrl({ url = 'https://cs-graphqlapi-staging.sitecore-staging.cloud', tenant, environment, preview, }) {
+    return `${normalizeUrl(url)}/api/graphql/v1/${tenant}/${environment}?preview=${preview}`;
+}

package/dist/esm/debug.js

@@ -22,6 +22,7 @@ export const enableDebug = (namespaces) => debug.enable(namespaces);
  */
 export default {
     common: debug(`${rootNamespace}:common`),
+    content: debug(`${rootNamespace}:content`),
     form: debug(`${rootNamespace}:form`),
     http: debug(`${rootNamespace}:http`),
     layout: debug(`${rootNamespace}:layout`),

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

@@ -1,4 +1,5 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Event to be sent when report status to design library
  */
@@ -103,5 +104,5 @@ export function getDesignLibraryStatusEvent(status, uid) {
  * @returns The full URL to the design library script.
  */
 export function getDesignLibraryScriptLink(sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) {
-    return `${sitecoreEdgeUrl}/v1/files/designlibrary/lib/rh-lib-script.js`;
+    return `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/designlibrary/lib/rh-lib-script.js`;
 }

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 // NOTE: all imports are now named as to not make breaking changes
 // and to keep react-native working with cjs modules.
 import * as constants from './constants';
+import * as form from './form';
 export { default as debug, enableDebug } from './debug';
 export { GraphQLRequestClient, } from './graphql-request-client';
 export { DefaultRetryStrategy } from './retries';
@@ -8,4 +9,5 @@ export { MemoryCacheClient } from './cache-client';
 export { ClientError } from 'graphql-request';
 export { NativeDataFetcher, } from './native-fetcher';
 export { constants };
+export { form };
 export { defineConfig } from './config';

package/dist/esm/layout/content-styles.js

@@ -1,4 +1,5 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Regular expression to check if the content styles are used in the field value
  */
@@ -22,7 +23,7 @@ export const getContentStylesheetLink = (layoutData, sitecoreEdgeContextId, site
         rel: 'stylesheet',
     };
 };
-export const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => `${sitecoreEdgeUrl}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+export const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 export const traversePlaceholder = (components, config) => {
     if (config.loadStyles)
         return;

package/dist/esm/layout/themes.js

@@ -1,5 +1,6 @@
 import { getFieldValue } from '.';
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Pattern for library ids
  * @example -library--foo
@@ -23,7 +24,7 @@ export function getDesignLibraryStylesheetLinks(layoutData, sitecoreEdgeContextI
     }));
 }
 export const getStylesheetUrl = (id, sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => {
-    return `${sitecoreEdgeUrl}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+    return `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 };
 /**
  * Traverse placeholder and components to add library ids

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/dist/esm/tools/auth/fetch-bearer-token.js

@@ -0,0 +1,34 @@
+import chalk from 'chalk';
+import { DEFAULT_SITECORE_AUTH_AUDIENCE, DEFAULT_SITECORE_AUTH_ENDPOINT } from '../../constants';
+/**
+ * Connects to M2M endpoint and fetches the bearer token
+ * Uses client_id and client_secret from environment variables
+ * @param {FetchBearerTokenOptions} options client id, secret, and other parameters for connection to m2m endpoint
+ * @returns {string} bearer token string
+ */
+export const fetchBearerToken = async (options) => {
+    const { clientId, clientSecret } = options;
+    const audience = options.audience || DEFAULT_SITECORE_AUTH_AUDIENCE;
+    const endpoint = options.endpoint || DEFAULT_SITECORE_AUTH_ENDPOINT;
+    try {
+        // TODO:adjust when M2M endpoint is live
+        const authenticateResponse = await fetch(endpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({
+                client_id: clientId,
+                client_secret: clientSecret,
+                audience: audience,
+                grant_type: 'client_credentials',
+            }),
+        });
+        const jsonResponse = await authenticateResponse.json();
+        return jsonResponse.access_token;
+    }
+    catch (error) {
+        console.error(chalk.red('Error authenticating with Sitecore Auth endpoint:', error));
+        return null;
+    }
+};

package/dist/esm/tools/index.js

@@ -2,3 +2,4 @@ export { generateSites } from './generateSites';
 export { generateMetadata } from './generateMetadata';
 export { scaffoldComponent } from './scaffold';
 export * from './templating';
+export { fetchBearerToken } from './auth/fetch-bearer-token';

package/dist/esm/utils/normalize-url.js

@@ -0,0 +1 @@
+export const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);

package/dist/esm/utils/utils.js

@@ -160,7 +160,7 @@ export const areURLSearchParamsEqual = (params1, params2) => {
  * @returns {string} - The modified string or regex with non-special "?" characters escaped.
  */
 export const escapeNonSpecialQuestionMarks = (input) => {
-    const regexPattern = /(?<!\\)\?/g; // Match unescaped "?" characters
+    const regexPattern = /(\\)?\?/g; // Match "?" that may or may not be preceded by a backslash
     const negativeLookaheadPattern = /\(\?!$/; // Detect the start of a Negative Lookahead pattern
     const specialRegexSymbols = /[.*+)\[\]|\(]$/; // Check for special regex symbols before "?"
     let result = '';
@@ -169,12 +169,14 @@ export const escapeNonSpecialQuestionMarks = (input) => {
     while ((match = regexPattern.exec(input)) !== null) {
         const index = match.index; // Position of the "?" in the string
         const before = input.slice(lastIndex, index); // Context before the "?"
+        // Check if "?" is preceded by a backslash (escaped)
+        const isEscaped = match[1] !== undefined; // match[1] is the backslash group
         // Check if "?" is part of a Negative Lookahead
         const isNegativeLookahead = negativeLookaheadPattern.test(before.slice(-3));
         // Check if "?" follows a special regex symbol
         const isSpecialRegexSymbol = specialRegexSymbols.test(before.slice(-1));
-        if (isNegativeLookahead || isSpecialRegexSymbol) {
-            // If it's a special case, keep the "?" as is
+        if (isEscaped || isNegativeLookahead || isSpecialRegexSymbol) {
+            // If it's escaped, part of a Negative Lookahead, or follows a special regex symbol, keep the "?" as is
             result += input.slice(lastIndex, index + 1);
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.2.0-canary.3",
+  "version": "0.2.0-canary.30",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -15,7 +15,7 @@
     "test": "mocha \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/form/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts src/content/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=22"
@@ -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": "^19.0.2",
+    "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": "4824a054121f530e5109a94b7d259d57d63b9fae",
+  "gitHead": "e13108ffd37e83ce84c60597c9c4dd699033a600",
   "files": [
     "dist",
     "types",

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,11 +222,21 @@ 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;

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/constants.d.ts

@@ -5,3 +5,5 @@ export declare enum SitecoreTemplateId {
 export declare const siteNameError = "The siteName cannot be empty";
 export declare const SITECORE_EDGE_URL_DEFAULT = "https://edge-platform.sitecorecloud.io";
 export declare const HIDDEN_RENDERING_NAME = "Hidden Rendering";
+export declare const DEFAULT_SITECORE_AUTH_ENDPOINT = "https://auth.sitecorecloud.io/oauth/token";
+export declare const DEFAULT_SITECORE_AUTH_AUDIENCE = "https://api.sitecorecloud.io";

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

@@ -0,0 +1,57 @@
+import { DocumentNode } from 'graphql';
+import { GraphQLRequestClient } from '../graphql-request-client';
+import { FetchOptions } from '../models';
+/**
+ * Interface representing the options for the ContentClient.
+ */
+export interface ContentClientOptions {
+    /** The base URL for the Content API. */
+    url?: string;
+    /** The tenant name. */
+    tenant: string;
+    /** The environment name. */
+    environment: string;
+    /** Indicates if preview mode is enabled. */
+    preview?: boolean;
+    /** The authentication token. */
+    token: string;
+}
+/**
+ * Class representing a client for interacting with the Content API.
+ */
+export declare class ContentClient {
+    endpoint: string;
+    graphqlClient: GraphQLRequestClient;
+    constructor({ url, tenant, environment, preview, token }: ContentClientOptions);
+    /**
+     * Factory method for creating a ContentClient instance. This method allows you to create a client with the values populated from environment variables or provided as arguments.
+     * @param {Partial<ContentClientOptions>} [options] - client configuration options
+     * @param {string} [options.url] - Content base graphql endpoint url. If not provided, it will be read from the SITECORE_CS_URL environment variable. Otherwise, it defaults to https://cs-graphqlapi-staging.sitecore-staging.cloud.
+     * @param {string} [options.tenant] - Tenant name. If not provided, it will be read from the SITECORE_CS_TENANT environment variable
+     * @param {string} [options.environment] - Environment name. If not provided, it will be read from the SITECORE_CS_ENVIRONMENT environment variable. Otherwise, it defaults to 'main'
+     * @param {boolean} [options.preview] - Indicates if preview mode is enabled. If not provided, it will be read from the SITECORE_CS_PREVIEW environment variable. Otherwise, it defaults to false
+     * @param {string} [options.token] - Token for authentication. If not provided, it will be read from the SITECORE_CS_TOKEN environment variable.
+     * @returns {ContentClient} ContentClient instance
+     * @throws {Error} If tenant or token is not provided
+     */
+    static createClient({ url, tenant, environment, preview, token, }?: Partial<ContentClientOptions>): ContentClient;
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {object} variables variables for the query
+     * @param {FetchOptions} options options for configuring the request
+     * @returns {T} response data
+     */
+    get<T>(query: string | DocumentNode, variables?: Record<string, unknown>, options?: FetchOptions): Promise<T>;
+    /**
+     * Retrieves the locale information for a given locale ID.
+     * @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/content/index.d.ts

@@ -0,0 +1,3 @@
+export { ContentClient, ContentClientOptions } from './content-client';
+export { GET_LOCALE_QUERY, GET_LOCALES_QUERY, LocaleQueryResponse, LocalesQueryResponse, Locale, } from './locales';
+export { getContentUrl } from './utils';