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

package/types/i18n/index.d.ts

@@ -0,0 +1,3 @@
+export { DictionaryPhrases, DictionaryServiceConfig, DictionaryService, } from './dictionary-service';
+export { getLocaleRewrite } from './utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/i18n/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC"}

package/types/i18n/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get a locale rewrite path for given pathname
+ * @param {string} pathname the pathname
+ * @param {string} locale the site data to include in the rewrite
+ * @returns {string} the rewrite path
+ * @public
+ */
+export declare function getLocaleRewrite(pathname: string, locale: string): string;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/i18n/utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMzE"}

package/types/index.d.ts

@@ -0,0 +1,7 @@
+import * as form from './form';
+export { default as debug } from './debug';
+export { HTMLLink, StaticPath } from './models';
+export { form };
+export { defineConfig } from './config';
+export { HIDDEN_RENDERING_NAME } from './constants';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,CAAC;AAChB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}

package/types/layout/content-styles.d.ts

@@ -0,0 +1,20 @@
+import { ComponentRendering, Field, Item, LayoutServiceData, RouteData } from './index';
+import { HTMLLink } from '../models';
+type Config = {
+    loadStyles: boolean;
+};
+/**
+ * Get the content styles link to be loaded from the Sitecore Edge Platform
+ * @param {LayoutServiceData} layoutData Layout service data
+ * @param {string} sitecoreEdgeContextId Sitecore Edge Context ID
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
+ * @returns {HTMLLink | null} content styles link, null if no styles are used in layout
+ * @public
+ */
+export declare const getContentStylesheetLink: (layoutData: LayoutServiceData, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => HTMLLink | null;
+export declare const getContentStylesheetUrl: (sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
+export declare const traversePlaceholder: (components: Array<ComponentRendering>, config: Config) => void;
+export declare const traverseField: (field: Field | Item | Item[] | undefined, config: Config) => void;
+export declare const traverseComponent: (component: RouteData | ComponentRendering, config: Config) => void;
+export {};
+//# sourceMappingURL=content-styles.d.ts.map

package/types/layout/content-styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-styles.d.ts","sourceRoot":"","sources":["../../src/layout/content-styles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AASrC,KAAK,MAAM,GAAG;IAAE,UAAU,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtC;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GACnC,YAAY,iBAAiB,EAC7B,uBAAuB,MAAM,EAC7B,wBAA2C,KAC1C,QAAQ,GAAG,IAab,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAClC,uBAAuB,MAAM,EAC7B,wBAA2C,KAC1C,MAGsF,CAAC;AAE1F,eAAO,MAAM,mBAAmB,GAAI,YAAY,KAAK,CAAC,kBAAkB,CAAC,EAAE,QAAQ,MAAM,SAMxF,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,OAAO,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,SAAS,EAAE,QAAQ,MAAM,SAcrF,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,WAAW,SAAS,GAAG,kBAAkB,EAAE,QAAQ,MAAM,SAc1F,CAAC"}

package/types/layout/index.d.ts

@@ -0,0 +1,6 @@
+export { LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, RouteData, PlaceholderData, ComponentRendering, Field, GenericFieldValue, Item, PlaceholdersData, ComponentFields, ComponentParams, EditMode, FieldMetadata, RenderingType, RouteOptions, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from './models';
+export { getFieldValue, getChildPlaceholder, isFieldValueEmpty, isDynamicPlaceholder, getDynamicPlaceholderPattern, EMPTY_DATE_FIELD_VALUE, } from './utils';
+export { getContentStylesheetLink } from './content-styles';
+export { LayoutService, LayoutServiceConfig, GRAPHQL_LAYOUT_QUERY_NAME } from './layout-service';
+export { getDesignLibraryStylesheetLinks } from './themes';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/layout/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,KAAK,EACL,iBAAiB,EACjB,IAAI,EACJ,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,QAAQ,EACR,aAAa,EACb,aAAa,EACb,YAAY,EACZ,6BAA6B,EAC7B,oBAAoB,GACrB,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC"}

package/types/layout/layout-service.d.ts

@@ -0,0 +1,45 @@
+import { FetchOptions } from '@sitecore-content-sdk/core';
+import { GraphQLServiceConfig, SitecoreServiceBase } from '../sitecore-service-base';
+import { LayoutServiceData, RouteOptions } from './models';
+import { SitecoreConfigInput } from '../config';
+/**
+ * GraphQL layout query name
+ * @internal
+ */
+export declare const GRAPHQL_LAYOUT_QUERY_NAME = "ContentSdkLayoutQuery";
+/**
+ * Layout service configuration
+ * @public
+ */
+export type LayoutServiceConfig = GraphQLServiceConfig & Partial<SitecoreConfigInput['layout']>;
+/**
+ * Service that fetch layout data using Sitecore's GraphQL API.
+ * @augments LayoutServiceBase
+ * @mixes GraphQLRequestClient
+ * @public
+ */
+export declare class LayoutService extends SitecoreServiceBase {
+    serviceConfig: LayoutServiceConfig;
+    /**
+     * Fetch layout data using the Sitecore GraphQL endpoint.
+     * @param {LayoutServiceConfig} serviceConfig configuration
+     */
+    constructor(serviceConfig: LayoutServiceConfig);
+    /**
+     * Fetch layout data for an item.
+     * @param {string} itemPath item path to fetch layout data for.
+     * @param {RouteOptions} [routeOptions] Request options like language and site to retrieve data for
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {Promise<LayoutServiceData>} layout service data
+     */
+    fetchLayoutData(itemPath: string, routeOptions: RouteOptions, fetchOptions?: FetchOptions): Promise<LayoutServiceData>;
+    /**
+     * Returns GraphQL Layout query
+     * @param {string} itemPath page route
+     * @param {string} [site] site name
+     * @param {string} [language] language
+     * @returns {string} GraphQL query
+     */
+    protected getLayoutQuery(itemPath: string, site: string, language?: string): string;
+}
+//# sourceMappingURL=layout-service.d.ts.map

package/types/layout/layout-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-service.d.ts","sourceRoot":"","sources":["../../src/layout/layout-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,0BAA0B,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEhG;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,mBAAmB;IAKjC,aAAa,EAAE,mBAAmB;IAJrD;;;OAGG;gBACgB,aAAa,EAAE,mBAAmB;IAIrD;;;;;;OAMG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,YAAY,EAC1B,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAgB7B;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;CAe3E"}

package/types/layout/models.d.ts

@@ -0,0 +1,174 @@
+/**
+ * A reply from the Sitecore Layout Service
+ * @public
+ */
+export interface LayoutServiceData {
+    sitecore: LayoutServiceContextData & {
+        route: RouteData | null;
+    };
+}
+/**
+ * Layout Service page state enum
+ * @public
+ */
+export declare enum LayoutServicePageState {
+    Preview = "preview",
+    Edit = "edit",
+    Normal = "normal"
+}
+/**
+ * Represents the edit mode for rendering content in Sitecore Editors
+ * @public
+ */
+export declare enum EditMode {
+    Metadata = "metadata"
+}
+/**
+ * Shape of context data from the Sitecore Layout Service
+ * @public
+ */
+export interface LayoutServiceContext {
+    [key: string]: unknown;
+    pageEditing?: boolean;
+    language?: string;
+    itemPath?: string;
+    pageState?: LayoutServicePageState;
+    visitorIdentificationTimestamp?: number;
+    site?: {
+        name?: string;
+    };
+    renderingType?: RenderingType;
+    clientScripts?: string[];
+    clientData?: Record<string, Record<string, unknown>>;
+}
+/**
+ * Context information from the Sitecore Layout Service
+ * @public
+ */
+export interface LayoutServiceContextData {
+    context: LayoutServiceContext;
+}
+/**
+ * Shape of route data returned from Sitecore Layout Service
+ * @public
+ */
+export interface RouteData<Fields = Record<string, Field | Item | Item[]>> {
+    name: string;
+    displayName?: string;
+    fields?: Fields;
+    databaseName?: string;
+    deviceId?: string;
+    itemLanguage?: string;
+    itemVersion?: number;
+    layoutId?: string;
+    templateId?: string;
+    templateName?: string;
+    placeholders: PlaceholdersData;
+    itemId?: string;
+}
+/**
+ * Placeholder contents data (name: placeholder name, then array of components within that placeholder name)
+ * @public
+ */
+export type PlaceholdersData<TYPEDNAME extends string = string> = {
+    [P in TYPEDNAME]: Array<ComponentRendering>;
+};
+/**
+ * Content field data passed to a component
+ * @public
+ */
+export interface ComponentFields {
+    [name: string]: Field | Item | Item[];
+}
+/**
+ * Component params
+ * @public
+ */
+export interface ComponentParams {
+    [name: string]: string;
+}
+/**
+ * Definition of a component instance within a placeholder on a route
+ * @public
+ */
+export interface ComponentRendering<T = ComponentFields> {
+    componentName: string;
+    dataSource?: string;
+    uid?: string;
+    placeholders?: PlaceholdersData;
+    fields?: T;
+    params?: ComponentParams;
+}
+/**
+ * Field value data on a component
+ * @public
+ */
+export type GenericFieldValue = string | boolean | number | Date | {
+    [key: string]: unknown;
+} | Array<{
+    [key: string]: unknown;
+}>;
+/**
+ * Field interface
+ * @public
+ */
+export interface Field<T = GenericFieldValue> extends FieldMetadata {
+    value: T;
+}
+/**
+ * Field metadata in editing mode
+ * @public
+ */
+export interface FieldMetadata {
+    metadata?: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * Content data returned from Layout Service
+ * @public
+ */
+export interface Item {
+    name: string;
+    displayName?: string;
+    id?: string;
+    url?: string;
+    fields: {
+        [name: string]: Field | Item | Item[] | undefined;
+    };
+}
+/**
+ * Contents of a single placeholder returned from placeholder service
+ * @public
+ */
+export interface PlaceholderData {
+    name: string;
+    path: string;
+    elements: ComponentRendering[];
+}
+/**
+ * Editing rendering type
+ * @public
+ */
+export declare enum RenderingType {
+    Component = "component"
+}
+/**
+ * Contract for additional route options when requesting layout data
+ * @public
+ */
+export type RouteOptions = {
+    site: string;
+    locale?: string;
+};
+/**
+ * Static placeholder name used for component rendering
+ * @internal
+ */
+export declare const EDITING_COMPONENT_PLACEHOLDER = "editing-componentmode-placeholder";
+/**
+ * Id of wrapper for component rendering
+ * @internal
+ */
+export declare const EDITING_COMPONENT_ID = "editing-component";
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/layout/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,wBAAwB,GAAG;QACnC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;KACzB,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;KAC/D,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,kBAAkB,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,eAAe;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,OAAO,GACP,MAAM,GACN,IAAI,GACJ;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAC1B,KAAK,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC,CAAC;AAGtC;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,iBAAiB,CAAE,SAAQ,aAAa;IACjE,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC;KACnD,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,SAAS,cAAc;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,sCAAsC,CAAC;AACjF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC"}

package/types/layout/themes.d.ts

@@ -0,0 +1,13 @@
+import { LayoutServiceData } from '.';
+import { HTMLLink } from '../models';
+/**
+ * Walks through rendering tree and returns list of links of all FEAAS, BYOC or SXA Design Library Stylesheets that are used
+ * @param {LayoutServiceData} layoutData Layout service data
+ * @param {string} sitecoreEdgeContextId Sitecore Edge Context ID
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
+ * @returns {HTMLLink[]} library stylesheet links
+ * @public
+ */
+export declare function getDesignLibraryStylesheetLinks(layoutData: LayoutServiceData, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string): HTMLLink[];
+export declare const getStylesheetUrl: (id: string, sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
+//# sourceMappingURL=themes.d.ts.map

package/types/layout/themes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"themes.d.ts","sourceRoot":"","sources":["../../src/layout/themes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,iBAAiB,EAA4B,MAAM,GAAG,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAUrC;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,iBAAiB,EAC7B,qBAAqB,EAAE,MAAM,EAC7B,eAAe,SAA4B,GAC1C,QAAQ,EAAE,CAWZ;AAED,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,uBAAuB,MAAM,EAC7B,wBAA2C,WAK5C,CAAC"}

package/types/layout/utils.d.ts

@@ -0,0 +1,56 @@
+import { ComponentRendering, ComponentFields, Field, GenericFieldValue } from './models';
+/**
+ * Safely extracts a field value from a rendering or fields object.
+ * Null will be returned if the field is not defined.
+ * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
+ * @param {string} fieldName the name of the field to extract
+ * @returns {T | undefined} the field value or null if the field is not defined
+ * @public
+ */
+export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string): T | undefined;
+/**
+ * Safely extracts a field value from a rendering or fields object.
+ * @param {ComponentRendering | ComponentFields} renderingOrFields the rendering or fields object to extract the field from
+ * @param {string} fieldName the name of the field to extract
+ * @param {T} defaultValue the default value to return if the field is not defined
+ * @returns {T} the field value or the default value if the field is not defined
+ * @public
+ */
+export declare function getFieldValue<T>(renderingOrFields: ComponentRendering | ComponentFields, fieldName: string, defaultValue: T): T;
+/**
+ * Gets rendering definitions in a given child placeholder under a current rendering.
+ * @param {ComponentRendering} rendering
+ * @param {string} placeholderName
+ * @returns {ComponentRendering[]} child placeholder
+ * @public
+ */
+export declare function getChildPlaceholder(rendering: ComponentRendering, placeholderName: string): ComponentRendering[];
+/**
+ * Returns a regular expression pattern for a dynamic placeholder name.
+ * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
+ * @returns Regular expression pattern for the dynamic segment
+ * @internal
+ */
+export declare const getDynamicPlaceholderPattern: (placeholder: string) => RegExp;
+/**
+ * Checks if the placeholder name is dynamic.
+ * @param {string} placeholder Placeholder name
+ * @returns True if the placeholder name is dynamic
+ * @internal
+ */
+export declare const isDynamicPlaceholder: (placeholder: string) => boolean;
+/**
+ * The default value for an empty Date field.
+ * This value is defined as a default one by .NET
+ * @internal
+ */
+export declare const EMPTY_DATE_FIELD_VALUE = "0001-01-01T00:00:00Z";
+/**
+ * Determines if the passed in field object's value is empty.
+ * @param {GenericFieldValue | Partial<Field>} field the field object.
+ * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
+ * @returns True if the field value is empty
+ * @public
+ */
+export declare function isFieldValueEmpty(field: GenericFieldValue | Partial<Field> | null | undefined): field is null | undefined;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/layout/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAEzF;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,iBAAiB,EAAE,kBAAkB,GAAG,eAAe,EACvD,SAAS,EAAE,MAAM,GAChB,CAAC,GAAG,SAAS,CAAC;AACjB;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,iBAAiB,EAAE,kBAAkB,GAAG,eAAe,EACvD,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,CAAC,GACd,CAAC,CAAC;AAoCL;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,kBAAkB,EAC7B,eAAe,EAAE,MAAM,GACtB,kBAAkB,EAAE,CAWtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GAAI,aAAa,MAAM,WAE/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,aAAa,MAAM,YAAsC,CAAC;AAE/F;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,yBAAyB,CAAC;AAE7D;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,GAC3D,KAAK,IAAI,IAAI,GAAG,SAAS,CA8C3B"}

package/types/media/index.d.ts

@@ -0,0 +1,3 @@
+import * as mediaApi from './media-api';
+export { mediaApi };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/media/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/types/media/media-api.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Get required query string params which should be merged with user params
+ * @param {object} qs layout service parsed query string
+ * @returns {object} requiredParams
+ * @public
+ */
+export declare const getRequiredParams: (qs: {
+    [key: string]: string | undefined;
+}) => {
+    rev: string | undefined;
+    db: string | undefined;
+    la: string | undefined;
+    vs: string | undefined;
+    ts: string | undefined;
+};
+/**
+ * Replace `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * @param {string} url The URL to replace the media URL prefix in
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The URL with the media URL prefix replaced
+ * @public
+ */
+export declare const replaceMediaUrlPrefix: (url: string, mediaUrlPrefix?: RegExp) => string;
+/**
+ * Prepares a Sitecore media URL with `params` for use by the Content SDK media handler.
+ * This is done by replacing `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Provided `params` are used as the querystring parameters for the media URL.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * If no `params` are sent, the original media URL is returned.
+ * @param {string} url The URL to prepare
+ * @param {object} [params] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+export declare const updateImageUrl: (url: string, params?: {
+    [key: string]: string | number | undefined;
+} | null, mediaUrlPrefix?: RegExp) => string;
+/**
+ * Receives an array of `srcSet` parameters that are iterated and used as parameters to generate
+ * a corresponding set of updated Sitecore media URLs via @see updateImageUrl. The result is a comma-delimited
+ * list of media URLs with respective dimension parameters.
+ * @example
+ * // returns '/ipsum.jpg?h=1000&w=1000 1000w, /ipsum.jpg?mh=250&mw=250 250w'
+ * getSrcSet('/ipsum.jpg', [{ h: 1000, w: 1000 }, { mh: 250, mw: 250 } ])
+ * More information about `srcSet`: {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img}
+ * @param {string} url The URL to prepare
+ * @param {Array} srcSet The array of parameters to use
+ * @param {object} [imageParams] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+export declare const getSrcSet: (url: string, srcSet: Array<{
+    [key: string]: string | number | undefined;
+}>, imageParams?: {
+    [key: string]: string | number | undefined;
+}, mediaUrlPrefix?: RegExp) => string;
+//# sourceMappingURL=media-api.d.ts.map

package/types/media/media-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-api.d.ts","sourceRoot":"","sources":["../../src/media/media-api.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE;;;;;;CAI1E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,KAAK,MAAM,EACX,iBAAgB,MAA4B,KAC3C,MAUF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GACzB,KAAK,MAAM,EACX,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,IAAI,EAC9D,iBAAgB,MAA4B,WA0B7C,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,SAAS,GACpB,KAAK,MAAM,EACX,QAAQ,KAAK,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC,EAC7D,cAAc;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,EAC5D,iBAAiB,MAAM,WAaxB,CAAC"}

package/types/models.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Html <link> tag data model
+ * @public
+ */
+export type HTMLLink = {
+    [key: string]: unknown;
+} & Pick<HTMLLinkElement, 'rel' | 'href'>;
+/**
+ * Object model of a sitemap's site page item.
+ * @public
+ */
+export type StaticPath = {
+    params: {
+        path: string[];
+    };
+    locale?: string;
+};
+/**
+ * Data needed to paginate results in graphql
+ * @public
+ */
+export interface PageInfo {
+    /**
+     * string token that can be used to fetch the next page of results
+     */
+    endCursor: string;
+    /**
+     * a value that indicates whether more pages of results are available
+     */
+    hasNext: boolean;
+}
+//# sourceMappingURL=models.d.ts.map

package/types/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,eAAe,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;AAE1C;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,EAAE,CAAC;KAChB,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/types/personalize/index.d.ts

@@ -0,0 +1,4 @@
+export { personalizeLayout } from './layout-personalizer';
+export { PersonalizeInfo, PersonalizeService, PersonalizeServiceConfig, } from './personalize-service';
+export { getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, PersonalizedRewriteData, CdpHelper, DEFAULT_VARIANT, VARIANT_PREFIX, } from './utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/personalize/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,eAAe,EACf,cAAc,GACf,MAAM,SAAS,CAAC"}

package/types/personalize/layout-personalizer.d.ts

@@ -0,0 +1,29 @@
+import { LayoutServiceData, ComponentRendering, PlaceholdersData } from '../layout/models';
+export type ComponentRenderingWithExperiences = ComponentRendering & {
+    experiences: {
+        [name: string]: ComponentRenderingWithExperiences;
+    };
+};
+/**
+ * Apply personalization to layout data. This will recursively go through all placeholders/components, check experiences nodes and replace default with object from specific experience.
+ * @param {LayoutServiceData} layout Layout data
+ * @param {string} variantId variant id
+ * @param {string[]} [componentVariantIds] component variant ids
+ * @public
+ */
+export declare function personalizeLayout(layout: LayoutServiceData, variantId: string, componentVariantIds?: string[]): PlaceholdersData<string> | undefined;
+/**
+ * @param {Array} components components within placeholder
+ * @param {string[]} variantIds variant ids
+ * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
+ * @returns {ComponentRendering[]} components with personalization applied
+ */
+export declare function personalizePlaceholder(components: ComponentRendering[], variantIds: string[], isEditing?: boolean): ComponentRendering[];
+/**
+ * @param {ComponentRenderingWithExperiences} component component with experiences
+ * @param {string[]} variantIds variant ids
+ * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
+ * @returns {ComponentRendering | null} component with personalization applied or null if hidden
+ */
+export declare function personalizeComponent(component: ComponentRenderingWithExperiences, variantIds: string[], isEditing?: boolean): ComponentRendering | null;
+//# sourceMappingURL=layout-personalizer.d.ts.map

package/types/personalize/layout-personalizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-personalizer.d.ts","sourceRoot":"","sources":["../../src/personalize/layout-personalizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAS3F,MAAM,MAAM,iCAAiC,GAAG,kBAAkB,GAAG;IACnE,WAAW,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,iCAAiC,CAAA;KAAE,CAAC;CACpE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,EACjB,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAC7B,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,CAkBtC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,kBAAkB,EAAE,EAChC,UAAU,EAAE,MAAM,EAAE,EACpB,SAAS,CAAC,EAAE,OAAO,GAClB,kBAAkB,EAAE,CA0BtB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,iCAAiC,EAC5C,UAAU,EAAE,MAAM,EAAE,EACpB,SAAS,CAAC,EAAE,OAAO,GAClB,kBAAkB,GAAG,IAAI,CA2C3B"}

package/types/personalize/personalize-service.d.ts

@@ -0,0 +1,89 @@
+import { GraphQLClient, GraphQLRequestClientFactory, CacheClient, CacheOptions } from '@sitecore-content-sdk/core';
+/**
+ * Configuration for the PersonalizeService.
+ * @public
+ */
+export type PersonalizeServiceConfig = CacheOptions & {
+    /**
+     * Timeout (ms) for the Personalize request. Default is 400.
+     */
+    timeout?: number;
+    /**
+     * Optional Sitecore Personalize scope identifier allowing you to isolate your personalization data between XM Cloud environments
+     * @deprecated Will be removed in a future release.
+     */
+    scope?: string;
+    /**
+     * Override fetch method. Uses 'GraphQLRequestClient' default otherwise.
+     */
+    fetch?: typeof fetch;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+};
+/**
+ * Object model of personlize info
+ * @public
+ */
+export type PersonalizeInfo = {
+    /**
+     * The page id
+     */
+    pageId: string;
+    /**
+     * The configured variant ids
+     */
+    variantIds: string[];
+};
+type PersonalizeQueryResult = {
+    layout: {
+        item: {
+            id: string;
+            version: string;
+            personalization: {
+                variantIds: string[];
+            };
+        };
+    };
+};
+/**
+ * Fetch personalize data using the Sitecore GraphQL endpoint.
+ * @public
+ */
+export declare class PersonalizeService {
+    protected config: PersonalizeServiceConfig;
+    private graphQLClient;
+    private cache;
+    /**
+     * Fetch personalize data using the Sitecore GraphQL endpoint.
+     * @param {PersonalizeServiceConfig} config
+     */
+    constructor(config: PersonalizeServiceConfig);
+    protected get query(): string;
+    /**
+     * Get personalize information for a route
+     * @param {string} itemPath page route
+     * @param {string} language language
+     * @param {string} siteName site name
+     * @returns {Promise<PersonalizeInfo | undefined>} the personalize information or undefined (if itemPath / language not found)
+     */
+    getPersonalizeInfo(itemPath: string, language: string, siteName: string): Promise<PersonalizeInfo | undefined>;
+    /**
+     * Gets cache client implementation
+     * Override this method if custom cache needs to be used
+     * @returns CacheClient instance
+     */
+    protected getCacheClient(): CacheClient<PersonalizeQueryResult>;
+    protected getCacheKey(itemPath: string, language: string, siteName: string): string;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+export {};
+//# sourceMappingURL=personalize-service.d.ts.map

package/types/personalize/personalize-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personalize-service.d.ts","sourceRoot":"","sources":["../../src/personalize/personalize-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,2BAA2B,EAC3B,WAAW,EACX,YAAY,EAEb,MAAM,4BAA4B,CAAC;AAIpC;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,GAAG;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,MAAM,EAAE;QAAE,IAAI,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE;gBAAE,UAAU,EAAE,MAAM,EAAE,CAAA;aAAE,CAAA;SAAE,CAAA;KAAE,CAAC;CAC9F,CAAC;AAEF;;;GAGG;AACH,qBAAa,kBAAkB;IAQjB,SAAS,CAAC,MAAM,EAAE,wBAAwB;IAPtD,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAAsC;IAEnD;;;OAGG;gBACmB,MAAM,EAAE,wBAAwB;IAMtD,SAAS,KAAK,KAAK,IAAI,MAAM,CAc5B;IAED;;;;;;OAMG;IACG,kBAAkB,CACtB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAgCvC;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,sBAAsB,CAAC;IAO/D,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI1E;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAW5C"}