From 341112d448267f5c949f53791062566db8c6f366 Mon Sep 17 00:00:00 2001 From: LaunchDarklyReleaseBot Date: Wed, 7 Dec 2022 17:02:38 +0000 Subject: [PATCH] Releasing version 3.0.0 --- CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bee9b0f..7c9c215c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,38 @@ All notable changes to the LaunchDarkly client-side JavaScript SDKs will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org). +## [3.0.0] - 2022-12-07 +The latest version of this SDK supports LaunchDarkly's new custom contexts feature. Contexts are an evolution of a previously-existing concept, "users." Contexts let you create targeting rules for feature flags based on a variety of different information, including attributes pertaining to users, organizations, devices, and more. You can even combine contexts to create "multi-contexts." + +This feature is only available to members of LaunchDarkly's Early Access Program (EAP). If you're in the EAP, you can use contexts by updating your SDK to the latest version and, if applicable, updating your Relay Proxy. Outdated SDK versions do not support contexts, and will cause unpredictable flag evaluation behavior. + +If you are not in the EAP, only use single contexts of kind "user", or continue to use the user type if available. If you try to create contexts, the context will be sent to LaunchDarkly, but any data not related to the user object will be ignored. + +For detailed information about this version, please refer to the list below. For information on how to upgrade from the previous version, please read the [migration guide](https://docs.launchdarkly.com/sdk/client-side/javascript/migration-2-to-3). + +### Added: +- The types `LDContext`, `LDSingleKindContext`, and `LDMultiKindContext` define the new "context" model. +- All SDK methods that took an `LDUser` parameter now take an `LDContext`. `LDUser` is now a subset of `LDContext`, so existing code based on users will still work. + +### Changed _(breaking changes from 3.x)_: +- There is no longer such a thing as a `secondary` meta-attribute that affects percentage rollouts. If you set an attribute with that name in `LDContext`, it will simply be a custom attribute like any other. +- Evaluations now treat the `anonymous` attribute as a simple boolean, with no distinction between a false state and an undefined state. +- `LDClient.getUser` has been replaced with `LDClient.getContext`. +- `privateAttributeNames` has been replaced with `privateAttributes` in `LDOptions`. Private attributes now allow using attribute references. + + +### Changed (behavioral changes): +- Analytics event data now uses a new JSON schema due to differences between the context model and the old user model. + +### Removed: +- Removed all types, fields, and methods that were deprecated as of the most recent 3.x release. +- Removed the `secondary` meta-attribute in `LDUser`. +- The `alias` method no longer exists because alias events are not needed in the new context model. +- The `autoAliasingOptOut` and `inlineUsersInEvents` options no longer exist because they are not relevant in the new context model. + +### Deprecated: +- The `LDUser` object has been deprecated. Support for `LDUser` is maintained to simplify the upgrade process, but it is recommended to use `LDContext` in the shape of either `LDSingleKindContext` or `LDMultiKindContext`. + ## [2.24.2] - 2022-10-20 ### Changed: - Updated to `js-sdk-common` `3.8.2` which includes jitter and backoff for re-connection attempts for streaming connections. diff --git a/package.json b/package.json index 055e4ed6..42e0ae3b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "launchdarkly-js-client-sdk", - "version": "2.24.2", + "version": "3.0.0", "description": "LaunchDarkly SDK for JavaScript", "author": "LaunchDarkly ", "license": "Apache-2.0",