fix: typing for evalation details for client side sdks

Author: joker23

packages/sdk/react-native/src/hooks/variation/LDEvaluationDetail.ts

@@ -1,18 +1,37 @@
-import { LDEvaluationDetailTyped as CommonLDEvaluationDetailTyped, LDEvaluationReason, } from '@launchdarkly/js-client-sdk-common';
+import {
+  LDEvaluationDetail as CommonDetail,
+  LDEvaluationDetailTyped as CommonDetailTyped,
+  LDEvaluationReason,
+} from '@launchdarkly/js-client-sdk-common';
+
+// Implementation note: In client-side SDKs the reason is optional. The common type, which is also
+// used by server SDKs, has a required reason. This file contains a client specific
+// LDEvaluationDetail which has an optional reason.
+
+// TODO: On major version change "reason" to be optional instead of nullable.
 
 /**
  * An object that combines the result of a feature flag evaluation with information about
  * how it was calculated.
  *
- * This is the result of calling detailed variation methods.
+ * This is the result of calling `LDClient.variationDetail`.
+ */
+export type LDEvaluationDetail = Omit<CommonDetail, 'reason'> & {
+  /**
+   * An optional object describing the main factor that influenced the flag evaluation value.
+   */
+  reason: LDEvaluationReason | null;
+};
+
+/**
+ * An object that combines the result of a feature flag evaluation with information about
+ * how it was calculated.
  *
- * @remarks
- * We will be deprecating this type in favor of {@link CommonLDEvaluationDetailTyped} in the
- * next major version.
+ * This is the result of calling detailed variation methods.
  */
-export type LDEvaluationDetailTyped<TFlag> = Omit<CommonLDEvaluationDetailTyped<TFlag>, 'reason'> & {
+export type LDEvaluationDetailTyped<TFlag> = Omit<CommonDetailTyped<TFlag>, 'reason'> & {
   /**
    * An optional object describing the main factor that influenced the flag evaluation value.
    */
   reason: LDEvaluationReason | null;
-};
+};

packages/sdk/react-native/src/hooks/variation/useTypedVariation.ts

@@ -1,6 +1,5 @@
-import { LDEvaluationDetailTyped } from './LDEvaluationDetail';
-
 import useLDClient from '../useLDClient';
+import { LDEvaluationDetailTyped } from './LDEvaluationDetail';
 
 /**
  * Determines the strongly typed variation of a feature flag.

packages/sdk/react-native/src/index.ts

@@ -16,5 +16,9 @@ export * from './LDPlugin';
 
 // Override the common type with a client specific one.
 // TODO: we will remove this once we major version this SDK.
-export type { LDEvaluationDetailTyped } from './hooks/variation/LDEvaluationDetail';
+export type {
+  LDEvaluationDetailTyped,
+  LDEvaluationDetail,
+} from './hooks/variation/LDEvaluationDetail';
+
 export { ReactNativeLDClient, RNOptions as LDOptions, RNStorage };