@flagship.io/react-sdk 3.0.4-alpha.4 → 3.0.6-alpha.0

package/dist/FlagshipHooks.js

@@ -0,0 +1,358 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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 (value, defaultValue) {
+    return (typeof value === 'object' &&
+        typeof defaultValue === 'object' &&
+        Array.isArray(value) === Array.isArray(defaultValue)) ||
+        typeof value === typeof defaultValue;
+};
+var fsModificationsSync = function (args) {
+    var visitor = args.visitor, params = args.params, activateAll = args.activateAll, state = args.state, functionName = args.functionName, config = args.config;
+    if (visitor) {
+        return visitor.getModificationsSync(params, activateAll);
+    }
+    var check = !state.status.isSdkReady &&
+        !!state.modifications &&
+        state.modifications.size > 0;
+    var flags = {};
+    if (check) {
+        params.forEach(function (item) {
+            var _a;
+            var modification = (_a = state.modifications) === null || _a === void 0 ? void 0 : _a.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(function (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.
+ * @deprecated use useFsFlag instead
+ */
+export var useFsModifications = function (params, activateAll) {
+    var state = useContext(FlagshipContext).state;
+    var visitor = state.visitor, config = state.config;
+    var functionName = 'useFsModifications';
+    return fsModificationsSync({
+        functionName: functionName,
+        state: state,
+        visitor: visitor,
+        config: config,
+        params: params,
+        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 useFsFlag instead
+ */
+export var useFsModification = function (params) {
+    var _a;
+    var state = useContext(FlagshipContext).state;
+    var visitor = state.visitor, config = state.config;
+    var functionName = 'useFsModifications';
+    if (visitor) {
+        return visitor.getModificationSync(params);
+    }
+    var modification = (_a = state.modifications) === null || _a === void 0 ? void 0 : _a.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;
+};
+var fsModificationInfoSync = function (args) {
+    var _a;
+    var key = args.key, visitor = args.visitor, state = args.state;
+    if (visitor) {
+        return visitor.getModificationInfoSync(key);
+    }
+    var modification = (_a = state.modifications) === null || _a === void 0 ? void 0 : _a.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.
+ * @deprecated use useFsFlag instead
+ */
+export var useFsModificationInfo = function (key) {
+    var state = useContext(FlagshipContext).state;
+    var visitor = state.visitor;
+    return fsModificationInfoSync({ key: key, state: state, visitor: visitor });
+};
+var fsActivate = function (params, functionName, visitor, config) { return __awaiter(void 0, void 0, void 0, function () {
+    var error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                if (!visitor) {
+                    logWarn(config, noVisitorMessage, functionName);
+                    return [2 /*return*/];
+                }
+                return [4 /*yield*/, visitor.activateModifications(params)
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                ];
+            case 1:
+                _a.sent();
+                return [3 /*break*/, 3];
+            case 2:
+                error_1 = _a.sent();
+                logWarn(config, error_1.message || error_1, functionName);
+                return [3 /*break*/, 3];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+/**
+ * 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 (key, defaultValue) {
+    var state = useContext(FlagshipContext).state;
+    var visitor = state.visitor;
+    if (!visitor) {
+        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 useFsFlag instead
+ * @returns
+ */
+export var useFsActivate = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    var state, visitor, config, functionName;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                state = useContext(FlagshipContext).state;
+                visitor = state.visitor, config = state.config;
+                functionName = 'useFsModifications';
+                return [4 /*yield*/, fsActivate(params, functionName, visitor, config)];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+export var useFlagship = function () {
+    var state = useContext(FlagshipContext).state;
+    var visitor = state.visitor, config = state.config;
+    var fsUpdateContext = function (context) {
+        var functionName = 'updateContext';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return;
+        }
+        visitor.clearContext();
+        visitor.updateContext(context);
+    };
+    var fsClearContext = function () {
+        var functionName = 'cleanContext';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return;
+        }
+        visitor.clearContext();
+    };
+    var fsAuthenticate = function (visitorId) {
+        var functionName = 'authenticate';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return;
+        }
+        visitor.authenticate(visitorId);
+    };
+    var fsUnauthenticate = function () {
+        var functionName = 'unauthenticate';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return;
+        }
+        visitor.unauthenticate();
+    };
+    /**
+     * Send a Hit to Flagship servers for reporting.
+     */
+    var fsSendHit = function (hit) {
+        var functionName = 'sendHit';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return Promise.resolve();
+        }
+        return visitor.sendHit(hit);
+    };
+    /**
+     * Send a Hit to Flagship servers for reporting.
+     */
+    var fsSendHits = function (hit) {
+        var functionName = 'sendHits';
+        if (!visitor) {
+            logError(config, noVisitorMessage, functionName);
+            return Promise.resolve();
+        }
+        return visitor.sendHits(hit);
+    };
+    var 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, function (_a) {
+            var _key = _a[0], item = _a[1];
+            return item;
+        });
+    }
+    var activateModification = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var functionName;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    functionName = 'activateModification';
+                    return [4 /*yield*/, fsActivate(params, functionName, visitor, config)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    var synchronizeModifications = function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!visitor) {
+                        logWarn(config, noVisitorMessage, 'synchronizeModifications');
+                        return [2 /*return*/];
+                    }
+                    return [4 /*yield*/, visitor.synchronizeModifications()];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    var getModifications = function (params, activateAll) {
+        var functionName = 'getModifications';
+        return fsModificationsSync({
+            functionName: functionName,
+            state: state,
+            visitor: visitor,
+            config: config,
+            params: params,
+            activateAll: activateAll
+        });
+    };
+    var getModificationInfo = function (key) {
+        return fsModificationInfoSync({ key: key, state: state, visitor: visitor });
+    };
+    function getFlag(key, defaultValue) {
+        if (!visitor) {
+            return new Flag(defaultValue, key, state.modifications);
+        }
+        return visitor.getFlag(key, defaultValue);
+    }
+    function fetchFlags() {
+        if (!visitor) {
+            logWarn(config, noVisitorMessage, 'fetchFlags');
+            return Promise.resolve();
+        }
+        return 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: __assign({}, 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,
+        unauthenticate: fsUnauthenticate,
+        status: state.status,
+        activateModification: activateModification,
+        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
+    };
+};

package/dist/constants.d.ts

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

package/dist/constants.js

@@ -0,0 +1,4 @@
+export var noVisitorMessage = 'flagship Visitor not initialized.';
+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';