@sitecore-content-sdk/core 0.1.0-beta.32 → 0.1.0-beta.33

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

@@ -8,6 +8,7 @@ const utils_1 = require("../personalize/utils");
 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");
 /**
  * This is a generic content client that can be used by any framework.
  * Use it to retrieve pages, preview data, dictionary and other data
@@ -21,6 +22,7 @@ class SitecoreClient {
         this.initOptions = initOptions;
         this.clientFactory = this.getClientFactory();
         this.siteResolver = this.getSiteResolver();
+        this.sitemapXmlService = this.getGraphqlSitemapXMLService();
         const baseServiceOptions = this.getBaseServiceOptions();
         this.layoutService = this.getLayoutService(baseServiceOptions);
         this.dictionaryService = this.getDictionaryService(baseServiceOptions);
@@ -209,10 +211,59 @@ class SitecoreClient {
     async getPagePaths(languages, fetchOptions) {
         return this.sitePathService.fetchSiteRoutes(languages || [], fetchOptions);
     }
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
+     */
+    async getSiteMap(reqOptions, fetchOptions) {
+        const ABSOLUTE_URL_REGEXP = '^(?:[a-z]+:)?//';
+        const { reqHost, reqProtocol, id } = reqOptions;
+        // Get specific sitemap
+        const sitemapPath = await this.sitemapXmlService.getSitemap(id);
+        if (sitemapPath) {
+            const isAbsoluteUrl = sitemapPath.match(ABSOLUTE_URL_REGEXP);
+            const sitemapUrl = isAbsoluteUrl
+                ? sitemapPath
+                : `${this.initOptions.api.local.apiHost}${sitemapPath}`;
+            try {
+                const fetcher = new native_fetcher_1.NativeDataFetcher();
+                const xmlResponse = await fetcher.fetch(sitemapUrl);
+                return xmlResponse.data;
+            }
+            catch (error) {
+                throw new Error('REDIRECT_404');
+            }
+        }
+        // Get sitemap index
+        const sitemaps = await this.sitemapXmlService.fetchSitemaps(fetchOptions);
+        if (!sitemaps.length) {
+            throw new Error('REDIRECT_404');
+        }
+        return `<?xml version="1.0" encoding="UTF-8"?>
+      <sitemapindex xmlns="http://sitemaps.org/schemas/sitemap/0.9">
+      ${sitemaps
+            .map((item) => {
+            const parseUrl = item.split('/');
+            const lastSegment = parseUrl[parseUrl.length - 1];
+            const escapedUrl = `${reqProtocol}://${reqHost}/${lastSegment}`.replace(/&/g, '&amp;');
+            return `<sitemap><loc>${escapedUrl}</loc></sitemap>`;
+        })
+            .join('')}
+      </sitemapindex>`;
+    }
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
      */
+    getGraphqlSitemapXMLService() {
+        return new site_1.GraphQLSitemapXmlService({
+            clientFactory: this.clientFactory,
+            siteName: this.initOptions.defaultSite,
+        });
+    }
     getBaseServiceOptions() {
         return {
             defaultSite: this.initOptions.defaultSite,

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

@@ -3,8 +3,9 @@ import { GraphQLDictionaryService } from '../i18n';
 import { getDesignLibraryStylesheetLinks, getContentStylesheetLink, GraphQLLayoutService, } from '../layout';
 import { getGroomedVariantIds } from '../personalize/utils';
 import { personalizeLayout } from '../personalize/layout-personalizer';
-import { SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService, } from '../site';
+import { SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService, GraphQLSitemapXmlService, } from '../site';
 import { createGraphQLClientFactory } from './utils';
+import { NativeDataFetcher } from '../native-fetcher';
 /**
  * This is a generic content client that can be used by any framework.
  * Use it to retrieve pages, preview data, dictionary and other data
@@ -18,6 +19,7 @@ export class SitecoreClient {
         this.initOptions = initOptions;
         this.clientFactory = this.getClientFactory();
         this.siteResolver = this.getSiteResolver();
+        this.sitemapXmlService = this.getGraphqlSitemapXMLService();
         const baseServiceOptions = this.getBaseServiceOptions();
         this.layoutService = this.getLayoutService(baseServiceOptions);
         this.dictionaryService = this.getDictionaryService(baseServiceOptions);
@@ -206,10 +208,59 @@ export class SitecoreClient {
     async getPagePaths(languages, fetchOptions) {
         return this.sitePathService.fetchSiteRoutes(languages || [], fetchOptions);
     }
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
+     */
+    async getSiteMap(reqOptions, fetchOptions) {
+        const ABSOLUTE_URL_REGEXP = '^(?:[a-z]+:)?//';
+        const { reqHost, reqProtocol, id } = reqOptions;
+        // Get specific sitemap
+        const sitemapPath = await this.sitemapXmlService.getSitemap(id);
+        if (sitemapPath) {
+            const isAbsoluteUrl = sitemapPath.match(ABSOLUTE_URL_REGEXP);
+            const sitemapUrl = isAbsoluteUrl
+                ? sitemapPath
+                : `${this.initOptions.api.local.apiHost}${sitemapPath}`;
+            try {
+                const fetcher = new NativeDataFetcher();
+                const xmlResponse = await fetcher.fetch(sitemapUrl);
+                return xmlResponse.data;
+            }
+            catch (error) {
+                throw new Error('REDIRECT_404');
+            }
+        }
+        // Get sitemap index
+        const sitemaps = await this.sitemapXmlService.fetchSitemaps(fetchOptions);
+        if (!sitemaps.length) {
+            throw new Error('REDIRECT_404');
+        }
+        return `<?xml version="1.0" encoding="UTF-8"?>
+      <sitemapindex xmlns="http://sitemaps.org/schemas/sitemap/0.9">
+      ${sitemaps
+            .map((item) => {
+            const parseUrl = item.split('/');
+            const lastSegment = parseUrl[parseUrl.length - 1];
+            const escapedUrl = `${reqProtocol}://${reqHost}/${lastSegment}`.replace(/&/g, '&amp;');
+            return `<sitemap><loc>${escapedUrl}</loc></sitemap>`;
+        })
+            .join('')}
+      </sitemapindex>`;
+    }
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
      */
+    getGraphqlSitemapXMLService() {
+        return new GraphQLSitemapXmlService({
+            clientFactory: this.clientFactory,
+            siteName: this.initOptions.defaultSite,
+        });
+    }
     getBaseServiceOptions() {
         return {
             defaultSite: this.initOptions.defaultSite,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.1.0-beta.32",
+  "version": "0.1.0-beta.33",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -45,6 +45,7 @@
     "@types/node": "^22.12.0",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^4.0.0",
     "@types/url-parse": "1.4.11",
     "chai": "^4.2.0",
     "chai-spies": "^1.1.0",
@@ -71,11 +72,12 @@
     "graphql": "^16.10.0",
     "graphql-request": "^6.1.0",
     "memory-cache": "^0.2.0",
+    "sinon-chai": "^4.0.0",
     "url-parse": "^1.5.10"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "36237ed63ce1e3829ccc45fddee95ed8d191c021",
+  "gitHead": "627eaa2aaf1042fefcfcecacc4084296766aabd1",
   "files": [
     "dist",
     "types",

package/types/client/index.d.ts

@@ -2,6 +2,6 @@ export { GraphQLClientError, GraphQLClient, GraphQLRequestClient, GraphQLRequest
 export { DefaultRetryStrategy } from '../retries';
 export { RetryStrategy, PageInfo, FetchOptions } from '../models';
 export { getEdgeProxyContentUrl, getEdgeProxyFormsUrl } from './graphql-edge-proxy';
-export { SitecoreClient, Page, PageOptions } from './sitecore-client';
+export { SitecoreClient, Page, PageOptions, SitemapXmlOptions } from './sitecore-client';
 export { SitecoreClientInit } from './models';
 export { createGraphQLClientFactory } from './utils';

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

@@ -4,7 +4,7 @@ import { DictionaryPhrases, GraphQLDictionaryService } from '../i18n';
 import { GraphQLLayoutService, LayoutServiceData, RouteOptions } from '../layout';
 import { HTMLLink, FetchOptions, StaticPath, RetryStrategy } from '../models';
 import { PersonalizedRewriteData } from '../personalize/utils';
-import { ErrorPages, SiteInfo, SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService } from '../site';
+import { ErrorPages, SiteInfo, SiteResolver, GraphQLErrorPagesService, GraphQLSitePathService, GraphQLSitemapXmlService } from '../site';
 import { SitecoreClientInit } from './models';
 /**
  * Represent a Page model returned from Edge endpoint
@@ -26,6 +26,17 @@ export type Page = {
 export type PageOptions = Partial<RouteOptions> & {
     personalize?: PersonalizedRewriteData;
 };
+/**
+ * Request options for the getSiteMap method
+ */
+export type SitemapXmlOptions = {
+    /** The hostname from the request (e.g., 'example.com') */
+    reqHost: string;
+    /** The protocol from request headers (e.g., 'https' or 'http') */
+    reqProtocol: string | string[];
+    /** Optional sitemap identifier when requesting a specific sitemap */
+    id?: string;
+};
 /**
  * Contract for the Sitecore Client implementations
  */
@@ -81,6 +92,12 @@ export interface BaseSitecoreClient {
         enableStyles?: boolean;
         enableThemes?: boolean;
     }): HTMLLink[];
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param { SitemapRequestConfig} reqOptions - Configuration for sitemap retrieval
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions): Promise<string>;
 }
 export interface BaseServiceOptions {
     defaultSite: string;
@@ -104,6 +121,7 @@ export declare class SitecoreClient implements BaseSitecoreClient {
     protected errorPagesService: GraphQLErrorPagesService;
     protected componentService: RestComponentLayoutService;
     protected sitePathService: GraphQLSitePathService;
+    protected sitemapXmlService: GraphQLSitemapXmlService;
     /**
      * Init SitecoreClient
      * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
@@ -176,10 +194,19 @@ export declare class SitecoreClient implements BaseSitecoreClient {
      * @returns {Promise<StaticPath[]>} A promise that resolves to an array of static paths.
      */
     getPagePaths(languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
     /**
      * Factory methods for creating dependencies
      * Subclasses can override these to provide custom implementations.
      */
+    protected getGraphqlSitemapXMLService(): GraphQLSitemapXmlService;
     protected getBaseServiceOptions(): BaseServiceOptions;
     protected getClientFactory(): GraphQLRequestClientFactory;
     protected getSiteResolver(): SiteResolver;