Migration to v5.X

This guide assists developers in transitioning from Flagship 3.X to Flagship 4.X and higher.

The primary changes include:

• FlagshipProvider props

• useFlagship hook

• useFsFlag hook

• Flagship SDK Status

For more details, see the change log

FlagshipProvider props

Below are the options that have been changed from version 3.X to 4.X and higher:

• In version 4.X and higher, when initializing a visitor, the hasConsented option within the visitorData props is now required. In contrast, this option was optional in version 3.X.

• The isNewInstance props has been replaced with shouldSaveInstance.

• The enableClientCacheprops has been replaced with reuseVisitorIds

• The statusChangedCallback has been replaced with onSdkStatusChanged.

• The onSdkStatusChanged is triggered with the current status of the SDK, leading to the removal of the onInitStart and onInitDone callbacks.

Now

import React from "react";
import { FlagshipProvider } from "@flagship.io/react-native-sdk";

const App = () => (
  <>
    <FlagshipProvider
      envId="YOUR_ENV_ID"
      apiKey="YOUR_API_KEY"
      visitorData={{
        hasConsented: true, // This is now mandatory
      }}
    >
      {/* ... */}
    </FlagshipProvider>
  </>
);

Before

import React from "react";
import { FlagshipProvider } from "@flagship.io/react-sdk";

const App = () => (
  <>
    <FlagshipProvider
      envId="YOUR_ENV_ID"
      apiKey="YOUR_API_KEY"
      visitorData={{}} // 'hasConsented' was optional
    >
      {/* ... */}
    </FlagshipProvider>
  </>
);

useFlagship hook

In version 4.X and higher, the useFlagship hook's methods hit.send and hit.sendMultiple have been superseded by the method sendHits .

Now

import React from "react";
import { useFlagship, HitType } from "@flagship.io/react-native-sdk";

export const MyReactComponent = () => {
  const fs = useFlagship()
  
  return (
    <button
      onClick={()=>{
        fs.sendHits({
          type: HitType.PAGE,
          documentLocation: "https://localhost",
        })
      }}>
      Send a hit
    </button>
  );
};

Before

import React from "react";
import { useFlagship, HitType } from "@flagship.io/react-sdk";

export const MyReactComponent = () => {
  const fs = useFlagship()
  
  return (
    <button
      onClick={()=>{
        fs.hit.send({
          type: HitType.PAGE,
          documentLocation: "https://localhost",
        })
      }}>
      Send a hit
    </button>
  );
};

GetFlag method update

In version 4.X and higher, the approach to setting a flag's default value has been modified. The default value is no longer set using the getFlag method of useFlagship instance. Instead, it is now set using the getValue of flag instance.

Here's how you can set the default value of a flag in versions 4.X and 3.X:

Now

...
const fs = useFlagship()
const flag = fs.getFlag("myFlagKey");
const flagValue = flag.getValue("default-value");

Before

...
const fs = useFlagship()
const flag = fs.getFlag("myFlagKey", "default-value");
const flagValue = flag.getValue();

useFsFlag hook

The default value is no longer set using the the second parameter of useFsFlag. Instead, it is now set using the getValue of flag instance.

Here's how you can set the default value of a flag in versions 4.X and 3.X:

Now

...
const flag = useFsFlag("myFlagKey");
const flagValue = flag.getValue("default-value");

Before

...
const flag = useFsFlag("myFlagKey", "default-value");
const flagValue = flag.getValue();

Renamed Types and APIs

Flag Status

In the version 5.x and higher, the FetchFlagsStatus type has been renamed to FlagsStatus for clarity.

Flagship SDK Status

In version 4.X and higher, the statusChangedCallback has been replaced with onSdkStatusChanged and the enum FlagshipStatus has been superseded by FSSdkStatus.

The table below matches the FlagshipStatus enum keys from version 3.X to the corresponding FSSdkStatus keys in version 4.X.

V4.X and higher	V3.X
SDK_NOT_INITIALIZED	NOT_READY
SDK_NOT_INITIALIZED	NOT_INITIALIZED
SDK_INITIALIZING	STARTING
SDK_INITIALIZING	POLLING
SDK_PANIC	READY_PANIC_ON
SDK_INITIALIZED	READY