DefinitelyTyped/types/rox-node/rox-node-tests.ts

import * as Rox from 'rox-node';

const flags = {
  superFlag: new Rox.Flag(false),
  superFlag2: new Rox.Flag(),
};

const variants = {
  superVariant: new Rox.Variant('value1', ['value1', 'value2']),
};

const configurations = {
  superConfiguration: new Rox.Configuration('☀️'),
  superConfiguration2: new Rox.Configuration(true),
};

// The register function should be called before the call to Rox.setup()
Rox.register('default', { ...configurations, ...variants, ...flags });
Rox.setContext({ user: 'John Doe' });
Rox.setup('ROLLOUT_IO_KEY', {
  impressionHandler,
  configurationFetchedHandler,
}).then(linkTargetGroupAttributes);

Rox.dynamicApi.isEnabled('system.repotAnalytics', false);
Rox.dynamicApi.value('ui.textColor', 'red');

Rox.flags[0].defaultValue;
Rox.flags[0].name;

flags.superFlag.isEnabled();
flags.superFlag.isEnabled({ user: 'John' });

configurations.superConfiguration.defaultValue;
configurations.superConfiguration.name;
configurations.superConfiguration.getValue();
configurations.superConfiguration.getValue({ user: 'John' });

variants.superVariant.defaultValue;
variants.superVariant.name;
variants.superVariant.getValue();
variants.superVariant.getValue({ user: 'John' });

function linkTargetGroupAttributes() {
  Rox.setCustomStringProperty('id', 'someId');
  Rox.setCustomStringProperty('id', () => 'someId');
  Rox.setCustomStringProperty('id', (context: any): string => context.id);

  Rox.setCustomBooleanProperty('thisIsATest', true);
  Rox.setCustomBooleanProperty('thisIsATest', () => true);
  Rox.setCustomBooleanProperty('thisIsATest', (context: any): boolean => context.value);

  Rox.setCustomNumberProperty('aNumberProperty', 17);
  Rox.setCustomNumberProperty('aNumberProperty', () => 17);
  Rox.setCustomNumberProperty('aNumberProperty', (context: any): number => context.value);

  Rox.setDynamicCustomPropertyRule((propName: string, _context: unknown) => {
    return propName === 'myPropName';
  });
}

function impressionHandler(
  _reporting: Rox.RoxReporting,
  _experiment?: Rox.RoxExperiment,
) {
  // If there is no experiment it means that the user has not been enrolled
  // or that the reporting is not used yet
}

function configurationFetchedHandler(fetcherResult: Rox.RoxFetcherResult) {
  if (
    fetcherResult.hasChanges &&
    fetcherResult.fetcherStatus === Rox.RoxFetcherStatus.AppliedFromCache
  ) {
  }
}