FlagshipProvider

Here is the full list of props available to use in the FlagshipProvider React component:

📘

Information

• Any change to the visitorData prop will automatically fetch flags.
• When the props fetchNow is set to true, the SDK will automatically fetch flags immediately after creating the visitor. see more
• If the props visitorData is null, no visitor will be initialized until it is set
• When both initialCampaigns and initialFlags are provided, the system will disregard initialCampaigns and only use initialFlags.
• When the SDK is running in Bucketing mode (decisionMode="BUCKETING"), the polling interval will restart when any of the following props change after the first render: envId, apiKey, decisionMode.

visitorData

The visitorData prop includes the following keys

Decision Mode

DECISION-APIMode (by default)

When the SDK operates in API mode, it uses our Decision API to manage campaign assignments and validate targeting. In this mode, each time a new Decision is needed, the SDK sends an HTTPS request to the API. This mode is enabled by default for all our SDKs.

BucketingMode

In Bucketing mode, the SDK downloads all campaign configurations in a single bucketing file. This allows the SDK to compute variation assignments on the client-side. The bucketing file is cached and only re-downloaded when campaign configurations are updated in the Flagship interface. Learn more

DecisionMode is an enum defining the decision type

onLog

The onLog function has 3 arguments

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


const App = () => (
  <>
    <FlagshipProvider
      envId="YOUR_ENV_ID"
      apiKey="YOUR_API_KEY"
      visitorData={{
        id: 'YOUR_VISITOR_ID',
        hasConsented: true,
        context: {
          // some context
        },
      }}
        onLog={(level, tag, message) => {
          console.log(`[${LogLevel[level]}] [${tag}] : ${message}`)
        }}
    >
      {/* [...] */}
    </FlagshipProvider>
  </>
)

LogLevel

LogLevel is an enum defined the level of log to receive

IFlagshipLogManager

The aims of this Interface is to define methods that an object must have in order to receive Flagship SDK logs

interface IFlagshipLogManager {
  emergency(message: string, tag: string): void;
  alert(message: string, tag: string): void;
  critical(message: string, tag: string): void;
  error(message: string, tag: string): void;
  warning(message: string, tag: string): void;
  notice(message: string, tag: string): void;
  info(message: string, tag: string): void;
  debug(message: string, tag: string): void;
  log(level: LogLevel, message: string, tag: string): void;
}

onSdkStatusChanged

The onSdkStatusChanged function has one argument

FSSdkStatus)

FSSdkStatus is an enum defining the different status of Flagship SDK

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

const status = FSSdkStatus.SDK_INITIALIZED;

import { FSSdkStatus } from "https://deno.land/x/flagship_io_js_sdk/mod.ts";

const status = FSSdkStatus.SDK_INITIALIZED;

onBucketingSuccess

The onBucketingSuccess function has one argument with the following shape:

onBucketingFail

The onBucketingFail function has one argument

onBucketingUpdated

The onBucketingUpdated function has one argument

OnVisitorExposed

In some cases, you'll need to send information about the exposure (When a flag has been seen by your visitor), like sending visitor and flag data to third parties.

To centralize it, we provide a callback in the configuration option of the SDK.

The OnVisitorExposed function accepts one argument with the following shape:

OnVisitorExposed shape

type OnVisitorExposed ={
    exposedVisitor: {
      id: string
      anonymousId?:string|null
      context: Record<string, string|number|boolean>
  },
    fromFlag: {
      key: string
      value: unknown
      defaultValue: unknown
      metadata: IFSFlagMetadata
  }
}

exposedVisitor object shape

fromFlag object shape

Here is an example on how to use this callback:

Example with Mixpanel integration
Example with Segment integration

onFetchFlagsStatusChanged

The onFetchFlagsStatusChanged function has one argument

FetchFlagsStatus

FetchFlagsStatus is an object representing the status of visitor fetch for flag data.

type FetchFlagsStatus = {
  /**
   * The new status of the flags fetch.
   */
  status: FSFetchStatus;
  /**
   * The reason for fetching Flags.
   */
  reason: FSFetchReasons;
};

FSFetchStatus enum

FSFetchStatus is an enum representing the status of the flags in the visitor instance

FSFetchReasons enum

FSFetchReasons is an enum representing the reasons for re-fetching Flags.

Tracking Manager Config

Represents the configuration for the tracking manager.

The Tracking Manager’s batch processing reduces network traffic, prevents hits loss through caching, and resends any failed hits.

options:

CacheStrategy

cacheStrategy is an enum defining the different caching strategies

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

const App = () => (
  <>
    <FlagshipProvider
      envId="YOUR_ENV_ID"
      apiKey="YOUR_API_KEY" 
      visitorData={{
        id: "YOUR_VISITOR_ID",
        hasConsented: true,
        context: {
          // some context
        },
        isAuthenticated: false,
      }}
      trackingManagerConfig={{
        cacheStrategy: CacheStrategy.CONTINUOUS_CACHING,
        poolMaxSize: 10,
        batchIntervals: 5
    }}
    >
      {/* [...] */}
    </FlagshipProvider>
  </>
);

useFlagship hook

This is the most frequently used hook from the Flagship React SDK. It provides additional functionalities such as retrieving the current flags of your actual visitor, sending hit tracking, checking SDK status, and more...

Returns an object. (Typescript:UseFlagshipOutput)

setConsent method

Sets whether the visitor has consented for protected data usage.

• setConsent(hasConsented: boolean): void

It accepts one argument:

updateContext method

Update the visitor context values, matching the given keys, used for targeting.

A new context value associated with this key will be created if there is no previous matching value.

• public updateContext(context: Record<string, string | number | boolean>): void

It has one argument :

clearContext method

Clear the actual visitor context

• clearContext(): void

🚧

• Visitor context keys must have a type of string
• Visitor context values must have a type of string, bool, numeric
• Visitor context keys and values are case sensitive
• Whenever you update visitor context, the SDK automatically re-fetches flags based on the updated context.

Context with predefined keys of context

Here's an example of how to use these predefined keys to update the visitor context in both Node.js and Deno environments:

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

const App = () => (
  <>
    <FlagshipProvider
      envId="YOUR_ENV_ID"
      apiKey="YOUR_API_KEY"
      visitorData={{
        hasConsented: true,
        context: {
          [DEVICE_LOCALE]: "fr",
        },
      }}
    >
      {/* [...] */}
    </FlagshipProvider>
  </>
);

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

export const MyReactComponent = () => {
  const { updateContext } = useFlagship()
  
  return (
    <button
    	onClick={()=>{
        updateContext({
          [DEVICE_LOCALE]: "fr"
        })
      }}>
      Trigger update context
    </button>
  );
};

Here is the List of all predefined context keys.

fetchFlags method

Invokes the decision API or refers to the bucketing file to refresh all campaign flags based on the visitor's context.

• fetchFlags(): Promise<void>

getFlag method

Return a Flag object by its key. If no flag matches the given key, an empty flag will be returned. the exists() method of the Flag object can be called to check if the flag has been found.

• getFlag(key:string):IFlag

Arguments:

getFlags method

Returns a collection of all flags fetched for the visitor.

• getFlags(): IFSFlagCollection

authenticate method

Authenticate anonymous visitor

• authenticate(visitorId: string): void

📘

Information

• Whenever the authenticate method is called, the SDK automatically re-fetches flags.
• The visitor targeting / Flags could change based on this new data.

unauthenticate method

This function change authenticated Visitor to anonymous visitor

• unauthenticate(): void

📘

Information

• Whenever the unauthenticate method is called, the SDK automatically re-fetches flags.
• The visitor targeting / Flags could change based on this new data.

sendHits method

This method Sends a hit or multiple hits to the Flagship server.

• send (hits: IHit| IHit[]): Promise<void>

Parameter:

useFsFlag hook

📘

Shortcut hook

The purpose of this hook is to rapidly get a flag.

This hook returns a Flag object by its key. If no flag matches the given key an empty flag will be returned.

• useFsFlag<T>(key: string) : IFlag<T>

IFSFlag interface

This interface represents a flag in the Flagship SDK. It helps you retrieve the flag value, access flag metadata, expose the flag, verify the flag's existence, and get the flag status with the following API:

metadata property

It returns an object that implements the IFSFlagMetadata interface, which contains the metadata of the campaign’s flag. If the flag doesn’t exist, it returns an empty object.

• metadata:IFSFlagMetadata

status property

Return the flag status.

• status: FSFlagStatus

FSFlagStatus is an enum representing the status of the flag

getValue method

Returns the value of the flag if the flag exists and the type of the default value matches the flag type value, otherwise it returns the default value.

• getValue<T>(defaultValue: T, visitorExposed : boolean) : T

Argument:

📘

Information

• The default value must be one of the following type : string, number, boolean, object, array or null.
• When the default value is null, no type checking will be performed

visitorExposed method

Notifies Flagship that the visitor has been exposed to and seen this flag.

• visitorExposed(): Promise<void>

exists method

This method checks if the flag exists.

• exists(): boolean

IFSFlagCollection interface

It represents a collection of flags.

size property

Gets the number of flags in the collection.

• readonly size: number

get method

It returns the flag associated with the specified key, or an empty if the key is not found.

• get(key: string): IFSFlag

Arguments:

has method

Checks if the collection contains a flag with the specified key.

• has(key: string): boolean

Arguments:

keys method

Gets the keys of all flags in the collection.

• keys(): Set<string>

filter method

It filters the collection based on a predicate function and returns A new IFSFlagCollection containing the flags that satisfy the predicate.

• filter(predicate: (value: IFSFlag, key: string, collection: IFSFlagCollection) => boolean): IFSFlagCollection;

Arguments:

exposeAll method

Exposes all flags in the collection.

• exposeAll(): Promise<void>

getMetadata method

A map containing the metadata for all flags in the collection.

• getMetadata(): Map<string, IFSFlagMetadata>;

toJSON method

Serializes the metadata for all flags in the collection.

• toJSON(): SerializedFlagMetadata[]

forEach method

Iterates over each flag in the collection.

• forEach (callbackfn: (value: IFSFlag, key: string, collection: IFSFlagCollection) => void): void

IFSFlagMetadata interface

interface IFSFlagMetadata{
    campaignId:string
  	campaignName:string
    variationGroupId:string
  	variationGroupName:string
    variationId: string
  	variationName:string
    isReference: boolean
    campaignType: string
    slug?:string|null
}

SerializedFlagMetadata

Hit Tracking

This section guides you on how to track visitors in your application and learn how to build hits to feed your reports. For more details about our measurement protocol, refer to our Universal Collect documentation.

There are five different types of Hits:

• Page
• Screen
• Transaction
• Item
• Event

HitType

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

export const MyReactComponent = () => {
  const pageHit = {
    type: HitType.PAGE,
    documentLocation: "https://localhost",
  }
  
  return (
    <>...</>
  );
};

Common Optional Parameters for Hits

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

export const MyReactComponent = () => {
  const fs = useFlagship()
  
  return (
    <button
      onClick={()=>{
        fs.sendHits({
          documentLocation: "https://localhost",
          userIp: "127.0.0.1",
          screenResolution: "800X600",
          locale: "fr",
          sessionNumber: "1234"
        })
      }}>
      Send a hit
    </button>
  );
};

Page hit

This hit should be sent each time a visitor navigates to a new page.

It has the following structure:

Screen hit

This hit should be sent each time a visitor navigates to a new interface on the client side.

It has the following structure:

Transaction hit

This hit should be sent when a visitor completes a Transaction.

It has this following structure:

Item hit

This hit is used to associate an item with a transaction. It should be sent following the corresponding transaction hit.

It has this following structure:

📘

Information

The Item hit is not currently available in the Flagship reporting view.

Event hit

This hit can be used to track any event, such as a click on 'Add To Cart' or a newsletter subscription.

It has the following structure:

Cache management

The purpose of cache management is to address the following issues:

• Re-allocation in bucketing mode :

In bucketing mode, the SDK ensures that a visitor remains in the variation where they were initially allocated, even if the customer or dynamic allocation changes the traffic allocation. This is because in bucketing mode, the assignment is made on the local device, so changing campaign allocation on the platform could cause visitors to see different campaigns.

• Handle offline mode on client side :

When the cache is enabled, the SDK attempts to retrieve the latest visitor data (campaign assignments) from the cache. It also saves all failed hits and visitor exposures to resend them later.

By default, the Flagship JS SDK provides a default cache manager implementation on the client side. However, you can use your own cache manager by implementing the IVisitorCacheImplementation and IHitCacheImplementation interfaces through the visitorCacheImplementation and hitCacheImplementation properties of the configuration.

Visitor Cache

The visitor cache is used to store the visitor data in a database through the IVisitorCacheImplementation interface which defines the methods that an object must implement to manager it.

interface IVisitorCacheImplementation {
    cacheVisitor(visitorId: string, data: VisitorCacheDTO):Promise<void>
    lookupVisitor(visitorId: string): Promise<VisitorCacheDTO>
    flushVisitor(visitorId: string): Promise<void>
}

cacheVisitor method

This method is invoked when the SDK needs to store visitor information in your database.

• public cacheVisitor(visitorId: string, data: object):Promise<void>

It accepts 2 arguments :

lookupVisitor method

This method is invoked when the SDK needs to retrieve visitor information associated with a specific visitor ID from your database.

It should return an object of type VisitorCacheDTO that adheres to this structure see.

• public lookupVisitor(visitorId: string): Promise<object>

It accepts one argument :

flushVisitor method

This method is invoked when the SDK needs to delete the visitor information associated with a specific visitor ID from your database.

• public flushVisitor(visitorId: string): Promise<void>

It accepts one argument :

📘

Information

• This method is called every time the setConsent method or the hasConsented key of the props visitorData is set to false.

VisitorCacheDTO

type VisitorCacheDTO = {
  version: number;
  data: {
    visitorId: string;
    anonymousId: string | null;
    consent?: boolean;
    context?: Record<string, boolean|number|string>;
    assignmentsHistory?: Record<string, string>;
    campaigns?: Array<{
      campaignId: string;
      variationGroupId: string;
      variationId: string;
      isReference?: boolean;
      type: string;
      activated?: boolean;
      flags?: Record<string, unknown>;
    }>;
  };
};

Hit Cache

The hit cache is used to store hits in your database based on the strategy used through the IHitCacheImplementation interface which defines the methods that an object must implement to handle it.

interface IHitCacheImplementation {
    cacheHit(hits: Record<string, HitCacheDTO>):Promise<void>
    lookupHits():Promise<Record<string, HitCacheDTO>>
    flushHits(hitKeys: string[]): Promise<void>
    flushAllHits(): Promise<void>
}

cacheHit method

This method is invoked to store hits based on cache the strategy used.

• public cacheHit(hits: Record<string, HitCacheDTO>):Promise<void>

It accepts 1 argument :

lookupHits method

This method is invoked to load all hits from your database and attempt to send them in the background.

It should return an object where the key is a unique ID for each hit, and the value is an object of type HitCacheDTO that adheres to this structure see.

• public lookupHits():Promise<Record<string, HitCacheDTO>>

📘

Information

• Hits older than 4H will be ignored during the re-sending process.

flushHits function

This method is invoked to delete all hits that match the unique hit IDs from your database.

NOTE: It is called every time setConsent is set to false, erasing all of the visitor's hits from the database.

• public flushHits(hitKeys: string[]): Promise<void>

It accepts one argument :

📘

* This method is called every time the setConsent method or the hasConsented key of the props visitorData is set to false.

flushAllHits function

This method is invoked to delete all hits from your database without exception.

• public flushAllHits(): Promise<void>

HitCacheDTO

type HitCacheLookupDTO = {
  version: number;
  data: {
    visitorId: string;
    anonymousId: string | null;
    type: HitType | "ACTIVATE";
    time: number;
    content?: Record<string, unknown>;
  };
};

IHitCacheImplementation implementation

localStorage

This is an implementation of the IHitCacheImplementation interface using localStorage.

import { Flagship, CacheStrategy } from "@flagship.io/react-sdk";

const FS_HIT_PREFIX = 'FS_DEFAULT_HIT_CACHE'


const hitCacheImplementation = {
  cacheHit (hits) {
    const localDatabaseJson = localStorage.getItem(FS_HIT_PREFIX) || '{}'
    const localDatabase = JSON.parse(localDatabaseJson)

    const newLocalDatabase = {
      ...localDatabase,
      ...hits
    }

    localStorage.setItem(FS_HIT_PREFIX, JSON.stringify(newLocalDatabase))
    return Promise.resolve()
  },
  lookupHits () {
    const localDatabaseJson = localStorage.getItem(FS_HIT_PREFIX) || '{}'
    const localDatabase = JSON.parse(localDatabaseJson)
    return Promise.resolve(localDatabase)
  },
  flushHits (hitKeys) {
    const localDatabaseJson = localStorage.getItem(FS_HIT_PREFIX) || '{}'
    const localDatabase = JSON.parse(localDatabaseJson)

    hitKeys.forEach(key => {
      delete localDatabase[key]
    })

    localStorage.setItem(FS_HIT_PREFIX, JSON.stringify(localDatabase))
    return Promise.resolve()
  },
  flushAllHits () {
    localStorage.removeItem(FS_HIT_PREFIX)
    return Promise.resolve()
  }
}

Flagship.start(ENV_ID, API_KEY, {
  hitCacheImplementation: hitCacheImplementation,
  trackingManagerConfig: {
    batchIntervals: 5,
    poolMaxSize: 10,
    cacheStrategy: CacheStrategy.CONTINUOUS_CACHING
  }
})

Redis

This is an implementation of the IHitCacheImplementation interface using redis.

import { Flagship, CacheStrategy } from "@flagship.io/react-sdk";
import Redis from 'ioredis'

function hitCacheImplementation (host, port, dbIndex) {
  const redis = new Redis({
    host,
    port
  })

  redis.select(dbIndex)

  return {

    async cacheHit (hits) {
      const multi = redis.multi()
      Object.entries(hits).forEach(([key, value]) => {
        multi.set(key, JSON.stringify(value))
      })
      await multi.exec()
    },
    async lookupHits () {
      const hits:Record<string, HitCacheDTO> = {}
      const keys = await redis.keys('*')
      if (!keys.length) {
        return hits
      }
      const redisData = await redis.mget(keys)

      redisData.forEach((value, index) => {
        if (!value) {
          return
        }
        hits[keys[index]] = JSON.parse(value)
      })
      return hits
    },
    async flushHits (hitKeys) {
      await redis.del(hitKeys)
    },

    async flushAllHits () {
      const keys = await redis.keys('*')
      if (!keys.length) {
        return
      }
      await redis.del(keys)
    }
  }
}

Flagship.start(ENV_ID, API_KEY, {
  hitCacheImplementation:hitCacheImplementation('127.0.0.1', '6379', 2),
  trackingManagerConfig: {
    batchIntervals: 10,
    poolMaxSize: 100,
    cacheStrategy: CacheStrategy.PERIODIC_CACHING
  }
})

In the LocalStorage implementation, the localStorage web API is used to store, retrieve, and delete hits. In the Redis implementation, the ioredis library is used to interact with a Redis database for the same purposes. Both implementations are passed to the Flagship.start method as part of the configuration object.

Predefined visitor context keys

The Flagship SDK contains predefined visitor context keys.

The keys marked as Yes in the Auto-set by SDK column will be automatically set, while the ones marked as No need to be set by customer.

All possible predefined keys are listed below: