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

package/README.md

@@ -1,7 +1,7 @@
-# Sitecore Content SDK Core
-
-This module is provided as a part of Sitecore Content SDK. It contains the core Sitecore Content SDK APIs and utilities.
-
-[Documentation](https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html)
-
-[API reference documentation](/ref-docs/core/)
+# Sitecore Content SDK Core
+
+This module is provided as a part of Sitecore Content SDK. It contains the core Sitecore Content SDK APIs and utilities.
+
+[Documentation](https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html)
+
+[API reference documentation](/ref-docs/core/)

package/dist/cjs/cache-client.js

@@ -1,54 +1,55 @@
-"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;
+"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
+ * @public
+ */
+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/client/constants.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.languageError = exports.siteNameError = void 0;
-/** @private */
-exports.siteNameError = 'The site name must be a non-empty string';
-/** @private */
-exports.languageError = 'The language must be a non-empty string';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.languageError = exports.siteNameError = void 0;
+/** @private */
+exports.siteNameError = 'The site name must be a non-empty string';
+/** @private */
+exports.languageError = 'The language must be a non-empty string';

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

@@ -1,22 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = void 0;
-const constants_1 = require("../constants");
-const normalize_url_1 = require("../utils/normalize-url");
-/**
- * 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) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/content/api/graphql/v1?sitecoreContextId=${sitecoreEdgeContextId}`;
-exports.getEdgeProxyContentUrl = getEdgeProxyContentUrl;
-/**
- * Generates a URL for accessing Sitecore Edge Platform Forms using the provided form ID and context ID.
- * @param {string} sitecoreEdgeContextId - The unique context id.
- * @param {string} formId - The unique form 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 forms through the Edge Platform.
- */
-const getEdgeProxyFormsUrl = (sitecoreEdgeContextId, formId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/forms/publisher/${formId}?sitecoreContextId=${sitecoreEdgeContextId}`;
-exports.getEdgeProxyFormsUrl = getEdgeProxyFormsUrl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = void 0;
+const constants_1 = require("../constants");
+const normalize_url_1 = require("../utils/normalize-url");
+/**
+ * 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.
+ * @public
+ */
+const getEdgeProxyContentUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/content/api/graphql/v1?sitecoreContextId=${sitecoreEdgeContextId}`;
+exports.getEdgeProxyContentUrl = getEdgeProxyContentUrl;
+/**
+ * Generates a URL for accessing Sitecore Edge Platform Forms using the provided form ID and context ID.
+ * @param {string} sitecoreEdgeContextId - The unique context id.
+ * @param {string} formId - The unique form 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 forms through the Edge Platform.
+ * @internal
+ */
+const getEdgeProxyFormsUrl = (sitecoreEdgeContextId, formId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/forms/publisher/${formId}?sitecoreContextId=${sitecoreEdgeContextId}`;
+exports.getEdgeProxyFormsUrl = getEdgeProxyFormsUrl;

package/dist/cjs/client/index.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGraphQLClientFactory = exports.ErrorPage = exports.SitecoreClient = exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = exports.DefaultRetryStrategy = exports.GraphQLRequestClient = void 0;
-var graphql_request_client_1 = require("../graphql-request-client");
-Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_request_client_1.GraphQLRequestClient; } });
-var retries_1 = require("../retries");
-Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return retries_1.DefaultRetryStrategy; } });
-var edge_proxy_1 = require("./edge-proxy");
-Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return edge_proxy_1.getEdgeProxyContentUrl; } });
-Object.defineProperty(exports, "getEdgeProxyFormsUrl", { enumerable: true, get: function () { return edge_proxy_1.getEdgeProxyFormsUrl; } });
-var sitecore_client_1 = require("./sitecore-client");
-Object.defineProperty(exports, "SitecoreClient", { enumerable: true, get: function () { return sitecore_client_1.SitecoreClient; } });
-Object.defineProperty(exports, "ErrorPage", { enumerable: true, get: function () { return sitecore_client_1.ErrorPage; } });
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "createGraphQLClientFactory", { enumerable: true, get: function () { return utils_1.createGraphQLClientFactory; } });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGraphQLClientFactory = exports.ErrorPage = exports.SitecoreClient = exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = exports.DefaultRetryStrategy = exports.GraphQLRequestClient = void 0;
+var graphql_request_client_1 = require("../graphql-request-client");
+Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_request_client_1.GraphQLRequestClient; } });
+var retries_1 = require("../retries");
+Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return retries_1.DefaultRetryStrategy; } });
+var edge_proxy_1 = require("./edge-proxy");
+Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return edge_proxy_1.getEdgeProxyContentUrl; } });
+Object.defineProperty(exports, "getEdgeProxyFormsUrl", { enumerable: true, get: function () { return edge_proxy_1.getEdgeProxyFormsUrl; } });
+var sitecore_client_1 = require("./sitecore-client");
+Object.defineProperty(exports, "SitecoreClient", { enumerable: true, get: function () { return sitecore_client_1.SitecoreClient; } });
+Object.defineProperty(exports, "ErrorPage", { enumerable: true, get: function () { return sitecore_client_1.ErrorPage; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "createGraphQLClientFactory", { enumerable: true, get: function () { return utils_1.createGraphQLClientFactory; } });

package/dist/cjs/client/models.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });