vwo-fme-node-sdk 1.0.1 → 1.2.0

package/README.md

@@ -1,6 +1,10 @@
 ## VWO Feature Management and Experimentation SDK for Node.js
 
 [![npm version](https://badge.fury.io/js/vwo-fme-node-sdk.svg)](https://www.npmjs.com/package/vwo-fme-node-sdk)
+[![CI](https://github.com/wingify/vwo-fme-node-sdk/workflows/CI/badge.svg?branch=master)](https://github.com/wingify/vwo-fme-node-sdk/actions?query=workflow%3ACI)
+
+[![codecov](https://codecov.io/gh/wingify/vwo-fme-node-sdk/branch/master/graph/badge.svg?token=813UYYMWGM)](https://codecov.io/gh/wingify/vwo-fme-node-sdk)
+
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
 ### Requirements
@@ -20,22 +24,48 @@ yarn add vwo-fme-node-sdk
 ### Example
 
 ```javascript
-
+const { init } = require('vwo-fme-node-sdk');
+
+const vwoClient = await vwo.init({
+  accountId: '123456', // VWO Account ID
+  sdkKey: '32-alpha-numeric-sdk-key' // SDK Key
+});
+
+// set user context
+const userContext = { id: "unique_user_id" };
+// returns a flag object
+const getFlag = await vwoClient.getFlag('feature_key', userContext);
+// check if flag is enabled
+const isFlagEnabled = getFlag.isEnabled();
+// get variable
+const intVar = getFlag.getVariable('int_variable_key');
+
+// track event
+vwoClient.trackEvent('addToCart', userContext, eventProperties);
 ```
 
-### Scripts
+### Development Scripts
 
-1. Install dependencies
+1. Install dependencies and bootstrap git-hooks
 
-`yarn install`
+```bash
+yarn install
+```
 
 2. Compile TypeScript code to JavaScript(ES6)
 
-`yarn tsc`
+```bash
+yarn tsc
+```
 
-2. To run example:
+3. To run tests:
 
-`yarn run example`
+```bash
+# for production
+yarn run test:prod
+# for development
+yarn run test:dev
+```
 
 ### Contributing
 

package/dist/VWO.d.ts

@@ -1,9 +1,40 @@
-import { dynamic } from './types/common';
+import { IVWOClient } from './VWOClient';
+import { IVWOOptions } from './models/VWOOptionsModel';
+import { dynamic } from './types/Common';
+import { LogLevelEnum } from './packages/logger/enums/LogLevelEnum';
+import { Connector } from './packages/storage/Connector';
+export { LogLevelEnum, Connector as StorageConnector };
 export declare class VWO {
     private static vwoBuilder;
     private static instance;
-    constructor(options?: Record<string, dynamic>);
+    /**
+     * Constructor for the VWO class.
+     * Initializes a new instance of VWO with the provided options.
+     * @param {Record<string, dynamic>} options - Configuration options for the VWO instance.
+     * @returns The instance of VWO.
+     */
+    constructor(options: IVWOOptions);
+    /**
+     * Sets the singleton instance of VWO.
+     * Configures and builds the VWO instance using the provided options.
+     * @param {Record<string, dynamic>} options - Configuration options for setting up VWO.
+     * @returns A Promise resolving to the configured VWO instance.
+     */
     private static setInstance;
+    /**
+     * Gets the singleton instance of VWO.
+     * @returns The singleton instance of VWO.
+     */
     static get Instance(): dynamic;
 }
-export declare function init(options?: Record<string, dynamic>): Promise<VWO>;
+/**
+ * Initializes a new instance of VWO with the provided options.
+ * @param options Configuration options for the VWO instance.
+ * @property {string} sdkKey - The SDK key for the VWO account.
+ * @property {string} accountId - The account ID for the VWO account.
+ * @property {GatewayServiceModel} gatewayService - The gateway service configuration.
+ * @property {StorageService} storage - The storage configuration.
+ * @returns
+ */
+export declare function init(options: IVWOOptions): Promise<IVWOClient>;
+export declare function onReady(): Promise<any>;

package/dist/VWO.js

@@ -36,33 +36,69 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.init = exports.VWO = void 0;
+exports.onReady = exports.init = exports.VWO = exports.StorageConnector = exports.LogLevelEnum = void 0;
+/**
+ * Copyright 2024 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 var VWOBuilder_1 = require("./VWOBuilder");
 var DataTypeUtil_1 = require("./utils/DataTypeUtil");
+var PromiseUtil_1 = require("./utils/PromiseUtil");
+var log_messages_1 = require("./enums/log-messages");
+var LogLevelEnum_1 = require("./packages/logger/enums/LogLevelEnum");
+Object.defineProperty(exports, "LogLevelEnum", { enumerable: true, get: function () { return LogLevelEnum_1.LogLevelEnum; } });
+var Connector_1 = require("./packages/storage/Connector");
+Object.defineProperty(exports, "StorageConnector", { enumerable: true, get: function () { return Connector_1.Connector; } });
+var LogMessageUtil_1 = require("./utils/LogMessageUtil");
 var VWO = /** @class */ (function () {
+    /**
+     * Constructor for the VWO class.
+     * Initializes a new instance of VWO with the provided options.
+     * @param {Record<string, dynamic>} options - Configuration options for the VWO instance.
+     * @returns The instance of VWO.
+     */
     function VWO(options) {
-        if (options === void 0) { options = {}; }
         return VWO.setInstance(options);
     }
+    /**
+     * Sets the singleton instance of VWO.
+     * Configures and builds the VWO instance using the provided options.
+     * @param {Record<string, dynamic>} options - Configuration options for setting up VWO.
+     * @returns A Promise resolving to the configured VWO instance.
+     */
     VWO.setInstance = function (options) {
         var _this = this;
-        this.vwoBuilder = new VWOBuilder_1.VWOBuilder(options);
+        var optionsVWOBuilder = options === null || options === void 0 ? void 0 : options.vwoBuilder;
+        this.vwoBuilder = optionsVWOBuilder || new VWOBuilder_1.VWOBuilder(options);
         this.instance = this.vwoBuilder
-            .setSettingsManager()
-            .setStorage()
-            .setLogger()
-            .setNetworkManager()
-            .setSegmentation()
-            .initBatching()
-            .initPolling();
-        // .getSettings()
-        // .setAnalyticsCallback()
+            .setLogger() // Sets up logging for debugging and monitoring.
+            .setSettingsManager() // Sets the settings manager for configuration management.
+            .setStorage() // Configures storage for data persistence.
+            .setNetworkManager() // Configures network management for API communication.
+            .setSegmentation() // Sets up segmentation for targeted functionality.
+            // .initBatching()        // Initializes batching for bulk data processing.
+            .initPolling(); // Starts polling mechanism for regular updates.
+        // .setAnalyticsCallback() // Sets up analytics callback for data analysis.
         return this.vwoBuilder.getSettings().then(function (settings) {
-            return _this.vwoBuilder.build(settings);
+            return _this.vwoBuilder.build(settings); // Builds the VWO instance with the fetched settings.
         });
-        // return this.instance;
     };
     Object.defineProperty(VWO, "Instance", {
+        /**
+         * Gets the singleton instance of VWO.
+         * @returns The singleton instance of VWO.
+         */
         get: function () {
             return this.instance;
         },
@@ -72,29 +108,108 @@ var VWO = /** @class */ (function () {
     return VWO;
 }());
 exports.VWO = VWO;
-function init() {
-    return __awaiter(this, arguments, void 0, function (options) {
-        var instance;
-        if (options === void 0) { options = {}; }
+var _global = {};
+/**
+ * Initializes a new instance of VWO with the provided options.
+ * @param options Configuration options for the VWO instance.
+ * @property {string} sdkKey - The SDK key for the VWO account.
+ * @property {string} accountId - The account ID for the VWO account.
+ * @property {GatewayServiceModel} gatewayService - The gateway service configuration.
+ * @property {StorageService} storage - The storage configuration.
+ * @returns
+ */
+function init(options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var apiName, date, msg, msg, msg, instance, msg;
         return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (!(0, DataTypeUtil_1.isObject)(options)) {
-                        throw new Error('Options should be of type object.');
-                    }
-                    if (!options.sdkKey || !(0, DataTypeUtil_1.isString)(options.sdkKey)) {
-                        throw new Error('Please provide the sdkKey in the options and should be a of type string');
-                    }
-                    if (!options.accountId) {
-                        throw new Error('Please provide VWO account ID in the options and should be a of type string|number');
-                    }
-                    return [4 /*yield*/, new VWO(options)];
-                case 1:
-                    instance = _a.sent();
-                    return [2 /*return*/, instance];
+            apiName = 'init';
+            date = new Date().toISOString();
+            try {
+                if (!(0, DataTypeUtil_1.isObject)(options)) {
+                    msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.ErrorLogMessagesEnum.INIT_OPTIONS_ERROR, {
+                        date: date,
+                    });
+                    console.error(msg); // Ensures options is an object.
+                }
+                if (!(options === null || options === void 0 ? void 0 : options.sdkKey) || !(0, DataTypeUtil_1.isString)(options === null || options === void 0 ? void 0 : options.sdkKey)) {
+                    msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.ErrorLogMessagesEnum.INIT_OPTIONS_SDK_KEY_ERROR, {
+                        date: date,
+                    });
+                    console.error(msg); // Validates sdkKey presence and type.
+                }
+                if (!options.accountId) {
+                    msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.ErrorLogMessagesEnum.INIT_OPTIONS_ACCOUNT_ID_ERROR, {
+                        date: date,
+                    });
+                    console.error(msg); // Validates accountId presence and type.
+                }
+                instance = new VWO(options);
+                _global = {
+                    vwoInitDeferred: new PromiseUtil_1.Deferred(),
+                    isSettingsFetched: false,
+                    instance: null,
+                };
+                return [2 /*return*/, instance.then(function (_vwoInstance) {
+                        _global.isSettingsFetched = true;
+                        _global.instance = _vwoInstance;
+                        _global.vwoInitDeferred.resolve(_vwoInstance);
+                        return _vwoInstance;
+                    })];
             }
+            catch (err) {
+                msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.ErrorLogMessagesEnum.API_THROW_ERROR, {
+                    apiName: apiName,
+                    err: err,
+                });
+                console.info("[INFO]: VWO-SDK ".concat(new Date().toISOString(), " ").concat(msg));
+            }
+            return [2 /*return*/];
         });
     });
 }
 exports.init = init;
+function onReady() {
+    return __awaiter(this, void 0, void 0, function () {
+        var apiName, date_1, msg, msg;
+        return __generator(this, function (_a) {
+            apiName = 'onReady';
+            try {
+                _global.vwoInitDeferred = new PromiseUtil_1.Deferred();
+                date_1 = new Date().toISOString();
+                // If settings are already fetched, resolve the promise
+                if (_global.isSettingsFetched) {
+                    msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.InfoLogMessagesEnum.ON_READY_ALREADY_RESOLVED, {
+                        date: date_1,
+                        apiName: apiName,
+                    });
+                    console.info(msg);
+                    _global.vwoInitDeferred.resolve(_global.instance);
+                }
+                else {
+                    // wait for five seconds, else reject the promise
+                    setTimeout(function () {
+                        if (_global.isSettingsFetched) {
+                            return;
+                        }
+                        var msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.InfoLogMessagesEnum.ON_READY_SETTINGS_FAILED, {
+                            date: date_1,
+                        });
+                        console.error(msg);
+                        _global.vwoInitDeferred.reject(new Error('VWO settings could not be fetched'));
+                    }, 5000);
+                }
+                return [2 /*return*/, _global.vwoInitDeferred.promise];
+            }
+            catch (err) {
+                msg = (0, LogMessageUtil_1.buildMessage)(log_messages_1.ErrorLogMessagesEnum.API_THROW_ERROR, {
+                    apiName: apiName,
+                    err: err,
+                });
+                console.info("[INFO]: VWO-SDK ".concat(new Date().toISOString(), " ").concat(msg));
+            }
+            return [2 /*return*/];
+        });
+    });
+}
+exports.onReady = onReady;
 //# sourceMappingURL=VWO.js.map

package/dist/VWO.js.map

@@ -1 +1 @@
-{"version":3,"file":"VWO.js","sourceRoot":"","sources":["../lib/VWO.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA0C;AAC1C,qDAA0D;AAI1D;IAIE,aAAY,OAAqC;QAArC,wBAAA,EAAA,YAAqC;QAC/C,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAEc,eAAW,GAA1B,UAA2B,OAAgC;QAA3D,iBAkBC;QAjBC,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU;aAC5B,kBAAkB,EAAE;aACpB,UAAU,EAAE;aACZ,SAAS,EAAE;aACX,iBAAiB,EAAE;aACnB,eAAe,EAAE;aACjB,YAAY,EAAE;aACd,WAAW,EAAE,CAAA;QACd,iBAAiB;QACjB,0BAA0B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,UAAC,QAAuB;YAChE,OAAO,KAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC,CAAC,CAAA;QAEF,wBAAwB;IAC1B,CAAC;IAED,sBAAW,eAAQ;aAAnB;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IACH,UAAC;AAAD,CAAC,AA/BD,IA+BC;AA/BY,kBAAG;AAiChB,SAAsB,IAAI;wDAAC,OAAqC;;QAArC,wBAAA,EAAA,YAAqC;;;;oBAC9D,IAAI,CAAC,IAAA,uBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;wBACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;oBACvD,CAAC;oBAED,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAA,uBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;wBACjD,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;oBAC7F,CAAC;oBAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;wBACvB,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;oBACxG,CAAC;oBAEgB,qBAAM,IAAI,GAAG,CAAC,OAAO,CAAC,EAAA;;oBAAjC,QAAQ,GAAG,SAAsB;oBAEvC,sBAAO,QAAQ,EAAC;;;;CACjB;AAhBD,oBAgBC"}
+{"version":3,"file":"VWO.js","sourceRoot":"","sources":["../lib/VWO.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;GAcG;AACH,2CAAuD;AAKvD,qDAA0D;AAC1D,mDAA+C;AAE/C,qDAAiF;AACjF,qEAAoE;AAI3D,6FAJA,2BAAY,OAIA;AAHrB,0DAAyD;AAGrB,iGAH3B,qBAAS,OAGkC;AAFpD,yDAAsD;AAItD;IAIE;;;;;OAKG;IACH,aAAY,OAAoB;QAC9B,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACY,eAAW,GAA1B,UAA2B,OAAoB;QAA/C,iBAiBC;QAhBC,IAAM,iBAAiB,GAAQ,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,iBAAiB,IAAI,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU;aAC5B,SAAS,EAAE,CAAC,gDAAgD;aAC5D,kBAAkB,EAAE,CAAC,0DAA0D;aAC/E,UAAU,EAAE,CAAC,2CAA2C;aACxD,iBAAiB,EAAE,CAAC,uDAAuD;aAC3E,eAAe,EAAE,CAAC,mDAAmD;YACtE,2EAA2E;aAC1E,WAAW,EAAE,CAAC,CAAC,gDAAgD;QAClE,2EAA2E;QAE3E,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,UAAC,QAAuB;YAChE,OAAO,KAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,qDAAqD;QAC/F,CAAC,CAAC,CAAC;IACL,CAAC;IAMD,sBAAW,eAAQ;QAJnB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IACH,UAAC;AAAD,CAAC,AA9CD,IA8CC;AA9CY,kBAAG;AAgDhB,IAAI,OAAO,GAAwB,EAAE,CAAC;AACtC;;;;;;;;GAQG;AAEH,SAAsB,IAAI,CAAC,OAAoB;;;;YACvC,OAAO,GAAG,MAAM,CAAC;YACjB,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAEtC,IAAI,CAAC;gBACH,IAAI,CAAC,IAAA,uBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;oBACjB,GAAG,GAAG,IAAA,6BAAY,EAAC,mCAAoB,CAAC,kBAAkB,EAAE;wBAChE,IAAI,MAAA;qBACL,CAAC,CAAC;oBACH,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,gCAAgC;gBACtD,CAAC;gBAED,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAA,IAAI,CAAC,IAAA,uBAAQ,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,EAAE,CAAC;oBAC7C,GAAG,GAAG,IAAA,6BAAY,EAAC,mCAAoB,CAAC,0BAA0B,EAAE;wBACxE,IAAI,MAAA;qBACL,CAAC,CAAC;oBACH,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,sCAAsC;gBAC5D,CAAC;gBAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBACjB,GAAG,GAAG,IAAA,6BAAY,EAAC,mCAAoB,CAAC,6BAA6B,EAAE;wBAC3E,IAAI,MAAA;qBACL,CAAC,CAAC;oBACH,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,yCAAyC;gBAC/D,CAAC;gBAEK,QAAQ,GAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;gBAEvC,OAAO,GAAG;oBACR,eAAe,EAAE,IAAI,sBAAQ,EAAE;oBAC/B,iBAAiB,EAAE,KAAK;oBACxB,QAAQ,EAAE,IAAI;iBACf,CAAC;gBAEF,sBAAO,QAAQ,CAAC,IAAI,CAAC,UAAC,YAAY;wBAChC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;wBACjC,OAAO,CAAC,QAAQ,GAAG,YAAY,CAAC;wBAChC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;wBAE9C,OAAO,YAAY,CAAC;oBACtB,CAAC,CAAC,EAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACP,GAAG,GAAG,IAAA,6BAAY,EAAC,mCAAoB,CAAC,eAAe,EAAE;oBAC7D,OAAO,SAAA;oBACP,GAAG,KAAA;iBACJ,CAAC,CAAC;gBAEH,OAAO,CAAC,IAAI,CAAC,0BAAmB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,cAAI,GAAG,CAAE,CAAC,CAAC;YACrE,CAAC;;;;CACF;AAjDD,oBAiDC;AAED,SAAsB,OAAO;;;;YACrB,OAAO,GAAG,SAAS,CAAC;YAE1B,IAAI,CAAC;gBACH,OAAO,CAAC,eAAe,GAAG,IAAI,sBAAQ,EAAE,CAAC;gBACnC,SAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBAEtC,uDAAuD;gBACvD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;oBACxB,GAAG,GAAG,IAAA,6BAAY,EAAC,kCAAmB,CAAC,yBAAyB,EAAE;wBACtE,IAAI,QAAA;wBACJ,OAAO,SAAA;qBACR,CAAC,CAAC;oBAEH,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAClB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpD,CAAC;qBAAM,CAAC;oBACN,iDAAiD;oBACjD,UAAU,CAAC;wBACT,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;4BAC9B,OAAO;wBACT,CAAC;wBAED,IAAM,GAAG,GAAG,IAAA,6BAAY,EAAC,kCAAmB,CAAC,wBAAwB,EAAE;4BACrE,IAAI,QAAA;yBACL,CAAC,CAAC;wBAEH,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACnB,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;oBACjF,CAAC,EAAE,IAAI,CAAC,CAAC;gBACX,CAAC;gBAED,sBAAO,OAAO,CAAC,eAAe,CAAC,OAAO,EAAC;YACzC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACP,GAAG,GAAG,IAAA,6BAAY,EAAC,mCAAoB,CAAC,eAAe,EAAE;oBAC7D,OAAO,SAAA;oBACP,GAAG,KAAA;iBACJ,CAAC,CAAC;gBAEH,OAAO,CAAC,IAAI,CAAC,0BAAmB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,cAAI,GAAG,CAAE,CAAC,CAAC;YACrE,CAAC;;;;CACF;AAzCD,0BAyCC"}

package/dist/VWOBuilder.d.ts

@@ -1,48 +1,114 @@
-import { dynamic } from './types/common';
-import { LogManager } from './modules/logger';
-import { Storage } from './modules/storage';
-import { VWOClient } from './VWOClient';
-import { SettingsModel } from './models/SettingsModel';
-interface IVWOBuilder {
+/**
+ * Copyright 2024 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { dynamic } from './types/Common';
+import { ILogManager } from './packages/logger';
+import { Storage } from './packages/storage';
+import { IVWOClient } from './VWOClient';
+import { SettingsModel } from './models/settings/SettingsModel';
+import { IVWOOptions } from './models/VWOOptionsModel';
+export interface IVWOBuilder {
     settings: SettingsModel;
     storage: Storage;
-    logManager: LogManager;
+    logManager: ILogManager;
     isSettingsFetchInProgress: boolean;
-    build(settings: SettingsModel): VWOClient;
+    vwoInstance: IVWOClient;
+    build(settings: SettingsModel): IVWOClient;
     fetchSettings(): Promise<SettingsModel>;
     setSettingsManager(): this;
-    setSettings(settings: SettingsModel): void;
     getSettings(force: boolean): Promise<dynamic>;
     setStorage(): this;
     setNetworkManager(): this;
-    initBatching(): this;
     initPolling(): this;
-    setAnalyticsCallback(): this;
     setLogger(): this;
     setSegmentation(): this;
 }
 export declare class VWOBuilder implements IVWOBuilder {
-    readonly apiKey: string;
-    readonly options: Record<string, any>;
+    readonly sdkKey: string;
+    readonly options: IVWOOptions;
     private settingFileManager;
     settings: SettingsModel;
     storage: Storage;
-    logManager: LogManager;
+    logManager: ILogManager;
     originalSettings: dynamic;
     isSettingsFetchInProgress: boolean;
-    constructor(options: Record<string, dynamic>);
+    vwoInstance: IVWOClient;
+    constructor(options: IVWOOptions);
+    /**
+     * Sets the network manager with the provided client and development mode options.
+     * @returns {this} The instance of this builder.
+     */
     setNetworkManager(): this;
+    /**
+     * Sets the segmentation evaluator with the provided segmentation options.
+     * @returns {this} The instance of this builder.
+     */
     setSegmentation(): this;
+    /**
+     * Fetches settings asynchronously, ensuring no parallel fetches.
+     * @param {boolean} [force=false] - Force fetch ignoring cache.
+     * @returns {Promise<SettingsModel>} A promise that resolves to the fetched settings.
+     */
     fetchSettings(force?: boolean): Promise<SettingsModel>;
-    setSettings(settings: Record<string, any> | string): void;
+    /**
+     * Gets the settings, fetching them if not cached or if forced.
+     * @param {boolean} [force=false] - Force fetch ignoring cache.
+     * @returns {Promise<SettingsModel>} A promise that resolves to the settings.
+     */
     getSettings(force?: boolean): Promise<SettingsModel>;
+    /**
+     * Sets the storage connector based on the provided storage options.
+     * @returns {this} The instance of this builder.
+     */
     setStorage(): this;
+    /**
+     * Sets the settings manager with the provided options.
+     * @returns {this} The instance of this builder.
+     */
     setSettingsManager(): this;
+    /**
+     * Sets the logger with the provided logger options.
+     * @returns {this} The instance of this builder.
+     */
     setLogger(): this;
-    setAnalyticsCallback(): this;
-    initBatching(): this;
+    /**
+     * Sets the analytics callback with the provided analytics options.
+     * @returns {this} The instance of this builder.
+     */
+    /**
+     * Generates a random user ID based on the provided API key.
+     * @returns {string} The generated random user ID.
+     */
+    getRandomUserId(): string;
+    /**
+     * Initializes the batching with the provided batch events options.
+     * @returns {this} The instance of this builder.
+     */
+    /**
+     * Initializes the polling with the provided poll interval.
+     * @returns {this} The instance of this builder.
+     */
     initPolling(): this;
-    build(settings: SettingsModel): VWOClient;
-    checkAndPoll(pollingInterval: number): void;
+    /**
+     * Builds a new VWOClient instance with the provided settings.
+     * @param {SettingsModel} settings - The settings for the VWOClient.
+     * @returns {VWOClient} The new VWOClient instance.
+     */
+    build(settings: SettingsModel): IVWOClient;
+    /**
+     * Checks and polls for settings updates at the provided interval.
+     */
+    checkAndPoll(): void;
 }
-export {};