@sitecore-content-sdk/core 0.1.0-beta.37 → 0.1.0-beta.39

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

@@ -76,7 +76,7 @@ class SitecoreClient {
             return null;
         }
         else {
-            const siteInfo = this.siteResolver.getByName(site);
+            const siteInfo = this.siteResolver.getByName(site) || layout.sitecore.context.site;
             // Initialize links to be inserted on the page
             if ((_c = pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.personalize) === null || _c === void 0 ? void 0 : _c.variantId) {
                 // Modify layoutData to use specific variant(s) instead of default
@@ -146,13 +146,14 @@ class SitecoreClient {
             return null;
         }
         // If we're in Pages preview (editing) mode, prefetch the editing data
-        const { site, itemId, language, version, variantIds, layoutKind, } = previewData;
+        const { site, itemId, language, version, variantIds, layoutKind, mode, } = previewData;
         const data = await this.editingService.fetchEditingData({
             siteName: site,
             itemId,
             language,
             version,
             layoutKind,
+            mode,
         }, fetchOptions);
         if (!data) {
             throw new Error(`Unable to fetch editing data for preview ${JSON.stringify(previewData)}`);

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

@@ -87,12 +87,13 @@ class GraphQLEditingService {
      * @param {string} variables.siteName - The site name.
      * @param {string} variables.itemId - The item id (path) to fetch layout data for.
      * @param {string} variables.language - The language to fetch layout data for.
+     * @param {string} variables.mode - The editing mode to fetch layout data for.
      * @param {string} [variables.version] - The version of the item (optional).
      * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
      * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise} The layout data and dictionary phrases.
      */
-    async fetchEditingData({ siteName, itemId, language, version, layoutKind = models_1.LayoutKind.Final }, fetchOptions) {
+    async fetchEditingData({ siteName, itemId, language, version, layoutKind = models_1.LayoutKind.Final, mode }, fetchOptions) {
         var _a, _b, _c;
         debug_1.default.editing('fetching editing data for %s %s %s %s', siteName, itemId, language, version, layoutKind);
         if (!siteName) {
@@ -104,6 +105,7 @@ class GraphQLEditingService {
         let initDictionary = [];
         let hasNext = true;
         let after = '';
+        const editModeHeader = mode === 'edit' ? 'true' : 'false';
         const editingData = await this.graphQLClient.request(exports.query, {
             siteName,
             itemId,
@@ -111,6 +113,7 @@ class GraphQLEditingService {
             language,
         }, Object.assign(Object.assign({}, fetchOptions), { headers: {
                 sc_layoutKind: layoutKind,
+                sc_editMode: editModeHeader,
             } }));
         if ((_b = (_a = editingData === null || editingData === void 0 ? void 0 : editingData.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
             initDictionary = editingData.site.siteInfo.dictionary.results;
@@ -170,9 +173,6 @@ class GraphQLEditingService {
         }
         return this.serviceConfig.clientFactory({
             debugger: debug_1.default.editing,
-            headers: {
-                sc_editMode: 'true',
-            },
         });
     }
 }

package/dist/cjs/editing/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDesignLibraryScriptLink = exports.getDesignLibraryStatusEvent = exports.DesignLibraryStatus = exports.addComponentUpdateHandler = exports.MetadataKind = exports.LayoutKind = exports.RestComponentLayoutService = exports.PAGES_EDITING_MARKER = exports.QUERY_PARAM_EDITING_SECRET = exports.EDITING_ALLOWED_ORIGINS = exports.getJssPagesClientData = exports.resetEditorChromes = exports.isEditorActive = exports.PagesEditor = exports.DEFAULT_PLACEHOLDER_UID = exports.GraphQLEditingService = void 0;
+exports.getDesignLibraryScriptLink = exports.getDesignLibraryStatusEvent = exports.DesignLibraryStatus = exports.addComponentUpdateHandler = exports.MetadataKind = exports.LayoutKind = exports.RestComponentLayoutService = exports.PREVIEW_KEY = exports.PAGES_EDITING_MARKER = exports.QUERY_PARAM_EDITING_SECRET = exports.EDITING_ALLOWED_ORIGINS = exports.getJssPagesClientData = exports.resetEditorChromes = exports.isEditorActive = exports.PagesEditor = exports.DEFAULT_PLACEHOLDER_UID = exports.GraphQLEditingService = void 0;
 var graphql_editing_service_1 = require("./graphql-editing-service");
 Object.defineProperty(exports, "GraphQLEditingService", { enumerable: true, get: function () { return graphql_editing_service_1.GraphQLEditingService; } });
 var utils_1 = require("./utils");
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "getJssPagesClientData", { enumerable: true, get:
 Object.defineProperty(exports, "EDITING_ALLOWED_ORIGINS", { enumerable: true, get: function () { return utils_1.EDITING_ALLOWED_ORIGINS; } });
 Object.defineProperty(exports, "QUERY_PARAM_EDITING_SECRET", { enumerable: true, get: function () { return utils_1.QUERY_PARAM_EDITING_SECRET; } });
 Object.defineProperty(exports, "PAGES_EDITING_MARKER", { enumerable: true, get: function () { return utils_1.PAGES_EDITING_MARKER; } });
+Object.defineProperty(exports, "PREVIEW_KEY", { enumerable: true, get: function () { return utils_1.PREVIEW_KEY; } });
 var rest_component_layout_service_1 = require("./rest-component-layout-service");
 Object.defineProperty(exports, "RestComponentLayoutService", { enumerable: true, get: function () { return rest_component_layout_service_1.RestComponentLayoutService; } });
 var models_1 = require("./models");

package/dist/cjs/editing/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJssPagesClientData = exports.resetEditorChromes = exports.isEditorActive = exports.PagesEditor = exports.ChromeRediscoveryGlobalFunctionName = exports.EDITING_ALLOWED_ORIGINS = exports.PAGES_EDITING_MARKER = exports.QUERY_PARAM_EDITING_SECRET = exports.DEFAULT_PLACEHOLDER_UID = void 0;
+exports.getJssPagesClientData = exports.resetEditorChromes = exports.isEditorActive = exports.PagesEditor = exports.ChromeRediscoveryGlobalFunctionName = exports.EDITING_ALLOWED_ORIGINS = exports.PAGES_EDITING_MARKER = exports.PREVIEW_KEY = exports.QUERY_PARAM_EDITING_SECRET = exports.DEFAULT_PLACEHOLDER_UID = void 0;
 const is_server_1 = __importDefault(require("../utils/is-server"));
 /**
  * Default value of uid for root placeholder when uid is not present.
@@ -13,6 +13,10 @@ exports.DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
  * Query parameter for editing secret
  */
 exports.QUERY_PARAM_EDITING_SECRET = 'secret';
+/**
+ * Key to identify whether the app is running in Sitecore Preview mode
+ */
+exports.PREVIEW_KEY = 'sc_preview';
 /**
  * ID to be used as a marker for a script rendered in XMC Pages
  * Should identify app is in XM Cloud Pages editing mode

package/dist/cjs/layout/models.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.EditMode = exports.LayoutServicePageState = void 0;
 /**
  * Layout Service page state enum
- * library mode would render a single component
  */
 var LayoutServicePageState;
 (function (LayoutServicePageState) {

package/dist/cjs/site/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SiteResolver = exports.SITE_PREFIX = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSitePathService = exports.GraphQLSiteInfoService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.GraphQLRedirectsService = exports.REDIRECT_TYPE_SERVER_TRANSFER = exports.REDIRECT_TYPE_302 = exports.REDIRECT_TYPE_301 = exports.GraphQLRobotsService = void 0;
+exports.SiteResolver = exports.SITE_KEY = exports.SITE_PREFIX = exports.normalizeSiteRewrite = exports.getSiteRewriteData = exports.getSiteRewrite = exports.GraphQLSitePathService = exports.GraphQLSiteInfoService = exports.GraphQLErrorPagesService = exports.GraphQLSitemapXmlService = exports.GraphQLRedirectsService = exports.REDIRECT_TYPE_SERVER_TRANSFER = exports.REDIRECT_TYPE_302 = exports.REDIRECT_TYPE_301 = exports.GraphQLRobotsService = void 0;
 var graphql_robots_service_1 = require("./graphql-robots-service");
 Object.defineProperty(exports, "GraphQLRobotsService", { enumerable: true, get: function () { return graphql_robots_service_1.GraphQLRobotsService; } });
 var graphql_redirects_service_1 = require("./graphql-redirects-service");
@@ -21,5 +21,6 @@ Object.defineProperty(exports, "getSiteRewrite", { enumerable: true, get: functi
 Object.defineProperty(exports, "getSiteRewriteData", { enumerable: true, get: function () { return utils_1.getSiteRewriteData; } });
 Object.defineProperty(exports, "normalizeSiteRewrite", { enumerable: true, get: function () { return utils_1.normalizeSiteRewrite; } });
 Object.defineProperty(exports, "SITE_PREFIX", { enumerable: true, get: function () { return utils_1.SITE_PREFIX; } });
+Object.defineProperty(exports, "SITE_KEY", { enumerable: true, get: function () { return utils_1.SITE_KEY; } });
 var site_resolver_1 = require("./site-resolver");
 Object.defineProperty(exports, "SiteResolver", { enumerable: true, get: function () { return site_resolver_1.SiteResolver; } });

package/dist/cjs/site/site-resolver.js

@@ -29,14 +29,10 @@ class SiteResolver {
         /**
          * Resolve site by site name
          * @param {string} siteName the site name
-         * @returns {SiteInfo} the resolved site
-         * @throws {Error} if a matching site is not found
+         * @returns {SiteInfo} the resolved site or undefined if not found
          */
         this.getByName = (siteName) => {
             const siteInfo = this.sites.find((info) => info.name.toLocaleLowerCase() === siteName.toLocaleLowerCase());
-            if (!siteInfo) {
-                throw new Error(`Could not resolve site for name ${siteName}`);
-            }
             return siteInfo;
         };
         this.getHostMap = () => {

package/dist/cjs/site/utils.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SITE_PREFIX = void 0;
+exports.SITE_KEY = exports.SITE_PREFIX = void 0;
 exports.getSiteRewrite = getSiteRewrite;
 exports.getSiteRewriteData = getSiteRewriteData;
 exports.normalizeSiteRewrite = normalizeSiteRewrite;
 exports.SITE_PREFIX = '_site_';
+/**
+ * Site key for cookie and query string parameter access
+ */
+exports.SITE_KEY = 'sc_site';
 /**
  * Get a site rewrite path for given pathname
  * @param {string} pathname the pathname

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

@@ -73,7 +73,7 @@ export class SitecoreClient {
             return null;
         }
         else {
-            const siteInfo = this.siteResolver.getByName(site);
+            const siteInfo = this.siteResolver.getByName(site) || layout.sitecore.context.site;
             // Initialize links to be inserted on the page
             if ((_c = pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.personalize) === null || _c === void 0 ? void 0 : _c.variantId) {
                 // Modify layoutData to use specific variant(s) instead of default
@@ -143,13 +143,14 @@ export class SitecoreClient {
             return null;
         }
         // If we're in Pages preview (editing) mode, prefetch the editing data
-        const { site, itemId, language, version, variantIds, layoutKind, } = previewData;
+        const { site, itemId, language, version, variantIds, layoutKind, mode, } = previewData;
         const data = await this.editingService.fetchEditingData({
             siteName: site,
             itemId,
             language,
             version,
             layoutKind,
+            mode,
         }, fetchOptions);
         if (!data) {
             throw new Error(`Unable to fetch editing data for preview ${JSON.stringify(previewData)}`);

package/dist/esm/editing/graphql-editing-service.js

@@ -81,12 +81,13 @@ export class GraphQLEditingService {
      * @param {string} variables.siteName - The site name.
      * @param {string} variables.itemId - The item id (path) to fetch layout data for.
      * @param {string} variables.language - The language to fetch layout data for.
+     * @param {string} variables.mode - The editing mode to fetch layout data for.
      * @param {string} [variables.version] - The version of the item (optional).
      * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
      * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise} The layout data and dictionary phrases.
      */
-    async fetchEditingData({ siteName, itemId, language, version, layoutKind = LayoutKind.Final }, fetchOptions) {
+    async fetchEditingData({ siteName, itemId, language, version, layoutKind = LayoutKind.Final, mode }, fetchOptions) {
         var _a, _b, _c;
         debug.editing('fetching editing data for %s %s %s %s', siteName, itemId, language, version, layoutKind);
         if (!siteName) {
@@ -98,6 +99,7 @@ export class GraphQLEditingService {
         let initDictionary = [];
         let hasNext = true;
         let after = '';
+        const editModeHeader = mode === 'edit' ? 'true' : 'false';
         const editingData = await this.graphQLClient.request(query, {
             siteName,
             itemId,
@@ -105,6 +107,7 @@ export class GraphQLEditingService {
             language,
         }, Object.assign(Object.assign({}, fetchOptions), { headers: {
                 sc_layoutKind: layoutKind,
+                sc_editMode: editModeHeader,
             } }));
         if ((_b = (_a = editingData === null || editingData === void 0 ? void 0 : editingData.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
             initDictionary = editingData.site.siteInfo.dictionary.results;
@@ -164,9 +167,6 @@ export class GraphQLEditingService {
         }
         return this.serviceConfig.clientFactory({
             debugger: debug.editing,
-            headers: {
-                sc_editMode: 'true',
-            },
         });
     }
 }

package/dist/esm/editing/index.js

@@ -1,5 +1,5 @@
 export { GraphQLEditingService } from './graphql-editing-service';
-export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, } from './utils';
+export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, PREVIEW_KEY, } from './utils';
 export { RestComponentLayoutService, } from './rest-component-layout-service';
 export { LayoutKind, MetadataKind, } from './models';
 export { addComponentUpdateHandler, DesignLibraryStatus, getDesignLibraryStatusEvent, getDesignLibraryScriptLink, } from './design-library';

package/dist/esm/editing/utils.js

@@ -7,6 +7,10 @@ export const DEFAULT_PLACEHOLDER_UID = '00000000-0000-0000-0000-000000000000';
  * Query parameter for editing secret
  */
 export const QUERY_PARAM_EDITING_SECRET = 'secret';
+/**
+ * Key to identify whether the app is running in Sitecore Preview mode
+ */
+export const PREVIEW_KEY = 'sc_preview';
 /**
  * ID to be used as a marker for a script rendered in XMC Pages
  * Should identify app is in XM Cloud Pages editing mode

package/dist/esm/layout/models.js

@@ -1,6 +1,5 @@
 /**
  * Layout Service page state enum
- * library mode would render a single component
  */
 export var LayoutServicePageState;
 (function (LayoutServicePageState) {

package/dist/esm/site/index.js

@@ -4,5 +4,5 @@ export { GraphQLSitemapXmlService, } from './graphql-sitemap-xml-service';
 export { GraphQLErrorPagesService, } from './graphql-error-pages-service';
 export { GraphQLSiteInfoService } from './graphql-siteinfo-service';
 export { GraphQLSitePathService } from './graphql-sitepath-service';
-export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SITE_PREFIX, } from './utils';
+export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SITE_PREFIX, SITE_KEY, } from './utils';
 export { SiteResolver } from './site-resolver';

package/dist/esm/site/site-resolver.js

@@ -26,14 +26,10 @@ export class SiteResolver {
         /**
          * Resolve site by site name
          * @param {string} siteName the site name
-         * @returns {SiteInfo} the resolved site
-         * @throws {Error} if a matching site is not found
+         * @returns {SiteInfo} the resolved site or undefined if not found
          */
         this.getByName = (siteName) => {
             const siteInfo = this.sites.find((info) => info.name.toLocaleLowerCase() === siteName.toLocaleLowerCase());
-            if (!siteInfo) {
-                throw new Error(`Could not resolve site for name ${siteName}`);
-            }
             return siteInfo;
         };
         this.getHostMap = () => {

package/dist/esm/site/utils.js

@@ -1,4 +1,8 @@
 export const SITE_PREFIX = '_site_';
+/**
+ * Site key for cookie and query string parameter access
+ */
+export const SITE_KEY = 'sc_site';
 /**
  * Get a site rewrite path for given pathname
  * @param {string} pathname the pathname

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.1.0-beta.37",
+  "version": "0.1.0-beta.39",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -77,7 +77,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "a2ec7a7854734141e897689e5aa12156cd15a87c",
+  "gitHead": "b09dd6c0ca170a5367e5d6f9a57bd24ce34d469b",
   "files": [
     "dist",
     "types",

package/types/editing/graphql-editing-service.d.ts

@@ -1,7 +1,7 @@
 import { PageInfo } from '../client';
 import { GraphQLClient, GraphQLRequestClientFactory } from '../graphql-request-client';
 import { DictionaryPhrases } from '../i18n';
-import { LayoutServiceData } from '../layout';
+import { LayoutServiceData, LayoutServicePageState } from '../layout';
 import { LayoutKind } from './models';
 import { FetchOptions } from '../models';
 /**
@@ -50,6 +50,7 @@ export type EditingOptions = {
     language: string;
     version?: string;
     layoutKind?: LayoutKind;
+    mode: Exclude<LayoutServicePageState, 'Normal'>;
 };
 /**
  * Service for fetching editing data from Sitecore using the Sitecore's GraphQL API.
@@ -69,12 +70,13 @@ export declare class GraphQLEditingService {
      * @param {string} variables.siteName - The site name.
      * @param {string} variables.itemId - The item id (path) to fetch layout data for.
      * @param {string} variables.language - The language to fetch layout data for.
+     * @param {string} variables.mode - The editing mode to fetch layout data for.
      * @param {string} [variables.version] - The version of the item (optional).
      * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
      * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise} The layout data and dictionary phrases.
      */
-    fetchEditingData({ siteName, itemId, language, version, layoutKind }: EditingOptions, fetchOptions?: FetchOptions): Promise<{
+    fetchEditingData({ siteName, itemId, language, version, layoutKind, mode }: EditingOptions, fetchOptions?: FetchOptions): Promise<{
         layoutData: LayoutServiceData;
         dictionary: DictionaryPhrases;
     }>;

package/types/editing/index.d.ts

@@ -1,5 +1,5 @@
 export { GraphQLEditingService } from './graphql-editing-service';
-export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, Metadata, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, } from './utils';
+export { DEFAULT_PLACEHOLDER_UID, PagesEditor, isEditorActive, resetEditorChromes, Metadata, getJssPagesClientData, EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, PAGES_EDITING_MARKER, ComponentUpdateEventArgs, PREVIEW_KEY, } from './utils';
 export { RestComponentLayoutService, ComponentLayoutRequestParams, } from './rest-component-layout-service';
 export { EditingRenderQueryParams, RenderComponentQueryParams } from './models';
 export { LayoutKind, MetadataKind, EditingPreviewData, DesignLibraryRenderPreviewData, } from './models';

package/types/editing/models.d.ts

@@ -57,7 +57,7 @@ export type EditingPreviewData = {
     site: string;
     itemId: string;
     language: string;
-    pageState: Exclude<LayoutServicePageState, 'Normal'>;
+    mode: Exclude<LayoutServicePageState, 'Normal'>;
     variantIds: string[];
     version?: string;
     layoutKind?: LayoutKind;
@@ -71,7 +71,6 @@ export interface DesignLibraryRenderPreviewData {
     renderingId: string;
     componentUid: string;
     language: string;
-    pageState: LayoutServicePageState;
     mode?: 'library';
     variant?: string;
     version?: string;

package/types/editing/utils.d.ts

@@ -7,6 +7,10 @@ export declare const DEFAULT_PLACEHOLDER_UID = "00000000-0000-0000-0000-00000000
  * Query parameter for editing secret
  */
 export declare const QUERY_PARAM_EDITING_SECRET = "secret";
+/**
+ * Key to identify whether the app is running in Sitecore Preview mode
+ */
+export declare const PREVIEW_KEY = "sc_preview";
 /**
  * ID to be used as a marker for a script rendered in XMC Pages
  * Should identify app is in XM Cloud Pages editing mode

package/types/layout/models.d.ts

@@ -8,7 +8,6 @@ export interface LayoutServiceData {
 }
 /**
  * Layout Service page state enum
- * library mode would render a single component
  */
 export declare enum LayoutServicePageState {
     Preview = "preview",

package/types/site/index.d.ts

@@ -5,5 +5,5 @@ export { ErrorPages, GraphQLErrorPagesService, GraphQLErrorPagesServiceConfig, }
 export { GraphQLSiteInfoService, GraphQLSiteInfoServiceConfig } from './graphql-siteinfo-service';
 export { GraphQLSitePathService, GraphQLSitePathServiceConfig } from './graphql-sitepath-service';
 export { SiteInfo } from './models';
-export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SiteRewriteData, SITE_PREFIX, } from './utils';
+export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SiteRewriteData, SITE_PREFIX, SITE_KEY, } from './utils';
 export { SiteResolver } from './site-resolver';

package/types/site/site-resolver.d.ts

@@ -18,10 +18,9 @@ export declare class SiteResolver {
     /**
      * Resolve site by site name
      * @param {string} siteName the site name
-     * @returns {SiteInfo} the resolved site
-     * @throws {Error} if a matching site is not found
+     * @returns {SiteInfo} the resolved site or undefined if not found
      */
-    getByName: (siteName: string) => SiteInfo;
+    getByName: (siteName: string) => SiteInfo | undefined;
     protected getHostMap: () => Map<string, SiteInfo>;
     protected matchesPattern(hostname: string, pattern: string): boolean;
 }

package/types/site/utils.d.ts

@@ -1,4 +1,8 @@
 export declare const SITE_PREFIX = "_site_";
+/**
+ * Site key for cookie and query string parameter access
+ */
+export declare const SITE_KEY = "sc_site";
 export type SiteRewriteData = {
     siteName: string;
 };