@sitecore-cloudsdk/personalize 0.1.1 → 0.1.3

package/README.md

@@ -6,10 +6,9 @@ This package provides browser- and server-side functions to run personalization
 
 ## Prerequisites
 
-To use the Sitecore Cloud SDK, you need:
+To use the Sitecore Cloud SDK, you need an XM Cloud project. This project has to be created from the [XM Cloud foundation template](https://github.com/sitecorelabs/xmcloud-foundation-head) and deployed on XM Cloud.
 
-- A Next.js 13 app deployed on Sitecore XM Cloud.
-- An XM Cloud Plus subscription.
+The foundation template contains an XM Cloud JSS Next.js app. You use the Sitecore Cloud SDK in this app. To be able to use the Sitecore Cloud SDK, you need JSS version 21.6.0 or newer.
 
 ## Installation
 
@@ -24,12 +23,20 @@ npm install @sitecore-cloudsdk/personalize
 
 ## Code examples
 
+---
+
+**NOTE**
+
+These code examples illustrate how the Sitecore Cloud SDK works in a standalone Next.js app. In production, you implement Sitecore Cloud SDK functionality differently, in a JSS Next.js app. See code examples for that environment in the official documentation.
+
+---
+
 Run personalization from the browser side:
 
 ```ts
-"use client";
-import { useEffect } from "react";
-import { init, personalize } from "@sitecore-cloudsdk/personalize/browser";
+'use client';
+import { useEffect } from 'react';
+import { init, personalize } from '@sitecore-cloudsdk/personalize/browser';
 
 export default function Home() {
   useEffect(() => {
@@ -38,8 +45,8 @@ export default function Home() {
 
   const initPersonalize = async () => {
     await init({
-      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || "",
-      siteName: process.env.NEXT_PUBLIC_SITENAME || "",
+      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
+      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
       enableBrowserCookie: true,
     });
 
@@ -48,15 +55,15 @@ export default function Home() {
 
   const runPersonalization = async () => {
     const personalizationData = {
-      channel: "WEB",
-      currency: "USD",
-      friendlyId: "personalize_test",
-      language: "EN",
+      channel: 'WEB',
+      currency: 'USD',
+      friendlyId: 'personalize_test',
+      language: 'EN',
     };
 
     await personalize(personalizationData);
 
-    console.log("Ran personalization.");
+    console.log('Ran personalization.');
   };
 
   return (
@@ -70,17 +77,17 @@ export default function Home() {
 Run personalization from the server side:
 
 ```ts
-import { NextResponse } from "next/server";
-import type { NextRequest } from "next/server";
-import { init, personalize } from "@sitecore-cloudsdk/personalize/server";
+import { NextResponse } from 'next/server';
+import type { NextRequest } from 'next/server';
+import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
 
 export async function middleware(req: NextRequest) {
   const res = NextResponse.next();
 
   await init(
     {
-      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || "",
-      siteName: process.env.NEXT_PUBLIC_SITENAME || "",
+      sitecoreEdgeContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID || '',
+      siteName: process.env.NEXT_PUBLIC_SITENAME || '',
       enableServerCookie: true,
     },
     req,
@@ -90,15 +97,15 @@ export async function middleware(req: NextRequest) {
   console.log(`Initialized "@sitecore-cloudsdk/personalize/server".`);
 
   const personalizationData = {
-    channel: "WEB",
-    currency: "EUR",
-    friendlyId: "personalize_test",
-    language: "EN",
+    channel: 'WEB',
+    currency: 'EUR',
+    friendlyId: 'personalize_test',
+    language: 'EN',
   };
 
   const personalizeRes = await personalize(personalizationData, req);
 
-  console.log("personalizeResponse:", personalizeRes);
+  console.log('personalizeResponse:', personalizeRes);
 
   return res;
 }
@@ -106,8 +113,8 @@ export async function middleware(req: NextRequest) {
 
 ## Documentation
 
-Coming soon.
+[Official Sitecore Cloud SDK documentation](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-cloud-sdk.html)
 
 ### License
 
-The Sitecore Cloud SDK uses the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+The Sitecore Cloud SDK uses the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sitecore-cloudsdk/personalize",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "license": "Apache-2.0",
     "exports": {
         "./server": {

package/dist/cjs/src/browser.d.ts

@@ -1,4 +1,4 @@
 export { init } from './lib/initializer/client/initializer';
 export { personalize } from './lib/personalization/personalize';
 export { LIBRARY_VERSION } from './lib/consts';
-export type { IPersonalizerInput } from './lib/personalization/personalizer';
+export type { PersonalizerInput } from './lib/personalization/personalizer';

package/dist/cjs/src/lib/initializer/client/initializer.d.ts

@@ -1,31 +1,28 @@
-import { ISettings, ISettingsParamsBrowser, IWebPersonalizationConfig } from '@sitecore-cloudsdk/core';
+import { Settings, SettingsParamsBrowser } from '@sitecore-cloudsdk/core';
 import { CallFlowEdgeProxyClient } from '../../personalization/callflow-edge-proxy-client';
 /**
  * Sets the personalize settings to be used by the application.
  *
  * @param settings - The personalize settings to be set, or `null` to clear the settings.
  */
-export declare function setDependencies(settings: IBrowserPersonalizeSettings | null): void;
+export declare function setDependencies(settings: BrowserPersonalizeSettings | null): void;
 /**
  * Retrieves the browser personalize settings object.
  *
- * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowCDPClient`.
+ * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowEPClient`.
  *
  * @returns The browser personalize settings object.
  * @throws Error if the personalize settings haven't been initialized with the required properties.
  */
-export declare function getDependencies(): IBrowserPersonalizeSettings;
+export declare function getDependencies(): BrowserPersonalizeSettings;
 /**
  * Initiates the Engage library using the global settings added by the developer
  * @param settingsInput - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
-export declare function init(settingsInput: ISettingsParamsBrowserPersonalize): Promise<void>;
-export type ISettingsParamsBrowserPersonalize = {
-    webPersonalization?: boolean | IWebPersonalizationConfig;
-} & ISettingsParamsBrowser;
-export interface IBrowserPersonalizeSettings {
+export declare function init(settingsInput: SettingsParamsBrowser): Promise<void>;
+export interface BrowserPersonalizeSettings {
     id: string;
-    settings: ISettings;
+    settings: Settings;
     callFlowEdgeProxyClient: CallFlowEdgeProxyClient;
 }

package/dist/cjs/src/lib/initializer/client/initializer.js

@@ -18,14 +18,14 @@ exports.setDependencies = setDependencies;
 /**
  * Retrieves the browser personalize settings object.
  *
- * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowCDPClient`.
+ * This function ensures that the browser personalize settings have been initialized and contain essential properties like `settings` and `callFlowEPClient`.
  *
  * @returns The browser personalize settings object.
  * @throws Error if the personalize settings haven't been initialized with the required properties.
  */
 function getDependencies() {
     if (!dependencies) {
-        throw Error(`[IE-0008] You must first initialize the "personalize" package. Run the "init" function.`);
+        throw Error(`[IE-0006] You must first initialize the "personalize/browser" module. Run the "init" function.`);
     }
     return dependencies;
 }

package/dist/cjs/src/lib/initializer/server/initializer.d.ts

@@ -1,23 +1,23 @@
-import { ISettingsParamsServer } from '@sitecore-cloudsdk/core';
-import { IBrowserPersonalizeSettings } from '../client/initializer';
-import { IHttpResponse, IMiddlewareNextResponse, TRequest } from '@sitecore-cloudsdk/utils';
+import { SettingsParamsServer } from '@sitecore-cloudsdk/core';
+import { BrowserPersonalizeSettings } from '../client/initializer';
+import { HttpResponse, MiddlewareNextResponse, Request } from '@sitecore-cloudsdk/utils';
 /**
  * Sets the personalize settings to be used by the application.
  *
  * @param settings - The personalize settings to be set, or `null` to clear the settings.
  */
-export declare function setDependencies(settings: IServerPersonalize | null): void;
+export declare function setDependencies(settings: ServerPersonalize | null): void;
 /**
  * Retrieves the personalize server settings used by the application.
  *
  * @returns The personalize server settings.
  * @throws Error if the personalize server settings haven't been initialized.
  */
-export declare function getServerDependencies(): IServerPersonalize;
+export declare function getServerDependencies(): ServerPersonalize;
 /**
  * Initiates the server Engage library using the global settings added by the developer
  * @param settings - Global settings added by the developer
  * @returns A promise that resolves with an object that handles the library functionality
  */
-export declare function initServer<TResponse extends IMiddlewareNextResponse | IHttpResponse>(settingsInput: ISettingsParamsServer, request: TRequest, response: TResponse): Promise<void>;
-export type IServerPersonalize = Omit<IBrowserPersonalizeSettings, 'id'>;
+export declare function initServer<Response extends MiddlewareNextResponse | HttpResponse>(settingsInput: SettingsParamsServer, request: Request, response: Response): Promise<void>;
+export type ServerPersonalize = Omit<BrowserPersonalizeSettings, 'id'>;

package/dist/cjs/src/lib/initializer/server/initializer.js

@@ -22,7 +22,7 @@ exports.setDependencies = setDependencies;
  */
 function getServerDependencies() {
     if (!serverDependencies) {
-        throw Error(`[IE-0009] You must first initialize the "personalize" package. Run the "init" function.`);
+        throw Error(`[IE-0007] You must first initialize the "personalize/server" module. Run the "init" function.`);
     }
     return serverDependencies;
 }

package/dist/cjs/src/lib/personalization/callflow-edge-proxy-client.d.ts

@@ -1,32 +1,32 @@
-import { ISettings } from '@sitecore-cloudsdk/core';
-import { INestedObject } from '@sitecore-cloudsdk/utils';
-export declare class CallFlowEdgeProxyClient implements IPersonalizeClient {
-    settings: ISettings;
+import { Settings } from '@sitecore-cloudsdk/core';
+import { NestedObject } from '@sitecore-cloudsdk/utils';
+export declare class CallFlowEdgeProxyClient implements PersonalizeClient {
+    settings: Settings;
     /**
      * A helper class which handles the functionality for sending CALLFLOW requests
-     * @param personalizeData - The mandatory payload to be send to Sitecore CDP
+     * @param personalizeData - The mandatory payload to be send to Sitecore EP
      * @param settings - The global settings
      */
-    constructor(settings: ISettings);
+    constructor(settings: Settings);
     /**
-     * A function that sends a CallFlow request to Sitecore CDP
-     * @param personalizeData - Properties to be send to Sitecore CDP
+     * A function that sends a CallFlow request to Sitecore EP
+     * @param personalizeData - Properties to be send to Sitecore EP
      * @param timeout - Optional timeout in milliseconds to cancel the request
-     * @returns - A promise that resolves with either the Sitecore CDP response object or unknown
+     * @returns - A promise that resolves with either the Sitecore EP response object or unknown
      */
-    sendCallFlowsRequest(cdpCallFlowsBody: ICdpCallFlowsBody, timeout?: number): Promise<any>;
+    sendCallFlowsRequest(epCallFlowsBody: EPCallFlowsBody, timeout?: number): Promise<any>;
 }
 /**
  * An interface with the basic functionality that the derived classes needs to implement
  */
-export interface IPersonalizeClient {
-    settings: ISettings;
-    sendCallFlowsRequest: (cdpCallFlowAttributes: ICdpCallFlowsBody, timeout?: number) => Promise<unknown | null | IFailedCalledFlowsResponse>;
+export interface PersonalizeClient {
+    settings: Settings;
+    sendCallFlowsRequest: (epCallFlowAttributes: EPCallFlowsBody, timeout?: number) => Promise<unknown | null | FailedCalledFlowsResponse>;
 }
 /**
- * An interface that describes the failed response model from Sitecore CDP
+ * An interface that describes the failed response model from Sitecore EP
  */
-export interface IFailedCalledFlowsResponse {
+export interface FailedCalledFlowsResponse {
     status: string;
     code: string;
     message: string;
@@ -36,26 +36,26 @@ export interface IFailedCalledFlowsResponse {
 /**
  * An interface that describes the identifier model attributes for the library
  */
-export interface ICdpIdentifier {
+export interface EPIdentifier {
     id: string;
     provider: string;
 }
 /**
- * An interface that describes the payload sent to Sitecore CDP library
+ * An interface that describes the payload sent to Sitecore EP library
  */
-export interface ICdpCallFlowsBody {
+export interface EPCallFlowsBody {
     browserId?: string;
     email?: string;
     friendlyId: string;
-    identifiers?: ICdpIdentifier;
+    identifiers?: EPIdentifier;
     channel: string;
     clientKey: string;
     currencyCode: string;
     language: string | undefined;
-    params?: ICdpCallFlowsParams;
+    params?: EPCallFlowsParams;
     pointOfSale: string;
 }
 /**
- * A type that describes the params property of the ICdpCallFlowsBody
+ * A type that describes the params property of the EPCallFlowsBody
  */
-export type ICdpCallFlowsParams = INestedObject;
+export type EPCallFlowsParams = NestedObject;

package/dist/cjs/src/lib/personalization/callflow-edge-proxy-client.js

@@ -7,22 +7,22 @@ const consts_1 = require("../consts");
 class CallFlowEdgeProxyClient {
     /**
      * A helper class which handles the functionality for sending CALLFLOW requests
-     * @param personalizeData - The mandatory payload to be send to Sitecore CDP
+     * @param personalizeData - The mandatory payload to be send to Sitecore EP
      * @param settings - The global settings
      */
     constructor(settings) {
         this.settings = settings;
     }
     /**
-     * A function that sends a CallFlow request to Sitecore CDP
-     * @param personalizeData - Properties to be send to Sitecore CDP
+     * A function that sends a CallFlow request to Sitecore EP
+     * @param personalizeData - Properties to be send to Sitecore EP
      * @param timeout - Optional timeout in milliseconds to cancel the request
-     * @returns - A promise that resolves with either the Sitecore CDP response object or unknown
+     * @returns - A promise that resolves with either the Sitecore EP response object or unknown
      */
-    async sendCallFlowsRequest(cdpCallFlowsBody, timeout) {
+    async sendCallFlowsRequest(epCallFlowsBody, timeout) {
         const requestUrl = `${this.settings.sitecoreEdgeUrl}/personalize/v2/callFlows?sitecoreContextId=${this.settings.sitecoreEdgeContextId}&siteId=${this.settings.siteName}`;
         const fetchOptions = {
-            body: JSON.stringify(cdpCallFlowsBody),
+            body: JSON.stringify(epCallFlowsBody),
             headers: {
                 // eslint-disable-next-line @typescript-eslint/naming-convention
                 'Content-Type': 'application/json',

package/dist/cjs/src/lib/personalization/personalize.d.ts

@@ -1,5 +1,5 @@
-import { IFailedCalledFlowsResponse } from './callflow-edge-proxy-client';
-import { IPersonalizerInput } from './personalizer';
+import { FailedCalledFlowsResponse } from './callflow-edge-proxy-client';
+import { PersonalizerInput } from './personalizer';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param personalizeData - The required/optional attributes in order to create a flow execution
@@ -7,4 +7,4 @@ import { IPersonalizerInput } from './personalizer';
  * Used to abort the request to execute an interactive experiment or web experiment.
  * @returns A flow execution response
  */
-export declare function personalize(personalizeData: IPersonalizerInput, timeout?: number): Promise<unknown | null | IFailedCalledFlowsResponse>;
+export declare function personalize(personalizeData: PersonalizerInput, timeout?: number): Promise<unknown | null | FailedCalledFlowsResponse>;

package/dist/cjs/src/lib/personalization/personalizeServer.d.ts

@@ -1,6 +1,6 @@
-import { IFailedCalledFlowsResponse } from './callflow-edge-proxy-client';
-import { TRequest } from '@sitecore-cloudsdk/utils';
-import { IPersonalizerInput } from './personalizer';
+import { FailedCalledFlowsResponse } from './callflow-edge-proxy-client';
+import { Request } from '@sitecore-cloudsdk/utils';
+import { PersonalizerInput } from './personalizer';
 /**
  * A function that executes an interactive experiment or web experiment over any web-based or mobile application.
  * @param personalizeData - The required/optional attributes in order to create a flow execution
@@ -9,4 +9,4 @@ import { IPersonalizerInput } from './personalizer';
  * Used to abort the request to execute an interactive experiment or web experiment.
  * @returns A flow execution response
  */
-export declare function personalizeServer<T extends TRequest>(personalizeData: IPersonalizerInput, request: T, timeout?: number): Promise<unknown | null | IFailedCalledFlowsResponse>;
+export declare function personalizeServer<T extends Request>(personalizeData: PersonalizerInput, request: T, timeout?: number): Promise<unknown | null | FailedCalledFlowsResponse>;

package/dist/cjs/src/lib/personalization/personalizer.d.ts

@@ -1,30 +1,30 @@
-import { IFailedCalledFlowsResponse, IPersonalizeClient } from './callflow-edge-proxy-client';
-import { INestedObject } from '@sitecore-cloudsdk/utils';
+import { FailedCalledFlowsResponse, PersonalizeClient } from './callflow-edge-proxy-client';
+import { NestedObject } from '@sitecore-cloudsdk/utils';
 export declare class Personalizer {
     private personalizeClient;
     private id;
     /**
      * The Personalizer Class runs a flow of interactive experiments.
-     * @param personalizeClient - The data to be send to Sitecore CDP
+     * @param personalizeClient - The data to be send to Sitecore EP
      * @param infer - The source of methods to estimate language and page parameters
      */
-    constructor(personalizeClient: IPersonalizeClient, id: string);
+    constructor(personalizeClient: PersonalizeClient, id: string);
     /**
-     * A function to make a request to the Sitecore CDP /callFlows API endpoint
+     * A function to make a request to the Sitecore EP /callFlows API endpoint
      * @param timeout - Optional timeout in milliseconds to cancel the request
-     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
-    getInteractiveExperienceData(personalizeInput: IPersonalizerInput, timeout?: number): Promise<unknown | null | IFailedCalledFlowsResponse>;
+    getInteractiveExperienceData(personalizeInput: PersonalizerInput, timeout?: number): Promise<unknown | null | FailedCalledFlowsResponse>;
     /**
      * A function that sanitizes the personalize input data
      * @returns - The sanitized object
      */
     private sanitizeInput;
     /**
-     * A function that maps the personalize input data with the CDP
-     * @returns - The CDP object
+     * A function that maps the personalize input data with the EP
+     * @returns - The EP object
      */
-    private mapPersonalizeInputToCDPData;
+    private mapPersonalizeInputToEPData;
     /**
      * A validation method to throw error for the mandatory property for runtime users
      */
@@ -33,23 +33,23 @@ export declare class Personalizer {
 /**
  * An interface that describes the flow execution model attributes input for the library
  */
-export interface IPersonalizerInput {
+export interface PersonalizerInput {
     channel: string;
     currency: string;
     email?: string;
     friendlyId: string;
-    identifier?: IPersonalizeIdentifierInput;
+    identifier?: PersonalizeIdentifierInput;
     language?: string;
-    params?: IPersonalizeInputParams;
+    params?: PersonalizeInputParams;
 }
 /**
  * An interface that describes the identifier model attributes for the library
  */
-export interface IPersonalizeIdentifierInput {
+export interface PersonalizeIdentifierInput {
     id: string;
     provider: string;
 }
 /**
  * A type that describes the params field
  */
-export type IPersonalizeInputParams = INestedObject;
+export type PersonalizeInputParams = NestedObject;

package/dist/cjs/src/lib/personalization/personalizer.js

@@ -7,7 +7,7 @@ const utils_1 = require("@sitecore-cloudsdk/utils");
 class Personalizer {
     /**
      * The Personalizer Class runs a flow of interactive experiments.
-     * @param personalizeClient - The data to be send to Sitecore CDP
+     * @param personalizeClient - The data to be send to Sitecore EP
      * @param infer - The source of methods to estimate language and page parameters
      */
     constructor(personalizeClient, id) {
@@ -15,14 +15,14 @@ class Personalizer {
         this.id = id;
     }
     /**
-     * A function to make a request to the Sitecore CDP /callFlows API endpoint
+     * A function to make a request to the Sitecore EP /callFlows API endpoint
      * @param timeout - Optional timeout in milliseconds to cancel the request
-     * @returns - A promise that resolves with either the Sitecore CDP response object or null
+     * @returns - A promise that resolves with either the Sitecore EP response object or null
      */
     async getInteractiveExperienceData(personalizeInput, timeout) {
         this.validate(personalizeInput);
         const sanitizedInput = this.sanitizeInput(personalizeInput);
-        const mappedData = this.mapPersonalizeInputToCDPData(sanitizedInput);
+        const mappedData = this.mapPersonalizeInputToEPData(sanitizedInput);
         if (!mappedData.email && !mappedData.identifiers)
             mappedData.browserId = this.id;
         const response = await this.personalizeClient.sendCallFlowsRequest(mappedData, timeout);
@@ -50,10 +50,10 @@ class Personalizer {
         return sanitizedInput;
     }
     /**
-     * A function that maps the personalize input data with the CDP
-     * @returns - The CDP object
+     * A function that maps the personalize input data with the EP
+     * @returns - The EP object
      */
-    mapPersonalizeInputToCDPData(input) {
+    mapPersonalizeInputToEPData(input) {
         const mappedData = {
             channel: input.channel,
             clientKey: '',
@@ -72,7 +72,7 @@ class Personalizer {
      */
     validate({ friendlyId }) {
         if (!friendlyId || friendlyId.trim().length === 0)
-            throw new Error(`[MV-0008] "friendlyId" is required.`);
+            throw new Error(`[MV-0004] "friendlyId" is required.`);
     }
 }
 exports.Personalizer = Personalizer;

package/dist/cjs/src/server.d.ts

@@ -1,4 +1,4 @@
 export { initServer as init } from './lib/initializer/server/initializer';
 export { personalizeServer as personalize } from './lib/personalization/personalizeServer';
 export { LIBRARY_VERSION } from './lib/consts';
-export type { IPersonalizerInput } from './lib/personalization/personalizer';
+export type { PersonalizerInput } from './lib/personalization/personalizer';