@optimizely/optimizely-sdk - npm Package Versions

5.0.0-beta

May 4, 2023

New Features

The 5.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#765, #775, #776, #777, #778, #786, #789, #790, #797, #799, #808).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.

  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

  • createUserContext() with anonymous user IDs: user-contexts can be created without a userId. The SDK will create and use a persistent VUID specific to a device when userId is not provided.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Client SDK Support

• Initialize JavaScript SDK

• OptimizelyUserContext JavaScript SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

Additionally, a handful of major package updates are also included in this release including murmurhash, uuid, and others. For more information, check out the Breaking Changes section below. (#762)

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.
• Updated murmurhash dependency to version 2.0.1.
• Updated uuid dependency to version 8.3.2.
• Dropped support for the following browser versions.
  • All versions of Microsof Internet Explorer.
  • Chrome versions earlier than 102.0.
  • Microsoft Edge versions earlier than 84.0.
  • Firefox versions earlier than 91.0.
  • Opera versions earlier than 76.0.
  • Safari versions earlier than 13.0.
• Dropped support for Node JS versions earlier than 14.

Changed

• Updated createUserContext's userId parameter to be optional due to the Browser variation's use of the new vuid field. Note: The Node variation of the SDK does not use the new vuid field and you should pass in a userId when within the context of the Node variant.

[4.9.3] - March 17, 2023

Changed

• Updated README.md and package.json files to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack (#803).

[4.9.2] - June 27, 2022

Changed

• Add package.json script for running Karma tests locally using Chrome (#651).
• Replaced explicit typescript typings with auto generated ones (#745).
• Integrated code from utils package into optimizely-sdk (#749).
• Added ODP Segments support in Audience Evaluation (#765).

[4.9.1] - January 18, 2022

Bug fixes

• Fixed typescript compilation issue introduced by 4.9.0 (#733)

[4.9.0] - January 14, 2022

New Features

• Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface (#705, #727, #729, #730):

  • setForcedDecision
  • getForcedDecision
  • removeForcedDecision
  • removeAllForcedDecisions

• For details, refer to our documentation pages: OptimizelyUserContext and Forced Decision methods.

[4.8.0] - November 29, 2021

New Features

• Added a Lite bundle which does not include Data file manager and Event Processor packages. This reduces the bundle size up to 20% and is helpful for some platforms (such as edge service providers) that do not need extended functionality offered by these packages.
• Removed Client engine validation in the SDK to allow tracking events from new clients without modifying SDK code.

Performance Improvements

• Reduced SDK client initialization time by removing OptimizelyConfig creation from initialization. The OptimizelyConfig object is now created on the first call to getOptimizelyConfig API.
• Made Improvements to logging mechanism. The SDK no longer concatenates and formats messages which do not qualify for the log level set by the user.

Changed

• Updated json-schema package version to 0.4.0 to fix a high-severity vulnerability (Prototype Pollution).

[4.8.0-beta.2] - November 1, 2021

New Features

• Removed Client engine validation in the SDK to allow tracking events from new clients without modifying SDK code.

[4.8.0-beta] - October 18, 2021

New Features

• Added a Lite bundle which does not include Data file manager and Event Processor packages. This reduces the bundle size up to 20% and is helpful for some platforms (such as edge service providers) that do not need extended functionality offered by these packages.

Performance Improvements

• Reduced SDK client initialization time by removing OptimizelyConfig creation from initialization. The OptimizelyConfig object is now created on the first call to getOptimizelyConfig API.
• Made Improvements to logging mechanism. The SDK now no longer concatenates and formats messages which do not qualify for the log level set by the user.

[4.7.0] - September 15, 2021

New Features

• Added new public properties to OptimizelyConfig. (#683, #698)
  • sdkKey
  • environmentKey
  • attributes
  • audiences
  • events
  • experimentRules and deliveryRules to OptimizelyFeature
  • audiences to OptimizelyExperiment
• For details, refer to our documentation page:
  • Node version: https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyconfig-javascript-node.
  • Browser version: https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyconfig-javascript.

Bug fixes

• Followed experimentIds order of experiments inside featuresMap of OptimizelyConfig (#701)

Deprecated

• OptimizelyFeature.experimentsMap of OptimizelyConfig is deprecated as of this release. Please use OptimizelyFeature.experimentRules and OptimizelyFeature.deliveryRules (#698)

[4.6.2] - July 15, 2021

Bug fixes

• Fixed incorrect impression event payload in projects containing multiple flags with dublicate key rules (#690)