@flagship.io/react-sdk 2.1.8 → 2.1.10-beta.0

package/README.md

@@ -1,108 +1,108 @@
-<p align="center">
-
-<img  src="https://mk0abtastybwtpirqi5t.kinstacdn.com/wp-content/uploads/picture-solutions-persona-product-flagship.jpg"  width="211"  height="182"  alt="flagship-react-sdk"  />
-
-</p>
-
-<h3 align="center">Bring your features to life</h3>
-
-<div style='display: flex; justify-content: space-around;'>
-
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
-
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-
-[![Apache2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
-
-[![GitHub release](https://img.shields.io/github/v/release/flagship-io/flagship-react-sdk.svg)](https://github.com/abtasty/flagship-react-sdk/releases)
-
-</div>
-
-## Docs
-
-**Visit [https://developers.flagship.io/](https://developers.flagship.io/) to get started with Flagship.**
-
--   [Installation & Getting Started](https://developers.flagship.io/docs/sdk/react/v2.0#getting-started)
--   [API Reference](https://developers.flagship.io/docs/sdk/react/v2.0#api-reference)
--   [Flagship Provider Props](https://developers.flagship.io/docs/sdk/react/v2.0#flagshipprovider)
--   Available Hooks
-
-    -   [useFlagship](https://developers.flagship.io/docs/sdk/react/v2.0#useflagship)
-    -   [useFsModifications](https://developers.flagship.io/docs/sdk/react/v2.0#usefsmodifications)
-    -   [useFsActivate](https://developers.flagship.io/docs/sdk/react/v2.0#usefsactivate)
-
--   [Getting modifications](https://developers.flagship.io/docs/sdk/react/v2.0#getting-modifications)
--   [Campaign synchronization](https://developers.flagship.io/docs/sdk/react/v2.0#campaign-synchronization)
--   [Hit tracking](https://developers.flagship.io/docs/sdk/react/v2.0#hit-tracking)
--   [Release Notes](https://github.com/flagship-io/flagship-react-sdk/blob/master/RELEASENOTES.md)
--   [Contributing](https://github.com/flagship-io/flagship-react-sdk/blob/master/CONTRIBUTING.md)
-
-## Examples
-
-Following demos illustrate how the SDK is used in practice ☕
-
--   With React (for developers):
-
-<a href="https://flagship-io.github.io/flagship-react-sdk/">
-<div style="max-width: 850px; margin: 0 auto;">
-
-![react-dev-demo](./src/assets/gif/react-dev-demo.gif)
-
-</div>
-</a>
-<div style="display: flex; justify-content: space-around; font-size: 24px">
-
-[Readme 📖](examples/react-dev-demo/README.md)
-
-[Live Demo 🕹](https://flagship-io.github.io/flagship-react-sdk/)
-
-</div>
-
--   With React, e-commerce app:
-
-<a href="https://react-ecommerce-demo.internal.flagship.io/">
-<div style="max-width: 850px; margin: 0 auto;">
-
-![react-ecommerce-demo](./src/assets/gif/react-ecommerce-demo.gif)
-
-</div>
-</a>
-<div style="display: flex; justify-content: space-around; font-size: 24px">
-
-[Readme 📖](examples/react-ecommerce-demo/README.md)
-
-[Live Demo 🕹](https://react-ecommerce-demo.internal.flagship.io/)
-
-</div>
-
--   With React, codeSandbox, using campaign displaying cats / dogs / both:
-
-<a href="https://codesandbox.io/s/flagship-sdk-react-example-sg5qu">
-<div style="max-width: 850px; margin: 0 auto;">
-
-![react-sandbox-demo](./src/assets/gif/react-sandbox.gif)
-
-</div>
-</a>
-<div style="display: flex; justify-content: space-around; font-size: 24px">
-
-[Live Demo 🕹](https://codesandbox.io/s/flagship-sdk-react-example-sg5qu)
-
-</div>
-</a>
-
--   With an universal (isomorphic) app, uses React both on server and client side:
-
-[Source code 📚](./examples/react-universal-demo/README.md)
-
--   With a server side rendering app, uses React on server:
-
-[Source code 📚](./examples/react-ssr-demo/README.md)
-
-</div>
-
-## Licence
-
-[Apache License.](https://github.com/flagship-io/flagship-react-sdk/blob/master/LICENSE)
+<p align="center">
+
+<img  src="https://mk0abtastybwtpirqi5t.kinstacdn.com/wp-content/uploads/picture-solutions-persona-product-flagship.jpg"  width="211"  height="182"  alt="flagship-react-sdk"  />
+
+</p>
+
+<h3 align="center">Bring your features to life</h3>
+
+<div style='display: flex; justify-content: space-around;'>
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+[![Apache2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+
+[![GitHub release](https://img.shields.io/github/v/release/flagship-io/flagship-react-sdk.svg)](https://github.com/abtasty/flagship-react-sdk/releases)
+
+</div>
+
+## Docs
+
+**Visit [https://developers.flagship.io/](https://developers.flagship.io/) to get started with Flagship.**
+
+-   [Installation & Getting Started](https://developers.flagship.io/docs/sdk/react/v2.0#getting-started)
+-   [API Reference](https://developers.flagship.io/docs/sdk/react/v2.0#api-reference)
+-   [Flagship Provider Props](https://developers.flagship.io/docs/sdk/react/v2.0#flagshipprovider)
+-   Available Hooks
+
+    -   [useFlagship](https://developers.flagship.io/docs/sdk/react/v2.0#useflagship)
+    -   [useFsModifications](https://developers.flagship.io/docs/sdk/react/v2.0#usefsmodifications)
+    -   [useFsActivate](https://developers.flagship.io/docs/sdk/react/v2.0#usefsactivate)
+
+-   [Getting modifications](https://developers.flagship.io/docs/sdk/react/v2.0#getting-modifications)
+-   [Campaign synchronization](https://developers.flagship.io/docs/sdk/react/v2.0#campaign-synchronization)
+-   [Hit tracking](https://developers.flagship.io/docs/sdk/react/v2.0#hit-tracking)
+-   [Release Notes](https://github.com/flagship-io/flagship-react-sdk/blob/master/RELEASENOTES.md)
+-   [Contributing](https://github.com/flagship-io/flagship-react-sdk/blob/master/CONTRIBUTING.md)
+
+## Examples
+
+Following demos illustrate how the SDK is used in practice ☕
+
+-   With React (for developers):
+
+<a href="https://flagship-io.github.io/flagship-react-sdk/">
+<div style="max-width: 850px; margin: 0 auto;">
+
+![react-dev-demo](./src/assets/gif/react-dev-demo.gif)
+
+</div>
+</a>
+<div style="display: flex; justify-content: space-around; font-size: 24px">
+
+[Readme 📖](examples/react-dev-demo/README.md)
+
+[Live Demo 🕹](https://flagship-io.github.io/flagship-react-sdk/)
+
+</div>
+
+-   With React, e-commerce app:
+
+<a href="https://react-ecommerce-demo.internal.flagship.io/">
+<div style="max-width: 850px; margin: 0 auto;">
+
+![react-ecommerce-demo](./src/assets/gif/react-ecommerce-demo.gif)
+
+</div>
+</a>
+<div style="display: flex; justify-content: space-around; font-size: 24px">
+
+[Readme 📖](examples/react-ecommerce-demo/README.md)
+
+[Live Demo 🕹](https://react-ecommerce-demo.internal.flagship.io/)
+
+</div>
+
+-   With React, codeSandbox, using campaign displaying cats / dogs / both:
+
+<a href="https://codesandbox.io/s/flagship-sdk-react-example-sg5qu">
+<div style="max-width: 850px; margin: 0 auto;">
+
+![react-sandbox-demo](./src/assets/gif/react-sandbox.gif)
+
+</div>
+</a>
+<div style="display: flex; justify-content: space-around; font-size: 24px">
+
+[Live Demo 🕹](https://codesandbox.io/s/flagship-sdk-react-example-sg5qu)
+
+</div>
+</a>
+
+-   With an universal (isomorphic) app, uses React both on server and client side:
+
+[Source code 📚](./examples/react-universal-demo/README.md)
+
+-   With a server side rendering app, uses React on server:
+
+[Source code 📚](./examples/react-ssr-demo/README.md)
+
+</div>
+
+## Licence
+
+[Apache License.](https://github.com/flagship-io/flagship-react-sdk/blob/master/LICENSE)

package/package.json

@@ -1,112 +1,111 @@
-{
-    "name": "@flagship.io/react-sdk",
-    "version": "2.1.8",
-    "description": "Flagship REACT SDK",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "files": [
-        "dist",
-        "CONTRIBUTING.md",
-        "README.md",
-        "package.json"
-    ],
-    "scripts": {
-        "test": "jest --silent --verbose",
-        "test:coverage": "jest --coverage --silent",
-        "release": "npm run checkReleasePrerequisites && docker login https://docker.pkg.github.com && np",
-        "version": "npm run build",
-        "checkReleasePrerequisites": "docker -v",
-        "publish": "npm run update:examples && npm run publish:reactDemoDev && npm run publish:reactDemoEcommerce && git add . && git commit -m\"Post publish update\" && git push",
-        "publish:reactDemoDev": "cd ./examples/react-dev-demo && npm i && npm run deploy:github",
-        "publish:reactDemoEcommerce": "cd ./examples/react-ecommerce-demo && npm run release:docker",
-        "update:fsLog": "npm install @flagship.io/js-sdk-logs@latest --save",
-        "update:examples": "npm run update:reactDemoDev && npm run update:reactDemoEcommerce && npm run update:reactUniversalDemo && npm run update:reactSSRDemo",
-        "update:reactDemoDev": "cd ./examples/react-dev-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
-        "update:reactUniversalDemo": "cd ./examples/react-universal-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
-        "update:reactSSRDemo": "cd ./examples/react-ssr-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
-        "update:reactDemoEcommerce": "cd ./examples/react-ecommerce-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
-        "contributors:add": "all-contributors add",
-        "contributors:generate": "all-contributors generate",
-        "clean": "rm -rf ./node_modules/react && rm -rf ./node_modules/react-dom",
-        "build": "npm install @flagship.io/js-sdk@latest --save && rm -rf dist && tsc",
-        "build:skipUpdate": "rm -rf dist && tsc"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/abtasty/flagship-react-sdk.git"
-    },
-    "license": "Apache-2.0",
-    "bugs": {
-        "url": "https://github.com/abtasty/flagship-react-sdk/issues",
-        "email": "emilien.domenge-heritier@abtasty.com"
-    },
-    "contributors": [
-        {
-            "name": "Emilien Domenge-Heritier",
-            "email": "emilien.domenge-heritier@abtasty.com",
-            "url": "https://domenge.fr"
-        },
-        {
-            "name": "Guillaume Jacquart",
-            "email": "guillaume.jacquart@abtasty.com"
-        }
-    ],
-    "keywords": [
-        "flagship",
-        "abtasty",
-        "react",
-        "sdk"
-    ],
-    "homepage": "https://github.com/abtasty/flagship-react-sdk#readme",
-    "dependencies": {
-        "@flagship.io/js-sdk": "^2.2.9",
-        "@flagship.io/js-sdk-logs": "^0.1.3",
-        "use-ssr": "^1.0.23"
-    },
-    "peerDependencies": {
-        "react": "^16.8.0 || ^17.0.0"
-    },
-    "devDependencies": {
-        "@testing-library/jest-dom": "^5.5.0",
-        "@testing-library/react": "^11.0.4",
-        "@testing-library/react-hooks": "^3.2.1",
-        "@types/enzyme": "^3.10.5",
-        "@types/enzyme-adapter-react-16": "^1.0.6",
-        "@types/jest": "^25.2.1",
-        "@types/react": "^16.9.32",
-        "@types/react-dom": "^16.9.6",
-        "@types/sinon": "^9.0.0",
-        "@typescript-eslint/eslint-plugin": "^2.26.0",
-        "@typescript-eslint/parser": "^2.26.0",
-        "all-contributors-cli": "^6.16.1",
-        "awesome-typescript-loader": "^5.2.1",
-        "axios": "^0.21.4",
-        "enzyme": "^3.11.0",
-        "enzyme-adapter-react-16": "^1.15.2",
-        "enzyme-to-json": "^3.4.4",
-        "eslint": "^6.8.0",
-        "eslint-config-airbnb": "^18.1.0",
-        "eslint-config-prettier": "^6.10.1",
-        "eslint-loader": "^3.0.3",
-        "eslint-plugin-import": "^2.25.4",
-        "eslint-plugin-jsx-a11y": "^6.2.3",
-        "eslint-plugin-prettier": "^3.1.2",
-        "eslint-plugin-react": "^7.19.0",
-        "eslint-plugin-react-hooks": "^2.5.0",
-        "jest": "^25.4.0",
-        "jest-mock-axios": "^3.2.0",
-        "np": "^6.2.3",
-        "prettier": "^2.0.4",
-        "react": "^16.9.0",
-        "react-dom": "^16.9.0",
-        "react-test-renderer": "^16.9.0",
-        "sinon": "^9.0.2",
-        "ts-jest": "^25.4.0",
-        "typescript": "^4.0.3"
-    },
-    "jest": {
-        "setupFilesAfterEnv": [
-            "./src/setupTests.js"
-        ]
-    }
-}
+{
+    "name": "@flagship.io/react-sdk",
+    "version": "2.1.10-beta.0",
+    "description": "Flagship REACT SDK",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "CONTRIBUTING.md",
+        "README.md",
+        "package.json"
+    ],
+    "scripts": {
+        "test": "jest",
+        "test:coverage": "jest --coverage --silent",
+        "release": "npm run checkReleasePrerequisites && docker login https://docker.pkg.github.com && np",
+        "version": "npm run build",
+        "checkReleasePrerequisites": "docker -v",
+        "publish:reactDemoDev": "cd ./examples/react-dev-demo && npm i && npm run deploy:github",
+        "publish:reactDemoEcommerce": "cd ./examples/react-ecommerce-demo && npm run release:docker",
+        "update:fsLog": "npm install @flagship.io/js-sdk-logs@latest --save",
+        "update:examples": "npm run update:reactDemoDev && npm run update:reactDemoEcommerce && npm run update:reactUniversalDemo && npm run update:reactSSRDemo",
+        "update:reactDemoDev": "cd ./examples/react-dev-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
+        "update:reactUniversalDemo": "cd ./examples/react-universal-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
+        "update:reactSSRDemo": "cd ./examples/react-ssr-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
+        "update:reactDemoEcommerce": "cd ./examples/react-ecommerce-demo && npm install @flagship.io/react-sdk@latest @flagship.io/js-sdk@latest --save && cd ../../",
+        "contributors:add": "all-contributors add",
+        "contributors:generate": "all-contributors generate",
+        "clean": "rm -rf ./node_modules/react && rm -rf ./node_modules/react-dom",
+        "build": "rm -rf dist && tsc",
+        "build:skipUpdate": "rm -rf dist && tsc"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/abtasty/flagship-react-sdk.git"
+    },
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/abtasty/flagship-react-sdk/issues",
+        "email": "emilien.domenge-heritier@abtasty.com"
+    },
+    "contributors": [
+        {
+            "name": "Emilien Domenge-Heritier",
+            "email": "emilien.domenge-heritier@abtasty.com",
+            "url": "https://domenge.fr"
+        },
+        {
+            "name": "Guillaume Jacquart",
+            "email": "guillaume.jacquart@abtasty.com"
+        }
+    ],
+    "keywords": [
+        "flagship",
+        "abtasty",
+        "react",
+        "sdk"
+    ],
+    "homepage": "https://github.com/abtasty/flagship-react-sdk#readme",
+    "dependencies": {
+        "@flagship.io/js-sdk": "^2.2.12",
+        "@flagship.io/js-sdk-logs": "^0.1.3",
+        "use-ssr": "^1.0.23"
+    },
+    "peerDependencies": {
+        "react": "^16.8.0 || ^17.0.0"
+    },
+    "devDependencies": {
+        "@testing-library/jest-dom": "^5.5.0",
+        "@testing-library/react": "^11.0.4",
+        "@testing-library/react-hooks": "^3.2.1",
+        "@types/enzyme": "^3.10.5",
+        "@types/enzyme-adapter-react-16": "^1.0.6",
+        "@types/jest": "^25.2.1",
+        "@types/react": "^16.9.32",
+        "@types/react-dom": "^16.9.6",
+        "@types/sinon": "^9.0.0",
+        "@typescript-eslint/eslint-plugin": "^2.26.0",
+        "@typescript-eslint/parser": "^2.26.0",
+        "all-contributors-cli": "^6.16.1",
+        "awesome-typescript-loader": "^5.2.1",
+        "axios": "^0.21.4",
+        "enzyme": "^3.11.0",
+        "enzyme-adapter-react-16": "^1.15.2",
+        "enzyme-to-json": "^3.4.4",
+        "eslint": "^6.8.0",
+        "eslint-config-airbnb": "^18.1.0",
+        "eslint-config-prettier": "^6.10.1",
+        "eslint-loader": "^3.0.3",
+        "eslint-plugin-import": "^2.25.4",
+        "eslint-plugin-jsx-a11y": "^6.2.3",
+        "eslint-plugin-prettier": "^3.1.2",
+        "eslint-plugin-react": "^7.19.0",
+        "eslint-plugin-react-hooks": "^2.5.0",
+        "jest": "^25.4.0",
+        "jest-mock-axios": "^3.2.0",
+        "np": "^6.2.3",
+        "prettier": "^2.0.4",
+        "react": "^16.9.0",
+        "react-dom": "^16.9.0",
+        "react-test-renderer": "^16.9.0",
+        "sinon": "^9.0.2",
+        "ts-jest": "^25.4.0",
+        "typescript": "^4.0.3"
+    },
+    "jest": {
+        "setupFilesAfterEnv": [
+            "./src/setupTests.js"
+        ]
+    }
+}

package/dist/FlagshipContext.d.ts

@@ -1,99 +0,0 @@
-import React, { SetStateAction, Dispatch } from 'react';
-import { FlagshipSdkConfig, FlagshipVisitorContext, IFlagshipVisitor, SaveCacheArgs, DecisionApiCampaign, PostFlagshipApiCallback, BucketingApiResponse, IFlagship } from '@flagship.io/js-sdk';
-import { FsLogger } from '@flagship.io/js-sdk-logs';
-import { HandleErrorBoundaryDisplay } from './FlagshipErrorBoundary';
-export declare type FsStatus = {
-    isLoading: boolean;
-    isSdkReady: boolean;
-    isVisitorDefined: boolean;
-    hasError: boolean;
-    lastRefresh: string | null;
-    firstInitSuccess: string | null;
-};
-export declare type FsState = {
-    fsSdk: IFlagship | null;
-    fsVisitor: IFlagshipVisitor | null;
-    fsModifications: DecisionApiCampaign[] | null;
-    status: FsStatus;
-    log: FsLogger | null;
-    private: {
-        previousFetchedModifications: undefined | DecisionApiCampaign[];
-    };
-};
-export interface FlagshipReactSdkConfig extends FlagshipSdkConfig {
-    fetchNow?: boolean;
-    pollingInterval?: number | null;
-    activateNow?: boolean;
-    enableConsoleLogs?: boolean;
-    decisionMode?: 'API' | 'Bucketing';
-    nodeEnv?: string;
-    enableClientCache?: boolean;
-    flagshipApi?: string;
-    apiKey?: string | null;
-    initialModifications?: DecisionApiCampaign[] | null;
-    initialBucketing?: BucketingApiResponse | null;
-    timeout?: number;
-    enableErrorLayout?: boolean;
-    enableSafeMode?: boolean;
-    internal?: {
-        react?: {};
-        reactNative?: {
-            httpCallback?: PostFlagshipApiCallback;
-        };
-    };
-}
-export declare const initState: FsState;
-export declare type BucketingSuccessArgs = {
-    status: string;
-    payload: BucketingApiResponse;
-};
-export declare type FsContext = {
-    hasError: boolean;
-    state: FsState;
-    setState: Dispatch<SetStateAction<FsState>> | null;
-};
-declare const FlagshipContext: React.Context<FsContext>;
-export declare type FsOnUpdateArguments = {
-    fsModifications: DecisionApiCampaign[] | null;
-    config: FlagshipReactSdkConfig;
-    status: FsStatus;
-};
-export declare type FsOnUpdate = (data: FsOnUpdateArguments, visitor: IFlagshipVisitor | null) => void;
-interface FlagshipProviderProps {
-    children: React.ReactNode;
-    loadingComponent?: React.ReactNode;
-    envId: string;
-    visitorData: {
-        id: string;
-        context?: FlagshipVisitorContext;
-        isAuthenticated?: boolean;
-    };
-    reactNative?: {
-        handleErrorDisplay: HandleErrorBoundaryDisplay;
-        httpCallback: PostFlagshipApiCallback;
-    };
-    fetchNow?: boolean;
-    decisionMode?: 'API' | 'Bucketing';
-    pollingInterval?: number | null;
-    activateNow?: boolean;
-    enableConsoleLogs?: boolean;
-    enableErrorLayout?: boolean;
-    enableSafeMode?: boolean;
-    enableClientCache?: boolean;
-    nodeEnv?: string;
-    timeout?: number;
-    flagshipApi?: string;
-    apiKey?: string | null;
-    initialModifications?: DecisionApiCampaign[];
-    initialBucketing?: BucketingApiResponse;
-    onInitStart?(): void;
-    onInitDone?(): void;
-    onBucketingSuccess?(data: BucketingSuccessArgs): void;
-    onBucketingFail?(error: Error): void;
-    onSavingModificationsInCache?(args: SaveCacheArgs): void;
-    onUpdate?: FsOnUpdate;
-}
-export declare const FlagshipProvider: React.SFC<FlagshipProviderProps>;
-export declare const FlagshipConsumer: React.Consumer<FsContext>;
-export default FlagshipContext;
-export declare const useFlagshipContext: () => any;