Skip to content

Commit 38d21fc

Browse files
[FSSDK-8721] chore: prep release 3.0.0 (#231)
* build: bump SDK version * docs: update changelog * docs: changelog corrections * docs: add bug fixes + formatting
1 parent a441b07 commit 38d21fc

File tree

4 files changed

+70
-10
lines changed

4 files changed

+70
-10
lines changed

CHANGELOG.md

+67-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,72 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
## [3.0.0] - January 24, 2024
4+
5+
### New Features
6+
7+
The 3.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) (
8+
[#229](https://github.com/optimizely/react-sdk/pull/229),
9+
[#214](https://github.com/optimizely/react-sdk/pull/214),
10+
[#213](https://github.com/optimizely/react-sdk/pull/213),
11+
[#212](https://github.com/optimizely/react-sdk/pull/212),
12+
[#208](https://github.com/optimizely/react-sdk/pull/208),
13+
[#207](https://github.com/optimizely/react-sdk/pull/207),
14+
[#206](https://github.com/optimizely/react-sdk/pull/206),
15+
[#205](https://github.com/optimizely/react-sdk/pull/205),
16+
[#201](https://github.com/optimizely/react-sdk/pull/201),
17+
[#200](https://github.com/optimizely/react-sdk/pull/200),
18+
[#199](https://github.com/optimizely/react-sdk/pull/199))
19+
20+
You can use ODP, a high-performance [Customer Data Platform (CDP)]( https://www.optimizely.com/optimization-glossary/customer-data-platform/), 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.
21+
22+
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.
23+
24+
This release leverages the Optimizely JavaScript SDK 5+
25+
26+
This version includes the following changes:
27+
28+
- New APIs added to `ReactSDKClient`:
29+
30+
- `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.
31+
32+
- `getUserContext()`: get the current `OptimizelyUserContext` object in use at the React SDK level.
33+
34+
- `getVuid()`: provides access to the anonymous client-side visitor ID (VUID) generated by the JS SDK. This ID is used to identify unique visitors in Optimizely Results in the absence of a standard user ID.
35+
36+
- `sendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.
37+
38+
For details, refer to our documentation pages:
39+
40+
- [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting)
41+
42+
- [Client SDK Support](https://docs.developers.optimizely.com/feature-experimentation/v1.0/docs/advanced-audience-targeting-for-client-side-sdks)
43+
44+
- [Initialize React SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/initialize-sdk-react)
45+
46+
- [Advanced Audience Targeting segment qualification methods](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-segment-qualification-methods-react)
47+
48+
- [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-react)
49+
50+
### Breaking Changes
51+
- Dropped support for the following browser versions.
52+
- All versions of Microsoft Internet Explorer.
53+
- Chrome versions earlier than `102.0`.
54+
- Microsoft Edge versions earlier than `84.0`.
55+
- Firefox versions earlier than `91.0`.
56+
- Opera versions earlier than `76.0`.
57+
- Safari versions earlier than `13.0`.
58+
- Dropped support for Node JS versions earlier than `16`.
59+
60+
### Changed
61+
- Updated `@optimizely/optimizely-sdk` to version `5.0.0` ([#230](https://github.com/optimizely/react-sdk/pull/230)).
62+
- Removed use of deprecated `@optimizely/js-sdk-*` packages.
63+
- Minor version bumps to dependencies.
64+
65+
### Bug Fixes
66+
- Updated `OptimizelyProvider` to ([#229](https://github.com/optimizely/react-sdk/pull/229))
67+
- correctly adhere to optional `userId?` and `user?` interface fields, using the `DefaultUser` to signal to client-side contexts to use the new `vuid` identifier.
68+
- correctly use of the correct React lifecyle methods.
469

5-
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6-
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
770

871
## [3.0.0-beta2] - December 26, 2023
972

@@ -53,9 +116,6 @@ For details, refer to our documentation pages:
53116
- [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-react)
54117

55118
### Breaking Changes
56-
- `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.
57-
- Updated `murmurhash` dependency to version `2.0.1`.
58-
- Updated `uuid` dependency to version `8.3.2`.
59119
- Dropped support for the following browser versions.
60120
- All versions of Microsoft Internet Explorer.
61121
- Chrome versions earlier than `102.0`.
@@ -65,7 +125,7 @@ For details, refer to our documentation pages:
65125
- Safari versions earlier than `13.0`.
66126
- Dropped support for Node JS versions earlier than `14`.
67127

68-
## Changed
128+
### Changed
69129
- Updated `createUserContext`'s `userId` parameter to be optional due to the Browser variation's use of the new `vuid` field.
70130

71131
## [2.9.2] - March 13, 2023

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@optimizely/react-sdk",
3-
"version": "3.0.0-beta2",
3+
"version": "3.0.0",
44
"description": "React SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts",
55
"homepage": "https://github.com/optimizely/react-sdk",
66
"repository": "https://github.com/optimizely/react-sdk",

src/client.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ describe('ReactSDKClient', () => {
123123
expect(createInstanceSpy).toBeCalledWith({
124124
...config,
125125
clientEngine: 'react-sdk',
126-
clientVersion: '3.0.0-beta2',
126+
clientVersion: '3.0.0',
127127
});
128128
});
129129

src/client.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface OnReadyResult extends ResolveResult {
4343
}
4444

4545
const REACT_SDK_CLIENT_ENGINE = 'react-sdk';
46-
const REACT_SDK_CLIENT_VERSION = '3.0.0-beta2';
46+
const REACT_SDK_CLIENT_VERSION = '3.0.0';
4747

4848
export const DefaultUser: UserInfo = {
4949
id: null,

0 commit comments

Comments
 (0)