This major version release of js-sdk-common corresponds to the upcoming releases of the js-client-sdk v3 and react-client-sdk v3, and cannot be used with earlier SDK versions.
Added:
Replaced users with contexts. A context is a generalized way of referring to the people, services, machines, or other resources that encounter feature flags in your product. All methods which previously operated on LDUser now operate on LDContext.
Changed:
LDClient.getUser has been replaced with LDClient.getContext.
privateAttributeNames has been replaced with privateAttributes. Private attributes now allow using attribute references, which allow for marking nodes in nested JSON private.
Removed:
Alias events are no longer supported and the alias method has been removed from LDClient.
Support for the secondary attribute has been removed from LDUser. If a secondary attribute is included in a context, then it is a normal attribute that can be used in rule evaluation, but it will not affect bucketing.
allowFrequentDuplicateEvents has been removed from LDOptions. This had been deprecated in a previous version. The default behavior is as if this option had been set to true.
autoAliasingOptOut has been removed from LDOptions. This functionality has been superseded by multi-context support.
inlineUsersInEvents has been removed from LDOptions. Changes associated with contexts has removed the needed for this option.
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.
[5.0.0] - 2022-11-30
This major version release of
js-sdk-commoncorresponds to the upcoming releases of thejs-client-sdkv3 andreact-client-sdkv3, and cannot be used with earlier SDK versions.Added:
LDUsernow operate onLDContext.Changed:
LDClient.getUserhas been replaced withLDClient.getContext.privateAttributeNameshas been replaced withprivateAttributes. Private attributes now allow using attribute references, which allow for marking nodes in nested JSON private.Removed:
aliasmethod has been removed fromLDClient.secondaryattribute has been removed fromLDUser. If a secondary attribute is included in a context, then it is a normal attribute that can be used in rule evaluation, but it will not affect bucketing.allowFrequentDuplicateEventshas been removed fromLDOptions. This had been deprecated in a previous version. The default behavior is as if this option had been set to true.autoAliasingOptOuthas been removed fromLDOptions. This functionality has been superseded by multi-context support.inlineUsersInEventshas been removed fromLDOptions. Changes associated with contexts has removed the needed for this option.Deprecated:
LDUserobject has been deprecated. Support forLDUseris maintained to simplify the upgrade process, but it is recommended to useLDContextin the shape of eitherLDSingleKindContextorLDMultiKindContext.