@featbit/js-client-sdk 3.0.13 → 4.0.0

package/src/logging/SafeLogger.ts

@@ -1,70 +1,70 @@
-import { ILogger } from "./ILogger";
-import { TypeValidators } from "../options/Validators";
-
-const loggerRequirements = {
-  error: TypeValidators.Function,
-  warn: TypeValidators.Function,
-  info: TypeValidators.Function,
-  debug: TypeValidators.Function,
-};
-
-/**
- * The safeLogger logic exists because we allow the application to pass in a custom logger, but
- * there is no guarantee that the logger works correctly and if it ever throws exceptions there
- * could be serious consequences (e.g. an uncaught exception within an error event handler, due
- * to the SDK trying to log the error, can terminate the application). An exception could result
- * from faulty logic in the logger implementation, or it could be that this is not a logger at
- * all but some other kind of object; the former is handled by a catch block that logs an error
- * message to the SDK's default logger, and we can at least partly guard against the latter by
- * checking for the presence of required methods at configuration time.
- */
-export class SafeLogger implements ILogger {
-  private logger: ILogger;
-
-  private fallback: ILogger;
-
-  /**
-   * Construct a safe logger with the specified logger.
-   * @param logger The logger to use.
-   * @param fallback A fallback logger to use in case an issue is  encountered using
-   * the provided logger.
-   */
-  constructor(logger: ILogger, fallback: ILogger) {
-    Object.entries(loggerRequirements).forEach(([level, validator]) => {
-      if (!validator.is((logger as any)[level])) {
-        throw new Error(`Provided logger instance must support logger.${ level }(...) method`);
-        // Note that the SDK normally does not throw exceptions to the application, but that rule
-        // does not apply to FbClientNode.init() which will throw an exception if the parameters are so
-        // invalid that we cannot proceed with creating the client. An invalid logger meets those
-        // criteria since the SDK calls the logger during nearly all of its operations.
-      }
-    });
-    this.logger = logger;
-    this.fallback = fallback;
-  }
-
-  private log(level: 'error' | 'warn' | 'info' | 'debug', args: any[]) {
-    try {
-      this.logger[level](...args);
-    } catch {
-      // If all else fails do not break.
-      this.fallback[level](...args);
-    }
-  }
-
-  error(...args: any[]): void {
-    this.log('error', args);
-  }
-
-  warn(...args: any[]): void {
-    this.log('warn', args);
-  }
-
-  info(...args: any[]): void {
-    this.log('info', args);
-  }
-
-  debug(...args: any[]): void {
-    this.log('debug', args);
-  }
+import { ILogger } from "./ILogger";
+import { TypeValidators } from "../options/Validators";
+
+const loggerRequirements = {
+  error: TypeValidators.Function,
+  warn: TypeValidators.Function,
+  info: TypeValidators.Function,
+  debug: TypeValidators.Function,
+};
+
+/**
+ * The safeLogger logic exists because we allow the application to pass in a custom logger, but
+ * there is no guarantee that the logger works correctly and if it ever throws exceptions there
+ * could be serious consequences (e.g. an uncaught exception within an error event handler, due
+ * to the SDK trying to log the error, can terminate the application). An exception could result
+ * from faulty logic in the logger implementation, or it could be that this is not a logger at
+ * all but some other kind of object; the former is handled by a catch block that logs an error
+ * message to the SDK's default logger, and we can at least partly guard against the latter by
+ * checking for the presence of required methods at configuration time.
+ */
+export class SafeLogger implements ILogger {
+  private logger: ILogger;
+
+  private fallback: ILogger;
+
+  /**
+   * Construct a safe logger with the specified logger.
+   * @param logger The logger to use.
+   * @param fallback A fallback logger to use in case an issue is  encountered using
+   * the provided logger.
+   */
+  constructor(logger: ILogger, fallback: ILogger) {
+    Object.entries(loggerRequirements).forEach(([level, validator]) => {
+      if (!validator.is((logger as any)[level])) {
+        throw new Error(`Provided logger instance must support logger.${ level }(...) method`);
+        // Note that the SDK normally does not throw exceptions to the application, but that rule
+        // does not apply to FbClientNode.init() which will throw an exception if the parameters are so
+        // invalid that we cannot proceed with creating the client. An invalid logger meets those
+        // criteria since the SDK calls the logger during nearly all of its operations.
+      }
+    });
+    this.logger = logger;
+    this.fallback = fallback;
+  }
+
+  private log(level: 'error' | 'warn' | 'info' | 'debug', args: any[]) {
+    try {
+      this.logger[level](...args);
+    } catch {
+      // If all else fails do not break.
+      this.fallback[level](...args);
+    }
+  }
+
+  error(...args: any[]): void {
+    this.log('error', args);
+  }
+
+  warn(...args: any[]): void {
+    this.log('warn', args);
+  }
+
+  info(...args: any[]): void {
+    this.log('info', args);
+  }
+
+  debug(...args: any[]): void {
+    this.log('debug', args);
+  }
 }

package/src/logging/format.ts

@@ -1,154 +1,154 @@
-import { TypeValidators } from "../options/Validators";
-
-
-/**
- * Attempt to produce a string representation of a value.
- * The format should be roughly comparable to `util.format`
- * aside from object which will be JSON versus the `util.inspect`
- * format.
- * @param val
- * @returns A string representation of the value if possible.
- */
-function tryStringify(val: any) {
-  if (typeof val === 'string') {
-    return val;
-  }
-  if (val === undefined) {
-    return 'undefined';
-  }
-  if (val === null) {
-    return 'null';
-  }
-  if (Object.prototype.hasOwnProperty.call(val, 'toString')) {
-    try {
-      return val.toString();
-    } catch {
-      /* Keep going */
-    }
-  }
-
-  if (typeof val === 'bigint') {
-    return `${ val }n`;
-  }
-  try {
-    return JSON.stringify(val);
-  } catch (error) {
-    if (error instanceof TypeError && error.message.indexOf('circular') >= 0) {
-      return '[Circular]';
-    }
-    return '[Not Stringifiable]';
-  }
-}
-
-/**
- * Attempt to produce a numeric representation.
- * BigInts have an `n` suffix.
- * @param val
- * @returns The numeric representation or 'NaN' if not numeric.
- */
-function toNumber(val: any): string {
-  // Symbol has to be treated special because it will
-  // throw an exception if an attempt is made to convert it.
-  if (typeof val === 'symbol') {
-    return 'NaN';
-  }
-  if (typeof val === 'bigint') {
-    return `${ val }n`;
-  }
-  return String(Number(val));
-}
-
-/**
- * Attempt to produce an integer representation.
- * BigInts have an `n` suffix.
- * @param val
- * @returns The integer representation or 'NaN' if not numeric.
- */
-function toInt(val: any): string {
-  if (typeof val === 'symbol') {
-    return 'NaN';
-  }
-  if (typeof val === 'bigint') {
-    return `${ val }n`;
-  }
-  return String(parseInt(val, 10));
-}
-
-/**
- * Attempt to produce a float representation.
- * BigInts have an `n` suffix.
- * @param val
- * @returns The integer representation or 'NaN' if not numeric.
- */
-function toFloat(val: any): string {
-  if (typeof val === 'symbol') {
-    return 'NaN';
-  }
-  return String(parseFloat(val));
-}
-
-// Based on:
-// https://nodejs.org/api/util.html#utilformatformat-args
-// The result will not match browser exactly, but it should get the
-// right information through.
-const escapes: Record<string, (val: any) => string> = {
-  s: (val: any) => tryStringify(val),
-  d: (val: any) => toNumber(val),
-  i: (val: any) => toInt(val),
-  f: (val: any) => toFloat(val),
-  j: (val: any) => tryStringify(val),
-  o: (val: any) => tryStringify(val),
-  O: (val: any) => tryStringify(val),
-  c: () => '',
-};
-
-/**
- * A basic formatted for use where `util.format` is not available.
- * This will not be as performant, but it will produce formatted
- * messages.
- *
- * @internal
- *
- * @param args
- * @returns Formatted string.
- */
-export default function format(...args: any[]): string {
-  const formatString = args.shift();
-  if (TypeValidators.String.is(formatString)) {
-    let out = '';
-    let i = 0;
-    while (i < formatString.length) {
-      const char = formatString.charAt(i);
-      if (char === '%') {
-        const nextIndex = i + 1;
-        if (nextIndex < formatString.length) {
-          const nextChar = formatString.charAt(i + 1);
-          if (nextChar in escapes && args.length) {
-            const value = args.shift();
-            // This rule is for math.
-            // eslint-disable-next-line no-unsafe-optional-chaining
-            out += escapes[nextChar]?.(value);
-          } else if (nextChar === '%') {
-            out += '%';
-          } else {
-            out += `%${ nextChar }`;
-          }
-          i += 2;
-        }
-      } else {
-        out += char;
-        i += 1;
-      }
-    }
-    // If there are any args left after we exhaust the format string
-    // then just stick those on the end.
-    if (args.length) {
-      if (out.length) {
-        out += ' ';
-      }
-      out += args.map(tryStringify).join(' ');
-    }
-    return out;
-  }
-  return args.map(tryStringify).join(' ');
-}
+import { TypeValidators } from "../options/Validators";
+
+
+/**
+ * Attempt to produce a string representation of a value.
+ * The format should be roughly comparable to `util.format`
+ * aside from object which will be JSON versus the `util.inspect`
+ * format.
+ * @param val
+ * @returns A string representation of the value if possible.
+ */
+function tryStringify(val: any) {
+  if (typeof val === 'string') {
+    return val;
+  }
+  if (val === undefined) {
+    return 'undefined';
+  }
+  if (val === null) {
+    return 'null';
+  }
+  if (Object.prototype.hasOwnProperty.call(val, 'toString')) {
+    try {
+      return val.toString();
+    } catch {
+      /* Keep going */
+    }
+  }
+
+  if (typeof val === 'bigint') {
+    return `${ val }n`;
+  }
+  try {
+    return JSON.stringify(val);
+  } catch (error) {
+    if (error instanceof TypeError && error.message.indexOf('circular') >= 0) {
+      return '[Circular]';
+    }
+    return '[Not Stringifiable]';
+  }
+}
+
+/**
+ * Attempt to produce a numeric representation.
+ * BigInts have an `n` suffix.
+ * @param val
+ * @returns The numeric representation or 'NaN' if not numeric.
+ */
+function toNumber(val: any): string {
+  // Symbol has to be treated special because it will
+  // throw an exception if an attempt is made to convert it.
+  if (typeof val === 'symbol') {
+    return 'NaN';
+  }
+  if (typeof val === 'bigint') {
+    return `${ val }n`;
+  }
+  return String(Number(val));
+}
+
+/**
+ * Attempt to produce an integer representation.
+ * BigInts have an `n` suffix.
+ * @param val
+ * @returns The integer representation or 'NaN' if not numeric.
+ */
+function toInt(val: any): string {
+  if (typeof val === 'symbol') {
+    return 'NaN';
+  }
+  if (typeof val === 'bigint') {
+    return `${ val }n`;
+  }
+  return String(parseInt(val, 10));
+}
+
+/**
+ * Attempt to produce a float representation.
+ * BigInts have an `n` suffix.
+ * @param val
+ * @returns The integer representation or 'NaN' if not numeric.
+ */
+function toFloat(val: any): string {
+  if (typeof val === 'symbol') {
+    return 'NaN';
+  }
+  return String(parseFloat(val));
+}
+
+// Based on:
+// https://nodejs.org/api/util.html#utilformatformat-args
+// The result will not match browser exactly, but it should get the
+// right information through.
+const escapes: Record<string, (val: any) => string> = {
+  s: (val: any) => tryStringify(val),
+  d: (val: any) => toNumber(val),
+  i: (val: any) => toInt(val),
+  f: (val: any) => toFloat(val),
+  j: (val: any) => tryStringify(val),
+  o: (val: any) => tryStringify(val),
+  O: (val: any) => tryStringify(val),
+  c: () => '',
+};
+
+/**
+ * A basic formatted for use where `util.format` is not available.
+ * This will not be as performant, but it will produce formatted
+ * messages.
+ *
+ * @internal
+ *
+ * @param args
+ * @returns Formatted string.
+ */
+export default function format(...args: any[]): string {
+  const formatString = args.shift();
+  if (TypeValidators.String.is(formatString)) {
+    let out = '';
+    let i = 0;
+    while (i < formatString.length) {
+      const char = formatString.charAt(i);
+      if (char === '%') {
+        const nextIndex = i + 1;
+        if (nextIndex < formatString.length) {
+          const nextChar = formatString.charAt(i + 1);
+          if (nextChar in escapes && args.length) {
+            const value = args.shift();
+            // This rule is for math.
+            // eslint-disable-next-line no-unsafe-optional-chaining
+            out += escapes[nextChar]?.(value);
+          } else if (nextChar === '%') {
+            out += '%';
+          } else {
+            out += `%${ nextChar }`;
+          }
+          i += 2;
+        }
+      } else {
+        out += char;
+        i += 1;
+      }
+    }
+    // If there are any args left after we exhaust the format string
+    // then just stick those on the end.
+    if (args.length) {
+      if (out.length) {
+        out += ' ';
+      }
+      out += args.map(tryStringify).join(' ');
+    }
+    return out;
+  }
+  return args.map(tryStringify).join(' ');
+}

package/src/logging/index.ts

@@ -1,6 +1,6 @@
-export * from './BasicLogger';
-export * from './format';
-export * from './IBasicLoggerOptions';
-export * from './ILogger';
-export * from './LogLevel';
+export * from './BasicLogger';
+export * from './format';
+export * from './IBasicLoggerOptions';
+export * from './ILogger';
+export * from './LogLevel';
 export * from './SafeLogger';

package/src/options/ClientContext.ts

@@ -1,40 +1,40 @@
-import { ILogger } from "../logging/ILogger";
-import { IPlatform } from "../platform/IPlatform";
-import { IClientContext } from "./IClientContext";
-import { IUser } from "./IUser";
-
-/**
- * The client context provides basic configuration and platform support which are required
- * when building SDK components.
- */
-export default class ClientContext implements IClientContext {
-  flushInterval: number;
-  maxEventsInQueue: number;
-  offline: boolean;
-  logger: ILogger;
-  eventsUri: string;
-  pollingUri: string;
-  streamingUri: string;
-
-  constructor(
-    public readonly sdkKey: string,
-    configuration: {
-      logger?: ILogger;
-      offline?: boolean;
-      flushInterval: number;
-      maxEventsInQueue: number;
-      streamingUri: string;
-      pollingUri: string;
-      eventsUri: string;
-    },
-    public readonly platform: IPlatform,
-  ) {
-    this.logger = configuration.logger!;
-    this.offline = configuration.offline!;
-    this.flushInterval = configuration.flushInterval;
-    this.maxEventsInQueue = configuration.maxEventsInQueue;
-    this.streamingUri = configuration.streamingUri;
-    this.pollingUri = configuration.pollingUri;
-    this.eventsUri = configuration.eventsUri;
-  }
+import { ILogger } from "../logging/ILogger";
+import { IPlatform } from "../platform/IPlatform";
+import { IClientContext } from "./IClientContext";
+import { IUser } from "./IUser";
+
+/**
+ * The client context provides basic configuration and platform support which are required
+ * when building SDK components.
+ */
+export default class ClientContext implements IClientContext {
+  flushInterval: number;
+  maxEventsInQueue: number;
+  offline: boolean;
+  logger: ILogger;
+  eventsUri: string;
+  pollingUri: string;
+  streamingUri: string;
+
+  constructor(
+    public readonly sdkKey: string,
+    configuration: {
+      logger?: ILogger;
+      offline?: boolean;
+      flushInterval: number;
+      maxEventsInQueue: number;
+      streamingUri: string;
+      pollingUri: string;
+      eventsUri: string;
+    },
+    public readonly platform: IPlatform,
+  ) {
+    this.logger = configuration.logger!;
+    this.offline = configuration.offline!;
+    this.flushInterval = configuration.flushInterval;
+    this.maxEventsInQueue = configuration.maxEventsInQueue;
+    this.streamingUri = configuration.streamingUri;
+    this.pollingUri = configuration.pollingUri;
+    this.eventsUri = configuration.eventsUri;
+  }
 }

package/src/options/IClientContext.ts

@@ -1,54 +1,54 @@
-import { ILogger } from "../logging/ILogger";
-import { IPlatform } from "../platform/IPlatform";
-
-/**
- * Factory methods receive this class as a parameter.
- *
- * Its public properties provide information about the SDK configuration and environment. The SDK
- * may also include non-public properties that are relevant only when creating one of the built-in
- * component types and are not accessible to custom components.
- */
-export interface IClientContext {
-
-  logger?: ILogger;
-
-  /**
-   * True if the SDK was configured to be completely offline.
-   */
-  offline?: boolean;
-
-  /**
-   * The configured SDK key.
-   */
-  sdkKey: string;
-
-  /**
-   * The base URI of the data-sync service
-   */
-  streamingUri: string;
-
-  /**
-   * The base URI of the polling service
-   */
-  pollingUri: string;
-
-  /**
-   * The base URI of the event service
-   */
-  eventsUri: string;
-
-  /**
-   * The interval in between flushes of events queue, in milliseconds.
-   */
-  flushInterval: number;
-
-  /**
-   * The max number of events in the events queue.
-   */
-  maxEventsInQueue: number;
-
-  /**
-   * Interfaces providing platform specific information and functionality.
-   */
-  platform: IPlatform;
+import { ILogger } from "../logging/ILogger";
+import { IPlatform } from "../platform/IPlatform";
+
+/**
+ * Factory methods receive this class as a parameter.
+ *
+ * Its public properties provide information about the SDK configuration and environment. The SDK
+ * may also include non-public properties that are relevant only when creating one of the built-in
+ * component types and are not accessible to custom components.
+ */
+export interface IClientContext {
+
+  logger?: ILogger;
+
+  /**
+   * True if the SDK was configured to be completely offline.
+   */
+  offline?: boolean;
+
+  /**
+   * The configured SDK key.
+   */
+  sdkKey: string;
+
+  /**
+   * The base URI of the data-sync service
+   */
+  streamingUri: string;
+
+  /**
+   * The base URI of the polling service
+   */
+  pollingUri: string;
+
+  /**
+   * The base URI of the event service
+   */
+  eventsUri: string;
+
+  /**
+   * The interval in between flushes of events queue, in milliseconds.
+   */
+  flushInterval: number;
+
+  /**
+   * The max number of events in the events queue.
+   */
+  maxEventsInQueue: number;
+
+  /**
+   * Interfaces providing platform specific information and functionality.
+   */
+  platform: IPlatform;
 }