@kameleoon/react-sdk 1.2.2 → 3.0.0

package/dist/withTrackingConversion.js

@@ -15,23 +15,21 @@ exports.withTrackingConversion = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var ProviderError_1 = require("./ProviderError");
-var _1 = require(".");
+var KameleoonContext_1 = require("./KameleoonContext");
 /**
- * A React HOC that gives a wrapped component access access to callback function
+ * A React HOC that gives a wrapped component access to callback function
  * which tracks conversion
  */
 function withTrackingConversion(Component) {
     return function WrappedComponent(props) {
-        var client = (0, react_1.useContext)(_1.KameleoonContext);
+        var client = (0, react_1.useContext)(KameleoonContext_1.KameleoonContext);
         var trackConversion = (0, react_1.useCallback)(function (visitorCode, goalId, revenue) {
             if (!client) {
                 throw new ProviderError_1.ProviderError('withTrackingConversion');
             }
             return client.trackConversion(visitorCode, goalId, revenue);
         }, [client]);
-        return (
-        // eslint-disable-next-line react/jsx-props-no-spreading
-        (0, jsx_runtime_1.jsx)(Component, __assign({ trackConversion: trackConversion }, props), void 0));
+        return ((0, jsx_runtime_1.jsx)(Component, __assign({ trackConversion: trackConversion }, props), void 0));
     };
 }
 exports.withTrackingConversion = withTrackingConversion;

package/dist/withTrackingConversion.js.map

@@ -1 +1 @@
-{"version":3,"file":"withTrackingConversion.js","sourceRoot":"","sources":["../src/withTrackingConversion.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,iDAAgD;AAChD,sBAAqC;AAerC;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mBAAgB,CAAC,CAAC;QAE5C,IAAM,eAAe,GAAG,IAAA,mBAAW,EACjC,UAAC,WAAmB,EAAE,MAAc,EAAE,OAAgB;YACpD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,wBAAwB,CAAC,CAAC;aACnD;YAED,OAAO,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,OAAO;QACL,wDAAwD;QACxD,uBAAC,SAAS,aAAC,eAAe,EAAE,eAAe,IAAO,KAAe,UAAI,CACtE,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAtBD,wDAsBC"}
+{"version":3,"file":"withTrackingConversion.js","sourceRoot":"","sources":["../src/withTrackingConversion.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,iDAAgD;AAChD,uDAAsD;AAetD;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;QAE5C,IAAM,eAAe,GAAG,IAAA,mBAAW,EACjC,UAAC,WAAmB,EAAE,MAAc,EAAE,OAAgB;YACpD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,wBAAwB,CAAC,CAAC;aACnD;YAED,OAAO,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,OAAO,CACL,uBAAC,SAAS,aAAC,eAAe,EAAE,eAAe,IAAO,KAAe,UAAI,CACtE,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AArBD,wDAqBC"}

package/dist/withTriggerExperiment.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import { KameleoonError } from './KameleoonError';
 import { UnknownPropsType, Without } from './types';
 interface IWithTriggerExperiment {
     /**
@@ -6,9 +7,10 @@ interface IWithTriggerExperiment {
      * @param experimentId - unique identifier of the experiment you want to expose to a user
      */
     getVariationId: (visitorCode: string, experimentId: number) => number;
+    triggerExperimentError: KameleoonError | null;
 }
 /**
- * A React HOC that gives a wrapped component access access to callback function which triggers experiment
+ * A React HOC that gives a wrapped component access to callback function which triggers experiment
  * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
  * If a user with a given visitorCode is already registered with a variation,
  * it will detect the previously registered variation and return the variationID

package/dist/withTriggerExperiment.js

@@ -13,26 +13,17 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withTriggerExperiment = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
-var react_1 = require("react");
-var KameleoonContext_1 = require("./KameleoonContext");
-var ProviderError_1 = require("./ProviderError");
+var useTriggerExperiment_1 = require("./useTriggerExperiment");
 /**
- * A React HOC that gives a wrapped component access access to callback function which triggers experiment
+ * A React HOC that gives a wrapped component access to callback function which triggers experiment
  * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
  * If a user with a given visitorCode is already registered with a variation,
  * it will detect the previously registered variation and return the variationID
  */
 function withTriggerExperiment(Component) {
     return function WrappedComponent(props) {
-        var client = (0, react_1.useContext)(KameleoonContext_1.KameleoonContext);
-        var getVariationId = (0, react_1.useCallback)(function (visitorCode, experimentId) {
-            if (!client) {
-                throw new ProviderError_1.ProviderError('withTriggerExperiment');
-            }
-            return client.triggerExperiment(visitorCode, experimentId);
-        }, [client]);
-        // eslint-disable-next-line react/jsx-props-no-spreading
-        return (0, jsx_runtime_1.jsx)(Component, __assign({ getVariationId: getVariationId }, props), void 0);
+        var _a = (0, useTriggerExperiment_1.useTriggerExperiment)(), getVariationId = _a.getVariationId, triggerExperimentError = _a.error;
+        return ((0, jsx_runtime_1.jsx)(Component, __assign({ getVariationId: getVariationId, triggerExperimentError: triggerExperimentError }, props), void 0));
     };
 }
 exports.withTriggerExperiment = withTriggerExperiment;

package/dist/withTriggerExperiment.js.map

@@ -1 +1 @@
-{"version":3,"file":"withTriggerExperiment.js","sourceRoot":"","sources":["../src/withTriggerExperiment.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,uDAAsD;AACtD,iDAAgD;AAUhD;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;QAE5C,IAAM,cAAc,GAAG,IAAA,mBAAW,EAChC,UAAC,WAAmB,EAAE,YAAoB;YACxC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,uBAAuB,CAAC,CAAC;aAClD;YAED,OAAO,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC7D,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,wDAAwD;QACxD,OAAO,uBAAC,SAAS,aAAC,cAAc,EAAE,cAAc,IAAO,KAAe,UAAI,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AApBD,sDAoBC"}
+{"version":3,"file":"withTriggerExperiment.js","sourceRoot":"","sources":["../src/withTriggerExperiment.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,+DAA8D;AAW9D;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QACrC,IAAA,KACJ,IAAA,2CAAoB,GAAE,EADhB,cAAc,oBAAA,EAAS,sBAAsB,WAC7B,CAAC;QAEzB,OAAO,CACL,uBAAC,SAAS,aACR,cAAc,EAAE,cAAc,EAC9B,sBAAsB,EAAE,sBAAsB,IACzC,KAAe,UACpB,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAfD,sDAeC"}

package/dist/withVariationAssociatedData.d.ts

@@ -1,10 +1,12 @@
 import React from 'react';
-import { UnknownPropsType, Without, AnyType } from './types';
+import { UnknownPropsType, Without, VariationAssociatedDataType } from './types';
+import { KameleoonError } from './KameleoonError';
 interface IWithVariationAssociatedData {
     /**
      * @param variationId - unique identifier of the variation you want to obtain associated data for
      */
-    getVariationAssociatedData: (variationId: number) => AnyType;
+    getVariationAssociatedData: (variationId: number) => VariationAssociatedDataType;
+    variationAssociatedDataError: KameleoonError | null;
 }
 /**
  * A React HOC that gives a wrapped component access to callback function which

package/dist/withVariationAssociatedData.js

@@ -13,9 +13,7 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withVariationAssociatedData = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
-var react_1 = require("react");
-var KameleoonContext_1 = require("./KameleoonContext");
-var ProviderError_1 = require("./ProviderError");
+var useVariationAssociatedData_1 = require("./useVariationAssociatedData");
 /**
  * A React HOC that gives a wrapped component access to callback function which
  * retrieves JSON data associated with a variation.
@@ -24,14 +22,8 @@ var ProviderError_1 = require("./ProviderError");
  */
 function withVariationAssociatedData(Component) {
     return function WrappedComponent(props) {
-        var client = (0, react_1.useContext)(KameleoonContext_1.KameleoonContext);
-        var getVariationAssociatedData = (0, react_1.useCallback)(function (variationId) {
-            if (!client) {
-                throw new ProviderError_1.ProviderError('withVariationAssociatedData');
-            }
-            return client.obtainVariationAssociatedData(variationId);
-        }, [client]);
-        return ((0, jsx_runtime_1.jsx)(Component, __assign({ getVariationAssociatedData: getVariationAssociatedData }, props), void 0));
+        var _a = (0, useVariationAssociatedData_1.useVariationAssociatedData)(), getVariationAssociatedData = _a.getVariationAssociatedData, variationAssociatedDataError = _a.error;
+        return ((0, jsx_runtime_1.jsx)(Component, __assign({ getVariationAssociatedData: getVariationAssociatedData, variationAssociatedDataError: variationAssociatedDataError }, props), void 0));
     };
 }
 exports.withVariationAssociatedData = withVariationAssociatedData;

package/dist/withVariationAssociatedData.js.map

@@ -1 +1 @@
-{"version":3,"file":"withVariationAssociatedData.js","sourceRoot":"","sources":["../src/withVariationAssociatedData.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,uDAAsD;AACtD,iDAAgD;AAShD;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;QAE5C,IAAM,0BAA0B,GAAG,IAAA,mBAAW,EAC5C,UAAC,WAAmB;YAClB,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,6BAA6B,CAAC,CAAC;aACxD;YACD,OAAO,MAAM,CAAC,6BAA6B,CAAC,WAAW,CAAC,CAAC;QAC3D,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,OAAO,CACL,uBAAC,SAAS,aACR,0BAA0B,EAAE,0BAA0B,IAEjD,KAAe,UACpB,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAxBD,kEAwBC"}
+{"version":3,"file":"withVariationAssociatedData.js","sourceRoot":"","sources":["../src/withVariationAssociatedData.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,2EAA0E;AAa1E;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QACrC,IAAA,KACJ,IAAA,uDAA0B,GAAE,EADtB,0BAA0B,gCAAA,EAAS,4BAA4B,WACzC,CAAC;QAE/B,OAAO,CACL,uBAAC,SAAS,aACR,0BAA0B,EAAE,0BAA0B,EACtD,4BAA4B,EAAE,4BAA4B,IACrD,KAAe,UACpB,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAfD,kEAeC"}

package/dist/withVisitorCode.js

@@ -29,7 +29,6 @@ function withVisitorCode(Component) {
             }
             return client.obtainVisitorCode(topLevelDomain, defaultVisitorCode);
         }, [client]);
-        // eslint-disable-next-line react/jsx-props-no-spreading
         return (0, jsx_runtime_1.jsx)(Component, __assign({ getVisitorCode: getVisitorCode }, props), void 0);
     };
 }

package/dist/withVisitorCode.js.map

@@ -1 +1 @@
-{"version":3,"file":"withVisitorCode.js","sourceRoot":"","sources":["../src/withVisitorCode.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,uDAAsD;AACtD,iDAAgD;AAahD;;;GAGG;AACH,SAAgB,eAAe,CAC7B,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;QAE5C,IAAM,cAAc,GAAG,IAAA,mBAAW,EAChC,UAAC,cAAsB,EAAE,kBAA2B;YAClD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,iBAAiB,CAAC,CAAC;aAC5C;YAED,OAAO,MAAM,CAAC,iBAAiB,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACtE,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,wDAAwD;QACxD,OAAO,uBAAC,SAAS,aAAC,cAAc,EAAE,cAAc,IAAO,KAAe,UAAI,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AApBD,0CAoBC"}
+{"version":3,"file":"withVisitorCode.js","sourceRoot":"","sources":["../src/withVisitorCode.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAAuD;AAEvD,uDAAsD;AACtD,iDAAgD;AAahD;;;GAGG;AACH,SAAgB,eAAe,CAC7B,SAAqC;IAErC,OAAO,SAAS,gBAAgB,CAAC,KAAY;QAC3C,IAAM,MAAM,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;QAE5C,IAAM,cAAc,GAAG,IAAA,mBAAW,EAChC,UAAC,cAAsB,EAAE,kBAA2B;YAClD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,6BAAa,CAAC,iBAAiB,CAAC,CAAC;aAC5C;YAED,OAAO,MAAM,CAAC,iBAAiB,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACtE,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,OAAO,uBAAC,SAAS,aAAC,cAAc,EAAE,cAAc,IAAO,KAAe,UAAI,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAnBD,0CAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/react-sdk",
-  "version": "1.2.2",
+  "version": "3.0.0",
   "description": "Kameleoon React SDK",
   "files": [
     "dist"
@@ -12,6 +12,7 @@
     "build": "npm run clear && tsc",
     "deploy": "npm publish --tag latest --access public",
     "release": "../../scripts/release.sh react-sdk",
+    "update-documentation": "../../scripts/update_documentation.sh react",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
@@ -34,7 +35,7 @@
   },
   "dependencies": {
     "@types/validator": "^13.6.3",
-    "kameleoon-client-javascript": "^1.0.5",
+    "kameleoon-client-javascript": "^1.0.8",
     "validator": "^13.6.0"
   },
   "devDependencies": {