index.ts

/* eslint-disable @typescript-eslint/no-unused-vars */
/**
 * Split software typescript declarations testing.
 *
 * This file is not meant to run but to be compiled without errors. This is the same way to test .d.ts files
 * that you will need to comply to publish packages on @types organization on NPM (DefinitelyTyped).
 * We import the declarations through the NPM package name (using the development branch of the repo)
 * to test in the same way in which customers will be using it on development.
 */

import type * as SplitTypes from '../types/splitio';

import { SplitFactory, DebugLogger, InfoLogger, WarnLogger, ErrorLogger, InLocalStorage } from '../types/index';

// Validate that the SplitIO namespace is available and matches the types when imported explicitly
let ambientType: SplitIO.ISDK;
let importedType: SplitTypes.ISDK;
ambientType = importedType;

let reactNativeSettings: SplitIO.IReactNativeSettings = {
  core: {
    authorizationKey: 'another-key',
    key: 'customer-key',
  },
};

let fullReactNativeSettings: SplitIO.IReactNativeSettings = {
  core: {
    authorizationKey: 'asd',
    key: 'asd',
    labelsEnabled: false,
  },
  scheduler: {
    featuresRefreshRate: 1,
    impressionsRefreshRate: 1,
    impressionsQueueSize: 1,
    telemetryRefreshRate: 1,
    segmentsRefreshRate: 1,
    offlineRefreshRate: 1,
    eventsPushRate: 1,
    eventsQueueSize: 1,
    pushRetryBackoffBase: 1,
  },
  startup: {
    readyTimeout: 1,
    requestTimeoutBeforeReady: 1,
    retriesOnFailureBeforeReady: 1,
    eventsFirstPushWindow: 1,
  },
  urls: {
    sdk: 'https://asd.com/sdk',
    events: 'https://asd.com/events',
    auth: 'https://asd.com/auth',
    streaming: 'https://asd.com/streaming',
    telemetry: 'https://asd.com/telemetry',
  },
  features: {
    feature1: 'treatment',
    feature2: { treatment: 'treatment2', config: "{ 'prop': 'value'}" },
    feature3: { treatment: 'treatment3', config: null },
  },
  initialRolloutPlan: {} as SplitIO.RolloutPlan,
  storage: InLocalStorage({
    prefix: 'splitio',
    clearOnInit: true,
    expirationDays: 1,
    wrapper: {
      getItem(key: string) {
        return Promise.resolve('value');
      },
      setItem(key: string, value: string) {
        return Promise.resolve();
      },
      removeItem(key: string) {
        return Promise.resolve();
      },
    } as SplitIO.StorageWrapper,
  }),
  impressionListener: {
    logImpression: (data: SplitIO.ImpressionData) => {
      let impressionData: SplitIO.ImpressionData = data;
    },
  },
  debug: true,
  integrations: [],
  streamingEnabled: true,
  sync: {
    splitFilters: [
      {
        type: 'bySet',
        values: ['set_a', 'set_b'],
      },
      {
        type: 'byName',
        values: ['my_split_1', 'my_split_1'],
      },
      {
        type: 'byPrefix',
        values: ['my_split', 'test_split_'],
      },
    ],
    impressionsMode: 'DEBUG',
    enabled: true,
    requestOptions: {
      getHeaderOverrides(context) {
        return { ...context.headers, headerName: 'value' };
      },
    },
  },
  userConsent: 'GRANTED',
  mode: 'standalone',
  fallbackTreatments: {
    global: { treatment: 'global-treatment', config: '{"global": true}' },
    byFlag: {
      my_flag: { treatment: 'flag-treatment', config: '{"flag": true}' },
      my_other_flag: 'other-flag-treatment',
    },
  },
};

reactNativeSettings.userConsent = 'DECLINED';
reactNativeSettings.userConsent = 'UNKNOWN';

// debug property can be a log level or Logger instance
reactNativeSettings.debug = 'ERROR';
reactNativeSettings.debug = DebugLogger();
reactNativeSettings.debug = InfoLogger();
reactNativeSettings.debug = WarnLogger();
reactNativeSettings.debug = ErrorLogger();

const SDK: SplitIO.IBrowserSDK = SplitFactory(reactNativeSettings);