Contentful Personalization & Analytics

Optimization Node SDK

The Optimization Node SDK implements functionality specific to Node environments, based on the Optimization Core Library. This SDK is part of the Contentful Optimization SDK Suite.

Getting Started

Install using an NPM-compatible package manager, pnpm for example:

pnpm install @contentful/optimization-node
Copy

Import the Optimization class; both CJS and ESM module systems are supported, ESM preferred:

import ContentfulOptimization from '@contentful/optimization-node'
Copy

Configure and initialize the Optimization Node SDK:

const optimization = new ContentfulOptimization({ clientId: 'abc123' })
Copy

Development Harness

The package-local dev harness runs from packages/node/node-sdk/dev/ and reads .env from this package directory.

1. Start from .env.example and create or update packages/node/node-sdk/.env.

2. Prefer the repo-standard PUBLIC_... variable names shown in .env.example.

3. Start the harness from the repo root:

   pnpm --filter @contentful/optimization-node dev
   Copy

Reference Implementations

Reference implementations illustrate how the SDK may be used under common scenarios, as well as select less-common scenarios, with the most basic example solution possible.

• Node SSR Only: Example application that uses the Node SDK to render an optimized Web page
• Node SSR + Web Vanilla: Example application demonstrating simple profile synchronization between the Node and Web SDKs via cookie

Configuration

Top-level Configuration Options

API Options

Configuration method signatures:

• beaconHandler: (url: string | URL, data: BatchInsightsEventArray) => boolean

Event Builder Options

Event builder options should only be supplied when building an SDK on top of the Optimization Node SDK or any of its descendent SDKs.

Fetch Options

Fetch options allow for configuration of a Fetch API-compatible fetch method and the retry/timeout logic integrated into the SDK's bundled API clients. Specify the fetchMethod when the host application environment does not offer a fetch method that is compatible with the standard Fetch API in its global scope.

Configuration method signatures:

• fetchMethod: (url: string | URL, init: RequestInit) => Promise<Response>
• onFailedAttempt and onRequestTimeout: (options: FetchMethodCallbackOptions) => void

Optimization Methods

Arguments marked with an asterisk (*) are always required.

Optimization Data Resolution Methods

getFlag

Get the specified Custom Flag's value from the provided changes array.

Arguments:

• name*: The name/key of the Custom Flag
• changes: Changes array

Returns:

• The resolved value for the specified Custom Flag, or undefined if it cannot be found.

Behavior notes:

• Node SDK is stateless; getFlag(...) does not auto-emit trackFlagView.
• If full map resolution is needed for advanced use cases, use optimization.flagsResolver.resolve(changes).

resolveOptimizedEntry

Resolve a baseline Contentful entry to an optimized variant using the provided selected optimizations.

Type arguments:

• S: Entry skeleton type
• M: Chain modifiers
• L: Locale code

Arguments:

• entry*: The baseline entry to resolve
• selectedOptimizations: Selected optimizations

Returns:

• The resolved optimized entry variant, or the supplied baseline entry if baseline is the selected variant or a variant cannot be found.

getMergeTagValue

Resolve a "Merge Tag" to a value based on the provided profile. A "Merge Tag" is a special Rich Text fragment supported by Contentful that specifies a profile data member to be injected into the Rich Text when rendered.

Arguments:

• embeddedNodeEntryTarget*: The merge tag entry node to resolve
• profile: The user profile

Experience API and Insights API Event Methods

Only the following methods may return an OptimizationData object:

• identify
• page
• screen
• track
• trackView (when payload.sticky is true)

trackClick, trackHover, and trackFlagView return no data. When returned, OptimizationData contains:

• changes: Currently used for Custom Flags
• selectedOptimizations: Selected optimizations for the profile
• profile: Profile associated with the evaluated events

identify

Identify the current profile/visitor to associate traits with a profile.

Arguments:

• payload*: Identify event builder arguments object, including an optional profile property with a PartialProfile value that requires only an id

page

Record an Experience API page view.

Arguments:

• payload*: Page view event builder arguments object, including an optional profile property with a PartialProfile value that requires only an id

screen

Record an Experience API screen view.

Arguments:

• payload*: Screen view event builder arguments object, including an optional profile property with a PartialProfile value that requires only an id

track

Record an Experience API custom track event.

Arguments:

• payload*: Track event builder arguments object, including an optional profile property with a PartialProfile value that requires only an id

trackView

Record an Insights API entry view event. When the payload marks the entry as "sticky", an additional Experience API entry view is recorded. This method only returns OptimizationData when the entry is marked as "sticky".

Arguments:

• payload*: Entry view event builder arguments object, including an optional profile property with a PartialProfile value that requires only an id

trackClick

Record an Insights API entry click event.

Returns:

• void

Arguments:

• payload*: Entry click event builder arguments object

trackHover

Record an Insights API entry hover event.

Returns:

• void

Arguments:

• payload*: Entry hover event builder arguments object

trackFlagView

Track a feature flag view via the Insights API. This is functionally the same as a non-sticky flag view event.

Returns:

• void

Arguments:

• payload*: Flag view event builder arguments object

Interceptors

Interceptors may be used to read and/or modify data flowing through the Core SDK.

Life-cycle Interceptors

• event: Intercepts an event's data before it is queued and/or emitted
• state: Intercepts state data retrieved from an Experience API call before updating the SDK's internal state

Example interceptor usage:

optimization.interceptors.event((event) => {
  event.properties.timestamp = new Date().toISOString()
})
Copy