added useTreatmentsAndContext and useClientAndContext hooks, for internal usage at the moment

Author: EmilianoSanchez

src/SplitContext.ts

@@ -4,12 +4,7 @@ import { EXCEPTION_NO_REACT_OR_CREATECONTEXT } from './constants';
 
 if (!React || !React.createContext) throw new Error(EXCEPTION_NO_REACT_OR_CREATECONTEXT);
 
-/**
- * Split Context is the React Context instance that represents our SplitIO global state.
- * It contains Split SDK objects, such as a factory instance, a client and its status (isReady, isTimedout, lastUpdate)
- * The context is created with default empty values, that eventually SplitFactory and SplitClient access and update.
- */
-const SplitContext = React.createContext<ISplitContextValues>({
+export const INITIAL_CONTEXT: ISplitContextValues = {
   client: null,
   factory: null,
   isReady: false,
@@ -18,7 +13,14 @@ const SplitContext = React.createContext<ISplitContextValues>({
   hasTimedout: false,
   lastUpdate: 0,
   isDestroyed: false,
-});
+}
+
+/**
+ * Split Context is the React Context instance that represents our SplitIO global state.
+ * It contains Split SDK objects, such as a factory instance, a client and its status (isReady, isTimedout, lastUpdate)
+ * The context is created with default empty values, that eventually SplitFactory and SplitClient access and update.
+ */
+const SplitContext = React.createContext<ISplitContextValues>(INITIAL_CONTEXT);
 
 export default SplitContext;
 export { ISplitContextValues };

src/useClient.ts

@@ -1,25 +1,15 @@
-import React from 'react';
-import SplitContext from './SplitContext';
-import { ERROR_UC_NO_USECONTEXT } from './constants';
-import { getSplitSharedClient, checkHooks, initAttributes } from './utils';
+import { useClientAndContext } from './useClientAndContext';
 
 /**
- * 'useClient' is a custom hook that returns a client from the Split context.
+ * 'useClient' is a hook that returns a client from the Split context.
  * 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 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}
  */
 const useClient = (key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): SplitIO.IBrowserClient | null => {
-  if (!checkHooks(ERROR_UC_NO_USECONTEXT)) return null;
-  // eslint-disable-next-line prefer-const
-  let { factory, client } = React.useContext(SplitContext);
-  if (key && factory) {
-    client = getSplitSharedClient(factory, key, trafficType, attributes);
-  }
-  if (client) initAttributes(client, attributes);
-  return client;
+  return useClientAndContext(key, trafficType, attributes).client;
 };
 
 export default useClient;

src/useClientAndContext.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import SplitContext, { ISplitContextValues, INITIAL_CONTEXT } from './SplitContext';
+import { ERROR_UC_NO_USECONTEXT } from './constants';
+import { getSplitSharedClient, checkHooks, initAttributes, IClientWithContext } from './utils';
+
+/**
+ * 'useClientAndContext' is a hook that returns an Split Context object with the client and its status corresponding to the provided key and trafficType.
+ * 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
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
+ */
+export function useClientAndContext(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): ISplitContextValues {
+  if (!checkHooks(ERROR_UC_NO_USECONTEXT)) return INITIAL_CONTEXT;
+
+  const context = React.useContext(SplitContext); // eslint-disable-next-line prefer-const
+  let { factory, client } = context;
+  if (key && factory) {
+    client = getSplitSharedClient(factory, key, trafficType, attributes);
+  }
+  if (client) initAttributes(client, attributes);
+  return client === context.client ? context : {
+    ...context, client, ...(client as IClientWithContext).__getStatus()
+  };
+}

src/useManager.ts

@@ -4,7 +4,7 @@ import { ERROR_UM_NO_USECONTEXT } from './constants';
 import { checkHooks } from './utils';
 
 /**
- * 'useManager' is a custom hook that returns the Manager instance from the Split factory.
+ * 'useManager' is a hook that returns the Manager instance from the Split factory.
  * It uses the 'useContext' hook to access the factory at Split context, which is updated by
  * the SplitFactory component.
  *

src/useTrack.ts

@@ -6,7 +6,7 @@ import { checkHooks } from './utils';
 const noOpFalse = () => false;
 
 /**
- * 'useTrack' is a custom hook that returns the track method from a Split client.
+ * 'useTrack' is a hook that returns the track method from a Split client.
  * It uses the 'useContext' hook to access the client from the Split context.
  *
  * @return A track function binded to a Split client. If the client is not available, the result is a no-op function that returns false.

src/useTreatments.ts

@@ -1,20 +1,15 @@
-import useClient from './useClient';
-import { getControlTreatmentsWithConfig, ERROR_UT_NO_USECONTEXT } from './constants';
-import { checkHooks, IClientWithContext } from './utils';
+import { useTreatmentsAndContext } from './useTreatmentsAndContext';
 
 /**
- * 'useTreatments' is a custom hook that returns a list of treatments.
+ * 'useTreatments' is a hook that returns an object of feature flag evaluations (i.e., treatments).
  * It uses the 'useContext' hook to access the client from the Split context,
  * and invokes the 'getTreatmentsWithConfig' method.
  *
  * @return A TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if split names do not exist.
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 const useTreatments = (splitNames: string[], attributes?: SplitIO.Attributes, key?: SplitIO.SplitKey): SplitIO.TreatmentsWithConfig => {
-  const client = checkHooks(ERROR_UT_NO_USECONTEXT) ? useClient(key) : null;
-  return client && (client as IClientWithContext).__getStatus().isOperational ?
-    client.getTreatmentsWithConfig(splitNames, attributes) :
-    getControlTreatmentsWithConfig(splitNames);
+  return useTreatmentsAndContext(splitNames, attributes, key).treatments;
 };
 
 export default useTreatments;

src/useTreatmentsAndContext.ts

@@ -0,0 +1,25 @@
+import { getControlTreatmentsWithConfig, ERROR_UT_NO_USECONTEXT } from './constants';
+import { checkHooks, IClientWithContext } from './utils';
+import { ISplitTreatmentsChildProps } from './types';
+import { INITIAL_CONTEXT } from './SplitContext';
+import { useClientAndContext } from './useClientAndContext';
+
+/**
+ * 'useTreatmentsAndContext' is a hook that returns an SplitContext object extended with a `treatments` property containing an object of feature flag evaluations (i.e., treatments).
+ * It uses the 'useClientAndContext' 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.
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
+ */
+export function useTreatmentsAndContext(splitNames: string[], attributes?: SplitIO.Attributes, key?: SplitIO.SplitKey): ISplitTreatmentsChildProps {
+  const context = checkHooks(ERROR_UT_NO_USECONTEXT) ? useClientAndContext(key) : INITIAL_CONTEXT;
+  const client = context.client;
+  const treatments = client && (client as IClientWithContext).__getStatus().isOperational ?
+    client.getTreatmentsWithConfig(splitNames, attributes) :
+    getControlTreatmentsWithConfig(splitNames);
+
+  return {
+    ...context,
+    treatments,
+  };
+}

types/SplitContext.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { ISplitContextValues } from './types';
+export declare const INITIAL_CONTEXT: ISplitContextValues;
 /**
  * Split Context is the React Context instance that represents our SplitIO global state.
  * It contains Split SDK objects, such as a factory instance, a client and its status (isReady, isTimedout, lastUpdate)

types/useClient.d.ts

@@ -1,5 +1,5 @@
 /**
- * 'useClient' is a custom hook that returns a client from the Split context.
+ * 'useClient' is a hook that returns a client from the Split context.
  * It uses the 'useContext' hook to access the context, which is updated by
  * SplitFactory and SplitClient components in the hierarchy of components.
  *

types/useClientAndContext.d.ts

@@ -0,0 +1,9 @@
+import { ISplitContextValues } from './SplitContext';
+/**
+ * 'useClientAndContext' is a hook that returns an Split Context object with the client and its status corresponding to the provided key and trafficType.
+ * 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
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
+ */
+export declare function useClientAndContext(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): ISplitContextValues;