Merge branch 'add_hooks' into refactor_no_default_export

Author: EmilianoSanchez

package.json

@@ -100,7 +100,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run check",
+      "pre-commit": "npm run check && npm run build",
       "pre-push": "npm test && npm run build"
     }
   }

src/useClient.ts

@@ -1,4 +1,4 @@
-import { useClientAndContext } from './useClientAndContext';
+import { useSplitClient } from './useSplitClient';
 
 /**
  * 'useClient' is a hook that returns a client from the Split context.
@@ -9,5 +9,5 @@ import { useClientAndContext } from './useClientAndContext';
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  */
 export function useClient(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): SplitIO.IBrowserClient | null {
-  return useClientAndContext(key, trafficType, attributes).client;
+  return useSplitClient(key, trafficType, attributes).client;
 }

src/useClientAndContext.ts src/useSplitClient.tssrc/useClientAndContext.ts renamed to src/useSplitClient.ts

@@ -5,13 +5,13 @@ import { getSplitSharedClient, checkHooks, initAttributes, IClientWithContext }
 import { ISplitContextValues } from './types';
 
 /**
- * 'useClientAndContext' is a hook that returns an Split Context object with the client and its status corresponding to the provided key and trafficType.
+ * 'useSplitClient' 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 {
+export function useSplitClient(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): ISplitContextValues {
   if (!checkHooks(ERROR_UC_NO_USECONTEXT)) return INITIAL_CONTEXT;
 
   const context = React.useContext(SplitContext);

src/useTreatmentsAndContext.ts src/useSplitTreatments.tssrc/useTreatmentsAndContext.ts renamed to src/useSplitTreatments.ts

@@ -2,17 +2,17 @@ import { getControlTreatmentsWithConfig, ERROR_UT_NO_USECONTEXT } from './consta
 import { checkHooks, IClientWithContext } from './utils';
 import { ISplitTreatmentsChildProps } from './types';
 import { INITIAL_CONTEXT } from './SplitContext';
-import { useClientAndContext } from './useClientAndContext';
+import { useSplitClient } from './useSplitClient';
 
 /**
- * '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.
+ * 'useSplitTreatments' 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 '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.
  * @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;
+export function useSplitTreatments(splitNames: string[], attributes?: SplitIO.Attributes, key?: SplitIO.SplitKey): ISplitTreatmentsChildProps {
+  const context = checkHooks(ERROR_UT_NO_USECONTEXT) ? useSplitClient(key) : INITIAL_CONTEXT;
   const client = context.client;
   const treatments = client && (client as IClientWithContext).__getStatus().isOperational ?
     client.getTreatmentsWithConfig(splitNames, attributes) :

src/useTreatments.ts

@@ -1,4 +1,4 @@
-import { useTreatmentsAndContext } from './useTreatmentsAndContext';
+import { useSplitTreatments } from './useSplitTreatments';
 
 /**
  * 'useTreatments' is a hook that returns an object of feature flag evaluations (i.e., treatments).
@@ -9,5 +9,5 @@ import { useTreatmentsAndContext } from './useTreatmentsAndContext';
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 export function useTreatments(featureFlagNames: string[], attributes?: SplitIO.Attributes, key?: SplitIO.SplitKey): SplitIO.TreatmentsWithConfig {
-  return useTreatmentsAndContext(featureFlagNames, attributes, key).treatments;
+  return useSplitTreatments(featureFlagNames, attributes, key).treatments;
 }

types/useClientAndContext.d.ts types/useSplitClient.d.tstypes/useClientAndContext.d.ts renamed to types/useSplitClient.d.ts

@@ -1,9 +1,9 @@
 import { ISplitContextValues } from './types';
 /**
- * 'useClientAndContext' is a hook that returns an Split Context object with the client and its status corresponding to the provided key and trafficType.
+ * 'useSplitClient' 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;
+export declare function useSplitClient(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): ISplitContextValues;

types/useSplitTreatments.d.ts

@@ -0,0 +1,9 @@
+import { ISplitTreatmentsChildProps } 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).
+ * 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.
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
+ */
+export declare function useSplitTreatments(splitNames: string[], attributes?: SplitIO.Attributes, key?: SplitIO.SplitKey): ISplitTreatmentsChildProps;