@flagship.io/react-sdk 3.0.4-alpha.3 → 3.0.5

package/README.md

@@ -1,14 +1,25 @@
-<p align="center">
-<img  src="https://mk0abtastybwtpirqi5t.kinstacdn.com/wp-content/uploads/picture-solutions-persona-product-flagship.jpg"  width="211"  height="182"  alt="flagship-java"  />
-</p>
-<h3 align="center">Bring your features to life</h3>
-
-**Visit [https://developers.flagship.io/](https://developers.flagship.io/) to get started with Flagship.**
-
-## Docs
-
-- [docs](https://docs.developers.flagship.io/docs/react-v3-0-x)
-
-## Licence
-
-[Apache License.](https://github.com/flagship-io/flagship-react-sdk/blob/master/LICENSE)
+## About Flagship
+
+​
+<img src="https://www.flagship.io/wp-content/uploads/Flagship-horizontal-black-wake-AB.png" alt="drawing" width="150"/>
+​
+[Flagship by AB Tasty](https://www.flagship.io/) is a feature flagging platform for modern engineering and product teams. It eliminates the risks of future releases by separating code deployments from these releases :bulb: With Flagship, you have full control over the release process. You can:
+​
+
+- Switch features on or off through remote config.
+- Automatically roll-out your features gradually to monitor performance and gather feedback from your most relevant users.
+- Roll back any feature should any issues arise while testing in production.
+- Segment users by granting access to a feature based on certain user attributes.
+- Carry out A/B tests by easily assigning feature variations to groups of users.
+  ​
+  <img src="https://www.flagship.io/wp-content/uploads/demo-setup.png" alt="drawing" width="600"/>
+  ​
+  Flagship also allows you to choose whatever implementation method works for you from our many available SDKs or directly through a REST API. Additionally, our architecture is based on multi-cloud providers that offer high performance and highly-scalable managed services.
+  ​
+  **To learn more:**
+  ​
+- [Solution overview](https://www.flagship.io/#showvideo) - A 5mn video demo :movie_camera:
+- [Documentation](https://docs.developers.flagship.io/) - Our dev portal with guides, how tos, API and SDK references
+- [Sign up for a free trial](https://www.flagship.io/sign-up/) - Create your free account
+- [Guide to feature flagging](https://www.flagship.io/feature-flags/) - Everyhting you need to know about feature flag related use cases
+- [Blog](https://www.flagship.io/blog/) - Additional resources about release management

package/dist/esm/Flag.js

@@ -7,46 +7,96 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 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; }
 
 import Flagship, { FlagMetadata } from '@flagship.io/js-sdk';
-import { noVisitorMessage } from './constants';
-import { logWarn } from './utils';
+import { GET_FLAG_CAST_ERROR, GET_METADATA_CAST_ERROR, noVisitorMessage } from './constants';
+import { hasSameType, logInfo, logWarn, sprintf } from './utils';
 export var Flag = /*#__PURE__*/function () {
-  function Flag(defaultValue) {
+  function Flag(defaultValue, key, flagsData) {
     _classCallCheck(this, Flag);
 
-    _defineProperty(this, "_defaultValue", void 0);
+    _defineProperty(this, "defaultValue", void 0);
 
-    logWarn(Flagship.getConfig(), noVisitorMessage, 'GetFlag');
-    this._defaultValue = defaultValue;
+    _defineProperty(this, "flagsData", void 0);
+
+    _defineProperty(this, "key", void 0);
+
+    _defineProperty(this, "flag", void 0);
+
+    if (!flagsData) {
+      logWarn(Flagship.getConfig(), noVisitorMessage, 'GetFlag');
+    }
+
+    this.defaultValue = defaultValue;
+    this.key = key;
+    this.flag = flagsData === null || flagsData === void 0 ? void 0 : flagsData.get(key);
   }
 
   _createClass(Flag, [{
+    key: "NotSameType",
+    value: function NotSameType() {
+      var _this$flag;
+
+      return this.defaultValue !== null && this.defaultValue !== undefined && !hasSameType((_this$flag = this.flag) === null || _this$flag === void 0 ? void 0 : _this$flag.value, this.defaultValue);
+    }
+  }, {
     key: "getValue",
     value: function getValue() {
-      logWarn(Flagship.getConfig(), noVisitorMessage, 'getValue');
-      return this._defaultValue;
+      if (!this.flag) {
+        logWarn(Flagship.getConfig(), noVisitorMessage, 'getValue');
+        return this.defaultValue;
+      }
+
+      if (this.NotSameType()) {
+        logInfo(Flagship.getConfig(), sprintf(GET_FLAG_CAST_ERROR, this.key), "getValue");
+        return this.defaultValue;
+      }
+
+      return this.flag.value;
     }
   }, {
     key: "exists",
     value: function exists() {
-      logWarn(Flagship.getConfig(), noVisitorMessage, 'exists');
-      return false;
+      var _this$flag2;
+
+      if (!this.flag) {
+        logWarn(Flagship.getConfig(), noVisitorMessage, 'exists');
+        return false;
+      }
+
+      return !!((_this$flag2 = this.flag) !== null && _this$flag2 !== void 0 && _this$flag2.campaignId && this.flag.variationId && this.flag.variationGroupId);
     }
   }, {
     key: "userExposed",
     value: function userExposed() {
-      logWarn(Flagship.getConfig(), noVisitorMessage, 'userExposed');
+      if (!this.flag) {
+        logWarn(Flagship.getConfig(), noVisitorMessage, 'userExposed');
+      }
+
       return Promise.resolve();
     }
   }, {
     key: "metadata",
     get: function get() {
-      logWarn(Flagship.getConfig(), noVisitorMessage, 'metadata');
+      var _this$flag3, _this$flag4, _this$flag5, _this$flag6, _this$flag7, _this$flag8;
+
+      var functionName = 'metadata';
+
+      if (!this.flag) {
+        logWarn(Flagship.getConfig(), noVisitorMessage, functionName);
+        return FlagMetadata.Empty();
+      }
+
+      if (this.NotSameType()) {
+        logInfo(Flagship.getConfig(), sprintf(GET_METADATA_CAST_ERROR, this.key), functionName);
+        return FlagMetadata.Empty();
+      }
+
       return new FlagMetadata({
-        campaignId: '',
-        campaignType: '',
-        isReference: false,
-        variationGroupId: '',
-        variationId: ''
+        campaignId: ((_this$flag3 = this.flag) === null || _this$flag3 === void 0 ? void 0 : _this$flag3.campaignId) || '',
+        variationGroupId: ((_this$flag4 = this.flag) === null || _this$flag4 === void 0 ? void 0 : _this$flag4.variationGroupId) || '',
+        variationId: ((_this$flag5 = this.flag) === null || _this$flag5 === void 0 ? void 0 : _this$flag5.variationId) || '',
+        isReference: !!((_this$flag6 = this.flag) !== null && _this$flag6 !== void 0 && _this$flag6.isReference),
+        campaignType: ((_this$flag7 = this.flag) === null || _this$flag7 === void 0 ? void 0 : _this$flag7.campaignType) || '',
+        slug: (_this$flag8 = this.flag) === null || _this$flag8 === void 0 ? void 0 : _this$flag8.slug
       });
     }
   }]);

package/dist/esm/FlagshipHooks.js

@@ -68,9 +68,9 @@ var fsModificationsSync = function fsModificationsSync(args) {
   });
   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.
- * @deprecated use useFsGetFlag instead
+/**
+ * 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 useFsFlag instead
  */
 
 
@@ -90,9 +90,9 @@ export var useFsModifications = function useFsModifications(params, activateAll)
     activateAll: 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
+/**
+ * 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 useFsFlag instead
  */
 
 export var useFsModification = function useFsModification(params) {
@@ -138,10 +138,10 @@ var fsModificationInfoSync = function fsModificationInfoSync(args) {
 
   return null;
 };
-/**
- * Get the campaign modification information value matching the given key.
- * @param {string} key key which identify the modification.
- * @deprecated use useFsGetFlag instead
+/**
+ * Get the campaign modification information value matching the given key.
+ * @param {string} key key which identify the modification.
+ * @deprecated use useFsFlag instead
  */
 
 
@@ -198,11 +198,11 @@ var fsActivate = /*#__PURE__*/function () {
     return _ref.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
+/**
+ * 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
  */
 
 
@@ -213,16 +213,16 @@ export var useFsFlag = function useFsFlag(key, defaultValue) {
   var visitor = state.visitor;
 
   if (!visitor) {
-    return new Flag(defaultValue);
+    return new Flag(defaultValue, key, state.modifications);
   }
 
   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
+/**
+ * Report this user has seen this modification. Report this user has seen these modifications.
+ * @param params
+ * @deprecated use useFsFlag instead
+ * @returns
  */
 
 export var useFsActivate = /*#__PURE__*/function () {
@@ -302,8 +302,8 @@ export var useFlagship = function useFlagship() {
 
     visitor.unauthenticate();
   };
-  /**
-   * Send a Hit to Flagship servers for reporting.
+  /**
+   * Send a Hit to Flagship servers for reporting.
    */
 
 
@@ -317,8 +317,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.
    */
 
 
@@ -423,7 +423,7 @@ export var useFlagship = function useFlagship() {
 
   function getFlag(key, defaultValue) {
     if (!visitor) {
-      return new Flag(defaultValue);
+      return new Flag(defaultValue, key, state.modifications);
     }
 
     return visitor.getFlag(key, defaultValue);
@@ -462,7 +462,7 @@ export var useFlagship = function useFlagship() {
     synchronizeModifications: synchronizeModifications,
     getModifications: getModifications,
     modifications: modifications || [],
-    FlagsData: (visitor === null || visitor === void 0 ? void 0 : visitor.getFlagsDataArray()) || [],
+    flagsData: (visitor === null || visitor === void 0 ? void 0 : visitor.getFlagsDataArray()) || [],
     getModificationInfo: getModificationInfo,
     hit: {
       send: fsSendHit,

package/dist/esm/constants.js

@@ -1,2 +1,4 @@
 export var noVisitorMessage = 'flagship Visitor not initialized.';
-export var noVisitorDefault = 'fsVisitor not initialized, returns default value';
+export var noVisitorDefault = 'fsVisitor not initialized, returns default value';
+export var GET_FLAG_CAST_ERROR = 'Flag for key {0} has a different type. Default value is returned.';
+export var GET_METADATA_CAST_ERROR = 'Flag for key {0} has a different type with defaultValue, an empty metadata object is returned';

package/dist/esm/utils.js

@@ -1,3 +1,5 @@
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 import { LogLevel } from '@flagship.io/js-sdk';
 import { useEffect, useRef } from 'react';
 export function logError(config, message, tag) {
@@ -64,4 +66,25 @@ export function useNonInitialEffect(effect, deps) {
       return effect();
     }
   }, deps);
+}
+export function hasSameType(flagValue, defaultValue) {
+  if (_typeof(flagValue) !== _typeof(defaultValue)) {
+    return false;
+  }
+
+  if (_typeof(flagValue) === 'object' && _typeof(defaultValue) === 'object' && Array.isArray(flagValue) !== Array.isArray(defaultValue)) {
+    return false;
+  }
+
+  return true;
+}
+export function sprintf(format) {
+  var formatted = format;
+
+  for (var i = 0; i < (arguments.length <= 1 ? 0 : arguments.length - 1); i++) {
+    var element = i + 1 < 1 || arguments.length <= i + 1 ? undefined : arguments[i + 1];
+    formatted = formatted.replace(new RegExp("\\{".concat(i, "\\}"), 'g'), element);
+  }
+
+  return formatted;
 }