@featbit/js-client-sdk 2.0.1 → 3.0.0

package/dist/esm/logging/format.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Validators_1 = require("../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) {
+    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 (_a) {
+            /* 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) {
+    // 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) {
+    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) {
+    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 = {
+    s: (val) => tryStringify(val),
+    d: (val) => toNumber(val),
+    i: (val) => toInt(val),
+    f: (val) => toFloat(val),
+    j: (val) => tryStringify(val),
+    o: (val) => tryStringify(val),
+    O: (val) => 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.
+ */
+function format(...args) {
+    var _a;
+    const formatString = args.shift();
+    if (Validators_1.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 += (_a = escapes[nextChar]) === null || _a === void 0 ? void 0 : _a.call(escapes, 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(' ');
+}
+exports.default = format;
+//# sourceMappingURL=format.js.map

package/dist/esm/logging/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/logging/format.ts"],"names":[],"mappings":";;AAAA,sDAAuD;AAGvD;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,GAAQ;IAC5B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IACD,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,OAAO,WAAW,CAAC;KACpB;IACD,IAAI,GAAG,KAAK,IAAI,EAAE;QAChB,OAAO,MAAM,CAAC;KACf;IACD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE;QACzD,IAAI;YACF,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;SACvB;QAAC,WAAM;YACN,gBAAgB;SACjB;KACF;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAI,GAAI,GAAG,CAAC;KACpB;IACD,IAAI;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,YAAY,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACxE,OAAO,YAAY,CAAC;SACrB;QACD,OAAO,qBAAqB,CAAC;KAC9B;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,GAAQ;IACxB,mDAAmD;IACnD,0DAA0D;IAC1D,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAI,GAAI,GAAG,CAAC;KACpB;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,SAAS,KAAK,CAAC,GAAQ;IACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAI,GAAI,GAAG,CAAC;KACpB;IACD,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CAAC,GAAQ;IACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IACD,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,YAAY;AACZ,yDAAyD;AACzD,mEAAmE;AACnE,6BAA6B;AAC7B,MAAM,OAAO,GAAyC;IACpD,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC;IAClC,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC9B,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;IAC3B,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAC7B,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC;IAClC,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC;IAClC,CAAC,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC;IAClC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;CACZ,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAwB,MAAM,CAAC,GAAG,IAAW;;IAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAClC,IAAI,2BAAc,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE;QAC1C,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE;YAC9B,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,IAAI,KAAK,GAAG,EAAE;gBAChB,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,CAAC;gBACxB,IAAI,SAAS,GAAG,YAAY,CAAC,MAAM,EAAE;oBACnC,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC5C,IAAI,QAAQ,IAAI,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE;wBACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;wBAC3B,yBAAyB;wBACzB,uDAAuD;wBACvD,GAAG,IAAI,MAAA,OAAO,CAAC,QAAQ,CAAC,wDAAG,KAAK,CAAC,CAAC;qBACnC;yBAAM,IAAI,QAAQ,KAAK,GAAG,EAAE;wBAC3B,GAAG,IAAI,GAAG,CAAC;qBACZ;yBAAM;wBACL,GAAG,IAAI,IAAK,QAAS,EAAE,CAAC;qBACzB;oBACD,CAAC,IAAI,CAAC,CAAC;iBACR;aACF;iBAAM;gBACL,GAAG,IAAI,IAAI,CAAC;gBACZ,CAAC,IAAI,CAAC,CAAC;aACR;SACF;QACD,gEAAgE;QAChE,oCAAoC;QACpC,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,GAAG,CAAC,MAAM,EAAE;gBACd,GAAG,IAAI,GAAG,CAAC;aACZ;YACD,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACzC;QACD,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1C,CAAC;AAvCD,yBAuCC"}

package/dist/esm/logging/index.d.ts

@@ -0,0 +1,7 @@
+export * from './BasicLogger';
+export * from './format';
+export * from './IBasicLoggerOptions';
+export * from './ILogger';
+export * from './LogLevel';
+export * from './SafeLogger';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/logging/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/logging/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/dist/esm/logging/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BasicLogger"), exports);
+__exportStar(require("./format"), exports);
+__exportStar(require("./IBasicLoggerOptions"), exports);
+__exportStar(require("./ILogger"), exports);
+__exportStar(require("./LogLevel"), exports);
+__exportStar(require("./SafeLogger"), exports);
+//# sourceMappingURL=index.js.map

package/dist/esm/logging/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/logging/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,2CAAyB;AACzB,wDAAsC;AACtC,4CAA0B;AAC1B,6CAA2B;AAC3B,+CAA6B"}

package/dist/esm/options/ClientContext.d.ts

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

package/dist/esm/options/ClientContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientContext.d.ts","sourceRoot":"","sources":["../../../src/options/ClientContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,cAAc;aAUxC,MAAM,EAAE,MAAM;aAUd,QAAQ,EAAE,SAAS;IAnBrC,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;gBAGH,MAAM,EAAE,MAAM,EAC9B,aAAa,EAAE;QACb,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,EAAE,MAAM,CAAC;QACrB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,EACe,QAAQ,EAAE,SAAS;CAUtC"}

package/dist/esm/options/ClientContext.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The client context provides basic configuration and platform support which are required
+ * when building SDK components.
+ */
+class ClientContext {
+    constructor(sdkKey, configuration, platform) {
+        this.sdkKey = sdkKey;
+        this.platform = platform;
+        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;
+    }
+}
+exports.default = ClientContext;
+//# sourceMappingURL=ClientContext.js.map

package/dist/esm/options/ClientContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientContext.js","sourceRoot":"","sources":["../../../src/options/ClientContext.ts"],"names":[],"mappings":";;AAKA;;;GAGG;AACH,MAAqB,aAAa;IAShC,YACkB,MAAc,EAC9B,aAQC,EACe,QAAmB;QAVnB,WAAM,GAAN,MAAM,CAAQ;QAUd,aAAQ,GAAR,QAAQ,CAAW;QAEnC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAO,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,OAAQ,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC;QACvD,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;IAC3C,CAAC;CACF;AA9BD,gCA8BC"}

package/dist/esm/options/IClientContext.d.ts

@@ -0,0 +1,45 @@
+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;
+}
+//# sourceMappingURL=IClientContext.d.ts.map

package/dist/esm/options/IClientContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IClientContext.d.ts","sourceRoot":"","sources":["../../../src/options/IClientContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAE7B,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB"}

package/dist/esm/options/IClientContext.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IClientContext.js.map

package/dist/esm/options/IClientContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IClientContext.js","sourceRoot":"","sources":["../../../src/options/IClientContext.ts"],"names":[],"mappings":""}

package/dist/esm/options/IOptions.d.ts

@@ -0,0 +1,101 @@
+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);
+}
+//# sourceMappingURL=IOptions.d.ts.map

package/dist/esm/options/IOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOptions.d.ts","sourceRoot":"","sources":["../../../src/options/IOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;IAEb;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IAExB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IAEjD;;;;OAIG;IACH,gBAAgB,CAAC,EACb,MAAM,GACN,CAAC,CACH,aAAa,EAAE,cAAc,EAC7B,KAAK,EAAE,MAAM,EACb,iBAAiB,EAAE,kBAAkB,EACrC,kBAAkB,EAAE,YAAY,EAChC,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,KAC9B,iBAAiB,CAAC,CAAC;CACzB"}

package/dist/esm/options/IOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IOptions.js.map

package/dist/esm/options/IOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOptions.js","sourceRoot":"","sources":["../../../src/options/IOptions.ts"],"names":[],"mappings":""}

package/dist/esm/options/IUser.d.ts

@@ -0,0 +1,7 @@
+import { IContextProperty } from "../IContextProperty";
+export interface IUser {
+    keyId: string;
+    name?: string;
+    customizedProperties?: IContextProperty[];
+}
+//# sourceMappingURL=IUser.d.ts.map

package/dist/esm/options/IUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUser.d.ts","sourceRoot":"","sources":["../../../src/options/IUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC3C"}

package/dist/esm/options/IUser.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IUser.js.map

package/dist/esm/options/IUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUser.js","sourceRoot":"","sources":["../../../src/options/IUser.ts"],"names":[],"mappings":""}

package/dist/esm/options/IValidatedOptions.d.ts

@@ -0,0 +1,27 @@
+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 { 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[];
+    [index: string]: any;
+}
+//# sourceMappingURL=IValidatedOptions.d.ts.map

package/dist/esm/options/IValidatedOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IValidatedOptions.d.ts","sourceRoot":"","sources":["../../../src/options/IValidatedOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IAChD,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IAGxB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB"}

package/dist/esm/options/IValidatedOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IValidatedOptions.js.map

package/dist/esm/options/IValidatedOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IValidatedOptions.js","sourceRoot":"","sources":["../../../src/options/IValidatedOptions.ts"],"names":[],"mappings":""}

package/dist/esm/options/OptionMessages.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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;
+    static unknownOption(name: string): string;
+    static wrongOptionType(name: string, expectedType: string, actualType: string): string;
+    static wrongOptionTypeBoolean(name: string, actualType: string): string;
+    static partialEndpoint(name: string): string;
+    static mandatory(name: string): string;
+    static invalidOptionValue(name: string): string;
+    static missingKeyInBootstrapValue(key: string): string;
+}
+//# sourceMappingURL=OptionMessages.d.ts.map

package/dist/esm/options/OptionMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionMessages.d.ts","sourceRoot":"","sources":["../../../src/options/OptionMessages.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAI3E,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI1C,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IAItF,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IAIvE,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI5C,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAItC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI/C,MAAM,CAAC,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAGvD"}

package/dist/esm/options/OptionMessages.js

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

package/dist/esm/options/OptionMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionMessages.js","sourceRoot":"","sources":["../../../src/options/OptionMessages.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAqB,cAAc;IACjC,MAAM,CAAC,kBAAkB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW;QAChE,OAAO,kBAAmB,IAAK,0BAA2B,KAAM,sBAAuB,GAAI,UAAU,CAAC;IACxG,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,IAAY;QAC/B,OAAO,mCAAoC,IAAK,GAAG,CAAC;IACtD,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,YAAoB,EAAE,UAAkB;QAC3E,OAAO,kBAAmB,IAAK,uBAAwB,YAAa,SAAU,UAAW,uBAAuB,CAAC;IACnH,CAAC;IAED,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,UAAkB;QAC5D,OAAO,kBAAmB,IAAK,8BAA+B,UAAW,yBAAyB,CAAC;IACrG,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,IAAY;QACjC,OAAO,mDAAoD,IAAK,yCAAyC,CAAC;IAC5G,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAY;QAC3B,OAAO,GAAI,IAAK,eAAe,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,IAAY;QACpC,OAAO,yBAA0B,IAAK,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,0BAA0B,CAAC,GAAW;QAC3C,OAAO,gBAAiB,GAAI,sBAAsB,CAAC;IACrD,CAAC;CACF;AAhCD,iCAgCC"}

package/dist/esm/options/UserBuilder.d.ts

@@ -0,0 +1,17 @@
+import { IUser } from "./IUser";
+/**
+ * Creates an instance of the FeatBit user.
+ *
+ * @return
+ *   The new {@link IUser} instance.
+ */
+export declare class UserBuilder {
+    private _keyId;
+    private _name;
+    private _custom;
+    constructor(keyId: string);
+    name(name: string): UserBuilder;
+    custom(propertyName: string, value: string): UserBuilder;
+    build(): IUser;
+}
+//# sourceMappingURL=UserBuilder.d.ts.map

package/dist/esm/options/UserBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserBuilder.d.ts","sourceRoot":"","sources":["../../../src/options/UserBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC;;;;;GAKG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,OAAO,CAA0B;gBAE7B,KAAK,EAAE,MAAM;IAIzB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAK/B,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW;IAKxD,KAAK,IAAI,KAAK;CAOf"}

package/dist/esm/options/UserBuilder.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserBuilder = void 0;
+/**
+ * Creates an instance of the FeatBit user.
+ *
+ * @return
+ *   The new {@link IUser} instance.
+ */
+class UserBuilder {
+    constructor(keyId) {
+        this._keyId = '';
+        this._name = '';
+        this._custom = [];
+        this._keyId = keyId;
+    }
+    name(name) {
+        this._name = name;
+        return this;
+    }
+    custom(propertyName, value) {
+        var _a;
+        (_a = this._custom) === null || _a === void 0 ? void 0 : _a.push({ name: propertyName, value: value });
+        return this;
+    }
+    build() {
+        return {
+            name: this._name,
+            keyId: this._keyId,
+            customizedProperties: this._custom
+        };
+    }
+}
+exports.UserBuilder = UserBuilder;
+//# sourceMappingURL=UserBuilder.js.map

package/dist/esm/options/UserBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserBuilder.js","sourceRoot":"","sources":["../../../src/options/UserBuilder.ts"],"names":[],"mappings":";;;AAGA;;;;;GAKG;AACH,MAAa,WAAW;IAKtB,YAAY,KAAa;QAJjB,WAAM,GAAW,EAAE,CAAC;QACpB,UAAK,GAAW,EAAE,CAAC;QACnB,YAAO,GAAuB,EAAE,CAAC;QAGvC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,YAAoB,EAAE,KAAa;;QACxC,MAAA,IAAI,CAAC,OAAO,0CAAE,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,oBAAoB,EAAE,IAAI,CAAC,OAAO;SACnC,CAAC;IACJ,CAAC;CACF;AA1BD,kCA0BC"}