@featbit/js-client-sdk 4.2.11 → 4.2.12

package/dist/cjs/events/index.js

@@ -0,0 +1,28 @@
+"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("./DefaultEventProcessor"), exports);
+__exportStar(require("./DefaultEventQueue"), exports);
+__exportStar(require("./DefaultEventSender"), exports);
+__exportStar(require("./DefaultEventSerializer"), exports);
+__exportStar(require("./event"), exports);
+__exportStar(require("./EventDispatcher"), exports);
+__exportStar(require("./EventSerializer"), exports);
+__exportStar(require("./IEventProcessor"), exports);
+__exportStar(require("./IEventQueue"), exports);
+__exportStar(require("./IEventSender"), exports);
+__exportStar(require("./NullEventProcessor"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/events/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/events/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,sDAAoC;AACpC,uDAAqC;AACrC,2DAAyC;AACzC,0CAAwB;AACxB,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,gDAA8B;AAC9B,iDAA+B;AAC/B,uDAAqC"}

package/dist/cjs/index.js

@@ -0,0 +1,37 @@
+"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("./bootstrap"), exports);
+__exportStar(require("./data-sources"), exports);
+__exportStar(require("./evaluation"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./platform"), exports);
+__exportStar(require("./store"), exports);
+__exportStar(require("./data-sync"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./Configuration"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./Context"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./FbClientBuilder"), exports);
+__exportStar(require("./IContextProperty"), exports);
+__exportStar(require("./IDataKind"), exports);
+__exportStar(require("./IFbClient"), exports);
+__exportStar(require("./IVersionedData"), exports);
+__exportStar(require("./FbClientCore"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,+CAA6B;AAC7B,2CAAyB;AACzB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B;AAC3B,0CAAwB;AACxB,8CAA4B;AAC5B,0CAAwB;AAExB,kDAAgC;AAChC,8CAA4B;AAC5B,4CAA0B;AAC1B,2CAAyB;AACzB,oDAAkC;AAClC,qDAAmC;AACnC,8CAA4B;AAC5B,8CAA4B;AAC5B,mDAAiC;AACjC,iDAA+B"}

package/dist/cjs/integrations/TestLogger.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestLogger = void 0;
+class TestLogger {
+    constructor() {
+        this.logs = [];
+    }
+    error(...args) {
+        this.logs.push(args.join(' '));
+    }
+    warn(...args) {
+        this.logs.push(args.join(' '));
+    }
+    info(...args) {
+        this.logs.push(args.join(' '));
+    }
+    debug(...args) {
+        this.logs.push(args.join(' '));
+    }
+    reset() {
+        this.logs = [];
+    }
+}
+exports.TestLogger = TestLogger;
+//# sourceMappingURL=TestLogger.js.map

package/dist/cjs/integrations/TestLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestLogger.js","sourceRoot":"","sources":["../../../src/integrations/TestLogger.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IAAvB;QACS,SAAI,GAAa,EAAE,CAAC;IAqB7B,CAAC;IAnBC,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,GAAG,IAAW;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;CACF;AAtBD,gCAsBC"}

package/dist/cjs/integrations/index.js

@@ -0,0 +1,21 @@
+"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 });
+exports.TestLogger = void 0;
+__exportStar(require("./test_data"), exports);
+var TestLogger_1 = require("./TestLogger");
+Object.defineProperty(exports, "TestLogger", { enumerable: true, get: function () { return TestLogger_1.TestLogger; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/integrations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/integrations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAA0C;AAAjC,wGAAA,UAAU,OAAA"}

package/dist/cjs/integrations/test_data/FlagBuilder.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlagBuilder = void 0;
+// used only by tests
+const IFlag_1 = require("../../evaluation/data/IFlag");
+class FlagBuilder {
+    constructor() {
+        this._id = `xxxxx-${new Date().getTime()}-xxxxxx`;
+        this._variationType = IFlag_1.VariationDataType.empty;
+        this._sendToExperiment = false;
+        this._variation = '';
+        this._variations = [];
+        this._matchReason = '';
+    }
+    id(id) {
+        this._id = id;
+        return this;
+    }
+    key(key) {
+        this._key = key;
+        return this;
+    }
+    version(version) {
+        this._version = version;
+        return this;
+    }
+    origin(origin) {
+        this._origin = origin;
+        return this;
+    }
+    sendToExperiment(val) {
+        this._sendToExperiment = val;
+        return this;
+    }
+    variation(variation) {
+        this._variation = variation;
+        return this;
+    }
+    variationType(variationType) {
+        this._variationType = variationType;
+        return this;
+    }
+    variations(variations) {
+        this._variations = variations;
+        return this;
+    }
+    matchReason(matchReason) {
+        this._matchReason = matchReason;
+        return this;
+    }
+    build() {
+        return {
+            id: this._id,
+            key: this._key,
+            version: this._version,
+            origin: this._origin,
+            variationType: this._variationType,
+            variations: this._variations,
+            sendToExperiment: this._sendToExperiment,
+            variation: this._variation,
+            timestamp: new Date().getTime(),
+            matchReason: this._matchReason,
+        };
+    }
+}
+exports.FlagBuilder = FlagBuilder;
+//# sourceMappingURL=FlagBuilder.js.map

package/dist/cjs/integrations/test_data/FlagBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlagBuilder.js","sourceRoot":"","sources":["../../../../src/integrations/test_data/FlagBuilder.ts"],"names":[],"mappings":";;;AAAA,qBAAqB;AACrB,uDAA8F;AAG9F,MAAa,WAAW;IAAxB;QACU,QAAG,GAAW,SAAS,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC;QAIrD,mBAAc,GAAsB,yBAAiB,CAAC,KAAK,CAAC;QAC5D,sBAAiB,GAAY,KAAK,CAAC;QACnC,eAAU,GAAc,EAAE,CAAC;QAC3B,gBAAW,GAAiB,EAAE,CAAC;QAC/B,iBAAY,GAAW,EAAE,CAAC;IA6DpC,CAAC;IA3DC,EAAE,CAAC,EAAU;QACX,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,GAAW;QACb,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAA2B;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,GAAY;QAC3B,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAA;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,SAAoB;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,aAAgC;QAC5C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAA;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,UAAwB;QACjC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,WAAmB;QAC7B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,GAAI;YACb,GAAG,EAAE,IAAI,CAAC,IAAK;YACf,OAAO,EAAE,IAAI,CAAC,QAAS;YACvB,MAAM,EAAE,IAAI,CAAC,OAAQ;YACrB,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;YACxC,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC/B,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;CACF;AAtED,kCAsEC"}

package/dist/cjs/integrations/test_data/TestData.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const TestDataSynchronizer_1 = __importDefault(require("./TestDataSynchronizer"));
+const createStreamListeners_1 = require("../../data-sources/createStreamListeners");
+const DataKinds_1 = __importDefault(require("../../store/DataKinds"));
+class TestData {
+    constructor() {
+        this.currentFlags = [];
+        this.store = {};
+    }
+    /**
+     * Get a factory for update processors that will be attached to this TestData instance.
+     * @returns An update processor factory.
+     */
+    getFactory() {
+        // Provides an arrow function to prevent needed to bind the method to
+        // maintain `this`.
+        return (clientContext, store, dataSourceUpdates, initSuccessHandler, _errorHandler) => {
+            this.store = store;
+            const listeners = (0, createStreamListeners_1.createStreamListeners)(dataSourceUpdates, clientContext.logger, {
+                put: initSuccessHandler,
+            });
+            this.dataSynchronizer = new TestDataSynchronizer_1.default(dataSourceUpdates, Object.values(this.currentFlags), () => { }, listeners);
+            return this.dataSynchronizer;
+        };
+    }
+    update(flag) {
+        var _a;
+        const oldVersion = ((_a = this.store.get(DataKinds_1.default.Flags, flag.id)) === null || _a === void 0 ? void 0 : _a.version) || 0;
+        const newFlag = Object.assign(Object.assign({}, flag), { version: oldVersion + 1, key: flag.id });
+        return this.dataSynchronizer.upsert(DataKinds_1.default.Flags, newFlag);
+    }
+}
+exports.default = TestData;
+//# sourceMappingURL=TestData.js.map

package/dist/cjs/integrations/test_data/TestData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestData.js","sourceRoot":"","sources":["../../../../src/integrations/test_data/TestData.ts"],"names":[],"mappings":";;;;;AACA,kFAA0D;AAI1D,oFAAiF;AAEjF,sEAA8C;AAE9C,MAAqB,QAAQ;IAA7B;QACU,iBAAY,GAAY,EAAE,CAAC;QAI3B,UAAK,GAAW,EAAY,CAAC;IA2CvC,CAAC;IAzCC;;;OAGG;IACH,UAAU;QACR,qEAAqE;QACrE,mBAAmB;QACnB,OAAO,CACL,aAA6B,EAC7B,KAAa,EACb,iBAAqC,EACrC,kBAAgC,EAChC,aAAkC,EAClC,EAAE;YACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YAEnB,MAAM,SAAS,GAAG,IAAA,6CAAqB,EACrC,iBAAiB,EACjB,aAAa,CAAC,MAAM,EACpB;gBACE,GAAG,EAAE,kBAAkB;aACxB,CACF,CAAC;YAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,8BAAoB,CAC9C,iBAAiB,EACjB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAChC,GAAG,EAAE,GAAE,CAAC,EACR,SAAS,CACV,CAAC;YAEF,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC,CAAA;IACH,CAAC;IAED,MAAM,CAAC,IAAW;;QAChB,MAAM,UAAU,GAAG,CAAA,MAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,mBAAS,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,0CAAE,OAAO,KAAI,CAAC,CAAC;QAC1E,MAAM,OAAO,mCAAQ,IAAI,KAAE,OAAO,EAAE,UAAU,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAE,CAAC;QAEnE,OAAO,IAAI,CAAC,gBAAiB,CAAC,MAAM,CAAC,mBAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAhDD,2BAgDC"}

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

@@ -0,0 +1,52 @@
+"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() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 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/cjs/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;IAEK,QAAQ;;YACZ,QAAQ;QACV,CAAC;KAAA;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/cjs/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/cjs/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/cjs/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, _d;
+        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 = (_d = options.destination) !== null && _d !== void 0 ? _d : console.log;
+        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/cjs/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,MAAA,OAAO,CAAC,WAAW,mCAAI,OAAO,CAAC,GAAG,CAAC;QACtD,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/cjs/logging/IBasicLoggerOptions.js

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

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

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

package/dist/cjs/logging/ILogger.js

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

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

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

package/dist/cjs/logging/LogLevel.js

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

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

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

package/dist/cjs/logging/SafeLogger.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SafeLogger = void 0;
+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.SafeLogger = SafeLogger;
+//# sourceMappingURL=SafeLogger.js.map

package/dist/cjs/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,MAAa,UAAU;IAKrB;;;;;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,gCAiDC"}