@featbit/js-client-sdk 3.0.13 → 4.0.0

package/src/options/IOptions.ts

@@ -1,124 +1,124 @@
-import { ILogger } from "../logging/ILogger";
-import { IDataSynchronizer } from "../data-sync/IDataSynchronizer";
-import { IClientContext } from "./IClientContext";
-import { IDataSourceUpdates } from "../store/IDataSourceUpdates";
-import { VoidFunction } from "../utils/VoidFunction";
-import { IStore } from "../platform/IStore";
-import { DataSyncModeEnum } from "../data-sync/DataSyncMode";
-import { IUser } from "./IUser";
-import { IFlagBase } from "../evaluation";
-
-export interface IOptions {
-  /**
-   * The user for whom you are evaluating feature flags.
-   */
-  user?: IUser;
-
-  /**
-   * How long the client constructor will block awaiting a successful connection to FeatBit, in milliseconds.
-   *
-   * Defaults to 5000 milliseconds.
-   */
-  startWaitTime?: number;
-
-  /**
-   * The SDK key for your FeatBit environment.
-   */
-  sdkKey?: string;
-
-  /**
-   * The mode to sync flag end segment data with the FeatBit server. See {@link DataSyncModeEnum} for possible values.
-   *
-   * Defaults to {@link DataSyncModeEnum.STREAMING}.
-   */
-  dataSyncMode?: DataSyncModeEnum;
-
-  /**
-   * The base URI of the data-sync service, mandatory if the {@link dataSyncMode} is set to {@link DataSyncModeEnum.STREAMING}.
-   */
-  streamingUri?: string;
-
-  /**
-   * The base URI of the polling service, mandatory if the {@link dataSyncMode} option is set to {@link DataSyncModeEnum.POLLING}.
-   */
-  pollingUri?: string;
-
-  /**
-   * The base URI of the event service
-   */
-  eventsUri?: string;
-
-  /**
-   * Whether this client is offline. If true, no calls to FeatBit will be made.
-   *
-   * Defaults to false
-   */
-  offline?: boolean;
-
-  /**
-   * The time between polling requests, in milliseconds. Ignored in data-sync mode.
-   *
-   * Defaults to 30 000 milliseconds.
-   */
-  pollingInterval?: number;
-
-  /**
-   * The interval in between flushes of events queue, in milliseconds.
-   *
-   * The default value is 2 000 milliseconds.
-   */
-  flushInterval?: number;
-
-  /**
-   * The max number of events in the events queue.
-   * defaults to 10 000
-   */
-  maxEventsInQueue?: number;
-
-  /**
-   * Configures a logger for warnings and errors generated by the SDK.
-   *
-   * The logger can be any object that conforms to the {@link ILogger} interface.
-   * For a simple implementation that lets you filter by log level, see
-   * {@link BasicLogger}. You can also use an instance of `winston.Logger` from
-   * the Winston logging package.
-   *
-   * If you do not set this property, the SDK uses {@link BasicLogger} with a
-   * minimum level of `info`.
-   */
-  logger?: ILogger;
-
-  /**
-   * The interval in between sending WebSocket ping messages to evaluation server, in milliseconds.
-
-   * Defaults to 18 000 milliseconds.
-   */
-  webSocketPingInterval?: number;
-
-  /**
-   * The flags to bootstrap the client, which should be the string representation of type {@link IFlagBase[]}.
-   */
-  bootstrap?: IFlagBase[];
-
-  /**
-   * The store to use for caching feature flag data.
-   *
-   * Defaults to {@link InMemoryStore}.
-   */
-  store?: IStore | ((options: IOptions) => IStore);
-
-  /**
-   * A component that obtains feature flag data and puts it in the store.
-   *
-   * Defaults to {@link WebSocketDataSynchronizer}.
-   */
-  dataSynchronizer?:
-    | object
-    | ((
-    clientContext: IClientContext,
-    store: IStore,
-    dataSourceUpdates: IDataSourceUpdates,
-    initSuccessHandler: VoidFunction,
-    errorHandler?: (e: Error) => void,
-  ) => IDataSynchronizer);
+import { ILogger } from "../logging/ILogger";
+import { IDataSynchronizer } from "../data-sync/IDataSynchronizer";
+import { IClientContext } from "./IClientContext";
+import { IDataSourceUpdates } from "../store/IDataSourceUpdates";
+import { VoidFunction } from "../utils/VoidFunction";
+import { IStore } from "../platform/IStore";
+import { DataSyncModeEnum } from "../data-sync/DataSyncMode";
+import { IUser } from "./IUser";
+import { IFlagBase } from "../evaluation";
+
+export interface IOptions {
+  /**
+   * The user for whom you are evaluating feature flags.
+   */
+  user?: IUser;
+
+  /**
+   * How long the client constructor will block awaiting a successful connection to FeatBit, in milliseconds.
+   *
+   * Defaults to 5000 milliseconds.
+   */
+  startWaitTime?: number;
+
+  /**
+   * The SDK key for your FeatBit environment.
+   */
+  sdkKey?: string;
+
+  /**
+   * The mode to sync flag end segment data with the FeatBit server. See {@link DataSyncModeEnum} for possible values.
+   *
+   * Defaults to {@link DataSyncModeEnum.STREAMING}.
+   */
+  dataSyncMode?: DataSyncModeEnum;
+
+  /**
+   * The base URI of the data-sync service, mandatory if the {@link dataSyncMode} is set to {@link DataSyncModeEnum.STREAMING}.
+   */
+  streamingUri?: string;
+
+  /**
+   * The base URI of the polling service, mandatory if the {@link dataSyncMode} option is set to {@link DataSyncModeEnum.POLLING}.
+   */
+  pollingUri?: string;
+
+  /**
+   * The base URI of the event service
+   */
+  eventsUri?: string;
+
+  /**
+   * Whether this client is offline. If true, no calls to FeatBit will be made.
+   *
+   * Defaults to false
+   */
+  offline?: boolean;
+
+  /**
+   * The time between polling requests, in milliseconds. Ignored in data-sync mode.
+   *
+   * Defaults to 30 000 milliseconds.
+   */
+  pollingInterval?: number;
+
+  /**
+   * The interval in between flushes of events queue, in milliseconds.
+   *
+   * The default value is 2 000 milliseconds.
+   */
+  flushInterval?: number;
+
+  /**
+   * The max number of events in the events queue.
+   * defaults to 10 000
+   */
+  maxEventsInQueue?: number;
+
+  /**
+   * Configures a logger for warnings and errors generated by the SDK.
+   *
+   * The logger can be any object that conforms to the {@link ILogger} interface.
+   * For a simple implementation that lets you filter by log level, see
+   * {@link BasicLogger}. You can also use an instance of `winston.Logger` from
+   * the Winston logging package.
+   *
+   * If you do not set this property, the SDK uses {@link BasicLogger} with a
+   * minimum level of `info`.
+   */
+  logger?: ILogger;
+
+  /**
+   * The interval in between sending WebSocket ping messages to evaluation server, in milliseconds.
+
+   * Defaults to 18 000 milliseconds.
+   */
+  webSocketPingInterval?: number;
+
+  /**
+   * The flags to bootstrap the client, which should be the string representation of type {@link IFlagBase[]}.
+   */
+  bootstrap?: IFlagBase[];
+
+  /**
+   * The store to use for caching feature flag data.
+   *
+   * Defaults to {@link InMemoryStore}.
+   */
+  store?: IStore | ((options: IOptions) => IStore);
+
+  /**
+   * A component that obtains feature flag data and puts it in the store.
+   *
+   * Defaults to {@link WebSocketDataSynchronizer}.
+   */
+  dataSynchronizer?:
+    | object
+    | ((
+    clientContext: IClientContext,
+    store: IStore,
+    dataSourceUpdates: IDataSourceUpdates,
+    initSuccessHandler: VoidFunction,
+    errorHandler?: (e: Error) => void,
+  ) => IDataSynchronizer);
 }

package/src/options/IUser.ts

@@ -1,7 +1,7 @@
-import { IContextProperty } from "../IContextProperty";
-
-export interface IUser {
-  keyId: string;
-  name?: string;
-  customizedProperties?: IContextProperty[];
+import { IContextProperty } from "../IContextProperty";
+
+export interface IUser {
+  keyId: string;
+  name?: string;
+  customizedProperties?: IContextProperty[];
 }

package/src/options/IValidatedOptions.ts

@@ -1,30 +1,30 @@
-import { ILogger } from "../logging/ILogger";
-import { IStore } from "../platform/IStore";
-import { IOptions } from "./IOptions";
-import { IDataSynchronizer } from "../data-sync/IDataSynchronizer";
-import { DataSyncModeEnum } from "../data-sync/DataSyncMode";
-import { IUser } from "./IUser";
-import { IBootstrapProvider } from "../bootstrap";
-import { IFlagBase } from "../evaluation";
-
-export interface IValidatedOptions {
-  startWaitTime: number;
-  sdkKey: string;
-  pollingUri: string;
-  streamingUri: string;
-  eventsUri: string;
-  dataSyncMode: DataSyncModeEnum;
-  webSocketPingInterval?: number;
-  flushInterval: number;
-  maxEventsInQueue: number;
-  pollingInterval: number;
-  offline: boolean;
-  store: IStore | ((options: IOptions) => IStore);
-  dataSynchronizer?: IDataSynchronizer;
-  logger?: ILogger;
-  user?: IUser;
-  bootstrap?: IFlagBase[];
-
-  // Allow indexing this by a string for the validation step.
-  [index: string]: any;
+import { ILogger } from "../logging/ILogger";
+import { IStore } from "../platform/IStore";
+import { IOptions } from "./IOptions";
+import { IDataSynchronizer } from "../data-sync/IDataSynchronizer";
+import { DataSyncModeEnum } from "../data-sync/DataSyncMode";
+import { IUser } from "./IUser";
+import { IBootstrapProvider } from "../bootstrap";
+import { IFlagBase } from "../evaluation";
+
+export interface IValidatedOptions {
+  startWaitTime: number;
+  sdkKey: string;
+  pollingUri: string;
+  streamingUri: string;
+  eventsUri: string;
+  dataSyncMode: DataSyncModeEnum;
+  webSocketPingInterval?: number;
+  flushInterval: number;
+  maxEventsInQueue: number;
+  pollingInterval: number;
+  offline: boolean;
+  store: IStore | ((options: IOptions) => IStore);
+  dataSynchronizer?: IDataSynchronizer;
+  logger?: ILogger;
+  user?: IUser;
+  bootstrap?: IFlagBase[];
+
+  // Allow indexing this by a string for the validation step.
+  [index: string]: any;
 }

package/src/options/OptionMessages.ts

@@ -1,36 +1,36 @@
-/**
- * Messages for issues which can be encountered from processing the configuration options.
- */
-export default class OptionMessages {
-  static optionBelowMinimum(name: string, value: number, min: number): string {
-    return `Config option "${ name }" had invalid value of ${ value }, using minimum of ${ min } instead`;
-  }
-
-  static unknownOption(name: string): string {
-    return `Ignoring unknown config option "${ name }"`;
-  }
-
-  static wrongOptionType(name: string, expectedType: string, actualType: string): string {
-    return `Config option "${ name }" should be of type ${ expectedType }, got ${ actualType }, using default value`;
-  }
-
-  static wrongOptionTypeBoolean(name: string, actualType: string): string {
-    return `Config option "${ name }" should be a boolean, got ${ actualType }, converting to boolean`;
-  }
-
-  static partialEndpoint(name: string): string {
-    return `You have set custom uris without specifying the ${ name } URI; connections may not work properly`;
-  }
-
-  static mandatory(name: string): string {
-    return `${ name } is mandatory`;
-  }
-
-  static invalidOptionValue(name: string): string {
-    return `Invalid option value: ${ name }`;
-  }
-
-  static missingKeyInBootstrapValue(key: string): string {
-    return `Missing key "${ key }" in bootstrap value`;
-  }
+/**
+ * Messages for issues which can be encountered from processing the configuration options.
+ */
+export default class OptionMessages {
+  static optionBelowMinimum(name: string, value: number, min: number): string {
+    return `Config option "${ name }" had invalid value of ${ value }, using minimum of ${ min } instead`;
+  }
+
+  static unknownOption(name: string): string {
+    return `Ignoring unknown config option "${ name }"`;
+  }
+
+  static wrongOptionType(name: string, expectedType: string, actualType: string): string {
+    return `Config option "${ name }" should be of type ${ expectedType }, got ${ actualType }, using default value`;
+  }
+
+  static wrongOptionTypeBoolean(name: string, actualType: string): string {
+    return `Config option "${ name }" should be a boolean, got ${ actualType }, converting to boolean`;
+  }
+
+  static partialEndpoint(name: string): string {
+    return `You have set custom uris without specifying the ${ name } URI; connections may not work properly`;
+  }
+
+  static mandatory(name: string): string {
+    return `${ name } is mandatory`;
+  }
+
+  static invalidOptionValue(name: string): string {
+    return `Invalid option value: ${ name }`;
+  }
+
+  static missingKeyInBootstrapValue(key: string): string {
+    return `Missing key "${ key }" in bootstrap value`;
+  }
 }

package/src/options/UserBuilder.ts

@@ -1,36 +1,36 @@
-import { IUser } from "./IUser";
-import {IContextProperty} from "../IContextProperty";
-
-/**
- * Creates an instance of the FeatBit user.
- *
- * @return
- *   The new {@link IUser} instance.
- */
-export class UserBuilder {
-  private _keyId: string = '';
-  private _name: string = '';
-  private _custom: IContextProperty[] = [];
-
-  constructor(keyId: string) {
-    this._keyId = keyId;
-  }
-
-  name(name: string): UserBuilder {
-    this._name = name;
-    return this;
-  }
-
-  custom(propertyName: string, value: string): UserBuilder {
-    this._custom?.push({ name: propertyName, value: `${value}` });
-    return this;
-  }
-
-  build(): IUser {
-    return {
-      name: this._name,
-      keyId: this._keyId,
-      customizedProperties: this._custom
-    };
-  }
+import { IUser } from "./IUser";
+import {IContextProperty} from "../IContextProperty";
+
+/**
+ * Creates an instance of the FeatBit user.
+ *
+ * @return
+ *   The new {@link IUser} instance.
+ */
+export class UserBuilder {
+  private _keyId: string = '';
+  private _name: string = '';
+  private _custom: IContextProperty[] = [];
+
+  constructor(keyId: string) {
+    this._keyId = keyId;
+  }
+
+  name(name: string): UserBuilder {
+    this._name = name;
+    return this;
+  }
+
+  custom(propertyName: string, value: string): UserBuilder {
+    this._custom?.push({ name: propertyName, value: `${value}` });
+    return this;
+  }
+
+  build(): IUser {
+    return {
+      name: this._name,
+      keyId: this._keyId,
+      customizedProperties: this._custom
+    };
+  }
 }