Contentful Personalization & Analytics

Node SDK SSR + Web SDK Vanilla JS Reference Implementation

This is a reference implementation using both the Optimization Node SDK and Optimization Web SDK, and is part of the Contentful Optimization SDK Suite.

On the server side, the stateless Node SDK is created once at module load and each request passes its request-scoped options directly to stateless event methods.

The goal of this reference implementation is to illustrate the usage of cookie-based communication in both the Node and Web SDKs, which is an important component of many server-side/client-side hybrid SSR and ESR solutions.

What this demonstrates

Use this implementation when you need a hybrid SSR/browser example. It demonstrates a stateless Node SDK server flow, a stateful Web SDK browser flow, cookie-based profile continuity between them, and local mock API usage for end-to-end validation.

Prerequisites

• Node.js >= 20.19.0 (24.13.0 recommended to match .nvmrc)
• pnpm 10.x

Setup

Run all steps from the monorepo root.

1. Install pnpm packages:

   pnpm install
   Copy

2. Build the local package tarballs consumed by implementations:

   pnpm build:pkgs
   Copy

3. Install this implementation so its local @contentful/* dependencies resolve from pkgs/:

   pnpm implementation:run -- node-sdk+web-sdk implementation:install
   Copy

4. Configure the environment in a .env file in implementations/node-sdk+web-sdk based on the .env.example included file. The file is pre-populated with values that are valid only against the mock server implementation. To test the implementation against a live server environment, see the mocks package for information on how to set up Contentful space with test data.

Running locally

Run these commands from the monorepo root.

1. Start servers:

   pnpm implementation:run -- node-sdk+web-sdk serve
   Copy

2. Stop servers:

   pnpm implementation:run -- node-sdk+web-sdk serve:stop
   Copy

3. Run E2E:

   pnpm test:e2e:node-sdk+web-sdk
   Copy

The application can be accessed via Web browser at http://localhost:3000. See implementations/node-sdk+web-sdk/package.json for lower-level local commands.

Running E2E tests

E2E tests are run using Playwright.

1. Install implementation dependencies, browser binaries, and system dependencies:

   pnpm setup:e2e:node-sdk+web-sdk
   Copy

2. Run the E2E test suite:

   pnpm test:e2e:node-sdk+web-sdk
   Copy

   The tests can alternatively be run using Playwright's GUI:

   pnpm implementation:run -- node-sdk+web-sdk test:e2e:ui
   Copy

Related

• @contentful/optimization-node - Node SDK package
• @contentful/optimization-web - Web SDK package
• Node SSR Only - Server-only reference implementation
• Web Vanilla - Browser-only reference implementation