@featbit/js-client-sdk 2.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,289 @@
+# FeatBit Client-Side SDK for JavaScript
+
+## Introduction
+
+This is the client side SDK for the feature management platform [FeatBit](https://github.com/featbit/featbit). 
+
+Be aware, this is a client side SDK, it is intended for use in a single-user context, which can be mobile, desktop or embedded applications. This SDK can only be ran in a browser environment, it is not suitable for NodeJs applications.
+
+## Get Started
+
+### Installation
+
+```bash
+npm install @featbit/js-client-sdk
+```
+
+### Prerequisite
+
+Before using the SDK, you need to obtain the environment secret and SDK URLs. 
+
+Follow the documentation below to retrieve these values
+
+- [How to get the environment secret](https://docs.featbit.co/sdk/faq#how-to-get-the-environment-secret)
+- [How to get the SDK URLs](https://docs.featbit.co/sdk/faq#how-to-get-the-sdk-urls)
+
+### Quick Start
+
+The following code demonstrates:
+1. Initialize the SDK
+2. Evaluate flag
+3. Subscribe to flag change
+
+```javascript
+import fbClient from '@featbit/js-client-sdk';
+
+const option = {
+  secret: "your env secret",
+  api:"http://localhost:5100", // the Streaming URL
+  user: {
+    name: "Bot",
+    keyId: "bot-id",
+    customizedProperties: [
+      {
+        "name": "level",
+        "value": "high"
+      }
+    ]
+  }
+};
+
+// initialization
+fbClient.init(option);
+
+// evaluation
+const flagValue = fbClient.variation("YOUR_FEATURE_KEY", defaultValue);
+
+// subscribe to flag change
+fbClient.on('ff_update:YOUR_FEATURE_KEY', (change) => {
+  // change has this structure {id: 'the feature_flag_key', oldValue: theOldValue, newValue: theNewValue }
+  // the type of theOldValue and theNewValue is defined on FeatBit
+
+  // defaultValue should have the same type as theOldValue and theNewValue
+  const myFeature = fbClient.variation('YOUR_FEATURE_KEY', defaultValue);
+});
+```
+
+## Examples
+
+- [Vue](https://github.com/featbit/featbit-samples/tree/main/samples/dino-game/interactive-demo-vue)
+- For how to use FeatBit with React, please refer to the [react-client-sdk](https://github.com/featbit/featbit-react-client-sdk)
+
+## SDK
+
+### Initialization
+
+Before initializing the SDK, you need to get the client-side env secret of your environment from FeatBit.
+
+```javascript
+const option = {
+  secret: "your env secret",
+  streamingUri:"ws://localhost:5100",
+  eventsUri:"http://localhost:5100",
+  user: {
+    name: "Bot",
+    keyId: "bot-id",
+    customizedProperties: [
+      {
+          "name": "level",
+          "value": "high"
+      }
+    ]
+  }
+};
+
+fbClient.init(option);
+```
+
+The user has three properties:
+- name(**requried**):  The user's name, useful when viewing users in the portal.
+- keyId(**requried**): The unique user identifier.
+- streamingUri: The streaming URL.
+- eventsUri: The events URL.
+- customizedProperties(**optional**): Any other customized properties. Users can be targeted by these customized properties. Here is the format definition:
+```json
+ [
+   {
+     "name": "the name of the property",
+     "value": "the value of the property"
+   }
+]
+```
+
+This table lists all available options
+
+| Options               | Defaults     | Description                                                                                                                                                                                              |
+|-----------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| secret (**required**) | -            | The client side secret of your environment.                                                                                                                                                              |
+| user   (**required**) | -            | The user connected to your APP, can be ignored if anonymous equals to true.                                                                                                                              |
+| anonymous             | `false`      | Set to true if you want to use a anonymous user, which is the case before user login to your APP. If that is your case, the user can be set later with the identify method after the user has logged in. |
+| enableDataSync        | `true`       | Set to false if you do not want to sync data with remote server, in this case feature flags must be set to bootstrap option or be passed to the method bootstrap.                                        |
+| bootstrap             | `[ ]`        | Init the SDK with feature flags, this will trigger the ready event immediately instead of requesting from the remote.                                                                                    |
+| streamingUri          | ``           | The evaluation server streaming URL.                                                                                                                                                                     |
+| eventsUri             | ``           | The evaluation server events URL.                                                                                                                                                                        |
+| appType               | `javascript` | The app type.                                                                                                                                                                                            |
+
+### Bootstrap
+If you already have the feature flags available, two ways to pass them to the SDK instead of requesting from the remote.
+- By the **init** method
+
+```javascript
+// define the option with the bootstrap parameter
+const option = {
+  ...
+  // the array should contain all your feature flags
+  bootstrap = [{
+    // feature flag key name
+    id: string,
+    // variation value
+    variation: string,
+    // variation data type, string will be used if not specified
+    variationType: VariationDataType
+  }],
+  ...
+}
+
+fbClient.init(option);
+```
+
+- By the **bootstrap** method
+
+```javascript
+// this array should contain all your feature flags
+const featureflags = [{
+  // feature flag key name
+  id: string,
+  // variation value
+  variation: string,
+  // variation data type, string will used if not specified
+  variationType: VariationDataType
+}]
+
+fbClient.bootstrap(featureflags);
+```
+
+**If you want to disable the synchronization with remote server, set enableDataSync to false in option**. In this case, bootstrap option must be set or bootstrap method must be called with feature flags.
+
+### Evaluation
+
+After initialization, the SDK has all the feature flags locally, and it does not need to request the remote server for any feature flag evaluation. All evaluation is done locally and synchronously, the average evaluation time is about **1** ms.
+
+```javascript
+// Use this method for all cases
+// This method supports type inspection, it returns the value with the type defined on FeatBit,
+// so defaultValue should have the same type as defined on FeatBit
+const flagValue = fbClient.variation("YOUR_FEATURE_KEY", defaultValue);
+```
+
+### Events
+
+#### Wait for ready
+
+To find out when the client is ready, you can use one of two mechanisms: events or promises.
+
+The client object can emit JavaScript events. It emits a ready event when it receives initial flag values from the server. You can listen for this event to determine when the client is ready to evaluate flags.
+
+```javascript
+fbClient.on('ready', (data) => {
+  // data has the following structure [ {id: 'featureFlagKey', variation: variationValue} ]
+  // variationValue has the type as defined on remote
+  var flagValue = fbClient.variation("YOUR_FEATURE_KEY", defaultValue);
+});
+```
+
+Or, you can use a promise instead of an event. The SDK has a method that return a promise for initialization: waitUntilReady(). The behavior of waitUntilReady() is equivalent to the ready event. The promise resolves when the client receives its initial flag data. As with all promises, you can either use .then() to provide a callback, or use await if you are writing asynchronous code.
+
+```javascript
+fbClient.waitUntilReady().then((data) => {
+  // data has the following structure [ {id: 'featureFlagKey', variation: variationValue } ]
+  // variationValue has the type as defined on remote
+  // initialization succeeded, flag values are now available
+});
+// or, with await:
+const featureFlags = await fbClient.waitUntilReady();
+// initialization succeeded, flag values are now available
+```
+
+The SDK only decides initialization has failed if it receives an error response indicating that the environment ID is invalid. If it has trouble connecting to feature-flags.co, it will keep retrying until it succeeds.
+
+#### Subscribe to flag(s) changes
+
+To get notified when a feature flag is changed, we offer two methods
+- subscribe to the changes of any feature flag(s)
+
+```javascript
+fbClient.on('ff_update', (changes) => {
+  // changes has this structure [{id: 'the feature_flag_key', oldValue: theOldValue, newValue: theNewValue }]
+  // the type of theOldValue and theNewValue is defined on FeatBit
+  
+  // do something when any feature flag changes
+});
+
+```
+- subscribe to the changes of a specific feature flag
+
+```javascript
+// replace feature_flag_key with your feature flag key
+fbClient.on('ff_update:feature_flag_key', (change) => {
+  // change has this structure {id: 'the feature_flag_key', oldValue: theOldValue, newValue: theNewValue }
+  // the type of theOldValue and theNewValue is defined on FeatBit
+
+  // defaultValue should have the same type as theOldValue and theNewValue
+  // this is the prefered way than calling change.newValue as each time you call fbClient.variation,
+  // the insight data is sent to server automatically
+  const myFeature = fbClient.variation('feature_flag_key', defaultValue);
+});
+
+```
+
+### Switch user after initialization
+If the user parameter cannot be passed by the init method, the following method can be used to set the user after initialization.
+
+```javascript
+await fbClient.identify(user);
+```
+
+We can manually call the method logout, which will switch the current user back to anonymous user if exists already or create a new anonymous user.
+
+```javascript
+fbClient.logout(user);
+```
+
+### Data synchronization
+
+We use websocket to make the local data synchronized with the server, and then store them in memory by default. Whenever there is any change to a feature flag or its related data, this change will be pushed to the SDK, the average synchronization time is less than 100ms. Be aware the websocket connection may be interrupted due to internet outage, but it will be resumed automatically once the problem is gone.
+
+### Network failure handling
+
+As all data is stored locally in the localStorage, in the following situations, the SDK would still work when there is temporarily no internet connection:
+- it has already received the data from previous connections
+- the fbClient.bootstrap(featureFlags) method is called with all necessary feature flags
+
+In the meantime, the SDK would try to reconnect to the server by an incremental interval, this makes sure that the websocket would be restored when the internet connection is back.
+
+
+### Experiments (A/B/n Testing)
+
+We support automatic experiments for page views and clicks, you just need to set your experiment on FeatBit portal, then you should be able to see the result in near real time after the experiment is started.
+
+In case you need more control over the experiment data sent to our server, we offer a method to send custom event.
+
+```javascript
+fbClient.sendCustomEvent([{
+  eventName: 'your event name',
+  numericValue: 1
+}])
+```
+
+**numericValue** is not mandatory, the default value is **1**.
+
+Make sure sendCustomEvent is called after the related feature flag is called by simply calling **fbClient.variation('featureFlagKeyName', 'default value')**, otherwise, the custom event won't be included into the experiment result.
+
+## Getting support
+
+- If you have a specific question about using this SDK, we encourage you to [ask it in Slack](https://join.slack.com/t/featbit/shared_invite/zt-1ew5e2vbb-x6Apan1xZOaYMnFzqZkGNQ).
+- If you encounter a bug or would like to request a feature, [submit an issue](https://github.com/featbit/featbit-js-client-sdk/issues).
+
+## See Also
+
+- [Connect To JavaScript Sdk](https://docs.featbit.co/getting-started/connect-an-sdk#javascript)

package/esm/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const insightsFlushTopic = "insights.flush";
+export declare const featureFlagEvaluatedTopic = "featureflag.evaluated.topic";
+export declare const featureFlagEvaluatedBufferTopic = "featureflag.evaluated.buffer.topic";
+export declare const websocketReconnectTopic = "network.websocket.reconnect";
+export declare const debugModeQueryStr = "debugmode";
+export declare const insightsTopic = "insights.topic";
+export declare const currentUserStorageKey = "fb-user";

package/esm/constants.js

@@ -0,0 +1,8 @@
+export var insightsFlushTopic = 'insights.flush';
+export var featureFlagEvaluatedTopic = 'featureflag.evaluated.topic';
+export var featureFlagEvaluatedBufferTopic = 'featureflag.evaluated.buffer.topic';
+export var websocketReconnectTopic = 'network.websocket.reconnect';
+export var debugModeQueryStr = 'debugmode'; // will print debug logs if true
+export var insightsTopic = 'insights.topic';
+export var currentUserStorageKey = 'fb-user';
+//# sourceMappingURL=constants.js.map

package/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,kBAAkB,GAAG,gBAAgB,CAAC;AACnD,MAAM,CAAC,IAAM,yBAAyB,GAAG,6BAA6B,CAAC;AACvE,MAAM,CAAC,IAAM,+BAA+B,GAAG,oCAAoC,CAAC;AACpF,MAAM,CAAC,IAAM,uBAAuB,GAAG,6BAA6B,CAAC;AACrE,MAAM,CAAC,IAAM,iBAAiB,GAAG,WAAW,CAAC,CAAC,gCAAgC;AAC9E,MAAM,CAAC,IAAM,aAAa,GAAG,gBAAgB,CAAC;AAC9C,MAAM,CAAC,IAAM,qBAAqB,GAAG,SAAS,CAAC"}

package/esm/events.d.ts

@@ -0,0 +1,14 @@
+interface Events {
+    [key: string]: Function[];
+}
+declare class EventEmitter {
+    events: Events;
+    constructor(events?: Events);
+    subscribe(name: string, cb: Function): {
+        unsubscribe: () => Function[];
+    };
+    unsubscribe(name: string, cb: Function): void;
+    emit(name: string, ...args: any[]): void;
+}
+export declare const eventHub: EventEmitter;
+export {};

package/esm/events.js

@@ -0,0 +1,27 @@
+var EventEmitter = /** @class */ (function () {
+    function EventEmitter(events) {
+        this.events = events || {};
+    }
+    EventEmitter.prototype.subscribe = function (name, cb) {
+        var _this = this;
+        (this.events[name] || (this.events[name] = [])).push(cb);
+        return {
+            unsubscribe: function () {
+                return _this.events[name] && _this.events[name].splice(_this.events[name].indexOf(cb) >>> 0, 1);
+            }
+        };
+    };
+    EventEmitter.prototype.unsubscribe = function (name, cb) {
+        this.events[name] && this.events[name].splice(this.events[name].indexOf(cb) >>> 0, 1);
+    };
+    EventEmitter.prototype.emit = function (name) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        (this.events[name] || []).forEach(function (fn) { return fn.apply(void 0, args); });
+    };
+    return EventEmitter;
+}());
+export var eventHub = new EventEmitter();
+//# sourceMappingURL=events.js.map

package/esm/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAIA;IAEE,sBAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;IAC7B,CAAC;IAEM,gCAAS,GAAhB,UAAiB,IAAY,EAAE,EAAY;QAA3C,iBAOC;QANC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEzD,OAAO;YACL,WAAW,EAAE;gBACX,OAAA,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAArF,CAAqF;SACxF,CAAC;IACJ,CAAC;IAEM,kCAAW,GAAlB,UAAmB,IAAY,EAAE,EAAY;QAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;IAEM,2BAAI,GAAX,UAAY,IAAY;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;QACtC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,EAAE,eAAI,IAAI,GAAV,CAAW,CAAC,CAAC;IACvD,CAAC;IACH,mBAAC;AAAD,CAAC,AAtBD,IAsBC;AAED,MAAM,CAAC,IAAM,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC"}

package/esm/featbit.d.ts

@@ -0,0 +1,34 @@
+import { FeatureFlagValue, ICustomEvent, IFeatureFlag, IFeatureFlagBase, IFeatureFlagSet, IOption, IUser } from "./types";
+export declare class FB {
+    private _readyEventEmitted;
+    private _readyPromise;
+    private _insightsQueue;
+    private _featureFlagEvaluationBuffer;
+    private _option;
+    constructor();
+    on(name: string, cb: Function): void;
+    off(name: string, cb: Function): void;
+    waitUntilReady(): Promise<IFeatureFlagBase[]>;
+    init(option: IOption): Promise<void>;
+    identify(user: IUser): Promise<void>;
+    logout(): Promise<IUser>;
+    /**
+     * bootstrap with predefined feature flags.
+     * @param {array} featureFlags the predefined feature flags.
+     * @param {boolean} forceFullFetch if a forced full fetch should be made.
+     * @return {Promise<void>} nothing.
+     */
+    bootstrap(featureFlags?: IFeatureFlag[], forceFullFetch?: boolean): Promise<void>;
+    private dataSync;
+    variation(key: string, defaultResult: FeatureFlagValue): FeatureFlagValue;
+    /**
+     * deprecated, you should use variation method directly
+     */
+    boolVariation(key: string, defaultResult: boolean): boolean;
+    getUser(): IUser;
+    sendCustomEvent(data: ICustomEvent[]): void;
+    sendFeatureFlagInsight(key: string, variation: string): void;
+    getAllFeatureFlags(): IFeatureFlagSet;
+}
+declare const _default: FB;
+export default _default;