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

package/dist/cjs/graphql-request-client.js

@@ -1,107 +1,108 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphQLRequestClient = void 0;
-const graphql_request_1 = require("graphql-request");
-const url_parse_1 = __importDefault(require("url-parse"));
-const debug_1 = __importDefault(require("./debug"));
-const timeout_promise_1 = __importDefault(require("./utils/timeout-promise"));
-const retries_1 = require("./retries");
-/**
- * A GraphQL client for Sitecore APIs that uses the 'graphql-request' library.
- * https://github.com/prisma-labs/graphql-request
- */
-class GraphQLRequestClient {
-    /**
-     * Provides ability to execute graphql query using given `endpoint`
-     * @param {string} endpoint The Graphql endpoint
-     * @param {GraphQLRequestClientConfig} [clientConfig] GraphQL request client configuration.
-     */
-    constructor(endpoint, clientConfig = {}) {
-        var _a;
-        this.endpoint = endpoint;
-        this.headers = {};
-        if (clientConfig.apiKey) {
-            this.headers.sc_apikey = clientConfig.apiKey;
-        }
-        if (clientConfig.headers) {
-            this.headers = Object.assign(Object.assign({}, this.headers), clientConfig.headers);
-        }
-        if (!endpoint || !(0, url_parse_1.default)(endpoint).hostname) {
-            throw new Error(`Invalid GraphQL endpoint '${endpoint}'. Verify that appropriate environment variable is set`);
-        }
-        this.timeout = clientConfig.timeout;
-        this.retries = (_a = clientConfig.retries) !== null && _a !== void 0 ? _a : 3;
-        this.retryStrategy =
-            clientConfig.retryStrategy ||
-                new retries_1.DefaultRetryStrategy({ statusCodes: [429, 502, 503, 504, 520, 521, 522, 523, 524] });
-        this.client = new graphql_request_1.GraphQLClient(endpoint, {
-            headers: this.headers,
-            fetch: clientConfig.fetch,
-        });
-        this.debug = clientConfig.debugger || debug_1.default.http;
-    }
-    /**
-     * Factory method for creating a GraphQLRequestClientFactory.
-     * @param {object} config - client configuration options.
-     * @param {string} config.endpoint - endpoint
-     * @param {string} [config.apiKey] - apikey
-     */
-    static createClientFactory({ endpoint, apiKey, }) {
-        return (config = {}) => new GraphQLRequestClient(endpoint, Object.assign(Object.assign({}, config), { apiKey }));
-    }
-    /**
-     * Execute graphql request
-     * @param {string | DocumentNode} query graphql query
-     * @param {RequestOptions} [options] Options for configuring a GraphQL request.
-     */
-    async request(query, variables, options) {
-        let attempt = 1;
-        const retryer = async () => {
-            const retries = (options === null || options === void 0 ? void 0 : options.retries) || this.retries;
-            const retryStrategy = (options === null || options === void 0 ? void 0 : options.retryStrategy) || this.retryStrategy;
-            const debug = (options === null || options === void 0 ? void 0 : options.debugger) || this.debug;
-            // Note we don't have access to raw request/response with graphql-request
-            // but we should log whatever we have.
-            debug('request: %o', {
-                url: this.endpoint,
-                headers: Object.assign(Object.assign({}, this.headers), options === null || options === void 0 ? void 0 : options.headers),
-                query,
-                variables,
-                timeout: this.timeout,
-            });
-            const startTimestamp = Date.now();
-            const headers = Object.assign(Object.assign({}, this.headers), options === null || options === void 0 ? void 0 : options.headers);
-            const fetchWithOptionalTimeout = [this.client.request(query, variables, headers)];
-            if (this.timeout) {
-                this.abortTimeout = new timeout_promise_1.default(this.timeout);
-                fetchWithOptionalTimeout.push(this.abortTimeout.start);
-            }
-            return Promise.race(fetchWithOptionalTimeout).then((data) => {
-                var _a;
-                (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
-                this.debug('response in %dms: %o', Date.now() - startTimestamp, data);
-                return Promise.resolve(data);
-            }, async (error) => {
-                var _a, _b;
-                (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
-                debug('response error: %o', error.response || error.message || error);
-                const status = ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) || error.code;
-                const shouldRetry = retryStrategy.shouldRetry(error, attempt, retries);
-                if (shouldRetry) {
-                    const delayMs = retryStrategy.getDelay(error, attempt);
-                    debug('Error: %s. Retrying in %dms (attempt %d).', status, delayMs, attempt);
-                    attempt++;
-                    return new Promise((resolve) => setTimeout(resolve, delayMs)).then(retryer);
-                }
-                else {
-                    return Promise.reject(error);
-                }
-            });
-        };
-        return retryer();
-    }
-}
-exports.GraphQLRequestClient = GraphQLRequestClient;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLRequestClient = void 0;
+const graphql_request_1 = require("graphql-request");
+const url_parse_1 = __importDefault(require("url-parse"));
+const debug_1 = __importDefault(require("./debug"));
+const timeout_promise_1 = __importDefault(require("./utils/timeout-promise"));
+const retries_1 = require("./retries");
+/**
+ * A GraphQL client for Sitecore APIs that uses the 'graphql-request' library.
+ * https://github.com/prisma-labs/graphql-request
+ * @public
+ */
+class GraphQLRequestClient {
+    /**
+     * Provides ability to execute graphql query using given `endpoint`
+     * @param {string} endpoint The Graphql endpoint
+     * @param {GraphQLRequestClientConfig} [clientConfig] GraphQL request client configuration.
+     */
+    constructor(endpoint, clientConfig = {}) {
+        var _a;
+        this.endpoint = endpoint;
+        this.headers = {};
+        if (clientConfig.apiKey) {
+            this.headers.sc_apikey = clientConfig.apiKey;
+        }
+        if (clientConfig.headers) {
+            this.headers = Object.assign(Object.assign({}, this.headers), clientConfig.headers);
+        }
+        if (!endpoint || !(0, url_parse_1.default)(endpoint).hostname) {
+            throw new Error(`Invalid GraphQL endpoint '${endpoint}'. Verify that appropriate environment variable is set`);
+        }
+        this.timeout = clientConfig.timeout;
+        this.retries = (_a = clientConfig.retries) !== null && _a !== void 0 ? _a : 3;
+        this.retryStrategy =
+            clientConfig.retryStrategy ||
+                new retries_1.DefaultRetryStrategy({ statusCodes: [429, 502, 503, 504, 520, 521, 522, 523, 524] });
+        this.client = new graphql_request_1.GraphQLClient(endpoint, {
+            headers: this.headers,
+            fetch: clientConfig.fetch,
+        });
+        this.debug = clientConfig.debugger || debug_1.default.http;
+    }
+    /**
+     * Factory method for creating a GraphQLRequestClientFactory.
+     * @param {object} config - client configuration options.
+     * @param {string} config.endpoint - endpoint
+     * @param {string} [config.apiKey] - apikey
+     */
+    static createClientFactory({ endpoint, apiKey, }) {
+        return (config = {}) => new GraphQLRequestClient(endpoint, Object.assign(Object.assign({}, config), { apiKey }));
+    }
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {RequestOptions} [options] Options for configuring a GraphQL request.
+     */
+    async request(query, variables, options) {
+        let attempt = 1;
+        const retryer = async () => {
+            const retries = (options === null || options === void 0 ? void 0 : options.retries) || this.retries;
+            const retryStrategy = (options === null || options === void 0 ? void 0 : options.retryStrategy) || this.retryStrategy;
+            const debug = (options === null || options === void 0 ? void 0 : options.debugger) || this.debug;
+            // Note we don't have access to raw request/response with graphql-request
+            // but we should log whatever we have.
+            debug('request: %o', {
+                url: this.endpoint,
+                headers: Object.assign(Object.assign({}, this.headers), options === null || options === void 0 ? void 0 : options.headers),
+                query,
+                variables,
+                timeout: this.timeout,
+            });
+            const startTimestamp = Date.now();
+            const headers = Object.assign(Object.assign({}, this.headers), options === null || options === void 0 ? void 0 : options.headers);
+            const fetchWithOptionalTimeout = [this.client.request(query, variables, headers)];
+            if (this.timeout) {
+                this.abortTimeout = new timeout_promise_1.default(this.timeout);
+                fetchWithOptionalTimeout.push(this.abortTimeout.start);
+            }
+            return Promise.race(fetchWithOptionalTimeout).then((data) => {
+                var _a;
+                (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
+                this.debug('response in %dms: %o', Date.now() - startTimestamp, data);
+                return Promise.resolve(data);
+            }, async (error) => {
+                var _a, _b;
+                (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
+                debug('response error: %o', error.response || error.message || error);
+                const status = ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) || error.code;
+                const shouldRetry = retryStrategy.shouldRetry(error, attempt, retries);
+                if (shouldRetry) {
+                    const delayMs = retryStrategy.getDelay(error, attempt);
+                    debug('Error: %s. Retrying in %dms (attempt %d).', status, delayMs, attempt);
+                    attempt++;
+                    return new Promise((resolve) => setTimeout(resolve, delayMs)).then(retryer);
+                }
+                else {
+                    return Promise.reject(error);
+                }
+            });
+        };
+        return retryer();
+    }
+}
+exports.GraphQLRequestClient = GraphQLRequestClient;

package/dist/cjs/i18n/dictionary-service.js

@@ -1,15 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DictionaryService = exports.queryError = void 0;
-const cache_client_1 = require("../cache-client");
-const constants_1 = require("../client/constants");
-const debug_1 = __importDefault(require("../debug"));
-/** @private */
-exports.queryError = 'Valid value for rootItemId not provided and failed to auto-resolve app root item.';
-/** @default */
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DictionaryService = exports.queryError = void 0;
+const cache_client_1 = require("../cache-client");
+const constants_1 = require("../client/constants");
+const debug_1 = __importDefault(require("../debug"));
+/** @private */
+exports.queryError = 'Valid value for rootItemId not provided and failed to auto-resolve app root item.';
+/** @default */
 const siteQuery = /* GraphQL */ `
   query DictionarySiteQuery(
     $siteName: String!
@@ -32,112 +32,113 @@ const siteQuery = /* GraphQL */ `
       }
     }
   }
-`;
-/**
- * Service that fetch dictionary data using Sitecore's GraphQL API.
- * @augments DictionaryServiceBase
- * @mixes SearchQueryService<DictionaryQueryResult>
- */
-class DictionaryService {
-    /**
-     * Creates an instance of graphQL dictionary service with the provided options
-     * @param {DictionaryService} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.cache = this.getCacheClient();
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    /**
-     * Fetches dictionary data for internalization. Uses search query by default
-     * @param {string} language the language to fetch
-     * @param {string} site site name to fetch data for.
-     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
-     * @returns {Promise<DictionaryPhrases>} dictionary phrases
-     * @throws {Error} if the app root was not found for the specified site and language.
-     */
-    async fetchDictionaryData(language, site, fetchOptions) {
-        var _a, _b;
-        const cacheKey = site + language;
-        const cachedValue = this.getCacheValue(cacheKey);
-        if (cachedValue) {
-            debug_1.default.dictionary('using cached dictionary data for %s %s', language, site);
-            return cachedValue;
-        }
-        const phrases = {};
-        debug_1.default.dictionary('fetching dictionary data for %s %s', language, site);
-        let results = [];
-        let hasNext = true;
-        let after = '';
-        if (!site) {
-            throw new RangeError(constants_1.siteNameError);
-        }
-        if (!language) {
-            throw new RangeError(constants_1.languageError);
-        }
-        while (hasNext) {
-            const fetchResponse = await this.graphQLClient.request(siteQuery, {
-                siteName: site,
-                language,
-                pageSize: this.options.pageSize,
-                after,
-            }, fetchOptions);
-            if ((_b = (_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
-                results = results.concat(fetchResponse.site.siteInfo.dictionary.results);
-                after = fetchResponse.site.siteInfo.dictionary.pageInfo.endCursor;
-                hasNext = fetchResponse.site.siteInfo.dictionary.pageInfo.hasNext;
-            }
-            else {
-                hasNext = false;
-            }
-        }
-        results.forEach((item) => (phrases[item.key] = item.value));
-        this.setCacheValue(cacheKey, phrases);
-        return phrases;
-    }
-    /**
-     * Caches a @see DictionaryPhrases value for the specified cache key.
-     * @param {string} key The cache key.
-     * @param {DictionaryPhrases} value The value to cache.
-     * @returns The value added to the cache.
-     * @mixes CacheClient<DictionaryPhrases>
-     */
-    setCacheValue(key, value) {
-        return this.cache.setCacheValue(key, value);
-    }
-    /**
-     * Retrieves a @see DictionaryPhrases value from the cache.
-     * @param {string} key The cache key.
-     * @returns The @see DictionaryPhrases value, or null if the specified key is not found in the cache.
-     */
-    getCacheValue(key) {
-        return this.cache.getCacheValue(key);
-    }
-    /**
-     * Gets a cache client that can cache data. Uses memory-cache as the default
-     * library for caching (@see MemoryCacheClient). Override this method if you
-     * want to use something else.
-     * @returns {CacheClient} implementation
-     */
-    getCacheClient() {
-        return new cache_client_1.MemoryCacheClient(this.options);
-    }
-    /**
-     * 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_1.default.dictionary,
-            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,
-        });
-    }
-}
-exports.DictionaryService = DictionaryService;
+`;
+/**
+ * Service that fetch dictionary data using Sitecore's GraphQL API.
+ * @augments DictionaryServiceBase
+ * @mixes SearchQueryService<DictionaryQueryResult>
+ * @public
+ */
+class DictionaryService {
+    /**
+     * Creates an instance of graphQL dictionary service with the provided options
+     * @param {DictionaryService} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.cache = this.getCacheClient();
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    /**
+     * Fetches dictionary data for internalization. Uses search query by default
+     * @param {string} language the language to fetch
+     * @param {string} site site name to fetch data for.
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {Promise<DictionaryPhrases>} dictionary phrases
+     * @throws {Error} if the app root was not found for the specified site and language.
+     */
+    async fetchDictionaryData(language, site, fetchOptions) {
+        var _a, _b;
+        const cacheKey = site + language;
+        const cachedValue = this.getCacheValue(cacheKey);
+        if (cachedValue) {
+            debug_1.default.dictionary('using cached dictionary data for %s %s', language, site);
+            return cachedValue;
+        }
+        const phrases = {};
+        debug_1.default.dictionary('fetching dictionary data for %s %s', language, site);
+        let results = [];
+        let hasNext = true;
+        let after = '';
+        if (!site) {
+            throw new RangeError(constants_1.siteNameError);
+        }
+        if (!language) {
+            throw new RangeError(constants_1.languageError);
+        }
+        while (hasNext) {
+            const fetchResponse = await this.graphQLClient.request(siteQuery, {
+                siteName: site,
+                language,
+                pageSize: this.options.pageSize,
+                after,
+            }, fetchOptions);
+            if ((_b = (_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
+                results = results.concat(fetchResponse.site.siteInfo.dictionary.results);
+                after = fetchResponse.site.siteInfo.dictionary.pageInfo.endCursor;
+                hasNext = fetchResponse.site.siteInfo.dictionary.pageInfo.hasNext;
+            }
+            else {
+                hasNext = false;
+            }
+        }
+        results.forEach((item) => (phrases[item.key] = item.value));
+        this.setCacheValue(cacheKey, phrases);
+        return phrases;
+    }
+    /**
+     * Caches a @see DictionaryPhrases value for the specified cache key.
+     * @param {string} key The cache key.
+     * @param {DictionaryPhrases} value The value to cache.
+     * @returns The value added to the cache.
+     * @mixes CacheClient<DictionaryPhrases>
+     */
+    setCacheValue(key, value) {
+        return this.cache.setCacheValue(key, value);
+    }
+    /**
+     * Retrieves a @see DictionaryPhrases value from the cache.
+     * @param {string} key The cache key.
+     * @returns The @see DictionaryPhrases value, or null if the specified key is not found in the cache.
+     */
+    getCacheValue(key) {
+        return this.cache.getCacheValue(key);
+    }
+    /**
+     * Gets a cache client that can cache data. Uses memory-cache as the default
+     * library for caching (@see MemoryCacheClient). Override this method if you
+     * want to use something else.
+     * @returns {CacheClient} implementation
+     */
+    getCacheClient() {
+        return new cache_client_1.MemoryCacheClient(this.options);
+    }
+    /**
+     * 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_1.default.dictionary,
+            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,
+        });
+    }
+}
+exports.DictionaryService = DictionaryService;

package/dist/cjs/i18n/index.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocaleRewrite = exports.DictionaryService = void 0;
-var dictionary_service_1 = require("./dictionary-service");
-Object.defineProperty(exports, "DictionaryService", { enumerable: true, get: function () { return dictionary_service_1.DictionaryService; } });
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "getLocaleRewrite", { enumerable: true, get: function () { return utils_1.getLocaleRewrite; } });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocaleRewrite = exports.DictionaryService = void 0;
+var dictionary_service_1 = require("./dictionary-service");
+Object.defineProperty(exports, "DictionaryService", { enumerable: true, get: function () { return dictionary_service_1.DictionaryService; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getLocaleRewrite", { enumerable: true, get: function () { return utils_1.getLocaleRewrite; } });

package/dist/cjs/i18n/utils.js

@@ -1,15 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocaleRewrite = getLocaleRewrite;
-/**
- * Get a locale rewrite path for given pathname
- * @param {string} pathname the pathname
- * @param {string} locale the site data to include in the rewrite
- * @returns {string} the rewrite path
- */
-function getLocaleRewrite(pathname, locale) {
-    if (pathname === '/')
-        return `/${locale}`;
-    const path = pathname.startsWith('/') ? pathname : '/' + pathname;
-    return `/${locale}${path}`;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocaleRewrite = getLocaleRewrite;
+/**
+ * Get a locale rewrite path for given pathname
+ * @param {string} pathname the pathname
+ * @param {string} locale the site data to include in the rewrite
+ * @returns {string} the rewrite path
+ * @public
+ */
+function getLocaleRewrite(pathname, locale) {
+    if (pathname === '/')
+        return `/${locale}`;
+    const path = pathname.startsWith('/') ? pathname : '/' + pathname;
+    return `/${locale}${path}`;
+}