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

package/dist/esm/site/error-pages-service.js

@@ -1,6 +1,6 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-// The default query for request error handling
+import { siteNameError } from '../constants';
+import debug from '../debug';
+// The default query for request error handling
 const defaultQuery = /* GraphQL */ `
   query ErrorPagesQuery($siteName: String!, $language: String!) {
     site {
@@ -18,57 +18,58 @@ const defaultQuery = /* GraphQL */ `
       }
     }
   }
-`;
-/**
- * Service that fetch the error pages data using Sitecore's GraphQL API.
- */
-export class ErrorPagesService {
-    /**
-     * Creates an instance of graphQL error pages service with the provided options
-     * @param {ErrorPagesServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * Fetch list of error pages for the site
-     * @param {string} siteName  The site name
-     * @param {string} locale  The language
-     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
-     * @returns {ErrorPages} list of url's error pages
-     * @throws {Error} if the siteName is empty.
-     */
-    async fetchErrorPages(siteName, locale, fetchOptions) {
-        const language = locale || this.options.language;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        return this.graphQLClient.request(this.query, {
-            siteName,
-            language,
-        }, fetchOptions)
-            .then((result) => result.site.siteInfo ? result.site.siteInfo.errorHandling : null)
-            .catch((e) => Promise.reject(e));
-    }
-    /**
-     * 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() {
-        var _a, _b;
-        if (!this.options.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.options.clientFactory({
-            debugger: debug.errorpages,
-            retries: (_a = this.options.retries) === null || _a === void 0 ? void 0 : _a.count,
-            retryStrategy: (_b = this.options.retries) === null || _b === void 0 ? void 0 : _b.retryStrategy,
-        });
-    }
-}
+`;
+/**
+ * Service that fetch the error pages data using Sitecore's GraphQL API.
+ * @public
+ */
+export class ErrorPagesService {
+    /**
+     * Creates an instance of graphQL error pages service with the provided options
+     * @param {ErrorPagesServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch list of error pages for the site
+     * @param {string} siteName  The site name
+     * @param {string} locale  The language
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {ErrorPages} list of url's error pages
+     * @throws {Error} if the siteName is empty.
+     */
+    async fetchErrorPages(siteName, locale, fetchOptions) {
+        const language = locale || this.options.language;
+        if (!siteName) {
+            throw new Error(siteNameError);
+        }
+        return this.graphQLClient.request(this.query, {
+            siteName,
+            language,
+        }, fetchOptions)
+            .then((result) => result.site.siteInfo ? result.site.siteInfo.errorHandling : null)
+            .catch((e) => Promise.reject(e));
+    }
+    /**
+     * 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() {
+        var _a, _b;
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.options.clientFactory({
+            debugger: debug.errorpages,
+            retries: (_a = this.options.retries) === null || _a === void 0 ? void 0 : _a.count,
+            retryStrategy: (_b = this.options.retries) === null || _b === void 0 ? void 0 : _b.retryStrategy,
+        });
+    }
+}

package/dist/esm/site/index.js

@@ -1,8 +1,8 @@
-export { RobotsService } from './robots-service';
-export { REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectsService, } from './redirects-service';
-export { SitemapXmlService, } from './sitemap-xml-service';
-export { ErrorPagesService } from './error-pages-service';
-export { SiteInfoService } from './siteinfo-service';
-export { SitePathService } from './sitepath-service';
-export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SITE_PREFIX, SITE_KEY, } from './utils';
-export { SiteResolver } from './site-resolver';
+export { RobotsService } from './robots-service';
+export { REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectsService, } from './redirects-service';
+export { SitemapXmlService, } from './sitemap-xml-service';
+export { ErrorPagesService } from './error-pages-service';
+export { SiteInfoService } from './siteinfo-service';
+export { SitePathService } from './sitepath-service';
+export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SITE_PREFIX, SITE_KEY, } from './utils';
+export { SiteResolver } from './site-resolver';

package/dist/esm/site/models.js

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,10 +1,22 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-import { MemoryCacheClient } from '../cache-client';
-export const REDIRECT_TYPE_301 = 'REDIRECT_301';
-export const REDIRECT_TYPE_302 = 'REDIRECT_302';
-export const REDIRECT_TYPE_SERVER_TRANSFER = 'SERVER_TRANSFER';
-// The default query for request redirects of site
+import { siteNameError } from '../constants';
+import debug from '../debug';
+import { MemoryCacheClient } from '../cache-client';
+/**
+ * Redirect type for 301 redirects
+ * @public
+ */
+export const REDIRECT_TYPE_301 = 'REDIRECT_301';
+/**
+ * Redirect type for 302 redirects
+ * @public
+ */
+export const REDIRECT_TYPE_302 = 'REDIRECT_302';
+/**
+ * Redirect type for server transfer
+ * @public
+ */
+export const REDIRECT_TYPE_SERVER_TRANSFER = 'SERVER_TRANSFER';
+// The default query for request redirects of site
 const defaultQuery = /* GraphQL */ `
   query RedirectsQuery($siteName: String!) {
     site {
@@ -19,70 +31,71 @@ const defaultQuery = /* GraphQL */ `
       }
     }
   }
-`;
-/**
- *  The RedirectsService class is used to query the Content SDK redirects using Graphql endpoint
- */
-export class RedirectsService {
-    /**
-     * Creates an instance of graphQL redirects service with the provided options
-     * @param {RedirectsServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-        this.cache = this.getCacheClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * Fetch an array of redirects from API
-     * @param {string} siteName site name
-     * @returns Promise<RedirectInfo[]>
-     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
-     * @throws {Error} if the siteName is empty.
-     */
-    async fetchRedirects(siteName, fetchOptions) {
-        var _a, _b;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        const cacheKey = `redirects-${siteName}`;
-        let data = this.cache.getCacheValue(cacheKey);
-        if (!data) {
-            data = await this.graphQLClient.request(this.query, {
-                siteName,
-            }, fetchOptions);
-            this.cache.setCacheValue(cacheKey, data);
-        }
-        return ((_b = (_a = data === null || data === void 0 ? void 0 : data.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.redirects) || [];
-    }
-    /**
-     * 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.redirects,
-            fetch: this.options.fetch,
-        });
-    }
-    /**
-     * 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.options.cacheEnabled) !== null && _a !== void 0 ? _a : true,
-            cacheTimeout: (_b = this.options.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
-        });
-    }
-}
+`;
+/**
+ * The RedirectsService class is used to query the Content SDK redirects using Graphql endpoint
+ * @public
+ */
+export class RedirectsService {
+    /**
+     * Creates an instance of graphQL redirects service with the provided options
+     * @param {RedirectsServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+        this.cache = this.getCacheClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch an array of redirects from API
+     * @param {string} siteName site name
+     * @returns Promise<RedirectInfo[]>
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @throws {Error} if the siteName is empty.
+     */
+    async fetchRedirects(siteName, fetchOptions) {
+        var _a, _b;
+        if (!siteName) {
+            throw new Error(siteNameError);
+        }
+        const cacheKey = `redirects-${siteName}`;
+        let data = this.cache.getCacheValue(cacheKey);
+        if (!data) {
+            data = await this.graphQLClient.request(this.query, {
+                siteName,
+            }, fetchOptions);
+            this.cache.setCacheValue(cacheKey, data);
+        }
+        return ((_b = (_a = data === null || data === void 0 ? void 0 : data.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.redirects) || [];
+    }
+    /**
+     * 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.redirects,
+            fetch: this.options.fetch,
+        });
+    }
+    /**
+     * 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.options.cacheEnabled) !== null && _a !== void 0 ? _a : true,
+            cacheTimeout: (_b = this.options.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
+        });
+    }
+}

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

@@ -1,6 +1,6 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-// The default query for request robots.txt
+import { siteNameError } from '../constants';
+import debug from '../debug';
+// The default query for request robots.txt
 const defaultQuery = /* GraphQL */ `
   query RobotsQuery($siteName: String!) {
     site {
@@ -9,58 +9,59 @@ const defaultQuery = /* GraphQL */ `
       }
     }
   }
-`;
-/**
- * Service that fetch the robots.txt data using Sitecore's GraphQL API.
- */
-export class RobotsService {
-    /**
-     * Creates an instance of graphQL robots.txt service with the provided options
-     * @param {RobotsServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * Fetch a data of robots.txt from API
-     * @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
-     * @returns text of robots.txt
-     * @throws {Error} if the siteName is empty.
-     */
-    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;
-                return (_b = (_a = result === null || result === void 0 ? void 0 : result.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.robots;
-            });
-        }
-        catch (e) {
-            return Promise.reject(e);
-        }
-    }
-    /**
-     * 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.robots,
-        });
-    }
-}
+`;
+/**
+ * Service that fetch the robots.txt data using Sitecore's GraphQL API.
+ * @public
+ */
+export class RobotsService {
+    /**
+     * Creates an instance of graphQL robots.txt service with the provided options
+     * @param {RobotsServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch a data of robots.txt from API
+     * @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
+     * @returns text of robots.txt
+     * @throws {Error} if the siteName is empty.
+     */
+    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;
+                return (_b = (_a = result === null || result === void 0 ? void 0 : result.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.robots;
+            });
+        }
+        catch (e) {
+            return Promise.reject(e);
+        }
+    }
+    /**
+     * 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.robots,
+        });
+    }
+}

package/dist/esm/site/site-resolver.js

@@ -1,68 +1,69 @@
-// Delimiters for multi-value hostnames
-const DELIMITERS = /\||,|;/g;
-/**
- * Resolves site based on the provided host or site name
- */
-export class SiteResolver {
-    /**
-     * @param {SiteInfo[]} sites Array of sites to be used in resolution
-     */
-    constructor(sites) {
-        this.sites = sites;
-        /**
-         * Resolve site by host name
-         * @param {string} hostName the host name
-         * @returns {SiteInfo} the resolved site
-         * @throws {Error} if a matching site is not found
-         */
-        this.getByHost = (hostName) => {
-            for (const [hostname, site] of this.getHostMap()) {
-                if (this.matchesPattern(hostName, hostname)) {
-                    return site;
-                }
-            }
-            throw new Error(`Could not resolve site for host ${hostName}`);
-        };
-        /**
-         * Resolve site by site name
-         * @param {string} siteName the site name
-         * @returns {SiteInfo} the resolved site or undefined if not found
-         */
-        this.getByName = (siteName) => {
-            const siteInfo = this.sites.find((info) => info.name.toLocaleLowerCase() === siteName.toLocaleLowerCase());
-            return siteInfo;
-        };
-        this.getHostMap = () => {
-            const map = new Map();
-            // First collect unique hostnames.
-            // For sites with same hostname defined, priority is given to the first encountered.
-            this.sites.forEach((site) => {
-                const hostnames = site.hostName.replace(/\s/g, '').toLocaleLowerCase().split(DELIMITERS);
-                hostnames.forEach((hostname) => {
-                    if (!map.has(hostname)) {
-                        map.set(hostname, site);
-                    }
-                });
-            });
-            // Now order by specificity.
-            // This equivalates to sorting from longest to shortest with the assumption
-            // that your match is less specific as wildcards are introduced.
-            // E.g. order.eu.site.com → *.eu.site.com → *.site.com → *
-            // In case of a tie (e.g. *.site.com vs i.site.com), prefer one with less wildcards.
-            return new Map(Array.from(map).sort((a, b) => {
-                if (a[0].length === b[0].length) {
-                    return (a[0].match(/\*/g) || []).length - (b[0].match(/\*/g) || []).length;
-                }
-                return b[0].length - a[0].length;
-            }));
-        };
-    }
-    // b[0].match(/\*/g) || []).length
-    matchesPattern(hostname, pattern) {
-        // dots should be treated as chars
-        // stars should be treated as wildcards
-        const regExpPattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
-        const regExp = new RegExp(`^${regExpPattern}$`, 'gi');
-        return !!hostname.match(regExp);
-    }
-}
+// Delimiters for multi-value hostnames
+const DELIMITERS = /\||,|;/g;
+/**
+ * Resolves site based on the provided host or site name
+ * @public
+ */
+export class SiteResolver {
+    /**
+     * @param {SiteInfo[]} sites Array of sites to be used in resolution
+     */
+    constructor(sites) {
+        this.sites = sites;
+        /**
+         * Resolve site by host name
+         * @param {string} hostName the host name
+         * @returns {SiteInfo} the resolved site
+         * @throws {Error} if a matching site is not found
+         */
+        this.getByHost = (hostName) => {
+            for (const [hostname, site] of this.getHostMap()) {
+                if (this.matchesPattern(hostName, hostname)) {
+                    return site;
+                }
+            }
+            throw new Error(`Could not resolve site for host ${hostName}`);
+        };
+        /**
+         * Resolve site by site name
+         * @param {string} siteName the site name
+         * @returns {SiteInfo} the resolved site or undefined if not found
+         */
+        this.getByName = (siteName) => {
+            const siteInfo = this.sites.find((info) => info.name.toLocaleLowerCase() === siteName.toLocaleLowerCase());
+            return siteInfo;
+        };
+        this.getHostMap = () => {
+            const map = new Map();
+            // First collect unique hostnames.
+            // For sites with same hostname defined, priority is given to the first encountered.
+            this.sites.forEach((site) => {
+                const hostnames = site.hostName.replace(/\s/g, '').toLocaleLowerCase().split(DELIMITERS);
+                hostnames.forEach((hostname) => {
+                    if (!map.has(hostname)) {
+                        map.set(hostname, site);
+                    }
+                });
+            });
+            // Now order by specificity.
+            // This equivalates to sorting from longest to shortest with the assumption
+            // that your match is less specific as wildcards are introduced.
+            // E.g. order.eu.site.com → *.eu.site.com → *.site.com → *
+            // In case of a tie (e.g. *.site.com vs i.site.com), prefer one with less wildcards.
+            return new Map(Array.from(map).sort((a, b) => {
+                if (a[0].length === b[0].length) {
+                    return (a[0].match(/\*/g) || []).length - (b[0].match(/\*/g) || []).length;
+                }
+                return b[0].length - a[0].length;
+            }));
+        };
+    }
+    // b[0].match(/\*/g) || []).length
+    matchesPattern(hostname, pattern) {
+        // dots should be treated as chars
+        // stars should be treated as wildcards
+        const regExpPattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
+        const regExp = new RegExp(`^${regExpPattern}$`, 'gi');
+        return !!hostname.match(regExp);
+    }
+}