launchdarkly-js-sdk-common 5.0.0 → 5.0.2

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to the `launchdarkly-js-sdk-common` package will be documented in this file. Changes that affect the dependent SDKs such as `launchdarkly-js-client-sdk` should also be logged in those projects, in the next release that uses the updated version of this package. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.0.1] - 2023-01-10
+### Changed:
+- Updated all types in `typings.d.ts` to be exported. This is to ensure that those types are included in generated documentation of dependent SDKs.
+
+## [5.0.0] - 2022-11-30
+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`.
+
 ## [4.3.2] - 2022-10-20
 ### Added:
 - Implemented `jitter` and `backoff` for streaming connections. When a connection fails the retry will start at the `streamReconnectDelay` and will double on each unsuccessful consecutive connection attempt (`backoff`) to a max of 30 seconds. The delay will be adjusted from 50%-100% of the calculated delay to prevent many clients from attempting to reconnect at the same time (`jitter`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",

package/src/InspectorManager.js

@@ -31,16 +31,17 @@ function InspectorManager(inspectors, logger) {
     [InspectorTypes.clientIdentityChanged]: [],
   };
 
-  const safeInspectors = inspectors?.map(inspector => SafeInspector(inspector, logger));
+  const safeInspectors = inspectors && inspectors.map(inspector => SafeInspector(inspector, logger));
 
-  safeInspectors.forEach(safeInspector => {
-    // Only add inspectors of supported types.
-    if (Object.prototype.hasOwnProperty.call(inspectorsByType, safeInspector.type)) {
-      inspectorsByType[safeInspector.type].push(safeInspector);
-    } else {
-      logger.warn(messages.invalidInspector(safeInspector.type, safeInspector.name));
-    }
-  });
+  safeInspectors &&
+    safeInspectors.forEach(safeInspector => {
+      // Only add inspectors of supported types.
+      if (Object.prototype.hasOwnProperty.call(inspectorsByType, safeInspector.type)) {
+        inspectorsByType[safeInspector.type].push(safeInspector);
+      } else {
+        logger.warn(messages.invalidInspector(safeInspector.type, safeInspector.name));
+      }
+    });
 
   /**
    * Check if there is an inspector of a specific type registered.
@@ -48,7 +49,7 @@ function InspectorManager(inspectors, logger) {
    * @param {string} type The type of the inspector to check.
    * @returns True if there are any inspectors of that type registered.
    */
-  manager.hasListeners = type => inspectorsByType[type]?.length;
+  manager.hasListeners = type => inspectorsByType[type] && inspectorsByType[type].length;
 
   /**
    * Notify registered inspectors of a flag being used.

package/src/configuration.js

@@ -45,7 +45,7 @@ const baseOptionDefs = {
 const allowedTagCharacters = /^(\w|\.|-)+$/;
 
 function canonicalizeUrl(url) {
-  return url?.replace(/\/+$/, '');
+  return url && url.replace(/\/+$/, '');
 }
 
 /**

package/src/context.js

@@ -107,7 +107,7 @@ function getContextKeys(context, logger = commonBasicLogger()) {
       Object.entries(context)
         .filter(([key]) => key !== 'kind')
         .forEach(([key, value]) => {
-          if (value?.key) {
+          if (value && value.key) {
             keys[key] = value.key;
           }
         });

package/typings.d.ts

@@ -337,7 +337,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * parts that compose a multi context. For more information see {@link LDSingleKindContext} and
    * {@link LDMultiKindContext}.
    */
-  interface LDContextCommon {
+  export interface LDContextCommon {
     /**
      * If true, the context will _not_ appear on the Contexts page in the LaunchDarkly dashboard.
      */
@@ -386,7 +386,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * The above context would be a single kind context representing an organization. It has a key
    * for that organization, and a single attribute 'someAttribute'.
    */
-  interface LDSingleKindContext extends LDContextCommon {
+  export interface LDSingleKindContext extends LDContextCommon {
     /**
      * The kind of the context.
      */
@@ -424,7 +424,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * The above multi-context contains both an 'org' and a 'user'. Each with their own key,
    * attributes, and _meta attributes.
    */
-  interface LDMultiKindContext {
+  export interface LDMultiKindContext {
     /**
      * The kind of the context.
      */
@@ -555,7 +555,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * Describes the reason that a flag evaluation produced a particular value. This is
    * part of the {@link LDEvaluationDetail} object returned by {@link LDClient.variationDetail]].
    */
-  interface LDEvaluationReason {
+  export interface LDEvaluationReason {
     /**
      * The general category of the reason:
      *
@@ -996,7 +996,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * This interface should not be used by the application to access flags for the purpose of controlling application
    * flow. It is intended for monitoring, analytics, or debugging purposes.
    */
-  interface LDInspectionFlagUsedHandler {
+  export interface LDInspectionFlagUsedHandler {
     type: 'flag-used',
 
     /**
@@ -1023,7 +1023,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * This interface should not be used by the application to access flags for the purpose of controlling application
    * flow. It is intended for monitoring, analytics, or debugging purposes.
    */
-  interface LDInspectionFlagDetailsChangedHandler {
+  export interface LDInspectionFlagDetailsChangedHandler {
     type: 'flag-details-changed',
 
     /**
@@ -1049,7 +1049,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * This interface should not be used by the application to access flags for the purpose of controlling application
    * flow. It is intended for monitoring, analytics, or debugging purposes.
    */
-  interface LDInspectionFlagDetailChangedHandler {
+  export interface LDInspectionFlagDetailChangedHandler {
     type: 'flag-detail-changed',
 
     /**
@@ -1072,7 +1072,7 @@ declare module 'launchdarkly-js-sdk-common' {
    * This interface should not be used by the application to access flags for the purpose of controlling application
    * flow. It is intended for monitoring, analytics, or debugging purposes.
    */
-  interface LDInspectionIdentifyHandler {
+  export interface LDInspectionIdentifyHandler {
     type: 'client-identity-changed',
 
     /**
@@ -1086,6 +1086,6 @@ declare module 'launchdarkly-js-sdk-common' {
     method: (context: LDContext) => void;
   }
 
-  type LDInspection = LDInspectionFlagUsedHandler | LDInspectionFlagDetailsChangedHandler
+  export type LDInspection = LDInspectionFlagUsedHandler | LDInspectionFlagDetailsChangedHandler
     | LDInspectionFlagDetailChangedHandler | LDInspectionIdentifyHandler;
 }