@sitecore-content-sdk/core 0.1.0-beta.10 → 0.1.0-beta.12

package/dist/cjs/config/define-config.js

@@ -40,7 +40,7 @@ const getFallbackConfig = () => ({
         enabled: process.env.NODE_ENV !== 'development',
         edgeTimeout: 400,
         cdpTimeout: 400,
-        scope: undefined,
+        scope: '',
         channel: 'WEB',
         currency: 'USD',
     },
@@ -69,10 +69,10 @@ const deepMerge = (base, override) => {
             edge: Object.assign(Object.assign({}, (_a = base.api) === null || _a === void 0 ? void 0 : _a.edge), (_b = override.api) === null || _b === void 0 ? void 0 : _b.edge),
             local: Object.assign(Object.assign({}, (_c = base.api) === null || _c === void 0 ? void 0 : _c.local), (_d = override.api) === null || _d === void 0 ? void 0 : _d.local),
         }, retries: Object.assign(Object.assign({}, base.retries), override.retries), layout: Object.assign(Object.assign({}, base.layout), override.layout), multisite: Object.assign(Object.assign({}, base.multisite), override.multisite), personalize: Object.assign(Object.assign({}, base.personalize), override.personalize), redirects: Object.assign(Object.assign({}, base.redirects), override.redirects), dictionary: Object.assign(Object.assign({}, base.dictionary), override.dictionary) });
-    if (Number.isNaN(result.personalize.cdpTimeout)) {
+    if (Number.isNaN(result.personalize.cdpTimeout) || !result.personalize.cdpTimeout) {
         result.personalize.cdpTimeout = base.personalize.cdpTimeout;
     }
-    if (Number.isNaN(result.personalize.edgeTimeout)) {
+    if (Number.isNaN(result.personalize.edgeTimeout) || !result.personalize.edgeTimeout) {
         result.personalize.edgeTimeout = base.personalize.edgeTimeout;
     }
     // fallback in case only one context provided

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

@@ -68,6 +68,7 @@ class GraphQLRequestClient {
                 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 fetchWithOptionalTimeout = [this.client.request(query, variables, options === null || options === void 0 ? void 0 : options.headers)];

package/dist/esm/config/define-config.js

@@ -37,7 +37,7 @@ export const getFallbackConfig = () => ({
         enabled: process.env.NODE_ENV !== 'development',
         edgeTimeout: 400,
         cdpTimeout: 400,
-        scope: undefined,
+        scope: '',
         channel: 'WEB',
         currency: 'USD',
     },
@@ -65,10 +65,10 @@ const deepMerge = (base, override) => {
             edge: Object.assign(Object.assign({}, (_a = base.api) === null || _a === void 0 ? void 0 : _a.edge), (_b = override.api) === null || _b === void 0 ? void 0 : _b.edge),
             local: Object.assign(Object.assign({}, (_c = base.api) === null || _c === void 0 ? void 0 : _c.local), (_d = override.api) === null || _d === void 0 ? void 0 : _d.local),
         }, retries: Object.assign(Object.assign({}, base.retries), override.retries), layout: Object.assign(Object.assign({}, base.layout), override.layout), multisite: Object.assign(Object.assign({}, base.multisite), override.multisite), personalize: Object.assign(Object.assign({}, base.personalize), override.personalize), redirects: Object.assign(Object.assign({}, base.redirects), override.redirects), dictionary: Object.assign(Object.assign({}, base.dictionary), override.dictionary) });
-    if (Number.isNaN(result.personalize.cdpTimeout)) {
+    if (Number.isNaN(result.personalize.cdpTimeout) || !result.personalize.cdpTimeout) {
         result.personalize.cdpTimeout = base.personalize.cdpTimeout;
     }
-    if (Number.isNaN(result.personalize.edgeTimeout)) {
+    if (Number.isNaN(result.personalize.edgeTimeout) || !result.personalize.edgeTimeout) {
         result.personalize.edgeTimeout = base.personalize.edgeTimeout;
     }
     // fallback in case only one context provided

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

@@ -62,6 +62,7 @@ export class GraphQLRequestClient {
                 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 fetchWithOptionalTimeout = [this.client.request(query, variables, options === null || options === void 0 ? void 0 : options.headers)];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.1.0-beta.10",
+  "version": "0.1.0-beta.12",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -66,7 +66,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "1dc51369ca4096c7a49fa659201ac0cb66b9cfc8",
+  "gitHead": "8f504530a297cbf241a930173b104a0203c5d7bf",
   "files": [
     "dist",
     "types",

package/types/config/models.d.ts

@@ -18,48 +18,85 @@ export type SitecoreConfigInput = {
          * Edge endpoint credentials for Sitecore connection. Will be used to connect to SaaS XMCloud instance
          */
         edge?: {
-            contextId?: string;
+            /**
+             * A unified identifier used to connect and retrieve data from XM Cloud instance
+             */
+            contextId: string;
+            /**
+             * Optional identifier used to connect and retrieve data from XM Cloud instance in client-side functionality
+             */
             clientContextId?: string;
+            /**
+             * XM Cloud endpoint that the app will communicate and retrieve data from
+             * @default https://edge-platform.sitecorecloud.io
+             */
             edgeUrl?: string;
         };
         /**
          * API endpoint credentials for connection to local Sitecore instance
          */
         local?: {
-            apiKey?: string;
-            apiHost?: string;
+            /**
+             * Sitecore API key identifier used to connect to the GraphQL endpoint
+             */
+            apiKey: string;
+            /**
+             * Sitecore API hostname that the app will connect and retrieve data from
+             */
+            apiHost: string;
+            /**
+             * GraphQL endpoint path, will be appended to apiHost to form full enpoint URL ($apiHost/$path)
+             * @default /sitecore/api/graph/edge
+             */
             path?: string;
         };
     };
-    defaultSite?: string;
+    /**
+     * The default and fallback locale for your site.
+     * Ensure it aligns with the framework-specific settings used in your application.
+     */
     defaultLanguage: string;
+    /**
+     * Your default site name. When using the multisite feature this variable defines the fallback site.
+     */
+    defaultSite?: string;
     /**
      * Editing secret required to support Sitecore editing and preview functionality.
      */
     editingSecret?: string;
+    /**
+     * Retry configuration applied to Layout, Dictionary and ErrorPages services out of the box
+     */
     retries?: {
         /**
          * Number of retries for graphql client. Will use the specified `retryStrategy`.
+         * @default 3
          */
         count?: number;
         /**
-         * Retry strategy for the client. Uses `DefaultRetryStrategy` by default with exponential
+         * Retry strategy for the client. By default, uses exponential
          * back-off factor of 2 for codes 429, 502, 503, 504, 520, 521, 522, 523, 524.
+         * @default DefaultRetryStrategy
          */
         retryStrategy?: RetryStrategy;
     };
+    /**
+     * Settings for Layout Service
+     */
     layout?: {
         /**
-         * Override default layout query for Layout Service
-         * @param {string} siteName
-         * @param {string} itemPath
-         * @param {string} [locale]
+         * Override the first part of graphQL query for Layout Service (excluding the fields part)
+         * @param {string} siteName your site name
+         * @param {string} itemPath full path to Sitecore item/route
+         * @param {string} [locale] item/route language
          * @returns {string} custom layout query
-         * Layout query
-         * layout(site:"${siteName}", routePath:"${itemPath}", language:"${language}")
+         * @default 'layout(site:"${siteName}", routePath:"${itemPath}", language:"${language}")'
          */
         formatLayoutQuery?: ((siteName: string, itemPath: string, locale?: string) => string) | null;
     };
+    /**
+     * Settings for Dictionary Service
+     */
     dictionary?: {
         /**
          * configure local memory caching for Dictionary Service requests
@@ -69,7 +106,14 @@ export type SitecoreConfigInput = {
             timeout?: number;
         };
     };
-    multisite: {
+    /**
+     * Settings for multisite functionaliry
+     */
+    multisite?: {
+        /**
+         * Enable multisite
+         * @default true
+         */
         enabled?: boolean;
         /**
          * Fallback hostname in case `host` header is not present
@@ -81,7 +125,14 @@ export type SitecoreConfigInput = {
          */
         useCookieResolution?: (req?: RequestInit, res?: ResponseInit) => boolean;
     };
-    personalize: {
+    /**
+     * Setting for personalize functionality
+     */
+    personalize?: {
+        /**
+         * Enable personalize middleware
+         * @default process.env.NODE_ENV !== 'development'
+         */
         enabled?: boolean;
         /**
          * Configuration for your Sitecore Experience Edge endpoint
@@ -94,21 +145,28 @@ export type SitecoreConfigInput = {
         /**
          * Optional Sitecore Personalize scope identifier allowing you to isolate your personalization data between XM Cloud environments
          */
-        scope: string | undefined;
+        scope?: string;
         /**
          * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
          */
-        channel?: string | undefined;
+        channel?: string;
         /**
          * Currency for CDP request. Uses 'USA' as default.
          */
-        currency?: string | undefined;
+        currency?: string;
     };
-    redirects: {
+    /**
+     * Settings for redirects functionality
+     */
+    redirects?: {
+        /**
+         * Enable redirects middleware
+         * @default process.env.NODE_ENV !== 'development'
+         */
         enabled?: boolean;
         /**
          * These are all the locales you support in your application.
-         * These should match those in your next.config.js (i18n.locales).
+         * These should match those in framework-specific configuration of your app.
          */
         locales?: string[];
     };