@sitecore-jss/sitecore-jss 0.1.0-beta.2

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,7 @@
+# Sitecore JavaScript Rendering SDK
+
+This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains the core JSS APIs and utilities.
+
+[Documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdks--jss-.html)
+
+[API reference documentation](/ref-docs/sitecore-jss/)

package/dist/cjs/cache-client.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryCacheClient = void 0;
+const memory_cache_1 = require("memory-cache");
+/**
+ * Default cache configuration
+ */
+const DEFAULTS = Object.freeze({
+    cacheTimeout: 60,
+    cacheEnabled: true,
+});
+/**
+ * A cache client that uses the 'memory-cache' library (https://github.com/ptarjan/node-cache).
+ * This class is meant to be extended or used as a mixin; it's not meant to be used directly.
+ * @template T The type of data being cached.
+ * @mixin
+ */
+class MemoryCacheClient {
+    /**
+     * Initializes a new instance of @see MemoryCacheClient using the provided @see CacheOptions
+     * @param {CacheOptions} options Configuration options
+     */
+    constructor(options) {
+        var _a;
+        this.options = options;
+        this.cache = new memory_cache_1.Cache();
+        this.options.cacheTimeout = ((_a = this.options.cacheTimeout) !== null && _a !== void 0 ? _a : DEFAULTS.cacheTimeout) * 1000;
+        if (this.options.cacheEnabled === undefined) {
+            this.options.cacheEnabled = DEFAULTS.cacheEnabled;
+        }
+    }
+    /**
+     * Retrieves a value from the cache.
+     * @template T The type of data being cached.
+     * @param {string} key The cache key.
+     * @returns The cache value as {T}, or null if the specified key is not found in the cache.
+     */
+    getCacheValue(key) {
+        return this.options.cacheEnabled ? this.cache.get(key) : null;
+    }
+    /**
+     * Adds a value to the cache for the specified cache key.
+     * @template T The type of data being cached.
+     * @param {string} key The cache key.
+     * @param {T} value The value to cache.
+     * @returns The value added to the cache.
+     */
+    setCacheValue(key, value) {
+        return this.options.cacheEnabled
+            ? this.cache.put(key, value, this.options.cacheTimeout)
+            : value;
+    }
+}
+exports.MemoryCacheClient = MemoryCacheClient;

package/dist/cjs/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SITECORE_EDGE_URL_DEFAULT = exports.siteNameError = exports.SitecoreTemplateId = void 0;
+var SitecoreTemplateId;
+(function (SitecoreTemplateId) {
+    // /sitecore/templates/Foundation/JavaScript Services/App
+    SitecoreTemplateId["JssApp"] = "061cba1554744b918a0617903b102b82";
+    // /sitecore/templates/System/Dictionary/Dictionary entry
+    SitecoreTemplateId["DictionaryEntry"] = "6d1cd89719364a3aa511289a94c2a7b1";
+})(SitecoreTemplateId = exports.SitecoreTemplateId || (exports.SitecoreTemplateId = {}));
+exports.siteNameError = 'The siteName cannot be empty';
+exports.SITECORE_EDGE_URL_DEFAULT = 'https://edge-platform.sitecorecloud.io';

package/dist/cjs/debug.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableDebug = void 0;
+const debug_1 = __importDefault(require("debug"));
+const is_server_1 = __importDefault(require("./utils/is-server"));
+const rootNamespace = 'sitecore-jss';
+// On server/node side, allow switching from the built-in
+// `%o` (pretty-print single line) and `%O` (pretty-print multiple line)
+// with a `DEBUG_MULTILINE` environment variable.
+if (is_server_1.default() &&
+    ((_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.DEBUG_MULTILINE) === 'true' &&
+    debug_1.default.formatters.o &&
+    debug_1.default.formatters.O) {
+    debug_1.default.formatters.o = debug_1.default.formatters.O;
+}
+/**
+ * Enable debug logging dynamically
+ * @param {string} namespaces space-separated list of namespaces to enable
+ */
+const enableDebug = (namespaces) => debug_1.default.enable(namespaces);
+exports.enableDebug = enableDebug;
+/**
+ * Default Sitecore JSS 'debug' module debuggers. Uses namespace prefix 'sitecore-jss:'.
+ * See {@link https://www.npmjs.com/package/debug} for details.
+ */
+exports.default = {
+    common: debug_1.default(`${rootNamespace}:common`),
+    http: debug_1.default(`${rootNamespace}:http`),
+    layout: debug_1.default(`${rootNamespace}:layout`),
+    dictionary: debug_1.default(`${rootNamespace}:dictionary`),
+    editing: debug_1.default(`${rootNamespace}:editing`),
+    sitemap: debug_1.default(`${rootNamespace}:sitemap`),
+    multisite: debug_1.default(`${rootNamespace}:multisite`),
+    robots: debug_1.default(`${rootNamespace}:robots`),
+    redirects: debug_1.default(`${rootNamespace}:redirects`),
+    personalize: debug_1.default(`${rootNamespace}:personalize`),
+    errorpages: debug_1.default(`${rootNamespace}:errorpages`),
+    revalidate: debug_1.default(`${rootNamespace}:revalidate`),
+};

package/dist/cjs/graphql/app-root-query.js

@@ -0,0 +1,73 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppRootId = exports.languageError = exports.siteNameError = void 0;
+const constants_1 = require("../constants");
+/** @private */
+exports.siteNameError = 'The site name must be a non-empty string';
+/** @private */
+exports.languageError = 'The language must be a non-empty string';
+/*
+ * GraphQL query that returns the ID of the root item of the specified site and language
+ */
+const appRootQuery = /* GraphQL */ `
+  query AppRootQuery($jssAppTemplateId: String!, $siteName: String!, $language: String!) {
+    layout(site: $siteName, routePath: "/", language: $language) {
+      homePage: item {
+        rootItem: ancestors(includeTemplateIDs: [$jssAppTemplateId]) {
+          id
+        }
+      }
+    }
+  }
+`;
+/**
+ * Gets the ID of the JSS App root item for the specified site and language.
+ * @param {GraphQLClient} client that fetches data from a GraphQL endpoint.
+ * @param {string} siteName the name of the Sitecore site.
+ * @param {string} language the item language version.
+ * @param {string} [jssAppTemplateId] optional template ID of the app root item. If not
+ * specified, the ID of the "/sitecore/templates/Foundation/JavaScript Services/App"
+ * item is used.
+ * @returns the root item ID of the JSS App in Sitecore. Returns null if the app root item is not found.
+ * @throws {RangeError} if a valid site name value is not provided.
+ * @throws {RangeError} if a valid language value is not provided.
+ * @summary This function intentionally avoids throwing an error if a root item is not found,
+ * leaving that decision up to implementations.
+ */
+function getAppRootId(client, siteName, language, jssAppTemplateId) {
+    var _a, _b, _c, _d, _e, _f;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!siteName) {
+            throw new RangeError(exports.siteNameError);
+        }
+        if (!language) {
+            throw new RangeError(exports.languageError);
+        }
+        let fetchResponse = yield client.request(appRootQuery, {
+            jssAppTemplateId: jssAppTemplateId || constants_1.SitecoreTemplateId.JssApp,
+            siteName,
+            language,
+        });
+        if (!((_c = (_b = (_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.layout) === null || _a === void 0 ? void 0 : _a.homePage) === null || _b === void 0 ? void 0 : _b.rootItem) === null || _c === void 0 ? void 0 : _c.length) && language !== 'en') {
+            fetchResponse = yield client.request(appRootQuery, {
+                jssAppTemplateId: jssAppTemplateId || constants_1.SitecoreTemplateId.JssApp,
+                siteName,
+                language: 'en',
+            });
+        }
+        if (!((_f = (_e = (_d = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.layout) === null || _d === void 0 ? void 0 : _d.homePage) === null || _e === void 0 ? void 0 : _e.rootItem) === null || _f === void 0 ? void 0 : _f.length)) {
+            return null;
+        }
+        return fetchResponse.layout.homePage.rootItem[0].id;
+    });
+}
+exports.getAppRootId = getAppRootId;

package/dist/cjs/graphql/graphql-edge-proxy.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEdgeProxyContentUrl = void 0;
+const constants_1 = require("../constants");
+/**
+ * Generates a URL for accessing Sitecore Edge Platform Content using the provided endpoint and context ID.
+ * @param {string} sitecoreEdgeContextId - The unique context id.
+ * @param {string} [sitecoreEdgeUrl] - The base endpoint URL for the Edge Platform. Default is https://edge-platform.sitecorecloud.io
+ * @returns {string} The complete URL for accessing content through the Edge Platform.
+ */
+const getEdgeProxyContentUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${sitecoreEdgeUrl}/v1/content/api/graphql/v1?sitecoreContextId=${sitecoreEdgeContextId}`;
+exports.getEdgeProxyContentUrl = getEdgeProxyContentUrl;

package/dist/cjs/graphql/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEdgeProxyContentUrl = exports.SearchQueryService = exports.GraphQLRequestClient = exports.getAppRootId = void 0;
+var app_root_query_1 = require("./app-root-query");
+Object.defineProperty(exports, "getAppRootId", { enumerable: true, get: function () { return app_root_query_1.getAppRootId; } });
+var graphql_request_client_1 = require("./../graphql-request-client");
+Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_request_client_1.GraphQLRequestClient; } });
+var search_service_1 = require("./search-service");
+Object.defineProperty(exports, "SearchQueryService", { enumerable: true, get: function () { return search_service_1.SearchQueryService; } });
+var graphql_edge_proxy_1 = require("./graphql-edge-proxy");
+Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_edge_proxy_1.getEdgeProxyContentUrl; } });

package/dist/cjs/graphql/search-service.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchQueryService = void 0;
+/**
+ * Provides functionality for performing GraphQL 'search' operations, including handling pagination.
+ * This class is meant to be extended or used as a mixin; it's not meant to be used directly.
+ * @template T The type of objects being requested.
+ * @mixin
+ */
+class SearchQueryService {
+    /**
+     * Creates an instance of search query service.
+     * @param {GraphQLClient} client that fetches data from a GraphQL endpoint.
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * 1. Validates mandatory search query arguments
+     * 2. Executes search query with pagination
+     * 3. Aggregates pagination results into a single result-set.
+     * @template T The type of objects being requested.
+     * @param {string | DocumentNode} query the search query.
+     * @param {SearchQueryVariables} args search query arguments.
+     * @returns {T[]} array of result objects.
+     * @throws {RangeError} if a valid root item ID is not provided.
+     * @throws {RangeError} if the provided language(s) is(are) not valid.
+     */
+    fetch(query, args) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!args.rootItemId) {
+                throw new RangeError('"rootItemId" and "language" must be non-empty strings');
+            }
+            if (!args.language) {
+                throw new RangeError('"rootItemId" and "language" must be non-empty strings');
+            }
+            let results = [];
+            let hasNext = true;
+            let after = '';
+            while (hasNext) {
+                const fetchResponse = yield this.client.request(query, Object.assign(Object.assign({}, args), { after }));
+                results = results.concat((_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.search) === null || _a === void 0 ? void 0 : _a.results);
+                hasNext = fetchResponse.search.pageInfo.hasNext;
+                after = fetchResponse.search.pageInfo.endCursor;
+            }
+            return results;
+        });
+    }
+}
+exports.SearchQueryService = SearchQueryService;

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

@@ -0,0 +1,106 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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"));
+/**
+ * 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 = {}) {
+        this.endpoint = endpoint;
+        this.headers = {};
+        if (clientConfig.apiKey) {
+            this.headers.sc_apikey = clientConfig.apiKey;
+        }
+        if (!endpoint || !url_parse_1.default(endpoint).hostname) {
+            throw new Error(`Invalid GraphQL endpoint '${endpoint}'. Verify that 'layoutServiceHost' property in 'scjssconfig.json' file or appropriate environment variable is set`);
+        }
+        this.timeout = clientConfig.timeout;
+        this.retries = clientConfig.retries || 0;
+        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 {Object} variables graphql variables
+     */
+    request(query, variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let retriesLeft = this.retries;
+            const retryer = () => __awaiter(this, void 0, void 0, function* () {
+                // Note we don't have access to raw request/response with graphql-request
+                // but we should log whatever we have.
+                this.debug('request: %o', {
+                    url: this.endpoint,
+                    headers: this.headers,
+                    query,
+                    variables,
+                });
+                const startTimestamp = Date.now();
+                const fetchWithOptionalTimeout = [this.client.request(query, variables)];
+                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);
+                }, (error) => {
+                    var _a, _b, _c, _d;
+                    (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
+                    this.debug('response error: %o', error.response || error.message || error);
+                    if (((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) === 429 && retriesLeft > 0) {
+                        const rawHeaders = (_d = (_c = error) === null || _c === void 0 ? void 0 : _c.response) === null || _d === void 0 ? void 0 : _d.headers;
+                        const delaySeconds = rawHeaders && rawHeaders.get('Retry-After')
+                            ? Number.parseInt(rawHeaders.get('Retry-After'), 10)
+                            : 1;
+                        this.debug('Error: Rate limit reached for GraphQL endpoint. Retrying in %ds. Retries left: %d', delaySeconds, retriesLeft);
+                        retriesLeft--;
+                        return new Promise((resolve) => setTimeout(resolve, delaySeconds * 1000)).then(retryer);
+                    }
+                    else {
+                        return Promise.reject(error);
+                    }
+                });
+            });
+            return retryer();
+        });
+    }
+}
+exports.GraphQLRequestClient = GraphQLRequestClient;

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

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DictionaryServiceBase = void 0;
+const cache_client_1 = require("../cache-client");
+/**
+ * Base implementation of @see DictionaryService that handles caching dictionary values
+ */
+class DictionaryServiceBase {
+    /**
+     * Initializes a new instance of @see DictionaryService using the provided @see CacheOptions
+     * @param {CacheOptions} options Configuration options
+     */
+    constructor(options) {
+        this.options = options;
+        this.cache = this.getCacheClient();
+    }
+    /**
+     * 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);
+    }
+}
+exports.DictionaryServiceBase = DictionaryServiceBase;