@flagship.io/react-sdk 2.2.0-beta.6 → 3.0.2-alpha.0

package/dist/es/FlagshipHooks.js

@@ -1,341 +0,0 @@
-import { useContext } from 'react';
-import { FlagshipContext } from './FlagshipContext';
-import { logError, logWarn } from './utils';
-
-const checkType = (value, defaultValue) => typeof value === 'object' && typeof defaultValue === 'object' && Array.isArray(value) === Array.isArray(defaultValue) || typeof value === typeof defaultValue;
-
-const fsModificationsSync = args => {
-  const {
-    visitor,
-    params,
-    activateAll,
-    state,
-    functionName,
-    config
-  } = args;
-
-  if (visitor) {
-    return visitor.getModificationsSync(params, activateAll);
-  }
-
-  const check = !state.status.isSdkReady && !!state.modifications && state.modifications.size > 0;
-  const flags = {};
-
-  if (check) {
-    params.forEach(item => {
-      var _state$modifications;
-
-      const modification = (_state$modifications = state.modifications) === null || _state$modifications === void 0 ? void 0 : _state$modifications.get(item.key);
-
-      if (modification && checkType(modification === null || modification === void 0 ? void 0 : modification.value, item.defaultValue)) {
-        flags[item.key] = modification.value;
-      } else {
-        flags[item.key] = item.defaultValue;
-      }
-    });
-    return flags;
-  }
-
-  logWarn(config, noVisitorDefault, functionName);
-  params.forEach(item => {
-    flags[item.key] = item.defaultValue;
-  });
-  return flags;
-};
-/**
- * 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.
- */
-
-
-export const useFsModifications = (params, activateAll) => {
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor,
-    config
-  } = state;
-  const functionName = 'useFsModifications';
-  return fsModificationsSync({
-    functionName,
-    state,
-    visitor,
-    config,
-    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.
- */
-
-export const useFsModification = params => {
-  var _state$modifications2;
-
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor,
-    config
-  } = state;
-  const functionName = 'useFsModifications';
-
-  if (visitor) {
-    return visitor.getModificationSync(params);
-  }
-
-  const modification = (_state$modifications2 = state.modifications) === null || _state$modifications2 === void 0 ? void 0 : _state$modifications2.get(params.key);
-
-  if (!state.status.isSdkReady && modification && checkType(modification === null || modification === void 0 ? void 0 : modification.value, params.defaultValue)) {
-    return modification.value;
-  }
-
-  logWarn(config, noVisitorDefault, functionName);
-  return params.defaultValue;
-};
-
-const fsModificationInfoSync = args => {
-  var _state$modifications3;
-
-  const {
-    key,
-    visitor,
-    state
-  } = args;
-
-  if (visitor) {
-    return visitor.getModificationInfoSync(key);
-  }
-
-  const modification = (_state$modifications3 = state.modifications) === null || _state$modifications3 === void 0 ? void 0 : _state$modifications3.get(key);
-
-  if (!state.status.isSdkReady && modification) {
-    return modification;
-  }
-
-  return null;
-};
-/**
- * Get the campaign modification information value matching the given key.
- * @param {string} key key which identify the modification.
- */
-
-
-export const useFsModificationInfo = key => {
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor
-  } = state;
-  return fsModificationInfoSync({
-    key,
-    state,
-    visitor
-  });
-};
-
-const fsSynchronizeModifications = async (functionName, visitor, config) => {
-  try {
-    if (!visitor) {
-      reportNoVisitor(config, functionName);
-      return;
-    }
-
-    await visitor.synchronizeModifications(); // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } catch (error) {
-    logError(config, error.message || error, functionName);
-  }
-};
-/**
- * This function calls the decision api and update all the campaigns modifications from the server according to the visitor context.
-*/
-
-
-export const useFsSynchronizeModifications = async () => {
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor,
-    config
-  } = state;
-  const functionName = 'useFsSynchronizeModifications';
-  await fsSynchronizeModifications(functionName, visitor, config);
-};
-
-const fsActivate = async (params, functionName, visitor, config) => {
-  try {
-    if (!visitor) {
-      logWarn(config, noVisitorMessage, functionName);
-      return;
-    }
-
-    await visitor.activateModifications(params); // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } catch (error) {
-    logWarn(config, error.message || error, functionName);
-  }
-};
-/**
- * Report this user has seen this modification. Report this user has seen these modifications.
- * @param params
- * @returns
- */
-
-
-export const useFsActivate = async params => {
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor,
-    config
-  } = state;
-  const functionName = 'useFsModifications';
-  await fsActivate(params, functionName, visitor, config);
-};
-export const useFlagship = () => {
-  const {
-    state
-  } = useContext(FlagshipContext);
-  const {
-    visitor,
-    config
-  } = state;
-
-  const fsUpdateContext = context => {
-    const functionName = 'updateContext';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return;
-    }
-
-    visitor.clearContext();
-    visitor.updateContext(context);
-  };
-
-  const fsClearContext = () => {
-    const functionName = 'cleanContext';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return;
-    }
-
-    visitor.clearContext();
-  };
-
-  const fsAuthenticate = visitorId => {
-    const functionName = 'authenticate';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return;
-    }
-
-    visitor.authenticate(visitorId);
-  };
-
-  const fsUnauthenticate = () => {
-    const functionName = 'unauthenticate';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return;
-    }
-
-    visitor.unauthenticate();
-  };
-  /**
-  * Send a Hit to Flagship servers for reporting.
-  */
-
-
-  const fsSendHit = hit => {
-    const functionName = 'sendHit';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return Promise.resolve();
-    }
-
-    return visitor.sendHit(hit);
-  };
-  /**
-  * Send a Hit to Flagship servers for reporting.
-  */
-
-
-  const fsSendHits = hit => {
-    const functionName = 'sendHits';
-
-    if (!visitor) {
-      logError(config, noVisitorMessage, functionName);
-      return Promise.resolve();
-    }
-
-    return visitor.sendHits(hit);
-  };
-
-  let modifications = visitor === null || visitor === void 0 ? void 0 : visitor.getModificationsArray();
-
-  if (!state.status.isSdkReady && state.modifications) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    modifications = Array.from(state.modifications, ([_key, item]) => item);
-  }
-
-  const activateModification = async params => {
-    const functionName = 'activateModification';
-    await fsActivate(params, functionName, visitor, config);
-  };
-
-  const synchronizeModifications = async () => {
-    const functionName = 'synchronizeModifications';
-    await fsSynchronizeModifications(functionName, visitor, config);
-  };
-
-  const getModifications = (params, activateAll) => {
-    const functionName = 'getModifications';
-    return fsModificationsSync({
-      functionName,
-      state,
-      visitor,
-      config,
-      params,
-      activateAll
-    });
-  };
-
-  const getModificationInfo = key => {
-    return fsModificationInfoSync({
-      key,
-      state,
-      visitor
-    });
-  };
-
-  return {
-    updateContext: fsUpdateContext,
-    clearContext: fsClearContext,
-    authenticate: fsAuthenticate,
-    unauthenticate: fsUnauthenticate,
-    status: state.status,
-    activateModification,
-    synchronizeModifications,
-    getModifications,
-    modifications: modifications || [],
-    getModificationInfo,
-    hit: {
-      send: fsSendHit,
-      sendMultiple: fsSendHits
-    }
-  };
-};
-export const noVisitorMessage = 'sdk not correctly initialized... Make sure fsVisitor is ready.';
-export const noVisitorDefault = 'fsVisitor not initialized, returns default value';
-
-const reportNoVisitor = (config, tag) => {
-  logError(config, noVisitorMessage, tag);
-};

package/dist/es/index.js

@@ -1,3 +0,0 @@
-export * from './FlagshipContext';
-export * from '@flagship.io/js-sdk';
-export * from './FlagshipHooks';

package/dist/es/utils.js

@@ -1,46 +0,0 @@
-import { LogLevel } from '@flagship.io/js-sdk';
-export function logError(config, message, tag) {
-  if (!config || !config.logManager || typeof config.logManager.error !== 'function' || !config.logLevel || config.logLevel < LogLevel.ERROR) {
-    return;
-  }
-
-  config.logManager.error(message, tag);
-}
-export function logInfo(config, message, tag) {
-  if (!config || !config.logManager || typeof config.logManager.info !== 'function' || !config.logLevel || config.logLevel < LogLevel.INFO) {
-    return;
-  }
-
-  config.logManager.info(message, tag);
-}
-export function logWarn(config, message, tag) {
-  if (!config || !config.logManager || typeof config.logManager.warning !== 'function' || !config.logLevel || config.logLevel < LogLevel.WARNING) {
-    return;
-  }
-
-  config.logManager.warning(message, tag);
-}
-export const getModificationsFromCampaigns = campaigns => {
-  const modifications = new Map();
-
-  if (!campaigns || !Array.isArray(campaigns)) {
-    return modifications;
-  }
-
-  campaigns.forEach(campaign => {
-    const object = campaign.variation.modifications.value;
-
-    for (const key in object) {
-      const value = object[key];
-      modifications.set(key, {
-        key,
-        campaignId: campaign.id,
-        variationGroupId: campaign.variationGroupId,
-        variationId: campaign.variation.id,
-        isReference: campaign.variation.reference,
-        value
-      });
-    }
-  });
-  return modifications;
-};

package/dist/esm/FlagshipContext.js

@@ -1,265 +0,0 @@
-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."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-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; }
-
-// eslint-disable-next-line no-use-before-define
-import React, { useState, useEffect, createContext, useRef } from 'react';
-import { Flagship, FlagshipStatus } from '@flagship.io/js-sdk';
-import { getModificationsFromCampaigns, logError } from './utils';
-var initStat = {
-  status: {
-    isLoading: true,
-    isSdkReady: false
-  }
-};
-export var FlagshipContext = /*#__PURE__*/createContext({
-  state: _objectSpread({}, initStat)
-});
-export var FlagshipProvider = function FlagshipProvider(_ref) {
-  var children = _ref.children,
-      fetchNow = _ref.fetchNow,
-      envId = _ref.envId,
-      apiKey = _ref.apiKey,
-      decisionMode = _ref.decisionMode,
-      decisionApiUrl = _ref.decisionApiUrl,
-      timeout = _ref.timeout,
-      logLevel = _ref.logLevel,
-      statusChangedCallback = _ref.statusChangedCallback,
-      logManager = _ref.logManager,
-      pollingInterval = _ref.pollingInterval,
-      visitorData = _ref.visitorData,
-      onInitStart = _ref.onInitStart,
-      onInitDone = _ref.onInitDone,
-      onBucketingSuccess = _ref.onBucketingSuccess,
-      onBucketingFail = _ref.onBucketingFail,
-      loadingComponent = _ref.loadingComponent,
-      onBucketingUpdated = _ref.onBucketingUpdated,
-      onUpdate = _ref.onUpdate,
-      enableClientCache = _ref.enableClientCache,
-      initialBucketing = _ref.initialBucketing,
-      initialCampaigns = _ref.initialCampaigns,
-      initialModifications = _ref.initialModifications,
-      synchronizeOnBucketingUpdated = _ref.synchronizeOnBucketingUpdated,
-      activateDeduplicationTime = _ref.activateDeduplicationTime,
-      hitDeduplicationTime = _ref.hitDeduplicationTime,
-      visitorCacheImplementation = _ref.visitorCacheImplementation,
-      hitCacheImplementation = _ref.hitCacheImplementation,
-      disableCache = _ref.disableCache;
-  var modifications = new Map();
-
-  if (initialModifications) {
-    initialModifications.forEach(function (modification) {
-      modifications.set(modification.key, modification);
-    });
-  } else if (initialCampaigns) {
-    modifications = getModificationsFromCampaigns(initialCampaigns);
-  }
-
-  var _useState = useState(_objectSpread(_objectSpread({}, initStat), {}, {
-    modifications: modifications
-  })),
-      _useState2 = _slicedToArray(_useState, 2),
-      state = _useState2[0],
-      setState = _useState2[1];
-
-  var _useState3 = useState(),
-      _useState4 = _slicedToArray(_useState3, 2),
-      lastModified = _useState4[0],
-      setLastModified = _useState4[1];
-
-  var stateRef = useRef();
-  stateRef.current = state;
-  useEffect(function () {
-    if (synchronizeOnBucketingUpdated) {
-      var _state$visitor;
-
-      (_state$visitor = state.visitor) === null || _state$visitor === void 0 ? void 0 : _state$visitor.synchronizeModifications();
-    }
-  }, [lastModified]);
-  useEffect(function () {
-    updateVisitor();
-  }, [JSON.stringify(visitorData)]);
-  useEffect(function () {
-    initSdk();
-  }, [envId, apiKey, decisionMode]);
-
-  var updateVisitor = function updateVisitor() {
-    if (!state.visitor) {
-      return;
-    }
-
-    if (visitorData.context) {
-      state.visitor.clearContext();
-      state.visitor.updateContext(visitorData.context);
-    }
-
-    if (typeof visitorData.hasConsented === 'boolean') {
-      state.visitor.setConsent(visitorData.hasConsented);
-    }
-
-    if (state.visitor.anonymousId && !visitorData.isAuthenticated) {
-      state.visitor.unauthenticate();
-    } else if (!state.visitor.anonymousId && visitorData.isAuthenticated) {
-      state.visitor.authenticate(visitorData.id);
-    }
-
-    if (visitorData.id) {
-      state.visitor.visitorId = visitorData.id;
-    }
-
-    state.visitor.synchronizeModifications();
-  };
-
-  function initializeState(param) {
-    var newStatus = {
-      isSdkReady: param.isSdkReady,
-      isLoading: param.isLoading,
-      isVisitorDefined: !!param.fsVisitor,
-      lastRefresh: new Date().toISOString()
-    };
-    setState(function (currentState) {
-      if (!currentState.status.firstInitSuccess) {
-        newStatus.firstInitSuccess = new Date().toISOString();
-      }
-
-      return _objectSpread(_objectSpread({}, currentState), {}, {
-        visitor: param.fsVisitor,
-        modifications: param.fsVisitor.modifications,
-        config: Flagship.getConfig(),
-        status: _objectSpread(_objectSpread({}, currentState.status), newStatus)
-      });
-    });
-    return newStatus;
-  } // eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-
-  var onVisitorReady = function onVisitorReady(fsVisitor, error) {
-    if (error) {
-      logError(Flagship.getConfig(), error.message || error, 'onReady');
-      return;
-    }
-
-    var newStatus = initializeState({
-      fsVisitor: fsVisitor,
-      isSdkReady: true,
-      isLoading: false
-    });
-
-    if (onUpdate) {
-      onUpdate({
-        fsModifications: fsVisitor.modifications,
-        config: Flagship.getConfig(),
-        status: newStatus
-      });
-    }
-  };
-
-  var statusChanged = function statusChanged(status) {
-    if (statusChangedCallback) {
-      statusChangedCallback(status);
-    }
-
-    if (status === FlagshipStatus.STARTING && onInitStart) {
-      onInitStart();
-    } else if (status === FlagshipStatus.READY_PANIC_ON || status === FlagshipStatus.READY) {
-      var _stateRef$current;
-
-      if (onInitDone) {
-        onInitDone();
-      }
-
-      if ((_stateRef$current = stateRef.current) !== null && _stateRef$current !== void 0 && _stateRef$current.visitor) {
-        var _stateRef$current2;
-
-        (_stateRef$current2 = stateRef.current) === null || _stateRef$current2 === void 0 ? void 0 : _stateRef$current2.visitor.synchronizeModifications();
-      } else {
-        var fsVisitor = Flagship.newVisitor({
-          visitorId: visitorData.id,
-          context: visitorData.context,
-          isAuthenticated: visitorData.isAuthenticated,
-          hasConsented: visitorData.hasConsented,
-          initialCampaigns: initialCampaigns,
-          initialModifications: initialModifications
-        });
-        fsVisitor === null || fsVisitor === void 0 ? void 0 : fsVisitor.on('ready', function (error) {
-          onVisitorReady(fsVisitor, error);
-        });
-
-        if (!fetchNow && fsVisitor) {
-          initializeState({
-            fsVisitor: fsVisitor,
-            isSdkReady: true,
-            isLoading: false
-          });
-        }
-      }
-    }
-  };
-
-  var onBucketingLastModified = function onBucketingLastModified(lastUpdate) {
-    if (onBucketingUpdated) {
-      onBucketingUpdated(lastUpdate);
-    }
-
-    setLastModified(lastUpdate);
-  };
-
-  var initSdk = function initSdk() {
-    Flagship.start(envId, apiKey, {
-      decisionMode: decisionMode,
-      fetchNow: fetchNow,
-      timeout: timeout,
-      logLevel: logLevel,
-      statusChangedCallback: statusChanged,
-      logManager: logManager,
-      pollingInterval: pollingInterval,
-      onBucketingFail: onBucketingFail,
-      onBucketingSuccess: onBucketingSuccess,
-      enableClientCache: enableClientCache,
-      decisionApiUrl: decisionApiUrl,
-      onBucketingUpdated: onBucketingLastModified,
-      initialBucketing: initialBucketing,
-      activateDeduplicationTime: activateDeduplicationTime,
-      hitDeduplicationTime: hitDeduplicationTime,
-      visitorCacheImplementation: visitorCacheImplementation,
-      hitCacheImplementation: hitCacheImplementation,
-      disableCache: disableCache
-    });
-  };
-
-  var handleDisplay = function handleDisplay() {
-    var isFirstInit = !state.visitor;
-
-    if (state.status.isLoading && loadingComponent && isFirstInit) {
-      return /*#__PURE__*/React.createElement(React.Fragment, null, loadingComponent);
-    }
-
-    return /*#__PURE__*/React.createElement(React.Fragment, null, children);
-  };
-
-  return /*#__PURE__*/React.createElement(FlagshipContext.Provider, {
-    value: {
-      state: state,
-      setState: setState
-    }
-  }, handleDisplay());
-};
-FlagshipProvider.defaultProps = {
-  nodeEnv: 'production',
-  activateDeduplicationTime: 10,
-  hitDeduplicationTime: 10
-};