@sitecore-content-sdk/content 1.5.0-canary.5

package/package.json

@@ -0,0 +1,157 @@
+{
+  "name": "@sitecore-content-sdk/content",
+  "version": "1.5.0-canary.5",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
+    "clean": "del-cli dist types",
+    "lint": "eslint \"./src/**/*.ts\"",
+    "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/content --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/config-cli/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/editing/index.ts --entryPoints src/tools/index.ts --entryPoints src/codegen/index.ts --githubPages false",
+    "api-extractor": "npm run build && api-extractor run --local --verbose",
+    "api-extractor:verify": "api-extractor run"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "author": {
+    "name": "Sitecore Corporation",
+    "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Sitecore/content-sdk"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html",
+  "bugs": {
+    "url": "https://github.com/sitecore/content-sdk/issues"
+  },
+  "devDependencies": {
+    "@sitecore-cloudsdk/events": "^0.5.1",
+    "@stylistic/eslint-plugin": "^5.2.2",
+    "@types/chai": "^5.2.2",
+    "@types/chai-spies": "^1.0.6",
+    "@types/chai-string": "^1.4.5",
+    "@types/debug": "^4.1.12",
+    "@types/jsdom": "^21.1.7",
+    "@types/memory-cache": "^0.2.6",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.10.4",
+    "@types/proxyquire": "^1.3.31",
+    "@types/sinon": "^17.0.4",
+    "@types/sinon-chai": "^4.0.0",
+    "@types/url-parse": "1.4.11",
+    "@typescript-eslint/eslint-plugin": "8.39.0",
+    "@typescript-eslint/parser": "8.39.0",
+    "chai": "^4.4.1",
+    "chai-spies": "^1.1.0",
+    "chai-string": "^1.6.0",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-jsdoc": "52.0.3",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jsdom": "^26.1.0",
+    "mocha": "^11.2.2",
+    "nock": "14.0.0-beta.7",
+    "nyc": "^17.1.0",
+    "prettier": "^2.8.0",
+    "proxyquire": "^2.1.3",
+    "sinon": "^20.0.0",
+    "sinon-chai": "^4.0.0",
+    "tslib": "^2.8.1",
+    "tsx": "^4.19.4",
+    "typescript": "~5.8.3"
+  },
+  "peerDependencies": {
+    "@sitecore-cloudsdk/events": "^0.5.1"
+  },
+  "dependencies": {
+    "@sitecore-content-sdk/core": "1.5.0-canary.5",
+    "chalk": "^4.1.2",
+    "debug": "^4.4.0",
+    "glob": "^11.0.2",
+    "graphql": "^16.11.0",
+    "url-parse": "^1.5.10"
+  },
+  "description": "",
+  "types": "types/index.d.ts",
+  "gitHead": "e8fa7da15d05d45f474b4f000c1f361b488466b0",
+  "files": [
+    "dist",
+    "types",
+    "/*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./client": {
+      "import": "./dist/esm/client/index.js",
+      "require": "./dist/cjs/client/index.js",
+      "types": "./types/client/index.d.ts"
+    },
+    "./config": {
+      "import": "./dist/esm/config/index.js",
+      "require": "./dist/cjs/config/index.js",
+      "types": "./types/config/index.d.ts"
+    },
+    "./config-cli": {
+      "import": "./dist/esm/config-cli/index.js",
+      "require": "./dist/cjs/config-cli/index.js",
+      "types": "./types/config-cli/index.d.ts"
+    },
+    "./codegen": {
+      "import": "./dist/esm/editing/codegen/index.js",
+      "require": "./dist/cjs/editing/codegen/index.js",
+      "types": "./types/editing/codegen/index.d.ts"
+    },
+    "./editing": {
+      "import": "./dist/esm/editing/index.js",
+      "require": "./dist/cjs/editing/index.js",
+      "types": "./types/editing/index.d.ts"
+    },
+    "./i18n": {
+      "import": "./dist/esm/i18n/index.js",
+      "require": "./dist/cjs/i18n/index.js",
+      "types": "./types/i18n/index.d.ts"
+    },
+    "./layout": {
+      "import": "./dist/esm/layout/index.js",
+      "require": "./dist/cjs/layout/index.js",
+      "types": "./types/layout/index.d.ts"
+    },
+    "./media": {
+      "import": "./dist/esm/media/index.js",
+      "require": "./dist/cjs/media/index.js",
+      "types": "./types/media/index.d.ts"
+    },
+    "./personalize": {
+      "import": "./dist/esm/personalize/index.js",
+      "require": "./dist/cjs/personalize/index.js",
+      "types": "./types/personalize/index.d.ts"
+    },
+    "./site": {
+      "import": "./dist/esm/site/index.js",
+      "require": "./dist/cjs/site/index.js",
+      "types": "./types/site/index.d.ts"
+    },
+    "./tools": {
+      "import": "./dist/esm/tools/index.js",
+      "require": "./dist/cjs/tools/index.js",
+      "types": "./types/tools/index.d.ts"
+    }
+  }
+}

package/personalize.d.ts

@@ -0,0 +1 @@
+export * from './types/personalize/index';

package/site.d.ts

@@ -0,0 +1 @@
+export * from './types/site/index';

package/tools.d.ts

@@ -0,0 +1 @@
+export * from './types/tools/index';

package/types/client/edge-proxy.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generates a URL for accessing Sitecore Edge Platform Content using the provided endpoint and 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
+ */
+export declare const getEdgeProxyContentUrl: (sitecoreEdgeUrl?: string) => string;
+/**
+ * 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
+ */
+export declare const getEdgeProxyFormsUrl: (sitecoreEdgeContextId: string, formId: string, sitecoreEdgeUrl?: string) => string;
+//# sourceMappingURL=edge-proxy.d.ts.map

package/types/client/edge-proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge-proxy.d.ts","sourceRoot":"","sources":["../../src/client/edge-proxy.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,wBAA2C,WACpB,CAAC;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,uBAAuB,MAAM,EAC7B,QAAQ,MAAM,EACd,wBAA2C,WAIgC,CAAC"}

package/types/client/index.d.ts

@@ -0,0 +1,7 @@
+export { GraphQLClientError, GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, DefaultRetryStrategy, RetryStrategy, FetchOptions } from '@sitecore-content-sdk/core';
+export { PageInfo } from '../models';
+export { getEdgeProxyContentUrl, getEdgeProxyFormsUrl } from './edge-proxy';
+export { SitecoreClient, Page, PageOptions, SitemapXmlOptions, PageMode, ErrorPage, } from './sitecore-client';
+export { SitecoreClientInit } from './models';
+export { createGraphQLClientFactory, GraphQLClientOptions } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/types/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,iCAAiC,EACjC,oBAAoB,EACpB,aAAa,EACb,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,EACL,cAAc,EACd,IAAI,EACJ,WAAW,EACX,iBAAiB,EACjB,QAAQ,EACR,SAAS,GACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC"}

package/types/client/models.d.ts

@@ -0,0 +1,21 @@
+import { SitecoreConfig } from '../config';
+import { EditingService } from '../editing/editing-service';
+import { ComponentLayoutService } from '../editing/component-layout-service';
+import { DictionaryService } from '../i18n/dictionary-service';
+import { LayoutService } from '../layout/layout-service';
+import { ErrorPagesService, SitePathService } from '../site';
+/**
+ * Init options for Sitecore Client that allows you to override services too
+ * @public
+ */
+export type SitecoreClientInit = Omit<SitecoreConfig, 'multisite' | 'redirects' | 'personalize'> & {
+    custom?: {
+        layoutService?: LayoutService;
+        dictionaryService?: DictionaryService;
+        editingService?: EditingService;
+        errorPagesService?: ErrorPagesService;
+        componentService?: ComponentLayoutService;
+        sitePathService?: SitePathService;
+    };
+};
+//# sourceMappingURL=models.d.ts.map

package/types/client/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/client/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,WAAW,GAAG,aAAa,CAAC,GAAG;IACjG,MAAM,CAAC,EAAE;QACP,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;QAC1C,eAAe,CAAC,EAAE,eAAe,CAAC;KACnC,CAAC;CACH,CAAC"}

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

@@ -0,0 +1,338 @@
+import { DocumentNode } from 'graphql';
+import { GraphQLClient, GraphQLRequestClientFactory, FetchOptions, RetryStrategy } from '@sitecore-content-sdk/core';
+import { DictionaryPhrases, DictionaryService } from '../i18n';
+import { LayoutService, LayoutServiceData, RouteOptions, LayoutServicePageState } from '../layout';
+import { HTMLLink, StaticPath } from '../models';
+import { PersonalizedRewriteData } from '../personalize/utils';
+import { ErrorPages, ErrorPagesService, SitePathService, SitemapXmlService } from '../site';
+import { SitecoreClientInit } from './models';
+import { RobotsService } from '../site/robots-service';
+import { DesignLibraryRenderPreviewData, EditingPreviewData, EditingService, ComponentLayoutService, DesignLibraryMode } from '../editing';
+/**
+ * Error page codes
+ * @public
+ */
+export declare enum ErrorPage {
+    NotFound = "404",
+    InternalServerError = "500"
+}
+/**
+ * Page mode name
+ * @public
+ */
+type PageModeName = LayoutServicePageState | DesignLibraryMode;
+/**
+ * Represents the mode of the page
+ * @public
+ */
+export type PageMode = {
+    /**
+     * Page mode name.
+     */
+    name: PageModeName;
+    /**
+     * Design Library related properties. Only available in Design Library mode.
+     */
+    designLibrary: {
+        /**
+         * Whether the page is in variant generation mode
+         */
+        isVariantGeneration: boolean;
+    };
+    /**
+     * Whether the page is in normal mode
+     */
+    isNormal: boolean;
+    /**
+     * Whether the page is in preview mode
+     */
+    isPreview: boolean;
+    /**
+     * Whether the page is in editing mode
+     */
+    isEditing: boolean;
+    /**
+     * Whether the page is in Design Library mode
+     */
+    isDesignLibrary: boolean;
+};
+/**
+ * Represent a Page model returned from Edge endpoint
+ * @public
+ */
+export type Page = {
+    /**
+     * Layout details and props for the page
+     */
+    layout: LayoutServiceData;
+    /**
+     * Site name for current page / route
+     */
+    siteName?: string;
+    /**
+     * Route locale
+     */
+    locale: string;
+    /**
+     * Page mode
+     */
+    mode: PageMode;
+};
+/**
+ * Page options
+ * @public
+ */
+export type PageOptions = Partial<RouteOptions> & {
+    personalize?: PersonalizedRewriteData;
+};
+/**
+ * Request options for the getSiteMap method
+ * @public
+ */
+export type SitemapXmlOptions = {
+    /** The hostname from the request (e.g., 'example.com') */
+    reqHost: string;
+    /** The protocol from request headers (e.g., 'https' or 'http') */
+    reqProtocol: string | string[];
+    /** Optional sitemap identifier when requesting a specific sitemap */
+    id?: string;
+    /** The site name to resolve the sitemap for */
+    siteName?: string;
+};
+/**
+ * Options for fetching robots.txt content.
+ */
+export type RobotsOptions = {
+    /**
+     * The name of the site for which to fetch robots.txt content.
+     */
+    siteName: string;
+};
+/**
+ * Contract for the Sitecore Client implementations
+ */
+export interface BaseSitecoreClient {
+    /**
+     * Execute a raw GraphQL request using the client's configured GraphQL endpoint(s).
+     * This is a thin pass-through to the underlying {@link GraphQLClient.request},
+     * @param query GraphQL string or DocumentNode
+     * @param variables Optional variables bag
+     * @param fetchOptions Optional fetch/retry overrides (headers, retries, fetch impl, debugger)
+     */
+    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
+    /**
+     * 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
+     * @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>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+    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
+     */
+    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
+     */
+    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get error page details for a given error code
+     * @param {ErrorPage} code - The error code to get the error page for
+     * @param {Partial<RouteOptions>} [pageOptions] - The page options to get the error page for
+     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
+     */
+    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get route paths for all pages in the site. Can be used for static site generation.
+     * @param {string[]} sites - sites to fetch routes for
+     * @param {string[]} [languages] languages to fetch routes in
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     */
+    getPagePaths(sites: string[], 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[];
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param { SitemapRequestConfig} reqOptions - Configuration for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetchOptions Additional fetch options to override GraphQL requests
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} fetchOptions Additional fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+}
+export interface BaseServiceOptions {
+    defaultSite: string;
+    clientFactory: GraphQLRequestClientFactory;
+    retries: {
+        count: number;
+        retryStrategy: RetryStrategy;
+    };
+}
+/**
+ * This is a generic content client that can be used by any framework.
+ * Use it to retrieve pages, preview data, dictionary and other data
+ * @public
+ */
+export declare class SitecoreClient implements BaseSitecoreClient {
+    protected initOptions: SitecoreClientInit;
+    protected layoutService: LayoutService;
+    protected dictionaryService: DictionaryService;
+    protected editingService: EditingService;
+    protected clientFactory: GraphQLRequestClientFactory;
+    protected errorPagesService: ErrorPagesService;
+    protected componentService: ComponentLayoutService;
+    protected sitePathService: SitePathService;
+    protected graphQLClient: GraphQLClient;
+    /**
+     * Init SitecoreClient
+     * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
+     */
+    constructor(initOptions: SitecoreClientInit);
+    /**
+     * Normalize path regardless of type
+     * @param {string | string[]} path string or string array path
+     * @returns {string} string path
+     */
+    parsePath(path: string | string[]): string;
+    /**
+     * Execute a raw GraphQL request using the client's configured GraphQL Edge endpoint.
+     * This is a thin pass-through to the underlying `GraphQLClient.request` method,
+     * @param {string | DocumentNode} query GraphQL query
+     * @param {Record<string, unknown>} [variables] Optional variables bag
+     * @param {FetchOptions} [fetchOptions] Optional fetch overrides (e.g. fetch, headers)
+     */
+    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
+    /**
+     * Get page details for a route, with layout and other details
+     * @param {string} path route path
+     * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page | null} page details
+     */
+    getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Retrieves the head `<link>` elements for Sitecore styles and themes.
+     * @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 for stylesheets.
+     */
+    getHeadLinks(layoutData: LayoutServiceData, options?: {
+        enableStyles?: boolean;
+        enableThemes?: boolean;
+    }): HTMLLink[];
+    /**
+     * Retrieves dictionary phrases for a given site and locale.
+     * @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
+     * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
+     */
+    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
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
+     */
+    getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
+    /**
+     * Retrieves preview page and layout details
+     * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page} preview page details
+     */
+    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get design library page details for Design Library mode of your app
+     * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page} preview page for Design Library
+     */
+    getDesignLibraryData(designLibData: DesignLibraryRenderPreviewData, fetchOptions?: FetchOptions): Promise<Page>;
+    /**
+     * Get error page details for a given error code
+     * @param {ErrorPage} code - The error code to get the error page for
+     * @param {Partial<RouteOptions>} pageOptions - The page options to get the error page for
+     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
+     */
+    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Retrieves the static paths for pages based on the given languages.
+     * @param {string[]} sites - An array of site names to fetch routes for.
+     * @param {string[]} [languages] - An optional array of language codes to generate paths for.
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<StaticPath[]>} A promise that resolves to an array of static paths.
+     */
+    getPagePaths(sites: string[], languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
+     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
+     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
+     * or null if no content is found.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+    /**
+     * Factory methods for creating dependencies
+     * Subclasses can override these to provide custom implementations.
+     */
+    protected getGraphqlSitemapXMLService(siteName: string): SitemapXmlService;
+    protected getRobotsService(siteName: string): RobotsService;
+    protected getBaseServiceOptions(): BaseServiceOptions;
+    /**
+     * Get page mode based on mode name
+     * @param {PageModeName} mode - The mode name to get the page mode for
+     * @param { DesignLibraryVariantGeneration} generation - The variant generation mode, if applicable
+     * @returns {PageMode} The page mode
+     */
+    private getPageMode;
+    private getClientFactory;
+    private getLayoutService;
+    private getDictionaryService;
+    private getEditingService;
+    private getErrorPagesService;
+    private getComponentService;
+    private getSitePathService;
+}
+export {};
+//# sourceMappingURL=sitecore-client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sitecore-client.d.ts","sourceRoot":"","sources":["../../src/client/sitecore-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EACL,aAAa,EACb,2BAA2B,EAC3B,YAAY,EACZ,aAAa,EAGd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAGL,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,sBAAsB,EACvB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAwB,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5F,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EACL,8BAA8B,EAC9B,kBAAkB,EAClB,cAAc,EACd,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,oBAAY,SAAS;IACnB,QAAQ,QAAQ;IAChB,mBAAmB,QAAQ;CAC5B;AAED;;;GAGG;AACH,KAAK,YAAY,GAAG,sBAAsB,GAAG,iBAAiB,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE;QACb;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG;IAChD,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,qEAAqE;IACrE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,EACjB,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IACd;;;;;;OAMG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,WAAW,CAAC,EAAE,WAAW,EACzB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACxB;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAOjF,aAAa,CACX,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,EACpC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9B;;;;OAIG;IACH,aAAa,CACX,YAAY,CAAC,EAAE,YAAY,EAC3B,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC9B;;;;OAIG;IACH,UAAU,CACR,WAAW,EAAE,kBAAkB,GAAG,SAAS,EAC3C,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACxB;;;;;;OAMG;IACH,YAAY,CACV,IAAI,EAAE,SAAS,EACf,WAAW,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,EACnC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACxB;;;;;OAKG;IACH,YAAY,CACV,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IACzB;;;;;;;OAOG;IACH,YAAY,CACV,UAAU,EAAE,iBAAiB,EAC7B,OAAO,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAC1D,QAAQ,EAAE,CAAC;IACd;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxF;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAClF;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,2BAA2B,CAAC;IAC3C,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,aAAa,CAAC;KAC9B,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,cAAe,YAAW,kBAAkB;IAc3C,SAAS,CAAC,WAAW,EAAE,kBAAkB;IAbrD,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;IACvC,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC/C,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IACzC,SAAS,CAAC,aAAa,EAAE,2BAA2B,CAAC;IACrD,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC/C,SAAS,CAAC,gBAAgB,EAAE,sBAAsB,CAAC;IACnD,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAC3C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;IAEvC;;;OAGG;gBACmB,WAAW,EAAE,kBAAkB;IAkBrD;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAY1C;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,EACjB,KAAK,EAAE,MAAM,GAAG,YAAY,EAC5B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;OAMG;IACG,OAAO,CACX,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,WAAW,CAAC,EAAE,WAAW,EACzB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAoCvB;;;;;;;OAOG;IACH,YAAY,CACV,UAAU,EAAE,iBAAiB,EAC7B,OAAO,GAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO,GAC/D,QAAQ,EAAE;IAmBb;;;;;OAKG;IACG,aAAa,CACjB,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,EACpC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAM7B;;;;;OAKG;IACG,aAAa,CACjB,YAAY,CAAC,EAAE,YAAY,EAC3B,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAM7B;;;;;OAKG;IACG,UAAU,CACd,WAAW,EAAE,kBAAkB,GAAG,SAAS,EAC3C,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAsCvB;;;;;OAKG;IACG,oBAAoB,CACxB,aAAa,EAAE,8BAA8B,EAC7C,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,CAAC;IA4ChB;;;;;;OAMG;IACG,YAAY,CAChB,IAAI,EAAE,SAAS,EACf,WAAW,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,EACnC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAqCvB;;;;;;OAMG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,EAAE,CAAC;IAIxB;;;;;;OAMG;IACG,UAAU,CAAC,UAAU,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IA+C7F;;;;;;OAMG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAMtF;;;OAGG;IAEH,SAAS,CAAC,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB;IAO1E,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa;IAO3D,SAAS,CAAC,qBAAqB,IAAI,kBAAkB;IAQrD;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IA4CnB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,oBAAoB;IAQ5B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,oBAAoB;IAQ5B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,kBAAkB;CAK3B"}

package/types/client/utils.d.ts

@@ -0,0 +1,15 @@
+import { FetchOptions } from '@sitecore-content-sdk/core';
+import { SitecoreConfigInput } from '../config';
+/**
+ * GraphQL client options
+ * @public
+ */
+export type GraphQLClientOptions = Pick<SitecoreConfigInput, 'api'> & FetchOptions;
+/**
+ * Creates a new GraphQLRequestClientFactory instance
+ * @param {GraphQLClientOptions} options content sdk config
+ * @returns GraphQLRequestClientFactory instance
+ * @public
+ */
+export declare const createGraphQLClientFactory: (options: GraphQLClientOptions) => import("@sitecore-content-sdk/core").GraphQLRequestClientFactory;
+//# sourceMappingURL=utils.d.ts.map

package/types/client/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAGhD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,GAAG,YAAY,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GAAI,SAAS,oBAAoB,qEA2CvE,CAAC"}

package/types/config/define-config.d.ts

@@ -0,0 +1,20 @@
+import { DeepPartial, SitecoreConfig, SitecoreConfigInput } from './models';
+/**
+ * Provides default initial values for SitecoreConfig
+ * @returns default config
+ */
+export declare const getFallbackConfig: () => SitecoreConfig;
+/**
+ * Deep merge utility that skips undefined or empty string values in the override.
+ * @param {T} base base value
+ * @param {DeepPartial<T>} [override] override value
+ */
+export declare function deepMerge<T>(base: T, override?: DeepPartial<T>): T;
+/**
+ * Accepts a SitecoreConfigInput object and returns full sitecore configuration
+ * @param {SitecoreConfigInput} config override values to be written over default config settings
+ * @returns {SitecoreConfig} full sitecore configuration to use in application
+ * @public
+ */
+export declare const defineConfig: (config: SitecoreConfigInput) => SitecoreConfig;
+//# sourceMappingURL=define-config.d.ts.map

package/types/config/define-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-config.d.ts","sourceRoot":"","sources":["../../src/config/define-config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAK5E;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAO,cAgDnC,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CA8BlE;AAyHD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,mBAAmB,KAAG,cAe1D,CAAC"}

package/types/config/index.d.ts

@@ -0,0 +1,3 @@
+export { SitecoreConfig, SitecoreConfigInput, SitecoreCliConfig, SitecoreCliConfigInput, ScaffoldTemplate, ComponentTemplateType, DeepRequired, } from './models';
+export { defineConfig } from './define-config';
+//# sourceMappingURL=index.d.ts.map

package/types/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,GACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}