Merge branch 'hooks_export' into hooks_useSplitManager

Author: EmilianoSanchez

src/__tests__/withSplitTreatments.test.tsx

@@ -12,38 +12,42 @@ import { sdkBrowser } from './testUtils/sdkConfigs';
 import { withSplitFactory } from '../withSplitFactory';
 import { withSplitClient } from '../withSplitClient';
 import { withSplitTreatments } from '../withSplitTreatments';
-import { ISplitTreatmentsChildProps } from '../types';
 import { getControlTreatmentsWithConfig } from '../constants';
 
 describe('withSplitTreatments', () => {
 
   it(`passes Split props and outer props to the child.
-      In this test, the value of "props.treatments" is obteined by the function "getControlTreatmentsWithConfig",
-      and not "client.getTreatmentsWithConfig" since the client is not ready.`, (done) => {
+      In this test, the value of "props.treatments" is obtained by the function "getControlTreatmentsWithConfig",
+      and not "client.getTreatmentsWithConfig" since the client is not ready.`, () => {
     const featureFlagNames = ['split1', 'split2'];
+
     const Component = withSplitFactory(sdkBrowser)<{ outerProp1: string, outerProp2: number }>(
       ({ outerProp1, outerProp2, factory }) => {
         const SubComponent = withSplitClient('user1')<{ outerProp1: string, outerProp2: number }>(
           withSplitTreatments(featureFlagNames)(
-            (props: ISplitTreatmentsChildProps & { outerProp1: string, outerProp2: number }) => {
+            (props) => {
               const clientMock = factory!.client('user1');
-              expect(props.outerProp1).toBe('outerProp1');
-              expect(props.outerProp2).toBe(2);
               expect((clientMock.getTreatmentsWithConfig as jest.Mock).mock.calls.length).toBe(0);
-              expect(props.treatments).toEqual(getControlTreatmentsWithConfig(featureFlagNames));
-              expect(props.isReady).toBe(false);
-              expect(props.isReadyFromCache).toBe(false);
-              expect(props.hasTimedout).toBe(false);
-              expect(props.isTimedout).toBe(false);
-              expect(props.isDestroyed).toBe(false);
-              expect(props.lastUpdate).toBe(0);
-              done();
+
+              expect(props).toStrictEqual({
+                factory: factory, client: clientMock,
+                outerProp1: 'outerProp1', outerProp2: 2,
+                treatments: getControlTreatmentsWithConfig(featureFlagNames),
+                isReady: false,
+                isReadyFromCache: false,
+                hasTimedout: false,
+                isTimedout: false,
+                isDestroyed: false,
+                lastUpdate: 0
+              });
+
               return null;
             }
           )
         );
         return <SubComponent outerProp1={outerProp1} outerProp2={outerProp2} />;
       });
+
     render(<Component outerProp1='outerProp1' outerProp2={2} />);
   });
 

src/useClient.ts

@@ -8,7 +8,7 @@ import { useSplitClient } from './useSplitClient';
  * @return A Split Client instance, or null if used outside the scope of SplitFactory
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  *
- * @deprecated useSplitClient is the new hook to use.
+ * @deprecated Replace with the new `useSplitClient` hook.
  */
 export function useClient(splitKey?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): SplitIO.IBrowserClient | null {
   return useSplitClient({ splitKey, trafficType, attributes }).client;

src/useSplitClient.ts

@@ -15,6 +15,12 @@ export const DEFAULT_UPDATE_OPTIONS = {
  * It uses the 'useContext' hook to access the context, which is updated by SplitFactory and SplitClient components in the hierarchy of components.
  *
  * @return A Split Context object
+ *
+ * @example
+ * ```js
+ * const { factory, client, isReady, isReadyFromCache, hasTimedout, lastUpdate } = useSplitClient({ splitKey: 'user_id' });
+ * ```
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  */
 export function useSplitClient(options?: IUseSplitClientOptions): ISplitContextValues {

src/useSplitTreatments.ts

@@ -5,10 +5,16 @@ import { ISplitTreatmentsChildProps, IUseSplitTreatmentsOptions } from './types'
 import { useSplitClient } from './useSplitClient';
 
 /**
- * 'useSplitTreatments' is a hook that returns an SplitContext object extended with a `treatments` property containing an object of feature flag evaluations (i.e., treatments).
+ * 'useSplitTreatments' is a hook that returns an SplitContext object extended with a `treatments` property object that contains feature flag evaluations.
  * It uses the 'useSplitClient' hook to access the client from the Split context, and invokes the 'getTreatmentsWithConfig' method.
  *
- * @return A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if split names do not exist.
+ * @return A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
+ *
+ * @example
+ * ```js
+ * const { treatments: { feature_1, feature_2 }, isReady, isReadyFromCache, hasTimedout, lastUpdate, ... } = useSplitTreatments({ names: ['feature_1', 'feature_2']});
+ * ```
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 export function useSplitTreatments(options: IUseSplitTreatmentsOptions): ISplitTreatmentsChildProps {

src/useTreatments.ts

@@ -8,7 +8,7 @@ import { useSplitTreatments } from './useSplitTreatments';
  * @return A TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  *
- * @deprecated useSplitTreatments is the new hook to use.
+ * @deprecated Replace with the new `useSplitTreatments` hook.
  */
 export function useTreatments(featureFlagNames: string[], attributes?: SplitIO.Attributes, splitKey?: SplitIO.SplitKey): SplitIO.TreatmentsWithConfig {
   return useSplitTreatments({ names: featureFlagNames, attributes, splitKey }).treatments;

types/useClient.d.ts

@@ -6,6 +6,6 @@
  * @return A Split Client instance, or null if used outside the scope of SplitFactory
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  *
- * @deprecated useSplitClient is the new hook to use.
+ * @deprecated Replace with the new `useSplitClient` hook.
  */
 export declare function useClient(splitKey?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): SplitIO.IBrowserClient | null;

types/useSplitClient.d.ts

@@ -10,6 +10,12 @@ export declare const DEFAULT_UPDATE_OPTIONS: {
  * It uses the 'useContext' hook to access the context, which is updated by SplitFactory and SplitClient components in the hierarchy of components.
  *
  * @return A Split Context object
+ *
+ * @example
+ * ```js
+ * const { factory, client, isReady, isReadyFromCache, hasTimedout, lastUpdate } = useSplitClient({ splitKey: 'user_id' });
+ * ```
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  */
 export declare function useSplitClient(options?: IUseSplitClientOptions): ISplitContextValues;

types/useSplitTreatments.d.ts

@@ -1,9 +1,15 @@
 import { ISplitTreatmentsChildProps, IUseSplitTreatmentsOptions } from './types';
 /**
- * 'useSplitTreatments' is a hook that returns an SplitContext object extended with a `treatments` property containing an object of feature flag evaluations (i.e., treatments).
+ * 'useSplitTreatments' is a hook that returns an SplitContext object extended with a `treatments` property object that contains feature flag evaluations.
  * It uses the 'useSplitClient' hook to access the client from the Split context, and invokes the 'getTreatmentsWithConfig' method.
  *
- * @return A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if split names do not exist.
+ * @return A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
+ *
+ * @example
+ * ```js
+ * const { treatments: { feature_1, feature_2 }, isReady, isReadyFromCache, hasTimedout, lastUpdate, ... } = useSplitTreatments({ names: ['feature_1', 'feature_2']});
+ * ```
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 export declare function useSplitTreatments(options: IUseSplitTreatmentsOptions): ISplitTreatmentsChildProps;

types/useTreatments.d.ts

@@ -6,6 +6,6 @@
  * @return A TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  *
- * @deprecated useSplitTreatments is the new hook to use.
+ * @deprecated Replace with the new `useSplitTreatments` hook.
  */
 export declare function useTreatments(featureFlagNames: string[], attributes?: SplitIO.Attributes, splitKey?: SplitIO.SplitKey): SplitIO.TreatmentsWithConfig;