Featurit-sdk-angular NPM

Featurit SDK for Angular

Angular wrapper of the Javascript client for the FeaturIT Feature Flag management platform.

Description

This package aims to simplify the integration of the FeaturIT API in an Angular project.

Getting started

Dependencies

"tslib": "^2.3.0"
"featurit-sdk-js-browser": "^0.0.4"

Installing

npm install featurit-sdk-angular --save

Inside your app.module.ts add:

@NgModule({
  ...,
  imports: [
    ...,
    FeaturitModule.forRoot({
      tenantIdentifier: "your_tenant_subdomain",
      frontendApiKey: "your_frontend_api_key",
      refreshIntervalMinutes: 5,
      enableAnalytics: false,
      enableTracking: false,
    }),
  ],

Basic Usage

That's how you would use Featurit in one of your Angular components:

featureFlag: FeatureFlag = {
  name: 'Feat',
  active: false,
  version: 'default',
};

constructor(private featurit: FeaturitService) {
  ...
}

async ngOnInit() {
  this.featurit.setUserContext(this.userContext);

  await this.listenFeatureFlag();
}

private async listenFeatureFlag() {
  await this.featurit.init();

  this.featureFlag.active = this.featurit.isActive("YOUR_FEATURE_NAME");
  this.featureFlag.version = this.featurit.version("YOUR_FEATURE_NAME");

  // This part is optional but it will allow for automatic updates 
  // on the application when the feature flag changes 
  // are synced from the server.
  
  this.featurit.onChange(this.featureFlag).subscribe({
    next: (newFeatureFlag: FeatureFlag) => {
      console.log('AngularComponent: ', `Observed change, updating my value to ${JSON.stringify(newFeatureFlag)}`);
      this.featureFlag = newFeatureFlag;
    }
  });
}

If for some reason you need to send your api key credentials after the application has loaded, you can call the init method with the full configuration instead.

private async my_method() {
  const my_api_key = get_api_key_from_server();
  const my_user_context = get_user_context();
  
  await this.featurit.init({
    tenantIdentifier: "your_tenant_subdomain",
    frontendApiKey: my_api_key,
    refreshIntervalMinutes: 5,
    enableAnalytics: true,
    sendAnalyticsInterval: 1,
    enableTracking: true,
    featuritUserContext: my_user_context,
  });
}

Defining your FeaturitUserContext

In order to show different versions of a feature to different users, Featurit needs to know about the attributes your user has in a certain context.

You can define the context using the as follows:

const contextData: FeaturitUserContext = get_your_user_context_data();

this.featurit.setUserContext(contextData);

// This call is optional and will retrieve the new values for the feature flags inmediately.
await this.featurit.refresh();

Event Tracking

In order to track some event in your application, we need to initialize the Module with enableTracking set to true:

@NgModule({
  ...,
  imports: [
    ...,
  FeaturitModule.forRoot({
    tenantIdentifier: "your_tenant_subdomain",
    frontendApiKey: "your_frontend_api_key",
    refreshIntervalMinutes: 5,
    enableAnalytics: false,
    enableTracking: true,
  }),
],

// Once we initialize our Component, we can register global properties that will be tracked  
// with every person and event.
// We can also track the person associated with the event after setting the appropiate user context.
async ngOnInit() {
  // (OPTIONAL) We can register global properties that will be sent with every
  // Person and Tracking Event from now on.
  this.featurit.register("my-global-property", "my-global-property-value");

  this.featurit.setUserContext(this.userContext);
  
  // This line will define the person to track (do this after setting the user context).
  this.featurit.trackPerson();

  await this.listenFeatureFlag();
}

// The track method will be used to send a new tracking event to the server.
// We can add as many properties to our events as we want.
this.featurit.track("my-event-name", {
  "my-event-property": "my-property-value",
});

// (OPTIONAL) Sometimes we want the event to be sent inmediately to the server,
// If so, we can use the following line:
this.featurit.flush();