@featbit/js-client-sdk 3.0.13 → 4.0.0

package/src/platform/IInfo.ts

@@ -1,103 +1,103 @@
-export interface IFbDevice {
-  manufacturer?: string;
-  model?: string;
-  storageBytes?: string;
-  memoryBytes?: string;
-  os?: {
-    /**
-     * The family of operating system.
-     */
-    family?: string;
-    name?: string;
-    version?: string;
-  };
-}
-
-/**
- * Information about the platform of the SDK and the environment it is executing.
- */
-export interface IPlatformData {
-  /**
-   * Information about the OS on which the SDK is running. Should be populated
-   * when available. Not all platforms will make this data accessible.
-   */
-  os?: {
-    /**
-     * The architecture. Ideally at runtime, but may be build time if that is
-     * a constraint.
-     */
-    arch?: string;
-    /**
-     * The name of the OS. "MacOS", "Windows", or "Linux". If not one of those,
-     * then use the value provided by the OS.
-     */
-    name?: string;
-
-    /** The version of the OS. */
-    version?: string;
-  };
-
-  /**
-   * The name of the platform the SDK is running on. For instance 'Node'.
-   */
-  name?: string;
-
-  /**
-   * Any additional attributes associated with the platform.
-   */
-  additional?: Record<string, string>;
-
-  /**
-   * Device hardware information. Should be populated when available. Not all
-   * platforms will have this data.
-   */
-  fbDevice?: IFbDevice;
-}
-
-export interface ISdkData {
-  /**
-   * The name of the SDK. e.g. "browser-server-sdk"
-   */
-  name?: string;
-
-  /**
-   * The version of the SDK.
-   */
-  version?: string;
-
-  /**
-   * If this is a top-level (not a wrapper) SDK this will be used to create the user agent string.
-   * It will take the form 'userAgentBase/version`.
-   */
-  userAgent?: string;
-
-  /**
-   * Name of the wrapper SDK if present.
-   */
-  wrapperName?: string;
-  /**
-   * Version of the wrapper if present.
-   */
-  wrapperVersion?: string;
-}
-
-/**
- * Interface for getting information about the SDK or the environment it is
- * executing in.
- */
-export interface IInfo {
-  /**
-   * Get the app type
-   */
-  get appType(): string;
-
-  /**
-   * Get information about the platform.
-   */
-  platformData(): IPlatformData;
-
-  /**
-   * Get information about the SDK implementation.
-   */
-  sdkData(): ISdkData;
+export interface IFbDevice {
+  manufacturer?: string;
+  model?: string;
+  storageBytes?: string;
+  memoryBytes?: string;
+  os?: {
+    /**
+     * The family of operating system.
+     */
+    family?: string;
+    name?: string;
+    version?: string;
+  };
+}
+
+/**
+ * Information about the platform of the SDK and the environment it is executing.
+ */
+export interface IPlatformData {
+  /**
+   * Information about the OS on which the SDK is running. Should be populated
+   * when available. Not all platforms will make this data accessible.
+   */
+  os?: {
+    /**
+     * The architecture. Ideally at runtime, but may be build time if that is
+     * a constraint.
+     */
+    arch?: string;
+    /**
+     * The name of the OS. "MacOS", "Windows", or "Linux". If not one of those,
+     * then use the value provided by the OS.
+     */
+    name?: string;
+
+    /** The version of the OS. */
+    version?: string;
+  };
+
+  /**
+   * The name of the platform the SDK is running on. For instance 'Node'.
+   */
+  name?: string;
+
+  /**
+   * Any additional attributes associated with the platform.
+   */
+  additional?: Record<string, string>;
+
+  /**
+   * Device hardware information. Should be populated when available. Not all
+   * platforms will have this data.
+   */
+  fbDevice?: IFbDevice;
+}
+
+export interface ISdkData {
+  /**
+   * The name of the SDK. e.g. "browser-server-sdk"
+   */
+  name?: string;
+
+  /**
+   * The version of the SDK.
+   */
+  version?: string;
+
+  /**
+   * If this is a top-level (not a wrapper) SDK this will be used to create the user agent string.
+   * It will take the form 'userAgentBase/version`.
+   */
+  userAgent?: string;
+
+  /**
+   * Name of the wrapper SDK if present.
+   */
+  wrapperName?: string;
+  /**
+   * Version of the wrapper if present.
+   */
+  wrapperVersion?: string;
+}
+
+/**
+ * Interface for getting information about the SDK or the environment it is
+ * executing in.
+ */
+export interface IInfo {
+  /**
+   * Get the app type
+   */
+  get appType(): string;
+
+  /**
+   * Get information about the platform.
+   */
+  platformData(): IPlatformData;
+
+  /**
+   * Get information about the SDK implementation.
+   */
+  sdkData(): ISdkData;
 }

package/src/platform/IPlatform.ts

@@ -1,21 +1,21 @@
-import { IRequests } from "./requests";
-import { IInfo } from "./IInfo";
-import { IWebSocketWithEvents } from "./IWebSocket";
-
-export interface IPlatform {
-  /**
-   * The interface for getting information about the platform and the execution
-   * environment.
-   */
-  info: IInfo;
-
-  /**
-   * The interface for performing http/https requests.
-   */
-  requests: IRequests;
-
-  /**
-   * The interface for performing websocket connections.
-   */
-  webSocket: IWebSocketWithEvents;
+import { IRequests } from "./requests";
+import { IInfo } from "./IInfo";
+import { IWebSocketWithEvents } from "./IWebSocket";
+
+export interface IPlatform {
+  /**
+   * The interface for getting information about the platform and the execution
+   * environment.
+   */
+  info: IInfo;
+
+  /**
+   * The interface for performing http/https requests.
+   */
+  requests: IRequests;
+
+  /**
+   * The interface for performing websocket connections.
+   */
+  webSocket: IWebSocketWithEvents;
 }

package/src/platform/IStore.ts

@@ -1,113 +1,113 @@
-import { IDataKind } from "../IDataKind";
-import { IKeyedStoreItem, IStoreDataStorage, IStoreItem, IStoreKindData } from "../store/store";
-import { IUser } from "../options/IUser";
-
-/**
- * Interface for a feature store component.
- *
- * The feature store is what the client uses to store feature flag data that has been received
- * from FeatBit. By default, it uses an in-memory implementation; database integrations are
- * also available. Read the [SDK features guide](xxx).
- * You will not need to use this interface unless you are writing your own implementation.
- *
- * Feature store methods can and should call their callbacks directly whenever possible, rather
- * than deferring them with setImmediate() or process.nextTick(). This means that if for any
- * reason you are updating or querying a feature store directly in your application code (which
- * is not part of normal use of the SDK) you should be aware that the callback may be executed
- * immediately.
- */
-export interface IStore {
-  /**
-   * Set the current user of the store.
-   *
-   * @param user
-   *   The current user. The actual type of this parameter is
-   *   {@link IUser}.
-   */
-  identify(user: IUser): Promise<void>;
-
-  /**
-   * Get the current user of the store.
-   */
-  user: IUser;
-
-  /**
-   * Get an entity from the store.
-   *
-   * The store should treat any entity with the property `deleted: true` as "not found".
-   *
-   * @param kind
-   *   The type of data to be accessed. The store should not make any assumptions about the format
-   *   of the data, but just return a JSON object. The actual type of this parameter is
-   *   {@link DataKind}.
-   *
-   * @param key
-   *   The unique key of the entity within the specified collection.
-   */
-  get(kind: IDataKind, key: string): IStoreItem | null
-
-  /**
-   * Get all entities from a collection.
-   *
-   * The store should filter out any entities with the property `deleted: true`.
-   *
-   * @param kind
-   *   The type of data to be accessed. The store should not make any assumptions about the format
-   *   of the data, but just return an object in which each key is the `key` property of an entity
-   *   and the value is the entity. The actual type of this parameter is
-   *   {@link IDataKind}.
-   */
-  all(kind: IDataKind): [IStoreKindData, number];
-
-  /**
-   * Initialize the store, overwriting any existing data.
-   *
-   * @param allData
-   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
-   *   the value is an object that maps keys to entities. The actual type of this parameter is
-   *   `interfaces.FullDataSet<VersionedData>`.
-   */
-  init(allData: IStoreDataStorage): Promise<void>;
-
-  /**
-   * Add an entity or update an existing entity.
-   *
-   * @param kind
-   *   The type of data to be accessed. The actual type of this parameter is
-   *   {@link IDataKind}.
-   *
-   * @param data
-   *   The contents of the entity, as an object that can be converted to JSON. The store
-   *   should check the `version` property of this object, and should *not* overwrite any
-   *   existing data if the existing `version` is greater than or equal to that value.
-   *   The actual type of this parameter is {@link IKeyedStoreItem}.
-   */
-  upsert(kind: IDataKind, data: IKeyedStoreItem): Promise<void>;
-
-  /**
-   * Tests whether the store is initialized.
-   *
-   * "Initialized" means that the store has been populated with data, either by the client
-   * having called `init()` within this process, or by another process (if this is a shared
-   * database).
-   *
-   * @param callback
-   *   Will be called back with the boolean result.
-   */
-  initialized(): boolean;
-
-  /**
-   * Releases any resources being used by the feature store.
-   */
-  close(): void;
-
-  /**
-   * Get a description of the store.
-   */
-  getDescription?(): string;
-
-  /**
-   * The current version of the store.
-   */
-  version: number;
+import { IDataKind } from "../IDataKind";
+import { IKeyedStoreItem, IStoreDataStorage, IStoreItem, IStoreKindData } from "../store/store";
+import { IUser } from "../options/IUser";
+
+/**
+ * Interface for a feature store component.
+ *
+ * The feature store is what the client uses to store feature flag data that has been received
+ * from FeatBit. By default, it uses an in-memory implementation; database integrations are
+ * also available. Read the [SDK features guide](xxx).
+ * You will not need to use this interface unless you are writing your own implementation.
+ *
+ * Feature store methods can and should call their callbacks directly whenever possible, rather
+ * than deferring them with setImmediate() or process.nextTick(). This means that if for any
+ * reason you are updating or querying a feature store directly in your application code (which
+ * is not part of normal use of the SDK) you should be aware that the callback may be executed
+ * immediately.
+ */
+export interface IStore {
+  /**
+   * Set the current user of the store.
+   *
+   * @param user
+   *   The current user. The actual type of this parameter is
+   *   {@link IUser}.
+   */
+  identify(user: IUser): Promise<void>;
+
+  /**
+   * Get the current user of the store.
+   */
+  user: IUser;
+
+  /**
+   * Get an entity from the store.
+   *
+   * The store should treat any entity with the property `deleted: true` as "not found".
+   *
+   * @param kind
+   *   The type of data to be accessed. The store should not make any assumptions about the format
+   *   of the data, but just return a JSON object. The actual type of this parameter is
+   *   {@link DataKind}.
+   *
+   * @param key
+   *   The unique key of the entity within the specified collection.
+   */
+  get(kind: IDataKind, key: string): IStoreItem | null
+
+  /**
+   * Get all entities from a collection.
+   *
+   * The store should filter out any entities with the property `deleted: true`.
+   *
+   * @param kind
+   *   The type of data to be accessed. The store should not make any assumptions about the format
+   *   of the data, but just return an object in which each key is the `key` property of an entity
+   *   and the value is the entity. The actual type of this parameter is
+   *   {@link IDataKind}.
+   */
+  all(kind: IDataKind): [IStoreKindData, number];
+
+  /**
+   * Initialize the store, overwriting any existing data.
+   *
+   * @param allData
+   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
+   *   the value is an object that maps keys to entities. The actual type of this parameter is
+   *   `interfaces.FullDataSet<VersionedData>`.
+   */
+  init(allData: IStoreDataStorage): Promise<void>;
+
+  /**
+   * Add an entity or update an existing entity.
+   *
+   * @param kind
+   *   The type of data to be accessed. The actual type of this parameter is
+   *   {@link IDataKind}.
+   *
+   * @param data
+   *   The contents of the entity, as an object that can be converted to JSON. The store
+   *   should check the `version` property of this object, and should *not* overwrite any
+   *   existing data if the existing `version` is greater than or equal to that value.
+   *   The actual type of this parameter is {@link IKeyedStoreItem}.
+   */
+  upsert(kind: IDataKind, data: IKeyedStoreItem): Promise<void>;
+
+  /**
+   * Tests whether the store is initialized.
+   *
+   * "Initialized" means that the store has been populated with data, either by the client
+   * having called `init()` within this process, or by another process (if this is a shared
+   * database).
+   *
+   * @param callback
+   *   Will be called back with the boolean result.
+   */
+  initialized(): boolean;
+
+  /**
+   * Releases any resources being used by the feature store.
+   */
+  close(): void;
+
+  /**
+   * Get a description of the store.
+   */
+  getDescription?(): string;
+
+  /**
+   * The current version of the store.
+   */
+  version: number;
 }

package/src/platform/IWebSocket.ts

@@ -1,23 +1,23 @@
-import { IEventEmitter } from "../utils/IEventEmitter";
-import { ILogger } from "../logging/ILogger";
-import { IUser } from "../options/IUser";
-
-export interface IWebSocketConfig {
-  sdkKey: string;
-  streamingUri: string;
-  pingInterval: number;
-  user: IUser;
-  logger: ILogger;
-  getStoreTimestamp: () => number,
-  emitter?: IEventEmitter;
-}
-
-export interface IWebSocket {
-  connect: () => void;
-  close: () => void;
-  config: (param: IWebSocketConfig) => void;
-  identify: (user: IUser) => void;
-}
-
-export interface IWebSocketWithEvents extends IWebSocket, IEventEmitter {
+import { IEventEmitter } from "../utils/IEventEmitter";
+import { ILogger } from "../logging/ILogger";
+import { IUser } from "../options/IUser";
+
+export interface IWebSocketConfig {
+  sdkKey: string;
+  streamingUri: string;
+  pingInterval: number;
+  user: IUser;
+  logger: ILogger;
+  getStoreTimestamp: () => number,
+  emitter?: IEventEmitter;
+}
+
+export interface IWebSocket {
+  connect: () => void;
+  close: () => void;
+  config: (param: IWebSocketConfig) => void;
+  identify: (user: IUser) => void;
+}
+
+export interface IWebSocketWithEvents extends IWebSocket, IEventEmitter {
 }

package/src/platform/browser/BrowserInfo.ts

@@ -1,25 +1,25 @@
-import { IInfo, IPlatformData, ISdkData } from "../IInfo";
-import { name, version } from '../../version';
-
-
-export default class BrowserInfo implements IInfo {
-  get appType(): string {
-    return 'Browser-Client-SDK';
-  }
-
-  platformData(): IPlatformData {
-    return {
-      os: {},
-      name: 'Browser',
-      additional: {},
-    };
-  }
-
-  sdkData(): ISdkData {
-    return {
-      name: name,
-      version: version,
-      userAgent: `${ this.appType }/${ version }`,
-    };
-  }
+import { IInfo, IPlatformData, ISdkData } from "../IInfo";
+import { name, version } from '../../version';
+
+
+export default class BrowserInfo implements IInfo {
+  get appType(): string {
+    return 'Browser-Client-SDK';
+  }
+
+  platformData(): IPlatformData {
+    return {
+      os: {},
+      name: 'Browser',
+      additional: {},
+    };
+  }
+
+  sdkData(): ISdkData {
+    return {
+      name: name,
+      version: version,
+      userAgent: `${ this.appType }/${ version }`,
+    };
+  }
 }

package/src/platform/browser/BrowserPlatform.ts

@@ -1,20 +1,20 @@
-import { IPlatform } from "../IPlatform";
-import { IInfo } from "../IInfo";
-import { IRequests } from "../requests";
-import { IOptions } from "../../options/IOptions";
-import BrowserInfo from "./BrowserInfo";
-import { BrowserRequests } from "./BrowserRequests";
-import { IWebSocketWithEvents } from "../IWebSocket";
-import BrowserWebSocket from "./BrowserWebSocket";
-
-export class BrowserPlatform implements IPlatform {
-  info: IInfo = new BrowserInfo();
-
-  requests: IRequests;
-  webSocket: IWebSocketWithEvents;
-
-  constructor(options: IOptions) {
-    this.requests = new BrowserRequests();
-    this.webSocket = new BrowserWebSocket();
-  }
+import { IPlatform } from "../IPlatform";
+import { IInfo } from "../IInfo";
+import { IRequests } from "../requests";
+import { IOptions } from "../../options/IOptions";
+import BrowserInfo from "./BrowserInfo";
+import { BrowserRequests } from "./BrowserRequests";
+import { IWebSocketWithEvents } from "../IWebSocket";
+import BrowserWebSocket from "./BrowserWebSocket";
+
+export class BrowserPlatform implements IPlatform {
+  info: IInfo = new BrowserInfo();
+
+  requests: IRequests;
+  webSocket: IWebSocketWithEvents;
+
+  constructor(options: IOptions) {
+    this.requests = new BrowserRequests();
+    this.webSocket = new BrowserWebSocket();
+  }
 }

package/src/platform/browser/BrowserRequests.ts

@@ -1,7 +1,7 @@
-import { IRequestOptions, IRequests } from "../requests";
-
-export  class BrowserRequests implements IRequests {
-  fetch(url: string, options: IRequestOptions = {}): Promise<any> {
-    return fetch(url, options);
-  }
+import { IRequestOptions, IRequests } from "../requests";
+
+export  class BrowserRequests implements IRequests {
+  fetch(url: string, options: IRequestOptions = {}): Promise<any> {
+    return fetch(url, options);
+  }
 }