@featbit/js-client-sdk 2.0.1 → 3.0.0

package/dist/esm/integrations/test_data/TestDataSynchronizer.d.ts

@@ -0,0 +1,21 @@
+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 dataSourceUpdates;
+    private readonly onStop;
+    private readonly listeners;
+    private readonly flags;
+    private readonly userKeyId;
+    constructor(dataSourceUpdates: IDataSourceUpdates, initialFlags: IFlag[], onStop: VoidFunction, listeners: Map<EventName, ProcessStreamResponse>);
+    start(): Promise<void>;
+    identify(): void;
+    stop(): void;
+    close(): void;
+    upsert(kind: IDataKind, value: IKeyedStoreItem): Promise<void>;
+}
+//# sourceMappingURL=TestDataSynchronizer.d.ts.map

package/dist/esm/integrations/test_data/TestDataSynchronizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestDataSynchronizer.d.ts","sourceRoot":"","sources":["../../../../src/integrations/test_data/TestDataSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,oBAAqB,YAAW,iBAAiB;IAKlE,OAAO,CAAC,iBAAiB;IAEzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAP5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAU;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;gBAG9C,iBAAiB,EAAE,kBAAkB,EAC7C,YAAY,EAAE,KAAK,EAAE,EACJ,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAO7D,KAAK;IAOX,QAAQ;IAIR,IAAI;IAIJ,KAAK;IAIC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe;CAOrD"}

package/dist/esm/integrations/test_data/TestDataSynchronizer.js

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+class TestDataSynchronizer {
+    constructor(dataSourceUpdates, initialFlags, onStop, listeners) {
+        this.dataSourceUpdates = dataSourceUpdates;
+        this.onStop = onStop;
+        this.listeners = listeners;
+        this.userKeyId = 'test-user-key-id';
+        // 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];
+    }
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.listeners.forEach(({ deserializeData, processJson }) => {
+                const data = deserializeData(this.flags);
+                processJson(this.userKeyId, data);
+            });
+        });
+    }
+    identify() {
+        // no-op
+    }
+    stop() {
+        this.onStop();
+    }
+    close() {
+        this.stop();
+    }
+    upsert(kind, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve) => {
+                this.dataSourceUpdates.upsert(this.userKeyId, kind, value, () => {
+                    resolve();
+                });
+            });
+        });
+    }
+}
+exports.default = TestDataSynchronizer;
+//# sourceMappingURL=TestDataSynchronizer.js.map

package/dist/esm/integrations/test_data/TestDataSynchronizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestDataSynchronizer.js","sourceRoot":"","sources":["../../../../src/integrations/test_data/TestDataSynchronizer.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,MAAqB,oBAAoB;IAIvC,YACU,iBAAqC,EAC7C,YAAqB,EACJ,MAAoB,EACpB,SAAgD;QAHzD,sBAAiB,GAAjB,iBAAiB,CAAoB;QAE5B,WAAM,GAAN,MAAM,CAAc;QACpB,cAAS,GAAT,SAAS,CAAuC;QANlD,cAAS,GAAW,kBAAkB,CAAC;QAQtD,mEAAmE;QACnE,qEAAqE;QACrE,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC;IACjC,CAAC;IAEK,KAAK;;YACT,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAC,eAAe,EAAE,WAAW,EAAE,EAAE,EAAE;gBACzD,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED,QAAQ;QACN,QAAQ;IACV,CAAC;IAED,IAAI;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAEK,MAAM,CAAC,IAAe,EAAE,KAAsB;;YAClD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE;oBAC9D,OAAO,EAAE,CAAC;gBACZ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAzCD,uCAyCC"}

package/dist/esm/integrations/test_data/index.d.ts

@@ -0,0 +1,5 @@
+import TestData from "./TestData";
+import { FlagBuilder } from "./FlagBuilder";
+import TestDataSynchronizer from "./TestDataSynchronizer";
+export { TestData, FlagBuilder, TestDataSynchronizer };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/integrations/test_data/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/integrations/test_data/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/esm/integrations/test_data/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestDataSynchronizer = exports.FlagBuilder = exports.TestData = void 0;
+const TestData_1 = __importDefault(require("./TestData"));
+exports.TestData = TestData_1.default;
+const FlagBuilder_1 = require("./FlagBuilder");
+Object.defineProperty(exports, "FlagBuilder", { enumerable: true, get: function () { return FlagBuilder_1.FlagBuilder; } });
+const TestDataSynchronizer_1 = __importDefault(require("./TestDataSynchronizer"));
+exports.TestDataSynchronizer = TestDataSynchronizer_1.default;
+//# sourceMappingURL=index.js.map

package/dist/esm/integrations/test_data/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/integrations/test_data/index.ts"],"names":[],"mappings":";;;;;;AAAA,0DAAkC;AAIzB,mBAJF,kBAAQ,CAIE;AAHjB,+CAA4C;AAGzB,4FAHV,yBAAW,OAGU;AAF9B,kFAA0D;AAE1B,+BAFzB,8BAAoB,CAEyB"}

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

@@ -0,0 +1,34 @@
+import { ILogger } from "./ILogger";
+import { IBasicLoggerOptions } from "./IBasicLoggerOptions";
+/**
+ * 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 declare class BasicLogger implements ILogger {
+    private logLevel;
+    private name;
+    private destination?;
+    private formatter?;
+    /**
+     * 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(): BasicLogger;
+    constructor(options: IBasicLoggerOptions);
+    private tryFormat;
+    private tryWrite;
+    private log;
+    error(...args: any[]): void;
+    warn(...args: any[]): void;
+    info(...args: any[]): void;
+    debug(...args: any[]): void;
+}
+//# sourceMappingURL=BasicLogger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasicLogger.d.ts","sourceRoot":"","sources":["../../../src/logging/BasicLogger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAY5D;;;;;;;;;;GAUG;AACH,qBAAa,WAAY,YAAW,OAAO;IACzC,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO,CAAC,WAAW,CAAC,CAAyB;IAE7C,OAAO,CAAC,SAAS,CAAC,CAA6B;IAE/C;;;;OAIG;IACH,MAAM,CAAC,GAAG;gBAIE,OAAO,EAAE,mBAAmB;IAQxC,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,GAAG;IAoBX,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI3B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI1B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI1B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;CAG5B"}

package/dist/esm/logging/BasicLogger.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicLogger = void 0;
+const format_1 = __importDefault(require("./format"));
+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.
+ */
+class BasicLogger {
+    /**
+     * 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) {
+        var _a, _b, _c;
+        this.logLevel = (_b = LogPriority[(_a = options.level) !== null && _a !== void 0 ? _a : 'info']) !== null && _b !== void 0 ? _b : LogPriority.info;
+        this.name = (_c = options.name) !== null && _c !== void 0 ? _c : 'FeatBit';
+        // eslint-disable-next-line no-console
+        this.destination = options.destination;
+        this.formatter = options.formatter;
+    }
+    tryFormat(...args) {
+        var _a;
+        try {
+            if (this.formatter) {
+                // In case the provided formatter fails.
+                return (_a = this.formatter) === null || _a === void 0 ? void 0 : _a.call(this, ...args);
+            }
+            return (0, format_1.default)(...args);
+        }
+        catch (_b) {
+            return (0, format_1.default)(...args);
+        }
+    }
+    tryWrite(msg) {
+        try {
+            this.destination(msg);
+        }
+        catch (_a) {
+            // eslint-disable-next-line no-console
+            console.error(msg);
+        }
+    }
+    log(level, args) {
+        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 (_a) {
+                // If all else fails do not break.
+                // eslint-disable-next-line no-console
+                console.error(...args);
+            }
+        }
+    }
+    error(...args) {
+        this.log(LogPriority.error, args);
+    }
+    warn(...args) {
+        this.log(LogPriority.warn, args);
+    }
+    info(...args) {
+        this.log(LogPriority.info, args);
+    }
+    debug(...args) {
+        this.log(LogPriority.debug, args);
+    }
+}
+exports.BasicLogger = BasicLogger;
+//# sourceMappingURL=BasicLogger.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasicLogger.js","sourceRoot":"","sources":["../../../src/logging/BasicLogger.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAI9B,MAAM,WAAW,GAAG;IAClB,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;CACR,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAE9D;;;;;;;;;;GAUG;AACH,MAAa,WAAW;IAStB;;;;OAIG;IACH,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED,YAAY,OAA4B;;QACtC,IAAI,CAAC,QAAQ,GAAG,MAAA,WAAW,CAAC,MAAA,OAAO,CAAC,KAAK,mCAAI,MAAM,CAAC,mCAAI,WAAW,CAAC,IAAI,CAAC;QACzE,IAAI,CAAC,IAAI,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,SAAS,CAAC;QACtC,sCAAsC;QACtC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACrC,CAAC;IAEO,SAAS,CAAC,GAAG,IAAW;;QAC9B,IAAI;YACF,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,wCAAwC;gBACxC,OAAO,MAAA,IAAI,CAAC,SAAS,qDAAG,GAAG,IAAI,CAAC,CAAC;aAClC;YACD,OAAO,IAAA,gBAAM,EAAC,GAAG,IAAI,CAAC,CAAC;SACxB;QAAC,WAAM;YACN,OAAO,IAAA,gBAAM,EAAC,GAAG,IAAI,CAAC,CAAC;SACxB;IACH,CAAC;IAEO,QAAQ,CAAC,GAAW;QAC1B,IAAI;YACF,IAAI,CAAC,WAAY,CAAC,GAAG,CAAC,CAAC;SACxB;QAAC,WAAM;YACN,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACpB;IACH,CAAC;IAEO,GAAG,CAAC,KAAa,EAAE,IAAW;QACpC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC1B,MAAM,MAAM,GAAG,GAAI,UAAU,CAAC,KAAK,CAAE,MAAO,IAAI,CAAC,IAAK,GAAG,CAAC;YAC1D,IAAI;gBACF,IAAI,IAAI,CAAC,WAAW,EAAE;oBACpB,IAAI,CAAC,QAAQ,CAAC,GAAI,MAAO,IAAK,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAE,EAAE,CAAC,CAAC;iBAC3D;qBAAM;oBACL,yCAAyC;oBACzC,mCAAmC;oBACnC,sCAAsC;oBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;iBACxB;aACF;YAAC,WAAM;gBACN,kCAAkC;gBAClC,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;aACxB;SACF;IACH,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAlFD,kCAkFC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBasicLoggerOptions.d.ts","sourceRoot":"","sources":["../../../src/logging/IBasicLoggerOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAErC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC;CACxC"}

package/dist/esm/logging/IBasicLoggerOptions.js

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ILogger.d.ts","sourceRoot":"","sources":["../../../src/logging/ILogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;OAKG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE5B;;;;;OAKG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CAC7B"}

package/dist/esm/logging/ILogger.js

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

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * 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';
+//# sourceMappingURL=LogLevel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LogLevel.d.ts","sourceRoot":"","sources":["../../../src/logging/LogLevel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC"}

package/dist/esm/logging/LogLevel.js

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

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

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

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

@@ -0,0 +1,28 @@
+import { ILogger } from "./ILogger";
+/**
+ * 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 default class SafeLogger implements ILogger {
+    private logger;
+    private fallback;
+    /**
+     * 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);
+    private log;
+    error(...args: any[]): void;
+    warn(...args: any[]): void;
+    info(...args: any[]): void;
+    debug(...args: any[]): void;
+}
+//# sourceMappingURL=SafeLogger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SafeLogger.d.ts","sourceRoot":"","sources":["../../../src/logging/SafeLogger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAUpC;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,YAAW,OAAO;IAChD,OAAO,CAAC,MAAM,CAAU;IAExB,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO;IAc9C,OAAO,CAAC,GAAG;IASX,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI3B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI1B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI1B,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;CAG5B"}

package/dist/esm/logging/SafeLogger.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Validators_1 = require("../options/Validators");
+const loggerRequirements = {
+    error: Validators_1.TypeValidators.Function,
+    warn: Validators_1.TypeValidators.Function,
+    info: Validators_1.TypeValidators.Function,
+    debug: Validators_1.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.
+ */
+class SafeLogger {
+    /**
+     * 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, fallback) {
+        Object.entries(loggerRequirements).forEach(([level, validator]) => {
+            if (!validator.is(logger[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;
+    }
+    log(level, args) {
+        try {
+            this.logger[level](...args);
+        }
+        catch (_a) {
+            // If all else fails do not break.
+            this.fallback[level](...args);
+        }
+    }
+    error(...args) {
+        this.log('error', args);
+    }
+    warn(...args) {
+        this.log('warn', args);
+    }
+    info(...args) {
+        this.log('info', args);
+    }
+    debug(...args) {
+        this.log('debug', args);
+    }
+}
+exports.default = SafeLogger;
+//# sourceMappingURL=SafeLogger.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SafeLogger.js","sourceRoot":"","sources":["../../../src/logging/SafeLogger.ts"],"names":[],"mappings":";;AACA,sDAAuD;AAEvD,MAAM,kBAAkB,GAAG;IACzB,KAAK,EAAE,2BAAc,CAAC,QAAQ;IAC9B,IAAI,EAAE,2BAAc,CAAC,QAAQ;IAC7B,IAAI,EAAE,2BAAc,CAAC,QAAQ;IAC7B,KAAK,EAAE,2BAAc,CAAC,QAAQ;CAC/B,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAqB,UAAU;IAK7B;;;;;OAKG;IACH,YAAY,MAAe,EAAE,QAAiB;QAC5C,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE;YAChE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAE,MAAc,CAAC,KAAK,CAAC,CAAC,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,gDAAiD,KAAM,cAAc,CAAC,CAAC;gBACvF,yFAAyF;gBACzF,+FAA+F;gBAC/F,yFAAyF;gBACzF,+EAA+E;aAChF;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEO,GAAG,CAAC,KAA0C,EAAE,IAAW;QACjE,IAAI;YACF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SAC7B;QAAC,WAAM;YACN,kCAAkC;YAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SAC/B;IACH,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AAjDD,6BAiDC"}

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

@@ -0,0 +1,12 @@
+/**
+ * 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;
+//# sourceMappingURL=format.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../src/logging/format.ts"],"names":[],"mappings":"AAwGA;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAuCrD"}