@featbit/js-client-sdk 3.0.11 → 3.0.13

package/src/integrations/test_data/TestDataSynchronizer.ts

@@ -1,50 +1,50 @@
-import { IDataSynchronizer } from "../../data-sync/IDataSynchronizer";
-import { IFlag } from "../../evaluation/data/IFlag";
-import { EventName, ProcessStreamResponse } from "../../data-sync/types";
-import { IDataSourceUpdates } from "../../store/IDataSourceUpdates";
-import { VoidFunction } from "../../utils/VoidFunction";
-import { IDataKind } from "../../IDataKind";
-import { IKeyedStoreItem } from "../../store/store";
-
-export default class TestDataSynchronizer implements IDataSynchronizer {
-  private readonly flags: IFlag[];
-  private readonly userKeyId: string = 'test-user-key-id';
-
-  constructor(
-    private dataSourceUpdates: IDataSourceUpdates,
-    initialFlags: IFlag[],
-    private readonly onStop: VoidFunction,
-    private readonly listeners: Map<EventName, ProcessStreamResponse>
-  ) {
-    // make copies of these objects to decouple them from the originals
-    // so updates made to the originals don't affect these internal data.
-    this.flags = [...initialFlags];
-  }
-
-  async start() {
-    this.listeners.forEach(({deserializeData, processJson }) => {
-      const data = deserializeData(this.flags);
-      processJson(this.userKeyId, data);
-    });
-  }
-
-  identify() {
-    // no-op
-  }
-
-  stop() {
-    this.onStop();
-  }
-
-  close() {
-    this.stop();
-  }
-
-  async upsert(kind: IDataKind, value: IKeyedStoreItem) {
-    return new Promise<void>((resolve) => {
-      this.dataSourceUpdates.upsert(this.userKeyId, kind, value, () => {
-        resolve();
-      });
-    });
-  }
+import { IDataSynchronizer } from "../../data-sync/IDataSynchronizer";
+import { IFlag } from "../../evaluation/data/IFlag";
+import { EventName, ProcessStreamResponse } from "../../data-sync/types";
+import { IDataSourceUpdates } from "../../store/IDataSourceUpdates";
+import { VoidFunction } from "../../utils/VoidFunction";
+import { IDataKind } from "../../IDataKind";
+import { IKeyedStoreItem } from "../../store/store";
+
+export default class TestDataSynchronizer implements IDataSynchronizer {
+  private readonly flags: IFlag[];
+  private readonly userKeyId: string = 'test-user-key-id';
+
+  constructor(
+    private dataSourceUpdates: IDataSourceUpdates,
+    initialFlags: IFlag[],
+    private readonly onStop: VoidFunction,
+    private readonly listeners: Map<EventName, ProcessStreamResponse>
+  ) {
+    // make copies of these objects to decouple them from the originals
+    // so updates made to the originals don't affect these internal data.
+    this.flags = [...initialFlags];
+  }
+
+  async start() {
+    this.listeners.forEach(({deserializeData, processJson }) => {
+      const data = deserializeData(this.flags);
+      processJson(this.userKeyId, data);
+    });
+  }
+
+  async identify(): Promise<void> {
+    // no-op
+  }
+
+  stop() {
+    this.onStop();
+  }
+
+  close() {
+    this.stop();
+  }
+
+  async upsert(kind: IDataKind, value: IKeyedStoreItem) {
+    return new Promise<void>((resolve) => {
+      this.dataSourceUpdates.upsert(this.userKeyId, kind, value, () => {
+        resolve();
+      });
+    });
+  }
 }

package/src/integrations/test_data/index.ts

@@ -1,5 +1,5 @@
-import TestData from "./TestData";
-import { FlagBuilder } from "./FlagBuilder";
-import TestDataSynchronizer from "./TestDataSynchronizer";
-
+import TestData from "./TestData";
+import { FlagBuilder } from "./FlagBuilder";
+import TestDataSynchronizer from "./TestDataSynchronizer";
+
 export { TestData, FlagBuilder, TestDataSynchronizer };

package/src/logging/BasicLogger.ts

@@ -1,108 +1,108 @@
-import format from './format';
-import { ILogger } from "./ILogger";
-import { IBasicLoggerOptions } from "./IBasicLoggerOptions";
-
-const LogPriority = {
-  debug: 0,
-  info: 1,
-  warn: 2,
-  error: 3,
-  none: 4,
-};
-
-const LevelNames = ['debug', 'info', 'warn', 'error', 'none'];
-
-/**
- * A basic logger which handles filtering by level.
- *
- * With the default options it will write to `console.error`
- * and it will use the formatting provided by `console.error`.
- * If the destination is overwritten, then it will use an included
- * formatter similar to `util.format`.
- *
- * If a formatter is available, then that should be overridden
- * as well for performance.
- */
-export class BasicLogger implements ILogger {
-  private logLevel: number;
-
-  private name: string;
-
-  private destination?: (line: string) => void;
-
-  private formatter?: (...args: any[]) => string;
-
-  /**
-   * This should only be used as a default fallback and not as a convenient
-   * solution. In most cases you should construct a new instance with the
-   * appropriate options for your specific needs.
-   */
-  static get() {
-    return new BasicLogger({});
-  }
-
-  constructor(options: IBasicLoggerOptions) {
-    this.logLevel = LogPriority[options.level ?? 'info'] ?? LogPriority.info;
-    this.name = options.name ?? 'FeatBit';
-    // eslint-disable-next-line no-console
-    this.destination = options.destination;
-    this.formatter = options.formatter;
-  }
-
-  private tryFormat(...args: any[]): string {
-    try {
-      if (this.formatter) {
-        // In case the provided formatter fails.
-        return this.formatter?.(...args);
-      }
-      return format(...args);
-    } catch {
-      return format(...args);
-    }
-  }
-
-  private tryWrite(msg: string) {
-    try {
-      this.destination!(msg);
-    } catch {
-      // eslint-disable-next-line no-console
-      console.error(msg);
-    }
-  }
-
-  private log(level: number, args: any[]) {
-    if (level >= this.logLevel) {
-      const prefix = `${ LevelNames[level] }: [${ this.name }]`;
-      try {
-        if (this.destination) {
-          this.tryWrite(`${ prefix } ${ this.tryFormat(...args) }`);
-        } else {
-          // `console.error` has its own formatter.
-          // So we don't need to do anything.
-          // eslint-disable-next-line no-console
-          console.error(...args);
-        }
-      } catch {
-        // If all else fails do not break.
-        // eslint-disable-next-line no-console
-        console.error(...args);
-      }
-    }
-  }
-
-  error(...args: any[]): void {
-    this.log(LogPriority.error, args);
-  }
-
-  warn(...args: any[]): void {
-    this.log(LogPriority.warn, args);
-  }
-
-  info(...args: any[]): void {
-    this.log(LogPriority.info, args);
-  }
-
-  debug(...args: any[]): void {
-    this.log(LogPriority.debug, args);
-  }
-}
+import format from './format';
+import { ILogger } from "./ILogger";
+import { IBasicLoggerOptions } from "./IBasicLoggerOptions";
+
+const LogPriority = {
+  debug: 0,
+  info: 1,
+  warn: 2,
+  error: 3,
+  none: 4,
+};
+
+const LevelNames = ['debug', 'info', 'warn', 'error', 'none'];
+
+/**
+ * A basic logger which handles filtering by level.
+ *
+ * With the default options it will write to `console.error`
+ * and it will use the formatting provided by `console.error`.
+ * If the destination is overwritten, then it will use an included
+ * formatter similar to `util.format`.
+ *
+ * If a formatter is available, then that should be overridden
+ * as well for performance.
+ */
+export class BasicLogger implements ILogger {
+  private logLevel: number;
+
+  private name: string;
+
+  private destination?: (line: string) => void;
+
+  private formatter?: (...args: any[]) => string;
+
+  /**
+   * This should only be used as a default fallback and not as a convenient
+   * solution. In most cases you should construct a new instance with the
+   * appropriate options for your specific needs.
+   */
+  static get() {
+    return new BasicLogger({});
+  }
+
+  constructor(options: IBasicLoggerOptions) {
+    this.logLevel = LogPriority[options.level ?? 'info'] ?? LogPriority.info;
+    this.name = options.name ?? 'FeatBit';
+    // eslint-disable-next-line no-console
+    this.destination = options.destination;
+    this.formatter = options.formatter;
+  }
+
+  private tryFormat(...args: any[]): string {
+    try {
+      if (this.formatter) {
+        // In case the provided formatter fails.
+        return this.formatter?.(...args);
+      }
+      return format(...args);
+    } catch {
+      return format(...args);
+    }
+  }
+
+  private tryWrite(msg: string) {
+    try {
+      this.destination!(msg);
+    } catch {
+      // eslint-disable-next-line no-console
+      console.error(msg);
+    }
+  }
+
+  private log(level: number, args: any[]) {
+    if (level >= this.logLevel) {
+      const prefix = `${ LevelNames[level] }: [${ this.name }]`;
+      try {
+        if (this.destination) {
+          this.tryWrite(`${ prefix } ${ this.tryFormat(...args) }`);
+        } else {
+          // `console.error` has its own formatter.
+          // So we don't need to do anything.
+          // eslint-disable-next-line no-console
+          console.error(...args);
+        }
+      } catch {
+        // If all else fails do not break.
+        // eslint-disable-next-line no-console
+        console.error(...args);
+      }
+    }
+  }
+
+  error(...args: any[]): void {
+    this.log(LogPriority.error, args);
+  }
+
+  warn(...args: any[]): void {
+    this.log(LogPriority.warn, args);
+  }
+
+  info(...args: any[]): void {
+    this.log(LogPriority.info, args);
+  }
+
+  debug(...args: any[]): void {
+    this.log(LogPriority.debug, args);
+  }
+}

package/src/logging/IBasicLoggerOptions.ts

@@ -1,46 +1,46 @@
-import { ILogLevel } from './LogLevel';
-
-/**
- * Configuration for {@link basicLogger}.
- */
-export interface IBasicLoggerOptions {
-  /**
-   * The lowest level of log message to enable.
-   *
-   * See {@link ILogLevel} for a list of possible levels. Setting a level here causes
-   * all lower-importance levels to be disabled: for instance, if you specify
-   * `'warn'`, then `'debug'` and `'info'` are disabled.
-   *
-   * If not specified, the default is `'info'` (meaning that `'debug'` is disabled).
-   */
-  level?: ILogLevel;
-
-  /**
-   * Name to use for the log entires. The default name is `FeatBit`.
-   */
-  name?: string;
-
-  /**
-   * An optional function to use to print each log line.
-   *
-   * If this is specified, `basicLogger` calls it to write each line of output. The
-   * argument is a fully formatted log line, not including a linefeed. The function
-   * is only called for log levels that are enabled.
-   *
-   * If not specified, the default is `console.error`.
-   *
-   * Setting this property to anything other than a function will cause SDK
-   * initialization to fail.
-   */
-  destination?: (line: string) => void;
-
-  /**
-   * An optional formatter to use. The formatter should be compatible
-   * with browser-style format strings like those used with `util.format`.
-   *
-   * If not specified, then a default implementation will be used.
-   * But using a browser-specific implementation, for instance, would
-   * have performance and quality benefits.
-   */
-  formatter?: (...args: any[]) => string;
-}
+import { ILogLevel } from './LogLevel';
+
+/**
+ * Configuration for {@link basicLogger}.
+ */
+export interface IBasicLoggerOptions {
+  /**
+   * The lowest level of log message to enable.
+   *
+   * See {@link ILogLevel} for a list of possible levels. Setting a level here causes
+   * all lower-importance levels to be disabled: for instance, if you specify
+   * `'warn'`, then `'debug'` and `'info'` are disabled.
+   *
+   * If not specified, the default is `'info'` (meaning that `'debug'` is disabled).
+   */
+  level?: ILogLevel;
+
+  /**
+   * Name to use for the log entires. The default name is `FeatBit`.
+   */
+  name?: string;
+
+  /**
+   * An optional function to use to print each log line.
+   *
+   * If this is specified, `basicLogger` calls it to write each line of output. The
+   * argument is a fully formatted log line, not including a linefeed. The function
+   * is only called for log levels that are enabled.
+   *
+   * If not specified, the default is `console.error`.
+   *
+   * Setting this property to anything other than a function will cause SDK
+   * initialization to fail.
+   */
+  destination?: (line: string) => void;
+
+  /**
+   * An optional formatter to use. The formatter should be compatible
+   * with browser-style format strings like those used with `util.format`.
+   *
+   * If not specified, then a default implementation will be used.
+   * But using a browser-specific implementation, for instance, would
+   * have performance and quality benefits.
+   */
+  formatter?: (...args: any[]) => string;
+}

package/src/logging/ILogger.ts

@@ -1,49 +1,49 @@
-/**
- * The FeatBit client logger interface.
- *
- * The {@link IOptions.logger} property accepts any object that conforms to this
- * interface. The SDK only uses four logging levels: `error`, `warn`, `info`, and
- * `debug`. It will call the corresponding method of the `ILogger` either with a
- * single string argument, or with a format string and variable arguments in the
- * format used by Node's `util.format()`.
- *
- * The [Winston](https://github.com/winstonjs/winston) logging package provides a
- * logger that conforms to this interface, so if you have created a logger with
- * Winston, you can simply put it into the {@link IOptions.logger} property.
- *
- * If you do not provide a logger object, the SDK uses the {@link basicLogger}
- * implementation with a minimum level of `info`.
- */
-export interface ILogger {
-  /**
-   * The error logger.
-   *
-   * @param args
-   *   A sequence of any JavaScript values.
-   */
-  error(...args: any[]): void;
-
-  /**
-   * The warning logger.
-   *
-   * @param args
-   *   A sequence of any JavaScript values.
-   */
-  warn(...args: any[]): void;
-
-  /**
-   * The info logger.
-   *
-   * @param args
-   *   A sequence of any JavaScript values.
-   */
-  info(...args: any[]): void;
-
-  /**
-   * The debug logger.
-   *
-   * @param args
-   *   A sequence of any JavaScript values.
-   */
-  debug(...args: any[]): void;
-}
+/**
+ * The FeatBit client logger interface.
+ *
+ * The {@link IOptions.logger} property accepts any object that conforms to this
+ * interface. The SDK only uses four logging levels: `error`, `warn`, `info`, and
+ * `debug`. It will call the corresponding method of the `ILogger` either with a
+ * single string argument, or with a format string and variable arguments in the
+ * format used by Node's `util.format()`.
+ *
+ * The [Winston](https://github.com/winstonjs/winston) logging package provides a
+ * logger that conforms to this interface, so if you have created a logger with
+ * Winston, you can simply put it into the {@link IOptions.logger} property.
+ *
+ * If you do not provide a logger object, the SDK uses the {@link basicLogger}
+ * implementation with a minimum level of `info`.
+ */
+export interface ILogger {
+  /**
+   * The error logger.
+   *
+   * @param args
+   *   A sequence of any JavaScript values.
+   */
+  error(...args: any[]): void;
+
+  /**
+   * The warning logger.
+   *
+   * @param args
+   *   A sequence of any JavaScript values.
+   */
+  warn(...args: any[]): void;
+
+  /**
+   * The info logger.
+   *
+   * @param args
+   *   A sequence of any JavaScript values.
+   */
+  info(...args: any[]): void;
+
+  /**
+   * The debug logger.
+   *
+   * @param args
+   *   A sequence of any JavaScript values.
+   */
+  debug(...args: any[]): void;
+}

package/src/logging/LogLevel.ts

@@ -1,9 +1,9 @@
-/**
- * Logging levels that can be used with {@link basicLogger}.
- *
- * Set {@link BasicLoggerOptions.level} to one of these values to control what levels
- * of log messages are enabled. Going from lowest importance (and most verbose)
- * to most importance, the levels are `'debug'`, `'info'`, `'warn'`, and `'error'`.
- * You can also specify `'none'` instead to disable all logging.
- */
+/**
+ * Logging levels that can be used with {@link basicLogger}.
+ *
+ * Set {@link BasicLoggerOptions.level} to one of these values to control what levels
+ * of log messages are enabled. Going from lowest importance (and most verbose)
+ * to most importance, the levels are `'debug'`, `'info'`, `'warn'`, and `'error'`.
+ * You can also specify `'none'` instead to disable all logging.
+ */
 export type ILogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';