1. Functions

init (deprecated)

Version:
Warning

Deprecated. Use the core package to initialize the Cloud SDK and its packages. See also install and initialize the Cloud SDK.

TypeFunction
Import path@sitecore-cloudsdk/personalize/server

Initializes the server module of the Cloud SDK personalize package.

Important

Run init before running other functions in the module.

Signature

export async function init(
  request: Request,
  response: Response,
  settings: ServerSettings
): Promise<void>

Parameters

NameTypeDescription
requestRequestRequired.

The HTTP request.
responseResponseRequired.

The HTTP response.
settingsServerSettingsRequired.

Details about your SitecoreAI instance and cookie settings.

ServerSettings properties

NameTypeDescriptionValue
sitecoreEdgeContextIdstringRequired.Context ID.Accessible and stored as an environment variable in your app."3axQRoRznWUqHR8B2RSbdo"
siteNamestringRequired.The name of the site.Accessible and stored as an environment variable in your app."myRetailSite"
cookieDomainstringOptional.The top-level domain of your app. The cookie domain ensures that the Cloud SDK stores cookies in the web browser as first-party cookies.ImportantSet the same value for this property in every Cloud SDK module.Default: your domain.".myretailsite.com"".beta.myretailsite.com""localhost"
cookieExpiryDaysintegerOptional.The number of days before cookies expire.ImportantSet the same value for this property in every Cloud SDK module.For example, set to 1 for cookies to expire in 1 day.If unset, cookies expire according to the Max-Age set by the web browser.365
cookiePathstringOptional.A URL path that must exist in the requested URL in order to send cookies.ImportantSet the same value for this property in every Cloud SDK module.Default: "/"."/"
enableServerCookiebooleanOptional.Flag to set cookies from the server side.If using only the server modules of packages, set to true.If using both the browser and the server modules of packages, set either enableBrowserCookie or enableServerCookie to true, and set the other to false.Default: false.true

Return value

Returns a promise. The promise resolves with an object that handles the module functionality.

Examples

Here's an example middleware.ts script showing how to initialize the module:

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { init } from "@sitecore-cloudsdk/personalize/server";

export async function middleware(request: NextRequest) {
  const response = NextResponse.next();

  // Initialize the module ->
  await init(request, response,
    {
      sitecoreEdgeContextId: process.env.SITECORE_EDGE_CONTEXT_ID,
      siteName: process.env.SITECORE_SITE_NAME,
      enableServerCookie: true
    }
  );

  console.log("Initialized the personalize/server module.");
  // <- Initialize the module

  return response;
};
If you have suggestions for improving this article, let us know!