@flagship.io/react-sdk 2.2.0-beta.6 → 3.0.0

package/dist/esm/FlagshipHooks.js

@@ -1,3 +1,9 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -19,6 +25,8 @@ function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "functi
 import { useContext } from 'react';
 import { FlagshipContext } from './FlagshipContext';
 import { logError, logWarn } from './utils';
+import { Flag } from './Flag';
+import { noVisitorDefault, noVisitorMessage } from './constants';
 
 var checkType = function checkType(value, defaultValue) {
   return _typeof(value) === 'object' && _typeof(defaultValue) === 'object' && Array.isArray(value) === Array.isArray(defaultValue) || _typeof(value) === _typeof(defaultValue);
@@ -62,6 +70,7 @@ var fsModificationsSync = function fsModificationsSync(args) {
 };
 /**
  * Retrieve a modification value by its key. If no modification match the given key or if the stored value type and default value type do not match, default value will be returned.
+ * @deprecated use useFsGetFlag instead
  */
 
 
@@ -83,6 +92,7 @@ export var useFsModifications = function useFsModifications(params, activateAll)
 };
 /**
  * Retrieve a modification value by its key. If no modification match the given key or if the stored value type and default value type do not match, default value will be returned.
+ * @deprecated use useFsGetFlag instead
  */
 
 export var useFsModification = function useFsModification(params) {
@@ -131,6 +141,7 @@ var fsModificationInfoSync = function fsModificationInfoSync(args) {
 /**
  * Get the campaign modification information value matching the given key.
  * @param {string} key key which identify the modification.
+ * @deprecated use useFsGetFlag instead
  */
 
 
@@ -187,110 +198,99 @@ var fsSynchronizeModifications = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-/**
- * This function calls the decision api and update all the campaigns modifications from the server according to the visitor context.
-*/
-
-
-export var useFsSynchronizeModifications = /*#__PURE__*/function () {
-  var _ref2 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
-    var _useContext4, state, visitor, config, functionName;
 
+var fsActivate = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(params, functionName, visitor, config) {
     return regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
-            _useContext4 = useContext(FlagshipContext), state = _useContext4.state;
-            visitor = state.visitor, config = state.config;
-            functionName = 'useFsSynchronizeModifications';
-            _context2.next = 5;
-            return fsSynchronizeModifications(functionName, visitor, config);
-
-          case 5:
-          case "end":
-            return _context2.stop();
-        }
-      }
-    }, _callee2);
-  }));
-
-  return function useFsSynchronizeModifications() {
-    return _ref2.apply(this, arguments);
-  };
-}();
-
-var fsActivate = /*#__PURE__*/function () {
-  var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(params, functionName, visitor, config) {
-    return regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) {
-        switch (_context3.prev = _context3.next) {
-          case 0:
-            _context3.prev = 0;
+            _context2.prev = 0;
 
             if (visitor) {
-              _context3.next = 4;
+              _context2.next = 4;
               break;
             }
 
             logWarn(config, noVisitorMessage, functionName);
-            return _context3.abrupt("return");
+            return _context2.abrupt("return");
 
           case 4:
-            _context3.next = 6;
+            _context2.next = 6;
             return visitor.activateModifications(params);
 
           case 6:
-            _context3.next = 11;
+            _context2.next = 11;
             break;
 
           case 8:
-            _context3.prev = 8;
-            _context3.t0 = _context3["catch"](0);
-            logWarn(config, _context3.t0.message || _context3.t0, functionName);
+            _context2.prev = 8;
+            _context2.t0 = _context2["catch"](0);
+            logWarn(config, _context2.t0.message || _context2.t0, functionName);
 
           case 11:
           case "end":
-            return _context3.stop();
+            return _context2.stop();
         }
       }
-    }, _callee3, null, [[0, 8]]);
+    }, _callee2, null, [[0, 8]]);
   }));
 
   return function fsActivate(_x4, _x5, _x6, _x7) {
-    return _ref3.apply(this, arguments);
+    return _ref2.apply(this, arguments);
   };
 }();
+/**
+ * This hook returns a flag object by its key. If no flag match the given key an empty flag will be returned.
+ * @param key
+ * @param defaultValue
+ * @returns
+ */
+
+
+export var useFsFlag = function useFsFlag(key, defaultValue) {
+  var _useContext4 = useContext(FlagshipContext),
+      state = _useContext4.state;
+
+  var visitor = state.visitor;
+
+  if (!visitor) {
+    return new Flag(defaultValue);
+  }
+
+  return visitor.getFlag(key, defaultValue);
+};
 /**
  * Report this user has seen this modification. Report this user has seen these modifications.
  * @param params
+ * @deprecated use useFsGetFlag instead
  * @returns
  */
 
-
 export var useFsActivate = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4(params) {
+  var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3(params) {
     var _useContext5, state, visitor, config, functionName;
 
-    return regeneratorRuntime.wrap(function _callee4$(_context4) {
+    return regeneratorRuntime.wrap(function _callee3$(_context3) {
       while (1) {
-        switch (_context4.prev = _context4.next) {
+        switch (_context3.prev = _context3.next) {
           case 0:
             _useContext5 = useContext(FlagshipContext), state = _useContext5.state;
             visitor = state.visitor, config = state.config;
             functionName = 'useFsModifications';
-            _context4.next = 5;
+            _context3.next = 5;
             return fsActivate(params, functionName, visitor, config);
 
           case 5:
           case "end":
-            return _context4.stop();
+            return _context3.stop();
         }
       }
-    }, _callee4);
+    }, _callee3);
   }));
 
   return function useFsActivate(_x8) {
-    return _ref4.apply(this, arguments);
+    return _ref3.apply(this, arguments);
   };
 }();
 export var useFlagship = function useFlagship() {
@@ -345,8 +345,8 @@ export var useFlagship = function useFlagship() {
     visitor.unauthenticate();
   };
   /**
-  * Send a Hit to Flagship servers for reporting.
-  */
+   * Send a Hit to Flagship servers for reporting.
+   */
 
 
   var fsSendHit = function fsSendHit(hit) {
@@ -360,8 +360,8 @@ export var useFlagship = function useFlagship() {
     return visitor.sendHit(hit);
   };
   /**
-  * Send a Hit to Flagship servers for reporting.
-  */
+   * Send a Hit to Flagship servers for reporting.
+   */
 
 
   var fsSendHits = function fsSendHits(hit) {
@@ -379,60 +379,60 @@ export var useFlagship = function useFlagship() {
 
   if (!state.status.isSdkReady && state.modifications) {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    modifications = Array.from(state.modifications, function (_ref5) {
-      var _ref6 = _slicedToArray(_ref5, 2),
-          _key = _ref6[0],
-          item = _ref6[1];
+    modifications = Array.from(state.modifications, function (_ref4) {
+      var _ref5 = _slicedToArray(_ref4, 2),
+          _key = _ref5[0],
+          item = _ref5[1];
 
       return item;
     });
   }
 
   var activateModification = /*#__PURE__*/function () {
-    var _ref7 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5(params) {
+    var _ref6 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4(params) {
       var functionName;
-      return regeneratorRuntime.wrap(function _callee5$(_context5) {
+      return regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) {
-          switch (_context5.prev = _context5.next) {
+          switch (_context4.prev = _context4.next) {
             case 0:
               functionName = 'activateModification';
-              _context5.next = 3;
+              _context4.next = 3;
               return fsActivate(params, functionName, visitor, config);
 
             case 3:
             case "end":
-              return _context5.stop();
+              return _context4.stop();
           }
         }
-      }, _callee5);
+      }, _callee4);
     }));
 
     return function activateModification(_x9) {
-      return _ref7.apply(this, arguments);
+      return _ref6.apply(this, arguments);
     };
   }();
 
   var synchronizeModifications = /*#__PURE__*/function () {
-    var _ref8 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6() {
+    var _ref7 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
       var functionName;
-      return regeneratorRuntime.wrap(function _callee6$(_context6) {
+      return regeneratorRuntime.wrap(function _callee5$(_context5) {
         while (1) {
-          switch (_context6.prev = _context6.next) {
+          switch (_context5.prev = _context5.next) {
             case 0:
               functionName = 'synchronizeModifications';
-              _context6.next = 3;
+              _context5.next = 3;
               return fsSynchronizeModifications(functionName, visitor, config);
 
             case 3:
             case "end":
-              return _context6.stop();
+              return _context5.stop();
           }
         }
-      }, _callee6);
+      }, _callee5);
     }));
 
     return function synchronizeModifications() {
-      return _ref8.apply(this, arguments);
+      return _ref7.apply(this, arguments);
     };
   }();
 
@@ -456,7 +456,38 @@ export var useFlagship = function useFlagship() {
     });
   };
 
+  function getFlag(key, defaultValue) {
+    if (!visitor) {
+      return new Flag(defaultValue);
+    }
+
+    return visitor.getFlag(key, defaultValue);
+  }
+
+  function fetchFlags() {
+    if (!visitor) {
+      logWarn(config, noVisitorMessage, 'fetchFlags');
+      return Promise.resolve();
+    }
+
+    return visitor === null || visitor === void 0 ? void 0 : visitor.fetchFlags();
+  }
+
+  function setConsent(hasConsented) {
+    if (!visitor) {
+      logWarn(config, noVisitorMessage, 'setConsent');
+      return;
+    }
+
+    visitor.setConsent(hasConsented);
+  }
+
   return {
+    visitorId: visitor === null || visitor === void 0 ? void 0 : visitor.visitorId,
+    anonymousId: visitor === null || visitor === void 0 ? void 0 : visitor.anonymousId,
+    context: _objectSpread({}, visitor === null || visitor === void 0 ? void 0 : visitor.context),
+    hasConsented: visitor === null || visitor === void 0 ? void 0 : visitor.hasConsented,
+    setConsent: setConsent,
     updateContext: fsUpdateContext,
     clearContext: fsClearContext,
     authenticate: fsAuthenticate,
@@ -466,15 +497,16 @@ export var useFlagship = function useFlagship() {
     synchronizeModifications: synchronizeModifications,
     getModifications: getModifications,
     modifications: modifications || [],
+    FlagsData: (visitor === null || visitor === void 0 ? void 0 : visitor.getFlagsDataArray()) || [],
     getModificationInfo: getModificationInfo,
     hit: {
       send: fsSendHit,
       sendMultiple: fsSendHits
-    }
+    },
+    getFlag: getFlag,
+    fetchFlags: fetchFlags
   };
 };
-export var noVisitorMessage = 'sdk not correctly initialized... Make sure fsVisitor is ready.';
-export var noVisitorDefault = 'fsVisitor not initialized, returns default value';
 
 var reportNoVisitor = function reportNoVisitor(config, tag) {
   logError(config, noVisitorMessage, tag);

package/dist/esm/constants.js

@@ -0,0 +1,2 @@
+export var noVisitorMessage = 'sdk not correctly initialized... Make sure fsVisitor is ready.';
+export var noVisitorDefault = 'fsVisitor not initialized, returns default value';

package/dist/esm/utils.js

@@ -20,6 +20,16 @@ export function logWarn(config, message, tag) {
 
   config.logManager.warning(message, tag);
 }
+export function log(level, message, tag) {
+  var now = new Date(); // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+  var getTwoDigit = function getTwoDigit(value) {
+    return value.toString().length === 1 ? "0".concat(value) : value;
+  };
+
+  var out = "[".concat(getTwoDigit(now.getFullYear()), "-").concat(getTwoDigit(now.getMonth()), "-").concat(getTwoDigit(now.getDay()), " ").concat(getTwoDigit(now.getHours()), ":").concat(getTwoDigit(now.getMinutes()), "] [Flagship SDK] [").concat(LogLevel[level], "] [").concat(tag, "] : ").concat(message);
+  console.log(out);
+}
 export var getModificationsFromCampaigns = function getModificationsFromCampaigns(campaigns) {
   var modifications = new Map();
 
@@ -43,4 +53,11 @@ export var getModificationsFromCampaigns = function getModificationsFromCampaign
     }
   });
   return modifications;
-};
+};
+export function uuidV4() {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (char) {
+    var rand = Math.random() * 16 | 0;
+    var value = char === 'x' ? rand : rand & 0x3 | 0x8;
+    return value.toString(16);
+  });
+}