@sitecore-content-sdk/core 0.1.0-beta.19 → 0.1.0-beta.20

package/dist/cjs/client/sitecore-client.js

@@ -28,8 +28,6 @@ class SitecoreClient {
         this.errorPagesService = this.getErrorPagesService();
         this.componentService = this.getComponentService();
         this.sitePathService = this.getSitePathService();
-        this.siteResolver = new site_1.SiteResolver(initOptions.sites);
-        this.editingService = new editing_1.GraphQLEditingService({ clientFactory: this.clientFactory });
     }
     /**
      * Resolve site by hostname
@@ -115,13 +113,13 @@ class SitecoreClient {
     }
     /**
      * Retrieves dictionary phrases for a given site and locale.
-     * @param {PageOptions} pageOptions - Route options containing language and site name to load dictionary for
+     * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
      * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
-    async getDictionary(pageOptions, fetchOptions) {
-        const locale = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.locale) || this.initOptions.defaultLanguage;
-        const site = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.site) || this.initOptions.defaultSite;
+    async getDictionary(routeOptions, fetchOptions) {
+        const locale = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale) || this.initOptions.defaultLanguage;
+        const site = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.site) || this.initOptions.defaultSite;
         return await this.dictionaryService.fetchDictionaryData(locale, site, fetchOptions);
     }
     /**
@@ -161,7 +159,6 @@ class SitecoreClient {
         const page = {
             locale: language,
             layout: data.layoutData,
-            headLinks: this.getHeadLinks(data.layoutData),
             dictionary: data.dictionary,
             site: data.layoutData.sitecore.context.site,
         };
@@ -199,7 +196,6 @@ class SitecoreClient {
         const page = {
             locale: componentLibData.language,
             layout: componentData,
-            headLinks: this.getHeadLinks(componentData),
             dictionary: dictionaryData,
         };
         return page;

package/dist/cjs/client/utils.js

@@ -5,7 +5,7 @@ const graphql_request_client_1 = require("../graphql-request-client");
 const graphql_edge_proxy_1 = require("./graphql-edge-proxy");
 /**
  * Creates a new GraphQLRequestClientFactory instance
- * @param {FetchOptions} options jss config
+ * @param {GraphQLClientOptions} options jss config
  * @returns GraphQLRequestClientFactory instance
  */
 const createGraphQLClientFactory = (options) => {

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

@@ -73,7 +73,8 @@ class GraphQLRequestClient {
                 timeout: this.timeout,
             });
             const startTimestamp = Date.now();
-            const fetchWithOptionalTimeout = [this.client.request(query, variables, options === null || options === void 0 ? void 0 : options.headers)];
+            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);

package/dist/esm/client/sitecore-client.js

@@ -25,8 +25,6 @@ export class SitecoreClient {
         this.errorPagesService = this.getErrorPagesService();
         this.componentService = this.getComponentService();
         this.sitePathService = this.getSitePathService();
-        this.siteResolver = new SiteResolver(initOptions.sites);
-        this.editingService = new GraphQLEditingService({ clientFactory: this.clientFactory });
     }
     /**
      * Resolve site by hostname
@@ -112,13 +110,13 @@ export class SitecoreClient {
     }
     /**
      * Retrieves dictionary phrases for a given site and locale.
-     * @param {PageOptions} pageOptions - Route options containing language and site name to load dictionary for
+     * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
      * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
-    async getDictionary(pageOptions, fetchOptions) {
-        const locale = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.locale) || this.initOptions.defaultLanguage;
-        const site = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.site) || this.initOptions.defaultSite;
+    async getDictionary(routeOptions, fetchOptions) {
+        const locale = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale) || this.initOptions.defaultLanguage;
+        const site = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.site) || this.initOptions.defaultSite;
         return await this.dictionaryService.fetchDictionaryData(locale, site, fetchOptions);
     }
     /**
@@ -158,7 +156,6 @@ export class SitecoreClient {
         const page = {
             locale: language,
             layout: data.layoutData,
-            headLinks: this.getHeadLinks(data.layoutData),
             dictionary: data.dictionary,
             site: data.layoutData.sitecore.context.site,
         };
@@ -196,7 +193,6 @@ export class SitecoreClient {
         const page = {
             locale: componentLibData.language,
             layout: componentData,
-            headLinks: this.getHeadLinks(componentData),
             dictionary: dictionaryData,
         };
         return page;

package/dist/esm/client/utils.js

@@ -2,7 +2,7 @@ import { GraphQLRequestClient } from '../graphql-request-client';
 import { getEdgeProxyContentUrl } from './graphql-edge-proxy';
 /**
  * Creates a new GraphQLRequestClientFactory instance
- * @param {FetchOptions} options jss config
+ * @param {GraphQLClientOptions} options jss config
  * @returns GraphQLRequestClientFactory instance
  */
 export const createGraphQLClientFactory = (options) => {

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

@@ -67,7 +67,8 @@ export class GraphQLRequestClient {
                 timeout: this.timeout,
             });
             const startTimestamp = Date.now();
-            const fetchWithOptionalTimeout = [this.client.request(query, variables, options === null || options === void 0 ? void 0 : options.headers)];
+            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 TimeoutPromise(this.timeout);
                 fetchWithOptionalTimeout.push(this.abortTimeout.start);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.1.0-beta.19",
+  "version": "0.1.0-beta.20",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -15,7 +15,7 @@
     "test": "mocha \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/graphql/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=22"
@@ -67,7 +67,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "a7c2c7af7497eb791b942e04f36a36feb06c9ea0",
+  "gitHead": "2e40659cd4f0858c509c8df228bf93f5b6d5c110",
   "files": [
     "dist",
     "types",

package/types/client/sitecore-client.d.ts

@@ -30,12 +30,57 @@ export type PageOptions = Partial<RouteOptions> & {
  * Contract for the Sitecore Client implementations
  */
 export interface BaseSitecoreClient {
+    /**
+     * Resolves site by request hostaname
+     * @param {string} hostname incoming request host name
+     * @returns {SiteInfo} site details including name, language and hostname
+     */
     resolveSite(hostname: string): SiteInfo;
+    /**
+     * Retrieves page layoutData and returns page details like language, layoutData and site info for current request
+     * @param {string} path current request path
+     * @param {PageOptions} pageOptions additional overrides like language, site name and personalization variants
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @returns {Page | null} page details when page layout is found and null when not
+     */
     getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
-    getDictionary(pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    /**
+     * Get dictionary data for a given site and locale.
+     * Can retrieve dictionary phrases for default site and language when page options not provided
+     * @param {RouteOptions} [routeOptions] language and site to load dictionary data for
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     */
+    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    /**
+     * Get error pages configured by SXA for a given site and locale
+     * @param {RouteOptions} [routeOptions] language and site to load error pages for
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     */
     getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
+    /**
+     * Get preview layout details based on details from EditingPreviewData input
+     * @param {EditingPreviewData | undefined} previewData preview details like route, site, language etc used to retrieve preview page and layout
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     */
     getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get route paths for all pages in the site. Can be used for static site generation.
+     * @param {string[]} [languages] languages to fetch routes in
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     */
     getPagePaths(languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    /**
+     * Retrieves the links to be loaded in app's <head> element for each page.
+     * @param {LayoutServiceData} layoutData - The layout data containing styles and themes.
+     * @param {object} [options] - Optional configuration for enabling styles and themes.
+     * @param {boolean} [options.enableStyles] - Whether to include content styles.
+     * @param {boolean} [options.enableThemes] - Whether to include theme styles.
+     * @returns {HTMLLink[]} An array of `<link>` elements.
+     */
+    getHeadLinks(layoutData: LayoutServiceData, options: {
+        enableStyles?: boolean;
+        enableThemes?: boolean;
+    }): HTMLLink[];
 }
 export interface BaseServiceOptions {
     defaultSite: string;
@@ -98,11 +143,11 @@ export declare class SitecoreClient implements BaseSitecoreClient {
     }): HTMLLink[];
     /**
      * Retrieves dictionary phrases for a given site and locale.
-     * @param {PageOptions} pageOptions - Route options containing language and site name to load dictionary for
+     * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
      * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
      * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
      */
-    getDictionary(pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
     /**
      * Retrieves error pages for a given site and locale.
      * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages

package/types/client/utils.d.ts

@@ -3,7 +3,7 @@ import { FetchOptions } from '../models';
 export type GraphQLClientOptions = Pick<SitecoreConfigInput, 'api'> & FetchOptions;
 /**
  * Creates a new GraphQLRequestClientFactory instance
- * @param {FetchOptions} options jss config
+ * @param {GraphQLClientOptions} options jss config
  * @returns GraphQLRequestClientFactory instance
  */
 export declare const createGraphQLClientFactory: (options: GraphQLClientOptions) => import("../graphql-request-client").GraphQLRequestClientFactory;

package/types/models.d.ts

@@ -1,5 +1,4 @@
 import { Debugger } from 'debug';
-import { SitecoreConfigInput } from './config';
 /**
  * Html <link> tag data model
  */
@@ -61,7 +60,7 @@ export interface PageInfo {
      */
     hasNext: boolean;
 }
-export type FetchOptions = Partial<Pick<SitecoreConfigInput, 'api'>> & {
+export type FetchOptions = {
     /**
      * Number of retries GraphQL client will attempt on request error
      */