@kameleoon/react-sdk 1.2.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +86 -13
  3. package/dist/constants.d.ts +1 -0
  4. package/dist/constants.js +2 -1
  5. package/dist/constants.js.map +1 -1
  6. package/dist/index.d.ts +3 -0
  7. package/dist/index.js +16 -1
  8. package/dist/index.js.map +1 -1
  9. package/dist/stories/Form.d.ts +4 -3
  10. package/dist/stories/Form.js +92 -35
  11. package/dist/stories/Form.js.map +1 -1
  12. package/dist/stories/FormHOC.js +12 -7
  13. package/dist/stories/FormHOC.js.map +1 -1
  14. package/dist/stories/FormHook.js +26 -19
  15. package/dist/stories/FormHook.js.map +1 -1
  16. package/dist/stories/constants.d.ts +4 -2
  17. package/dist/stories/constants.js +10 -8
  18. package/dist/stories/constants.js.map +1 -1
  19. package/dist/types.d.ts +10 -1
  20. package/dist/useConversion.d.ts +1 -1
  21. package/dist/useFeature.d.ts +1 -1
  22. package/dist/useFeature.js +16 -8
  23. package/dist/useFeature.js.map +1 -1
  24. package/dist/useRetrieveDataFromRemoteSource.d.ts +12 -0
  25. package/dist/useRetrieveDataFromRemoteSource.js +76 -0
  26. package/dist/useRetrieveDataFromRemoteSource.js.map +1 -0
  27. package/dist/useVariationAssociatedData.d.ts +2 -2
  28. package/dist/withActivateFeature.js +0 -1
  29. package/dist/withActivateFeature.js.map +1 -1
  30. package/dist/withAddData.js +0 -1
  31. package/dist/withAddData.js.map +1 -1
  32. package/dist/withBrowser.js +0 -1
  33. package/dist/withBrowser.js.map +1 -1
  34. package/dist/withConversion.d.ts +1 -1
  35. package/dist/withConversion.js +0 -1
  36. package/dist/withConversion.js.map +1 -1
  37. package/dist/withCustomData.js +0 -1
  38. package/dist/withCustomData.js.map +1 -1
  39. package/dist/withFeature.js +0 -1
  40. package/dist/withFeature.js.map +1 -1
  41. package/dist/withFeatureVariable.js.map +1 -1
  42. package/dist/withFlush.js +0 -1
  43. package/dist/withFlush.js.map +1 -1
  44. package/dist/withInterest.js +0 -1
  45. package/dist/withInterest.js.map +1 -1
  46. package/dist/withKameleoon.js +0 -1
  47. package/dist/withKameleoon.js.map +1 -1
  48. package/dist/withPageView.js +0 -1
  49. package/dist/withPageView.js.map +1 -1
  50. package/dist/withRetrieveDataFromRemoteSource.d.ts +14 -0
  51. package/dist/withRetrieveDataFromRemoteSource.js +28 -0
  52. package/dist/withRetrieveDataFromRemoteSource.js.map +1 -0
  53. package/dist/withTrackingConversion.d.ts +1 -1
  54. package/dist/withTrackingConversion.js +4 -6
  55. package/dist/withTrackingConversion.js.map +1 -1
  56. package/dist/withTriggerExperiment.d.ts +1 -1
  57. package/dist/withTriggerExperiment.js +1 -2
  58. package/dist/withTriggerExperiment.js.map +1 -1
  59. package/dist/withVariationAssociatedData.js.map +1 -1
  60. package/dist/withVisitorCode.js +0 -1
  61. package/dist/withVisitorCode.js.map +1 -1
  62. package/package.json +4 -3
@@ -15,23 +15,21 @@ exports.withTrackingConversion = void 0;
15
15
  var jsx_runtime_1 = require("react/jsx-runtime");
16
16
  var react_1 = require("react");
17
17
  var ProviderError_1 = require("./ProviderError");
18
- var _1 = require(".");
18
+ var KameleoonContext_1 = require("./KameleoonContext");
19
19
  /**
20
- * A React HOC that gives a wrapped component access access to callback function
20
+ * A React HOC that gives a wrapped component access to callback function
21
21
  * which tracks conversion
22
22
  */
23
23
  function withTrackingConversion(Component) {
24
24
  return function WrappedComponent(props) {
25
- var client = (0, react_1.useContext)(_1.KameleoonContext);
25
+ var client = (0, react_1.useContext)(KameleoonContext_1.KameleoonContext);
26
26
  var trackConversion = (0, react_1.useCallback)(function (visitorCode, goalId, revenue) {
27
27
  if (!client) {
28
28
  throw new ProviderError_1.ProviderError('withTrackingConversion');
29
29
  }
30
30
  return client.trackConversion(visitorCode, goalId, revenue);
31
31
  }, [client]);
32
- return (
33
- // eslint-disable-next-line react/jsx-props-no-spreading
34
- (0, jsx_runtime_1.jsx)(Component, __assign({ trackConversion: trackConversion }, props), void 0));
32
+ return ((0, jsx_runtime_1.jsx)(Component, __assign({ trackConversion: trackConversion }, props), void 0));
35
33
  };
36
34
  }
37
35
  exports.withTrackingConversion = withTrackingConversion;
@@ -1 +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"}
1
+ {"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"}
@@ -8,7 +8,7 @@ interface IWithTriggerExperiment {
8
8
  getVariationId: (visitorCode: string, experimentId: number) => number;
9
9
  }
10
10
  /**
11
- * A React HOC that gives a wrapped component access access to callback function which triggers experiment
11
+ * A React HOC that gives a wrapped component access to callback function which triggers experiment
12
12
  * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
13
13
  * If a user with a given visitorCode is already registered with a variation,
14
14
  * it will detect the previously registered variation and return the variationID
@@ -17,7 +17,7 @@ var react_1 = require("react");
17
17
  var KameleoonContext_1 = require("./KameleoonContext");
18
18
  var ProviderError_1 = require("./ProviderError");
19
19
  /**
20
- * A React HOC that gives a wrapped component access access to callback function which triggers experiment
20
+ * A React HOC that gives a wrapped component access to callback function which triggers experiment
21
21
  * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
22
22
  * If a user with a given visitorCode is already registered with a variation,
23
23
  * it will detect the previously registered variation and return the variationID
@@ -31,7 +31,6 @@ function withTriggerExperiment(Component) {
31
31
  }
32
32
  return client.triggerExperiment(visitorCode, experimentId);
33
33
  }, [client]);
34
- // eslint-disable-next-line react/jsx-props-no-spreading
35
34
  return (0, jsx_runtime_1.jsx)(Component, __assign({ getVariationId: getVariationId }, props), void 0);
36
35
  };
37
36
  }
@@ -1 +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"}
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,OAAO,uBAAC,SAAS,aAAC,cAAc,EAAE,cAAc,IAAO,KAAe,UAAI,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAnBD,sDAmBC"}
@@ -1 +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"}
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,IACjD,KAAe,UACpB,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAvBD,kEAuBC"}
@@ -29,7 +29,6 @@ function withVisitorCode(Component) {
29
29
  }
30
30
  return client.obtainVisitorCode(topLevelDomain, defaultVisitorCode);
31
31
  }, [client]);
32
- // eslint-disable-next-line react/jsx-props-no-spreading
33
32
  return (0, jsx_runtime_1.jsx)(Component, __assign({ getVisitorCode: getVisitorCode }, props), void 0);
34
33
  };
35
34
  }
@@ -1 +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"}
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,OAAO,uBAAC,SAAS,aAAC,cAAc,EAAE,cAAc,IAAO,KAAe,UAAI,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAnBD,0CAmBC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kameleoon/react-sdk",
3
- "version": "1.2.1",
3
+ "version": "2.1.0",
4
4
  "description": "Kameleoon React SDK",
5
5
  "files": [
6
6
  "dist"
@@ -10,8 +10,9 @@
10
10
  "clear": "rimraf dist",
11
11
  "start": "npm run clear && tsc -w",
12
12
  "build": "npm run clear && tsc",
13
- "deploy": "npm publish --access public",
13
+ "deploy": "npm publish --tag latest --access public",
14
14
  "release": "../../scripts/release.sh react-sdk",
15
+ "update-documentation": "../../scripts/update_documentation.sh react",
15
16
  "test": "jest",
16
17
  "test:watch": "jest --watch",
17
18
  "test:coverage": "jest --coverage",
@@ -34,7 +35,7 @@
34
35
  },
35
36
  "dependencies": {
36
37
  "@types/validator": "^13.6.3",
37
- "kameleoon-client-javascript": "^1.0.5",
38
+ "kameleoon-client-javascript": "^1.0.7",
38
39
  "validator": "^13.6.0"
39
40
  },
40
41
  "devDependencies": {