@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.2

package/dist/esm/site/siteinfo-service.js

@@ -1,5 +1,5 @@
-import debug from '../debug';
-import { MemoryCacheClient } from '../cache-client';
+import debug from '../debug';
+import { MemoryCacheClient } from '../cache-client';
 const siteQuery = /* GraphQL */ `
   query {
     site {
@@ -10,74 +10,78 @@ const siteQuery = /* GraphQL */ `
       }
     }
   }
-`;
-export class SiteInfoService {
-    /**
-     * Creates an instance of graphQL service to retrieve site configuration list from Sitecore
-     * @param {SiteInfoServiceConfig} config instance
-     */
-    constructor(config) {
-        this.config = config;
-        this.graphQLClient = this.getGraphQLClient();
-        this.cache = this.getCacheClient();
-    }
-    /**
-     * site query is available on XM Cloud and XP 10.4+
-     */
-    get siteQuery() {
-        return siteQuery;
-    }
-    async fetchSiteInfo(fetchOptions) {
-        var _a, _b;
-        const cachedResult = this.cache.getCacheValue(this.getCacheKey());
-        if (cachedResult) {
-            return cachedResult;
-        }
-        if (process.env.SITECORE) {
-            debug.multisite('Skipping site information fetch (building on XM Cloud)');
-            return [];
-        }
-        const response = await this.graphQLClient.request(this.siteQuery, {}, fetchOptions);
-        const results = (_b = (_a = response === null || response === void 0 ? void 0 : response.site) === null || _a === void 0 ? void 0 : _a.siteInfoCollection) === null || _b === void 0 ? void 0 : _b.reduce((result, current) => {
-            // filter out built in website
-            current.name !== 'website' &&
-                result.push({
-                    name: current.name,
-                    hostName: current.hostName,
-                    language: current.language,
-                });
-            return result;
-        }, []);
-        this.cache.setCacheValue(this.getCacheKey(), results);
-        return results;
-    }
-    /**
-     * Gets cache client implementation
-     * Override this method if custom cache needs to be used
-     * @returns CacheClient instance
-     */
-    getCacheClient() {
-        var _a, _b;
-        return new MemoryCacheClient({
-            cacheEnabled: (_a = this.config.cacheEnabled) !== null && _a !== void 0 ? _a : true,
-            cacheTimeout: (_b = this.config.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
-        });
-    }
-    /**
-     * 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
-     * want to use something else.
-     * @returns {GraphQLClient} implementation
-     */
-    getGraphQLClient() {
-        if (!this.config.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.config.clientFactory({
-            debugger: debug.multisite,
-        });
-    }
-    getCacheKey() {
-        return 'siteinfo-service-cache';
-    }
-}
+`;
+/**
+ * Service to fetch site information
+ * @public
+ */
+export class SiteInfoService {
+    /**
+     * Creates an instance of graphQL service to retrieve site configuration list from Sitecore
+     * @param {SiteInfoServiceConfig} config instance
+     */
+    constructor(config) {
+        this.config = config;
+        this.graphQLClient = this.getGraphQLClient();
+        this.cache = this.getCacheClient();
+    }
+    /**
+     * site query is available on XM Cloud and XP 10.4+
+     */
+    get siteQuery() {
+        return siteQuery;
+    }
+    async fetchSiteInfo(fetchOptions) {
+        var _a, _b;
+        const cachedResult = this.cache.getCacheValue(this.getCacheKey());
+        if (cachedResult) {
+            return cachedResult;
+        }
+        if (process.env.SITECORE) {
+            debug.multisite('Skipping site information fetch (building on XM Cloud)');
+            return [];
+        }
+        const response = await this.graphQLClient.request(this.siteQuery, {}, fetchOptions);
+        const results = (_b = (_a = response === null || response === void 0 ? void 0 : response.site) === null || _a === void 0 ? void 0 : _a.siteInfoCollection) === null || _b === void 0 ? void 0 : _b.reduce((result, current) => {
+            // filter out built in website
+            current.name !== 'website' &&
+                result.push({
+                    name: current.name,
+                    hostName: current.hostName,
+                    language: current.language,
+                });
+            return result;
+        }, []);
+        this.cache.setCacheValue(this.getCacheKey(), results);
+        return results;
+    }
+    /**
+     * Gets cache client implementation
+     * Override this method if custom cache needs to be used
+     * @returns CacheClient instance
+     */
+    getCacheClient() {
+        var _a, _b;
+        return new MemoryCacheClient({
+            cacheEnabled: (_a = this.config.cacheEnabled) !== null && _a !== void 0 ? _a : true,
+            cacheTimeout: (_b = this.config.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
+        });
+    }
+    /**
+     * 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
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    getGraphQLClient() {
+        if (!this.config.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.config.clientFactory({
+            debugger: debug.multisite,
+        });
+    }
+    getCacheKey() {
+        return 'siteinfo-service-cache';
+    }
+}

package/dist/esm/site/sitemap-xml-service.js

@@ -1,7 +1,7 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-const PREFIX_NAME_SITEMAP = 'sitemap';
-// The default query for request sitemaps
+import { siteNameError } from '../constants';
+import debug from '../debug';
+const PREFIX_NAME_SITEMAP = 'sitemap';
+// The default query for request sitemaps
 const defaultQuery = /* GraphQL */ `
   query SitemapQuery($siteName: String!) {
     site {
@@ -10,75 +10,76 @@ const defaultQuery = /* GraphQL */ `
       }
     }
   }
-`;
-/**
- * Service that fetch the sitemaps data using Sitecore's GraphQL API.
- */
-export class SitemapXmlService {
-    /**
-     * Creates an instance of graphQL sitemaps service with the provided options
-     * @param {SitemapXmlServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * Fetch list of sitemaps for the site
-     * @returns {string[]} list of sitemap paths
-     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
-     * @throws {Error} if the siteName is empty.
-     */
-    async fetchSitemaps(fetchOptions) {
-        const siteName = this.options.siteName;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        const sitemapResult = this.graphQLClient.request(this.query, {
-            siteName,
-        }, fetchOptions);
-        try {
-            return sitemapResult.then((result) => result.site.siteInfo.sitemap);
-        }
-        catch (e) {
-            return Promise.reject(e);
-        }
-    }
-    /**
-     * Get sitemap file path for sitemap id
-     * @param {string} id the sitemap id (can be empty for default 'sitemap.xml' file)
-     * @returns {string | undefined} the sitemap file path or undefined if one doesn't exist
-     */
-    async getSitemap(id) {
-        let searchSitemap;
-        if (id === undefined) {
-            return undefined;
-        }
-        else if (id === '') {
-            searchSitemap = `${PREFIX_NAME_SITEMAP}.xml`;
-        }
-        else {
-            const normalizedId = id.startsWith('-') ? id.slice(1) : id;
-            searchSitemap = `${PREFIX_NAME_SITEMAP}-${normalizedId}.xml`;
-        }
-        const sitemaps = await this.fetchSitemaps();
-        return sitemaps.find((sitemap) => sitemap.includes(searchSitemap));
-    }
-    /**
-     * 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
-     * want to use something else.
-     * @returns {GraphQLClient} implementation
-     */
-    getGraphQLClient() {
-        if (!this.options.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.options.clientFactory({
-            debugger: debug.sitemap,
-        });
-    }
-}
+`;
+/**
+ * Service that fetch the sitemaps data using Sitecore's GraphQL API.
+ * @public
+ */
+export class SitemapXmlService {
+    /**
+     * Creates an instance of graphQL sitemaps service with the provided options
+     * @param {SitemapXmlServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch list of sitemaps for the site
+     * @returns {string[]} list of sitemap paths
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @throws {Error} if the siteName is empty.
+     */
+    async fetchSitemaps(fetchOptions) {
+        const siteName = this.options.siteName;
+        if (!siteName) {
+            throw new Error(siteNameError);
+        }
+        const sitemapResult = this.graphQLClient.request(this.query, {
+            siteName,
+        }, fetchOptions);
+        try {
+            return sitemapResult.then((result) => result.site.siteInfo.sitemap);
+        }
+        catch (e) {
+            return Promise.reject(e);
+        }
+    }
+    /**
+     * Get sitemap file path for sitemap id
+     * @param {string} id the sitemap id (can be empty for default 'sitemap.xml' file)
+     * @returns {string | undefined} the sitemap file path or undefined if one doesn't exist
+     */
+    async getSitemap(id) {
+        let searchSitemap;
+        if (id === undefined) {
+            return undefined;
+        }
+        else if (id === '') {
+            searchSitemap = `${PREFIX_NAME_SITEMAP}.xml`;
+        }
+        else {
+            const normalizedId = id.startsWith('-') ? id.slice(1) : id;
+            searchSitemap = `${PREFIX_NAME_SITEMAP}-${normalizedId}.xml`;
+        }
+        const sitemaps = await this.fetchSitemaps();
+        return sitemaps.find((sitemap) => sitemap.includes(searchSitemap));
+    }
+    /**
+     * 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
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    getGraphQLClient() {
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.options.clientFactory({
+            debugger: debug.sitemap,
+        });
+    }
+}