@sitecore-jss/sitecore-jss-proxy 22.3.0 → 22.3.1-canary.2

package/types/personalize/test-data/personalizeData.d.ts

@@ -0,0 +1,59 @@
+export declare const mountainBikeVariant: {
+    uid: string;
+    componentName: string;
+    dataSource: string;
+    fields: {
+        content: {
+            value: string;
+        };
+        heading: {
+            value: string;
+        };
+    };
+};
+export declare const cityBikeVariant: {
+    uid: string;
+    componentName: string;
+    dataSource: string;
+    fields: {
+        content: {
+            value: string;
+        };
+        heading: {
+            value: string;
+        };
+    };
+};
+export declare const component_variant: {
+    uid: string;
+    componentName: string;
+    dataSource: string;
+    fields: {
+        content: {
+            value: string;
+        };
+        heading: {
+            value: string;
+        };
+    };
+};
+export declare const getPersonalizeLayoutData: (variant: string, language?: string, path?: string) => {
+    sitecore: {
+        context: {
+            pageEditing: boolean;
+            site: {
+                name: string;
+            };
+            visitorIdentificationTimestamp: number;
+            language: string;
+            variantId: string;
+            itemPath: string;
+        };
+        route: {
+            name: string;
+            placeholders: {
+                main: {};
+            };
+        };
+    };
+};

package/types/types/AppRenderer.d.ts

@@ -0,0 +1,35 @@
+import { LayoutServiceData } from '@sitecore-jss/sitecore-jss/layout';
+import { DictionaryPhrases } from '@sitecore-jss/sitecore-jss/types/i18n';
+/**
+ * Response object produced by the AppRenderer callback function.
+ */
+export interface RenderResponse {
+    /**
+     * The rendered HTML to return to the client
+     */
+    html: string;
+    /**
+     * Set the HTTP status code. If not set, the status code returned from Layout Service is returned.
+     */
+    status?: number;
+    /**
+     * Sets a redirect URL, causing the reply to send a HTTP redirect instead of the HTML content.
+     * Note: when using this you must set the status code to 301 or 302.
+     */
+    redirect?: string;
+}
+/**
+ * AppRenderer is a function that renders a JSS app's markup for a given route and data.
+ */
+export type AppRenderer = (callback: (error: Error | null, result: RenderResponse | null) => void, path: string, 
+/**
+ * Data returned by Layout Service. If the route does not exist, null.
+ */
+data: LayoutServiceData, 
+/**
+ * Additional data to pass to the view
+ */
+viewBag: {
+    [key: string]: unknown;
+    dictionary: DictionaryPhrases;
+}) => void;

package/types/types/index.d.ts

@@ -0,0 +1,3 @@
+export { AppRenderer, RenderResponse } from './AppRenderer';
+export { RouteUrlParser } from './RouteUrlParser';
+export { PersonalizeConfig } from './personalize';

package/types/types/personalize.d.ts

@@ -0,0 +1,85 @@
+import { GraphQLPersonalizeServiceConfig } from '@sitecore-jss/sitecore-jss/personalize';
+import { IncomingMessage, OutgoingMessage } from 'http';
+export type CdpServiceConfig = {
+    /**
+     * Your Sitecore Edge Platform endpoint
+     * Default is https://edge-platform.sitecorecloud.io
+     */
+    sitecoreEdgeUrl?: string;
+    /**
+     * Your unified Sitecore Edge Context Id
+     */
+    sitecoreEdgeContextId: string;
+    /**
+     * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
+     */
+    channel?: string;
+    /**
+     * Currency for CDP request. Uses 'USA' as default.
+     */
+    currency?: string;
+    /**
+     * Timeout (ms) for CDP request. Default is 400.
+     */
+    timeout?: number;
+};
+export type PersonalizeConfig = {
+    /**
+     * function, determines if personalization should be turned off, based on cookie, header, or other considerations
+     * @param {IncomingMessage} [req] request object
+     * @param {OutgoingMessage} [res] response object
+     */
+    disabled?: (req?: IncomingMessage, res?: OutgoingMessage) => boolean;
+    /**
+     * Function used to determine if route should be excluded.
+     * @param {string} pathname The pathname
+     * @returns {boolean} Whether to exclude the route
+     */
+    excludeRoute?: (pathname: string) => boolean;
+    /**
+     * Fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
+    /**
+     * Fallback language in case language can't be read from layout data
+     * @default 'en'
+     */
+    defaultLanguage?: string;
+    /**
+     * Site name for current site
+     */
+    sitecoreSiteName: string;
+    /**
+     * Configuration for your Sitecore Experience Edge endpoint
+     */
+    edgeConfig: Omit<GraphQLPersonalizeServiceConfig, 'fetch'>;
+    /**
+     * Configuration for your Sitecore CDP endpoint
+     */
+    cdpConfig: CdpServiceConfig;
+    /**
+     * Optional Sitecore Personalize scope identifier allowing you to isolate your personalization data between XM Cloud environments
+     */
+    scope?: string;
+};
+/**
+ * Object model of Experience Context data
+ */
+export type ExperienceParams = {
+    referrer: string;
+    utm: {
+        [key: string]: string | undefined;
+        campaign: string | undefined;
+        source: string | undefined;
+        medium: string | undefined;
+        content: string | undefined;
+    };
+};
+/**
+ * Object model of personalize execution data
+ */
+export type PersonalizeExecution = {
+    friendlyId: string;
+    variantIds: string[];
+};

package/types/AppRenderer.d.ts

@@ -1,10 +0,0 @@
-import { RenderResponse } from './RenderResponse';
-export type AppRenderer = (callback: (error: Error | null, result: RenderResponse | null) => void, path: string, 
-/**
- * Data returned by Layout Service. If the route does not exist, null.
- */
-data: {
-    [key: string]: unknown;
-}, viewBag: {
-    [key: string]: unknown;
-}) => void;

package/types/RenderResponse.d.ts

@@ -1,15 +0,0 @@
-export interface RenderResponse {
-    /**
-     * The rendered HTML to return to the client
-     */
-    html: string;
-    /**
-     * Set the HTTP status code. If not set, the status code returned from Layout Service is returned.
-     */
-    status?: number;
-    /**
-     * Sets a redirect URL, causing the reply to send a HTTP redirect instead of the HTML content.
-     * Note: when using this you must set the status code to 301 or 302.
-     */
-    redirect?: string;
-}