Merge pull request #136 from splitio/SDKS-6947

[SDKS-6947][DW] Update public methods splitName param

Author: emmaz90

src/SplitTreatments.tsx

@@ -18,7 +18,7 @@ function evaluateFeatureFlags(client: SplitIO.IBrowserClient, lastUpdate: number
 }
 
 /**
- * SplitTreatments accepts a list of split names and optional attributes. It access the client at SplitContext to
+ * SplitTreatments accepts a list of feature flag names and optional attributes. It access the client at SplitContext to
  * call 'client.getTreatmentsWithConfig()' method, and passes the returned treatments to a child as a function.
  *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
@@ -28,7 +28,7 @@ class SplitTreatments extends React.Component<ISplitTreatmentsProps> {
   private logWarning?: boolean;
 
   // Attaching a memoized `client.getTreatmentsWithConfig` function to the component instance, to avoid duplicated impressions because
-  // the function result is the same given the same `client` instance, `lastUpdate` timestamp, and list of split `names` and `attributes`.
+  // the function result is the same given the same `client` instance, `lastUpdate` timestamp, and list of feature flag `names` and `attributes`.
   private evaluateFeatureFlags = memoizeOne(evaluateFeatureFlags, argsAreEqual);
 
   render() {

src/constants.ts

@@ -15,14 +15,14 @@ export const CONTROL_WITH_CONFIG: SplitIO.TreatmentWithConfig = {
   config: null,
 };
 
-export const getControlTreatmentsWithConfig = (splitNames: unknown): SplitIO.TreatmentsWithConfig => {
+export const getControlTreatmentsWithConfig = (featureFlagNames: unknown): SplitIO.TreatmentsWithConfig => {
   // validate featureFlags Names
-  const validatedFeatureFlagNames = validateFeatureFlags(splitNames);
+  const validatedFeatureFlagNames = validateFeatureFlags(featureFlagNames);
 
   // return empty object if the returned value is false
   if (!validatedFeatureFlagNames) return {};
 
-  // return control treatments for each validated split name
+  // return control treatments for each validated feature flag name
   return validatedFeatureFlagNames.reduce((pValue: SplitIO.TreatmentsWithConfig, cValue: string) => {
     pValue[cValue] = CONTROL_WITH_CONFIG;
     return pValue;

src/types.ts

@@ -117,7 +117,7 @@ export interface ISplitFactoryProps extends IUpdateProps {
   factory?: SplitIO.IBrowserSDK;
 
   /**
-   * An object of type Attributes used to evaluate the splits.
+   * An object of type Attributes used to evaluate the feature flags.
    */
   attributes?: SplitIO.Attributes;
 
@@ -185,7 +185,7 @@ export interface ISplitTreatmentsChildProps extends ISplitContextValues {
 export interface ISplitTreatmentsProps {
 
   /**
-   * list of Split names
+   * list of feature flag names
    */
   names: string[];
 

src/useTreatments.ts

@@ -10,11 +10,11 @@ import { checkHooks, IClientWithContext } from './utils';
  * @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 useTreatments = (featureFlagNames: 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);
+    client.getTreatmentsWithConfig(featureFlagNames, attributes) :
+    getControlTreatmentsWithConfig(featureFlagNames);
 };
 
 export default useTreatments;

src/utils.ts

@@ -112,7 +112,7 @@ export function validateFeatureFlags(maybeFeatureFlags: unknown, listName = 'spl
       if (featureFlagName) validatedArray.push(featureFlagName);
     });
 
-    // Strip off duplicated values if we have valid split names then return
+    // Strip off duplicated values if we have valid feature flag names then return
     if (validatedArray.length) return uniq(validatedArray);
   }
 

src/withSplitTreatments.tsx

@@ -7,7 +7,7 @@ import SplitTreatments from './SplitTreatments';
  * The wrapped component receives all the props of the container,
  * along with the passed props from SplitTreatments (see ISplitTreatmentsChildProps).
  *
- * @param names list of Split names
+ * @param names list of feature flag names
  * @param attributes An object of type Attributes used to evaluate the splits.
  */
 function withSplitTreatments(names: string[], attributes?: SplitIO.Attributes) {

types/SplitTreatments.d.ts

@@ -7,9 +7,9 @@ import { ISplitTreatmentsProps } from './types';
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 declare class SplitTreatments extends React.Component<ISplitTreatmentsProps> {
-    private logWarning?;
-    private evaluateSplits;
-    render(): JSX.Element;
-    componentDidMount(): void;
+  private logWarning?;
+  private evaluateFeatureFlags;
+  render(): JSX.Element;
+  componentDidMount(): void;
 }
 export default SplitTreatments;

types/constants.d.ts

@@ -3,7 +3,7 @@ export declare const ON: SplitIO.Treatment;
 export declare const OFF: SplitIO.Treatment;
 export declare const CONTROL: SplitIO.Treatment;
 export declare const CONTROL_WITH_CONFIG: SplitIO.TreatmentWithConfig;
-export declare const getControlTreatmentsWithConfig: (splitNames: unknown) => SplitIO.TreatmentsWithConfig;
+export declare const getControlTreatmentsWithConfig: (featureFlagNames: unknown) => SplitIO.TreatmentsWithConfig;
 export declare const WARN_SF_CONFIG_AND_FACTORY: string;
 export declare const ERROR_SF_NO_CONFIG_AND_FACTORY: string;
 export declare const ERROR_SC_NO_FACTORY: string;

types/types.d.ts

@@ -97,7 +97,7 @@ export interface ISplitFactoryProps extends IUpdateProps {
      */
     factory?: SplitIO.IBrowserSDK;
     /**
-     * An object of type Attributes used to evaluate the splits.
+     * An object of type Attributes used to evaluate the feature flags.
      */
     attributes?: SplitIO.Attributes;
     /**
@@ -153,7 +153,7 @@ export interface ISplitTreatmentsChildProps extends ISplitContextValues {
  */
 export interface ISplitTreatmentsProps {
     /**
-     * list of Split names
+     * list of feature flag names
      */
     names: string[];
     /**

types/useTreatments.d.ts

@@ -6,5 +6,5 @@
  * @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}
  */
-declare const useTreatments: (splitNames: string[], attributes?: import("@splitsoftware/splitio/types/splitio").Attributes | undefined, key?: import("@splitsoftware/splitio/types/splitio").SplitKey | undefined) => SplitIO.TreatmentsWithConfig;
+declare const useTreatments: (featureFlagNames: string[], attributes?: import("@splitsoftware/splitio/types/splitio").Attributes | undefined, key?: import("@splitsoftware/splitio/types/splitio").SplitKey | undefined) => SplitIO.TreatmentsWithConfig;
 export default useTreatments;