@kameleoon/react-sdk 6.1.3 → 7.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.
- package/README.md +8 -1
- package/dist/eventSource/nativeEventSource.js +2 -2
- package/dist/eventSource/nativeEventSource.js.map +1 -1
- package/dist/index.d.ts +9 -4
- package/dist/index.js +68 -3
- package/dist/index.js.map +1 -1
- package/dist/kameleoonClient.js +2 -2
- package/dist/kameleoonClient.js.map +1 -1
- package/dist/kameleoonUtils/nativeUtils.js +0 -1
- package/dist/kameleoonUtils/nativeUtils.js.map +1 -1
- package/dist/useAddData.d.ts +7 -5
- package/dist/useAddData.js +3 -13
- package/dist/useAddData.js.map +1 -1
- package/dist/useBrowserVisitorCode.d.ts +4 -5
- package/dist/useBrowserVisitorCode.js +1 -1
- package/dist/useBrowserVisitorCode.js.map +1 -1
- package/dist/useConfigurationUpdate.d.ts +4 -4
- package/dist/useConfigurationUpdate.js +3 -13
- package/dist/useConfigurationUpdate.js.map +1 -1
- package/dist/useEngineTrackingCode.d.ts +5 -0
- package/dist/useEngineTrackingCode.js +20 -0
- package/dist/useEngineTrackingCode.js.map +1 -0
- package/dist/useExperimentVariationData.d.ts +21 -0
- package/dist/useExperimentVariationData.js +25 -0
- package/dist/useExperimentVariationData.js.map +1 -0
- package/dist/useExperiments.d.ts +4 -4
- package/dist/useExperiments.js +3 -14
- package/dist/useExperiments.js.map +1 -1
- package/dist/useFeatureFlagActive.d.ts +8 -4
- package/dist/useFeatureFlagActive.js +3 -14
- package/dist/useFeatureFlagActive.js.map +1 -1
- package/dist/useFeatureFlagVariationKey.d.ts +10 -7
- package/dist/useFeatureFlagVariationKey.js +3 -14
- package/dist/useFeatureFlagVariationKey.js.map +1 -1
- package/dist/useFeatureFlags.d.ts +4 -4
- package/dist/useFeatureFlags.js +3 -14
- package/dist/useFeatureFlags.js.map +1 -1
- package/dist/useFeatureVariable.d.ts +11 -6
- package/dist/useFeatureVariable.js +3 -14
- package/dist/useFeatureVariable.js.map +1 -1
- package/dist/useFlushData.d.ts +3 -0
- package/dist/useFlushData.js.map +1 -1
- package/dist/useInitialize.d.ts +5 -4
- package/dist/useInitialize.js +3 -14
- package/dist/useInitialize.js.map +1 -1
- package/dist/useKameleoon.d.ts +2 -1
- package/dist/useKameleoon.js +3 -3
- package/dist/useKameleoon.js.map +1 -1
- package/dist/useNativeVisitorCode.d.ts +3 -4
- package/dist/useNativeVisitorCode.js +1 -1
- package/dist/useNativeVisitorCode.js.map +1 -1
- package/dist/useRemoteData.d.ts +5 -5
- package/dist/useRemoteData.js +2 -14
- package/dist/useRemoteData.js.map +1 -1
- package/dist/useTrackConversion.d.ts +4 -3
- package/dist/useTrackConversion.js +2 -12
- package/dist/useTrackConversion.js.map +1 -1
- package/dist/useTriggerExperiment.d.ts +7 -3
- package/dist/useTriggerExperiment.js +3 -15
- package/dist/useTriggerExperiment.js.map +1 -1
- package/dist/useVisitorExperiments.d.ts +7 -6
- package/dist/useVisitorExperiments.js +3 -14
- package/dist/useVisitorExperiments.js.map +1 -1
- package/dist/useVisitorFeatureFlags.d.ts +6 -4
- package/dist/useVisitorFeatureFlags.js +3 -14
- package/dist/useVisitorFeatureFlags.js.map +1 -1
- package/package.json +3 -2
- package/dist/KameleoonError.d.ts +0 -5
- package/dist/KameleoonError.js +0 -20
- package/dist/KameleoonError.js.map +0 -1
- package/dist/ProviderError.d.ts +0 -3
- package/dist/ProviderError.js +0 -14
- package/dist/ProviderError.js.map +0 -1
- package/dist/constants.d.ts +0 -1
- package/dist/constants.js +0 -9
- package/dist/constants.js.map +0 -1
- package/dist/useError.d.ts +0 -7
- package/dist/useError.js +0 -18
- package/dist/useError.js.map +0 -1
- package/dist/useErrors.d.ts +0 -7
- package/dist/useErrors.js +0 -19
- package/dist/useErrors.js.map +0 -1
package/README.md
CHANGED
|
@@ -43,20 +43,26 @@ function MyComponentWrapper(): JSX.Element {
|
|
|
43
43
|
import { useEffect } from 'react';
|
|
44
44
|
import {
|
|
45
45
|
useInitialize,
|
|
46
|
+
useAddData,
|
|
46
47
|
getBrowserVisitorCode,
|
|
47
48
|
useFeatureFlagActive,
|
|
49
|
+
CustomData,
|
|
48
50
|
} from '@kameleoon/react-sdk';
|
|
49
51
|
|
|
50
52
|
function MyComponent(): JSX.Element {
|
|
51
53
|
const { initialize } = useInitialize();
|
|
54
|
+
const { addData } = useAddData();
|
|
52
55
|
const { getBrowserVisitorCode } = useBrowserVisitorCode();
|
|
53
56
|
const { isFeatureFlagActive } = useFeatureFlagActive();
|
|
57
|
+
const visitorCode = getBrowserVisitorCode('www.example.com');
|
|
58
|
+
const customDataIndex = 0;
|
|
54
59
|
|
|
55
60
|
async function waitForInitialize(): Promise<void> {
|
|
56
61
|
const isReady = await initialize();
|
|
57
62
|
|
|
58
63
|
if (isReady) {
|
|
59
|
-
|
|
64
|
+
// -- Add targeting data
|
|
65
|
+
addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
|
|
60
66
|
|
|
61
67
|
// -- Check if the feature is active for visitor
|
|
62
68
|
const isMyFeatureActive = isFeatureFlagActive(
|
|
@@ -80,6 +86,7 @@ import {
|
|
|
80
86
|
useBrowserVisitorCode,
|
|
81
87
|
useTriggerExperiment,
|
|
82
88
|
useFeatureFlagActive,
|
|
89
|
+
CustomData,
|
|
83
90
|
} from '@kameleoon/react-sdk';
|
|
84
91
|
|
|
85
92
|
function MyComponent(): JSX.Element {
|
|
@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
6
|
exports.NativeEventSourceConstructor = void 0;
|
|
7
|
-
var
|
|
7
|
+
var _reactNativeEventSourceTs = _interopRequireDefault(require("react-native-event-source-ts"));
|
|
8
8
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
9
9
|
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
10
10
|
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
|
|
@@ -18,7 +18,7 @@ exports.NativeEventSourceConstructor = NativeEventSourceConstructor;
|
|
|
18
18
|
class ExternalEventSource {
|
|
19
19
|
constructor(url) {
|
|
20
20
|
_defineProperty(this, "eventSource", void 0);
|
|
21
|
-
const eventSource = new
|
|
21
|
+
const eventSource = new _reactNativeEventSourceTs.default(url);
|
|
22
22
|
this.eventSource = eventSource;
|
|
23
23
|
}
|
|
24
24
|
open({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nativeEventSource.js","names":["
|
|
1
|
+
{"version":3,"file":"nativeEventSource.js","names":["_reactNativeEventSourceTs","_interopRequireDefault","require","obj","__esModule","default","_defineProperty","key","value","_toPropertyKey","Object","defineProperty","enumerable","configurable","writable","arg","_toPrimitive","String","input","hint","prim","Symbol","toPrimitive","undefined","res","call","TypeError","Number","NativeEventSourceConstructor","initialize","url","ExternalEventSource","exports","constructor","eventSource","EventSource","open","siteCode","eventType","onEvent","addEventListener","message","data","event","JSON","parse","eventSiteCode","ts","close"],"sources":["../../src/eventSource/nativeEventSource.ts"],"sourcesContent":["import EventSource from 'react-native-event-source-ts';\nimport {\n RealTimeEventType,\n IExternalEventSource,\n EventSourceOpenParametersType,\n IExternalEventSourceConstructor,\n} from '@kameleoon/javascript-sdk-core';\n\nexport class NativeEventSourceConstructor\n implements IExternalEventSourceConstructor\n{\n public initialize(url: string): IExternalEventSource {\n return new ExternalEventSource(url);\n }\n}\n\nclass ExternalEventSource implements IExternalEventSource {\n private eventSource: EventSource;\n\n constructor(url: string) {\n const eventSource = new EventSource(url);\n\n this.eventSource = eventSource;\n }\n\n public open({\n siteCode,\n eventType,\n onEvent,\n }: EventSourceOpenParametersType): void {\n this.eventSource.addEventListener(eventType, (message: MessageEvent) => {\n if (message.data) {\n const event: RealTimeEventType = JSON.parse(message.data);\n const { siteCode: eventSiteCode, ts } = event;\n\n if (siteCode === eventSiteCode) {\n onEvent(ts);\n }\n }\n });\n }\n\n public close() {\n this.eventSource.close();\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,yBAAA,GAAAC,sBAAA,CAAAC,OAAA;AAAuD,SAAAD,uBAAAE,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,gBAAAH,GAAA,EAAAI,GAAA,EAAAC,KAAA,IAAAD,GAAA,GAAAE,cAAA,CAAAF,GAAA,OAAAA,GAAA,IAAAJ,GAAA,IAAAO,MAAA,CAAAC,cAAA,CAAAR,GAAA,EAAAI,GAAA,IAAAC,KAAA,EAAAA,KAAA,EAAAI,UAAA,QAAAC,YAAA,QAAAC,QAAA,oBAAAX,GAAA,CAAAI,GAAA,IAAAC,KAAA,WAAAL,GAAA;AAAA,SAAAM,eAAAM,GAAA,QAAAR,GAAA,GAAAS,YAAA,CAAAD,GAAA,2BAAAR,GAAA,gBAAAA,GAAA,GAAAU,MAAA,CAAAV,GAAA;AAAA,SAAAS,aAAAE,KAAA,EAAAC,IAAA,eAAAD,KAAA,iBAAAA,KAAA,kBAAAA,KAAA,MAAAE,IAAA,GAAAF,KAAA,CAAAG,MAAA,CAAAC,WAAA,OAAAF,IAAA,KAAAG,SAAA,QAAAC,GAAA,GAAAJ,IAAA,CAAAK,IAAA,CAAAP,KAAA,EAAAC,IAAA,2BAAAK,GAAA,sBAAAA,GAAA,YAAAE,SAAA,4DAAAP,IAAA,gBAAAF,MAAA,GAAAU,MAAA,EAAAT,KAAA;AAQhD,MAAMU,4BAA4B,CAEzC;EACSC,UAAUA,CAACC,GAAW,EAAwB;IACnD,OAAO,IAAIC,mBAAmB,CAACD,GAAG,CAAC;EACrC;AACF;AAACE,OAAA,CAAAJ,4BAAA,GAAAA,4BAAA;AAED,MAAMG,mBAAmB,CAAiC;EAGxDE,WAAWA,CAACH,GAAW,EAAE;IAAAxB,eAAA;IACvB,MAAM4B,WAAW,GAAG,IAAIC,iCAAW,CAACL,GAAG,CAAC;IAExC,IAAI,CAACI,WAAW,GAAGA,WAAW;EAChC;EAEOE,IAAIA,CAAC;IACVC,QAAQ;IACRC,SAAS;IACTC;EAC6B,CAAC,EAAQ;IACtC,IAAI,CAACL,WAAW,CAACM,gBAAgB,CAACF,SAAS,EAAGG,OAAqB,IAAK;MACtE,IAAIA,OAAO,CAACC,IAAI,EAAE;QAChB,MAAMC,KAAwB,GAAGC,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACC,IAAI,CAAC;QACzD,MAAM;UAAEL,QAAQ,EAAES,aAAa;UAAEC;QAAG,CAAC,GAAGJ,KAAK;QAE7C,IAAIN,QAAQ,KAAKS,aAAa,EAAE;UAC9BP,OAAO,CAACQ,EAAE,CAAC;QACb;MACF;IACF,CAAC,CAAC;EACJ;EAEOC,KAAKA,CAAA,EAAG;IACb,IAAI,CAACd,WAAW,CAACc,KAAK,EAAE;EAC1B;AACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,18 +1,23 @@
|
|
|
1
|
-
export { Device, Browser, PageView, JSONType, Conversion, CustomData, DeviceType, BrowserType, Environment, VariableType, KameleoonException, KameleoonStorageKey, } from '@kameleoon/javascript-sdk-core';
|
|
1
|
+
export { Device, Browser, PageView, JSONType, Conversion, CustomData, DeviceType, BrowserType, Environment, VariableType, KameleoonError, KameleoonException, KameleoonStorageKey, } from '@kameleoon/javascript-sdk-core';
|
|
2
2
|
export { default as KameleoonProvider, IKameleoonProviderProps, } from './KameleoonProvider';
|
|
3
3
|
export { KameleoonContext } from './KameleoonContext';
|
|
4
4
|
export { createClient } from './kameleoonClient';
|
|
5
|
+
export { useKameleoon } from './useKameleoon';
|
|
5
6
|
export { useInitialize, IInitializeHookResult } from './useInitialize';
|
|
6
7
|
export { useExperiments, IExperimentsHookResult } from './useExperiments';
|
|
7
8
|
export { useFeatureFlags, IFeatureFlagsHookResult } from './useFeatureFlags';
|
|
9
|
+
export { useRemoteData, IRemoteDataHookResult } from './useRemoteData';
|
|
10
|
+
export { useAddData, IAddDataHookResult } from './useAddData';
|
|
11
|
+
export { useFlushData, IFlushDataHookResult } from './useFlushData';
|
|
12
|
+
export { useBrowserVisitorCode, IBrowserVisitorCodeHookResult, } from './useBrowserVisitorCode';
|
|
13
|
+
export { useNativeVisitorCode, INativeVisitorCodeHookResult, } from './useNativeVisitorCode';
|
|
8
14
|
export { useVisitorExperiments, IVisitorExperimentsHookResult, } from './useVisitorExperiments';
|
|
9
15
|
export { useVisitorFeatureFlags, IVisitorFeatureFlagsHookResult, } from './useVisitorFeatureFlags';
|
|
10
16
|
export { useFeatureFlagVariationKey, IFeatureFlagVariationKeyHookResult, } from './useFeatureFlagVariationKey';
|
|
11
17
|
export { useTriggerExperiment, ITriggerExperimentHookResult, } from './useTriggerExperiment';
|
|
12
18
|
export { useFeatureFlagActive, IFeatureFlagActiveHookResult, } from './useFeatureFlagActive';
|
|
19
|
+
export { useEngineTrackingCode, IEngineTrackingCodeHookResult, } from './useEngineTrackingCode';
|
|
13
20
|
export { useFeatureVariable, IFeatureVariableHookResult, } from './useFeatureVariable';
|
|
14
21
|
export { useTrackConversion, ITrackConversionHookResult, } from './useTrackConversion';
|
|
15
22
|
export { useConfigurationUpdate, IConfigurationUpdateHookResult, } from './useConfigurationUpdate';
|
|
16
|
-
export {
|
|
17
|
-
export { useAddData, IAddDataHookResult } from './useAddData';
|
|
18
|
-
export { useFlushData, IFlushDataHookResult } from './useFlushData';
|
|
23
|
+
export { useExperimentVariationData, IExperimentVariationDataHookResult, } from './useExperimentVariationData';
|
package/dist/index.js
CHANGED
|
@@ -51,12 +51,30 @@ Object.defineProperty(exports, "IAddDataHookResult", {
|
|
|
51
51
|
return _useAddData.IAddDataHookResult;
|
|
52
52
|
}
|
|
53
53
|
});
|
|
54
|
+
Object.defineProperty(exports, "IBrowserVisitorCodeHookResult", {
|
|
55
|
+
enumerable: true,
|
|
56
|
+
get: function () {
|
|
57
|
+
return _useBrowserVisitorCode.IBrowserVisitorCodeHookResult;
|
|
58
|
+
}
|
|
59
|
+
});
|
|
54
60
|
Object.defineProperty(exports, "IConfigurationUpdateHookResult", {
|
|
55
61
|
enumerable: true,
|
|
56
62
|
get: function () {
|
|
57
63
|
return _useConfigurationUpdate.IConfigurationUpdateHookResult;
|
|
58
64
|
}
|
|
59
65
|
});
|
|
66
|
+
Object.defineProperty(exports, "IEngineTrackingCodeHookResult", {
|
|
67
|
+
enumerable: true,
|
|
68
|
+
get: function () {
|
|
69
|
+
return _useEngineTrackingCode.IEngineTrackingCodeHookResult;
|
|
70
|
+
}
|
|
71
|
+
});
|
|
72
|
+
Object.defineProperty(exports, "IExperimentVariationDataHookResult", {
|
|
73
|
+
enumerable: true,
|
|
74
|
+
get: function () {
|
|
75
|
+
return _useExperimentVariationData.IExperimentVariationDataHookResult;
|
|
76
|
+
}
|
|
77
|
+
});
|
|
60
78
|
Object.defineProperty(exports, "IExperimentsHookResult", {
|
|
61
79
|
enumerable: true,
|
|
62
80
|
get: function () {
|
|
@@ -105,6 +123,12 @@ Object.defineProperty(exports, "IKameleoonProviderProps", {
|
|
|
105
123
|
return _KameleoonProvider.IKameleoonProviderProps;
|
|
106
124
|
}
|
|
107
125
|
});
|
|
126
|
+
Object.defineProperty(exports, "INativeVisitorCodeHookResult", {
|
|
127
|
+
enumerable: true,
|
|
128
|
+
get: function () {
|
|
129
|
+
return _useNativeVisitorCode.INativeVisitorCodeHookResult;
|
|
130
|
+
}
|
|
131
|
+
});
|
|
108
132
|
Object.defineProperty(exports, "IRemoteDataHookResult", {
|
|
109
133
|
enumerable: true,
|
|
110
134
|
get: function () {
|
|
@@ -147,6 +171,12 @@ Object.defineProperty(exports, "KameleoonContext", {
|
|
|
147
171
|
return _KameleoonContext.KameleoonContext;
|
|
148
172
|
}
|
|
149
173
|
});
|
|
174
|
+
Object.defineProperty(exports, "KameleoonError", {
|
|
175
|
+
enumerable: true,
|
|
176
|
+
get: function () {
|
|
177
|
+
return _javascriptSdkCore.KameleoonError;
|
|
178
|
+
}
|
|
179
|
+
});
|
|
150
180
|
Object.defineProperty(exports, "KameleoonException", {
|
|
151
181
|
enumerable: true,
|
|
152
182
|
get: function () {
|
|
@@ -189,12 +219,30 @@ Object.defineProperty(exports, "useAddData", {
|
|
|
189
219
|
return _useAddData.useAddData;
|
|
190
220
|
}
|
|
191
221
|
});
|
|
222
|
+
Object.defineProperty(exports, "useBrowserVisitorCode", {
|
|
223
|
+
enumerable: true,
|
|
224
|
+
get: function () {
|
|
225
|
+
return _useBrowserVisitorCode.useBrowserVisitorCode;
|
|
226
|
+
}
|
|
227
|
+
});
|
|
192
228
|
Object.defineProperty(exports, "useConfigurationUpdate", {
|
|
193
229
|
enumerable: true,
|
|
194
230
|
get: function () {
|
|
195
231
|
return _useConfigurationUpdate.useConfigurationUpdate;
|
|
196
232
|
}
|
|
197
233
|
});
|
|
234
|
+
Object.defineProperty(exports, "useEngineTrackingCode", {
|
|
235
|
+
enumerable: true,
|
|
236
|
+
get: function () {
|
|
237
|
+
return _useEngineTrackingCode.useEngineTrackingCode;
|
|
238
|
+
}
|
|
239
|
+
});
|
|
240
|
+
Object.defineProperty(exports, "useExperimentVariationData", {
|
|
241
|
+
enumerable: true,
|
|
242
|
+
get: function () {
|
|
243
|
+
return _useExperimentVariationData.useExperimentVariationData;
|
|
244
|
+
}
|
|
245
|
+
});
|
|
198
246
|
Object.defineProperty(exports, "useExperiments", {
|
|
199
247
|
enumerable: true,
|
|
200
248
|
get: function () {
|
|
@@ -237,6 +285,18 @@ Object.defineProperty(exports, "useInitialize", {
|
|
|
237
285
|
return _useInitialize.useInitialize;
|
|
238
286
|
}
|
|
239
287
|
});
|
|
288
|
+
Object.defineProperty(exports, "useKameleoon", {
|
|
289
|
+
enumerable: true,
|
|
290
|
+
get: function () {
|
|
291
|
+
return _useKameleoon.useKameleoon;
|
|
292
|
+
}
|
|
293
|
+
});
|
|
294
|
+
Object.defineProperty(exports, "useNativeVisitorCode", {
|
|
295
|
+
enumerable: true,
|
|
296
|
+
get: function () {
|
|
297
|
+
return _useNativeVisitorCode.useNativeVisitorCode;
|
|
298
|
+
}
|
|
299
|
+
});
|
|
240
300
|
Object.defineProperty(exports, "useRemoteData", {
|
|
241
301
|
enumerable: true,
|
|
242
302
|
get: function () {
|
|
@@ -271,20 +331,25 @@ var _javascriptSdkCore = require("@kameleoon/javascript-sdk-core");
|
|
|
271
331
|
var _KameleoonProvider = _interopRequireWildcard(require("./KameleoonProvider"));
|
|
272
332
|
var _KameleoonContext = require("./KameleoonContext");
|
|
273
333
|
var _kameleoonClient = require("./kameleoonClient");
|
|
334
|
+
var _useKameleoon = require("./useKameleoon");
|
|
274
335
|
var _useInitialize = require("./useInitialize");
|
|
275
336
|
var _useExperiments = require("./useExperiments");
|
|
276
337
|
var _useFeatureFlags = require("./useFeatureFlags");
|
|
338
|
+
var _useRemoteData = require("./useRemoteData");
|
|
339
|
+
var _useAddData = require("./useAddData");
|
|
340
|
+
var _useFlushData = require("./useFlushData");
|
|
341
|
+
var _useBrowserVisitorCode = require("./useBrowserVisitorCode");
|
|
342
|
+
var _useNativeVisitorCode = require("./useNativeVisitorCode");
|
|
277
343
|
var _useVisitorExperiments = require("./useVisitorExperiments");
|
|
278
344
|
var _useVisitorFeatureFlags = require("./useVisitorFeatureFlags");
|
|
279
345
|
var _useFeatureFlagVariationKey = require("./useFeatureFlagVariationKey");
|
|
280
346
|
var _useTriggerExperiment = require("./useTriggerExperiment");
|
|
281
347
|
var _useFeatureFlagActive = require("./useFeatureFlagActive");
|
|
348
|
+
var _useEngineTrackingCode = require("./useEngineTrackingCode");
|
|
282
349
|
var _useFeatureVariable = require("./useFeatureVariable");
|
|
283
350
|
var _useTrackConversion = require("./useTrackConversion");
|
|
284
351
|
var _useConfigurationUpdate = require("./useConfigurationUpdate");
|
|
285
|
-
var
|
|
286
|
-
var _useAddData = require("./useAddData");
|
|
287
|
-
var _useFlushData = require("./useFlushData");
|
|
352
|
+
var _useExperimentVariationData = require("./useExperimentVariationData");
|
|
288
353
|
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
289
354
|
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
290
355
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["_javascriptSdkCore","require","_KameleoonProvider","_interopRequireWildcard","_KameleoonContext","_kameleoonClient","_useInitialize","_useExperiments","_useFeatureFlags","_useVisitorExperiments","_useVisitorFeatureFlags","_useFeatureFlagVariationKey","_useTriggerExperiment","_useFeatureFlagActive","_useFeatureVariable","_useTrackConversion","_useConfigurationUpdate","
|
|
1
|
+
{"version":3,"file":"index.js","names":["_javascriptSdkCore","require","_KameleoonProvider","_interopRequireWildcard","_KameleoonContext","_kameleoonClient","_useKameleoon","_useInitialize","_useExperiments","_useFeatureFlags","_useRemoteData","_useAddData","_useFlushData","_useBrowserVisitorCode","_useNativeVisitorCode","_useVisitorExperiments","_useVisitorFeatureFlags","_useFeatureFlagVariationKey","_useTriggerExperiment","_useFeatureFlagActive","_useEngineTrackingCode","_useFeatureVariable","_useTrackConversion","_useConfigurationUpdate","_useExperimentVariationData","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set"],"sources":["../src/index.ts"],"sourcesContent":["export {\n Device,\n Browser,\n PageView,\n JSONType,\n Conversion,\n CustomData,\n DeviceType,\n BrowserType,\n Environment,\n VariableType,\n KameleoonError,\n KameleoonException,\n KameleoonStorageKey,\n} from '@kameleoon/javascript-sdk-core';\nexport {\n default as KameleoonProvider,\n IKameleoonProviderProps,\n} from './KameleoonProvider';\nexport { KameleoonContext } from './KameleoonContext';\nexport { createClient } from './kameleoonClient';\nexport { useKameleoon } from './useKameleoon';\nexport { useInitialize, IInitializeHookResult } from './useInitialize';\nexport { useExperiments, IExperimentsHookResult } from './useExperiments';\nexport { useFeatureFlags, IFeatureFlagsHookResult } from './useFeatureFlags';\nexport { useRemoteData, IRemoteDataHookResult } from './useRemoteData';\nexport { useAddData, IAddDataHookResult } from './useAddData';\nexport { useFlushData, IFlushDataHookResult } from './useFlushData';\nexport {\n useBrowserVisitorCode,\n IBrowserVisitorCodeHookResult,\n} from './useBrowserVisitorCode';\nexport {\n useNativeVisitorCode,\n INativeVisitorCodeHookResult,\n} from './useNativeVisitorCode';\nexport {\n useVisitorExperiments,\n IVisitorExperimentsHookResult,\n} from './useVisitorExperiments';\nexport {\n useVisitorFeatureFlags,\n IVisitorFeatureFlagsHookResult,\n} from './useVisitorFeatureFlags';\nexport {\n useFeatureFlagVariationKey,\n IFeatureFlagVariationKeyHookResult,\n} from './useFeatureFlagVariationKey';\nexport {\n useTriggerExperiment,\n ITriggerExperimentHookResult,\n} from './useTriggerExperiment';\nexport {\n useFeatureFlagActive,\n IFeatureFlagActiveHookResult,\n} from './useFeatureFlagActive';\nexport {\n useEngineTrackingCode,\n IEngineTrackingCodeHookResult,\n} from './useEngineTrackingCode';\nexport {\n useFeatureVariable,\n IFeatureVariableHookResult,\n} from './useFeatureVariable';\nexport {\n useTrackConversion,\n ITrackConversionHookResult,\n} from './useTrackConversion';\nexport {\n useConfigurationUpdate,\n IConfigurationUpdateHookResult,\n} from './useConfigurationUpdate';\nexport {\n useExperimentVariationData,\n IExperimentVariationDataHookResult,\n} from './useExperimentVariationData';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAeA,IAAAC,kBAAA,GAAAC,uBAAA,CAAAF,OAAA;AAIA,IAAAG,iBAAA,GAAAH,OAAA;AACA,IAAAI,gBAAA,GAAAJ,OAAA;AACA,IAAAK,aAAA,GAAAL,OAAA;AACA,IAAAM,cAAA,GAAAN,OAAA;AACA,IAAAO,eAAA,GAAAP,OAAA;AACA,IAAAQ,gBAAA,GAAAR,OAAA;AACA,IAAAS,cAAA,GAAAT,OAAA;AACA,IAAAU,WAAA,GAAAV,OAAA;AACA,IAAAW,aAAA,GAAAX,OAAA;AACA,IAAAY,sBAAA,GAAAZ,OAAA;AAIA,IAAAa,qBAAA,GAAAb,OAAA;AAIA,IAAAc,sBAAA,GAAAd,OAAA;AAIA,IAAAe,uBAAA,GAAAf,OAAA;AAIA,IAAAgB,2BAAA,GAAAhB,OAAA;AAIA,IAAAiB,qBAAA,GAAAjB,OAAA;AAIA,IAAAkB,qBAAA,GAAAlB,OAAA;AAIA,IAAAmB,sBAAA,GAAAnB,OAAA;AAIA,IAAAoB,mBAAA,GAAApB,OAAA;AAIA,IAAAqB,mBAAA,GAAArB,OAAA;AAIA,IAAAsB,uBAAA,GAAAtB,OAAA;AAIA,IAAAuB,2BAAA,GAAAvB,OAAA;AAGsC,SAAAwB,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAvB,wBAAA2B,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAE,GAAA,CAAAL,GAAA,SAAAM,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAX,GAAA,QAAAW,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAd,GAAA,EAAAW,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAV,GAAA,EAAAW,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAX,GAAA,CAAAW,GAAA,SAAAL,MAAA,CAAAJ,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAhB,GAAA,EAAAM,MAAA,YAAAA,MAAA"}
|
package/dist/kameleoonClient.js
CHANGED
|
@@ -26,8 +26,8 @@ function createClient(siteCode, configuration) {
|
|
|
26
26
|
externalEventSource: eventSource,
|
|
27
27
|
externalRequestDispatcher: requestDispatcher,
|
|
28
28
|
externalPackageInfo: {
|
|
29
|
-
|
|
30
|
-
version: "
|
|
29
|
+
type: _javascriptSdkCore.SDKType.React,
|
|
30
|
+
version: "7.1.0"
|
|
31
31
|
}
|
|
32
32
|
}
|
|
33
33
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kameleoonClient.js","names":["_javascriptSdkCore","require","_eventSource","_storage","_requester","createClient","siteCode","configuration","isBrowser","window","Boolean","document","storage","LocalStorageConstructor","NativeStorageConstructor","eventSource","BrowserEventSourceConstructor","NativeEventSourceConstructor","requestDispatcher","RequestDispatcher","client","KameleoonCore","internalConfiguration","externalStorage","externalEventSource","externalRequestDispatcher","externalPackageInfo","
|
|
1
|
+
{"version":3,"file":"kameleoonClient.js","names":["_javascriptSdkCore","require","_eventSource","_storage","_requester","createClient","siteCode","configuration","isBrowser","window","Boolean","document","storage","LocalStorageConstructor","NativeStorageConstructor","eventSource","BrowserEventSourceConstructor","NativeEventSourceConstructor","requestDispatcher","RequestDispatcher","client","KameleoonCore","internalConfiguration","externalStorage","externalEventSource","externalRequestDispatcher","externalPackageInfo","type","SDKType","React","version"],"sources":["../src/kameleoonClient.ts"],"sourcesContent":["import {\n KameleoonCore,\n SDKConfigurationType,\n IExternalStorageConstructor,\n IExternalEventSourceConstructor,\n SDKType,\n} from '@kameleoon/javascript-sdk-core';\nimport {\n BrowserEventSourceConstructor,\n NativeEventSourceConstructor,\n} from './eventSource';\nimport { LocalStorageConstructor, NativeStorageConstructor } from './storage';\nimport { RequestDispatcher } from './requester';\n\n/**\n * Creates an instance of KameleoonClient\n * @param {string} siteCode - client's siteCode defined on Kameleoon platform\n * @param {Partial<SDKConfigurationType> | undefined} configuration - client's configuration\n */\nexport function createClient(\n siteCode: string,\n configuration?: Partial<SDKConfigurationType>,\n): KameleoonCore {\n const isBrowser = typeof window !== 'undefined' && Boolean(window.document);\n const storage: IExternalStorageConstructor = isBrowser\n ? new LocalStorageConstructor()\n : new NativeStorageConstructor();\n const eventSource: IExternalEventSourceConstructor = isBrowser\n ? new BrowserEventSourceConstructor()\n : new NativeEventSourceConstructor();\n const requestDispatcher = new RequestDispatcher();\n\n const client = new KameleoonCore({\n siteCode,\n configuration,\n internalConfiguration: {\n externalStorage: storage,\n externalEventSource: eventSource,\n externalRequestDispatcher: requestDispatcher,\n externalPackageInfo: {\n type: SDKType.React,\n version: process.env.npm_package_version as string,\n },\n },\n });\n\n return client;\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAOA,IAAAC,YAAA,GAAAD,OAAA;AAIA,IAAAE,QAAA,GAAAF,OAAA;AACA,IAAAG,UAAA,GAAAH,OAAA;AAEA;AACA;AACA;AACA;AACA;AACO,SAASI,YAAYA,CAC1BC,QAAgB,EAChBC,aAA6C,EAC9B;EACf,MAAMC,SAAS,GAAG,OAAOC,MAAM,KAAK,WAAW,IAAIC,OAAO,CAACD,MAAM,CAACE,QAAQ,CAAC;EAC3E,MAAMC,OAAoC,GAAGJ,SAAS,GAClD,IAAIK,gCAAuB,EAAE,GAC7B,IAAIC,iCAAwB,EAAE;EAClC,MAAMC,WAA4C,GAAGP,SAAS,GAC1D,IAAIQ,0CAA6B,EAAE,GACnC,IAAIC,yCAA4B,EAAE;EACtC,MAAMC,iBAAiB,GAAG,IAAIC,4BAAiB,EAAE;EAEjD,MAAMC,MAAM,GAAG,IAAIC,gCAAa,CAAC;IAC/Bf,QAAQ;IACRC,aAAa;IACbe,qBAAqB,EAAE;MACrBC,eAAe,EAAEX,OAAO;MACxBY,mBAAmB,EAAET,WAAW;MAChCU,yBAAyB,EAAEP,iBAAiB;MAC5CQ,mBAAmB,EAAE;QACnBC,IAAI,EAAEC,0BAAO,CAACC,KAAK;QACnBC,OAAO;MACT;IACF;EACF,CAAC,CAAC;EAEF,OAAOV,MAAM;AACf"}
|
|
@@ -35,7 +35,6 @@ class KameleoonUtilsConstructor extends _javascriptSdkCore.KameleoonCoreUtils {
|
|
|
35
35
|
* BrowserUtils - a class with containing a number of static helper methods
|
|
36
36
|
* */
|
|
37
37
|
class NativeUtils {
|
|
38
|
-
// TODO: docs
|
|
39
38
|
/**
|
|
40
39
|
* @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie
|
|
41
40
|
* @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nativeUtils.js","names":["_javascriptSdkCore","require","_storage","storage","NativeStorageConstructor","initialize","KameleoonStorageKey","VisitorCode","KameleoonUtilsConstructor","KameleoonCoreUtils","getVisitorCode","defaultVisitorCode","readResult","read","ok","data","visitorCode","generateRandomString","VISITOR_CODE_LENGTH","write","NativeUtils","kameleoonUtilsConstructor","exports"],"sources":["../../src/kameleoonUtils/nativeUtils.ts"],"sourcesContent":["import {\n KameleoonCoreUtils,\n KameleoonStorageKey,\n VISITOR_CODE_LENGTH,\n MobileGetVisitorCodeParametersType,\n} from '@kameleoon/javascript-sdk-core';\nimport { NativeStorageConstructor } from '../storage';\n\nconst storage = new NativeStorageConstructor().initialize(\n KameleoonStorageKey.VisitorCode,\n);\n\n// --- Note ---\n// Extra class is created:\n// - To be able to enforce abstract `getVisitorCode` method\n// - To be able to use extended methods while `KameleoonUtils` iself only operates on static methods\n// - To keep similar parameters object on inner implementation and dispers it for proprietary implementations\nclass KameleoonUtilsConstructor extends KameleoonCoreUtils {\n public getVisitorCode({\n defaultVisitorCode,\n }: MobileGetVisitorCodeParametersType): string {\n const readResult = storage.read();\n\n if (readResult.ok) {\n return readResult.data;\n }\n\n const visitorCode =\n defaultVisitorCode || this.generateRandomString(VISITOR_CODE_LENGTH);\n\n // --- Note ---\n // `write` result is ignored because there is no exceptions for `mmkv` write operation\n storage.write(visitorCode);\n\n return visitorCode;\n }\n}\n\n/**\n * @class\n * BrowserUtils - a class with containing a number of static helper methods\n * */\nexport class NativeUtils {\n
|
|
1
|
+
{"version":3,"file":"nativeUtils.js","names":["_javascriptSdkCore","require","_storage","storage","NativeStorageConstructor","initialize","KameleoonStorageKey","VisitorCode","KameleoonUtilsConstructor","KameleoonCoreUtils","getVisitorCode","defaultVisitorCode","readResult","read","ok","data","visitorCode","generateRandomString","VISITOR_CODE_LENGTH","write","NativeUtils","kameleoonUtilsConstructor","exports"],"sources":["../../src/kameleoonUtils/nativeUtils.ts"],"sourcesContent":["import {\n KameleoonCoreUtils,\n KameleoonStorageKey,\n VISITOR_CODE_LENGTH,\n MobileGetVisitorCodeParametersType,\n} from '@kameleoon/javascript-sdk-core';\nimport { NativeStorageConstructor } from '../storage';\n\nconst storage = new NativeStorageConstructor().initialize(\n KameleoonStorageKey.VisitorCode,\n);\n\n// --- Note ---\n// Extra class is created:\n// - To be able to enforce abstract `getVisitorCode` method\n// - To be able to use extended methods while `KameleoonUtils` iself only operates on static methods\n// - To keep similar parameters object on inner implementation and dispers it for proprietary implementations\nclass KameleoonUtilsConstructor extends KameleoonCoreUtils {\n public getVisitorCode({\n defaultVisitorCode,\n }: MobileGetVisitorCodeParametersType): string {\n const readResult = storage.read();\n\n if (readResult.ok) {\n return readResult.data;\n }\n\n const visitorCode =\n defaultVisitorCode || this.generateRandomString(VISITOR_CODE_LENGTH);\n\n // --- Note ---\n // `write` result is ignored because there is no exceptions for `mmkv` write operation\n storage.write(visitorCode);\n\n return visitorCode;\n }\n}\n\n/**\n * @class\n * BrowserUtils - a class with containing a number of static helper methods\n * */\nexport class NativeUtils {\n /**\n * @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie\n * @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated\n * @returns {string} result visitor code\n * */\n static getVisitorCode(defaultVisitorCode?: string): string {\n const kameleoonUtilsConstructor = new KameleoonUtilsConstructor();\n\n return kameleoonUtilsConstructor.getVisitorCode({\n defaultVisitorCode,\n });\n }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAMA,IAAAC,QAAA,GAAAD,OAAA;AAEA,MAAME,OAAO,GAAG,IAAIC,iCAAwB,EAAE,CAACC,UAAU,CACvDC,sCAAmB,CAACC,WAAW,CAChC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,yBAAyB,SAASC,qCAAkB,CAAC;EAClDC,cAAcA,CAAC;IACpBC;EACkC,CAAC,EAAU;IAC7C,MAAMC,UAAU,GAAGT,OAAO,CAACU,IAAI,EAAE;IAEjC,IAAID,UAAU,CAACE,EAAE,EAAE;MACjB,OAAOF,UAAU,CAACG,IAAI;IACxB;IAEA,MAAMC,WAAW,GACfL,kBAAkB,IAAI,IAAI,CAACM,oBAAoB,CAACC,sCAAmB,CAAC;;IAEtE;IACA;IACAf,OAAO,CAACgB,KAAK,CAACH,WAAW,CAAC;IAE1B,OAAOA,WAAW;EACpB;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMI,WAAW,CAAC;EACvB;AACF;AACA;AACA;AACA;EACE,OAAOV,cAAcA,CAACC,kBAA2B,EAAU;IACzD,MAAMU,yBAAyB,GAAG,IAAIb,yBAAyB,EAAE;IAEjE,OAAOa,yBAAyB,CAACX,cAAc,CAAC;MAC9CC;IACF,CAAC,CAAC;EACJ;AACF;AAACW,OAAA,CAAAF,WAAA,GAAAA,WAAA"}
|
package/dist/useAddData.d.ts
CHANGED
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
import { KameleoonDataType } from '@kameleoon/javascript-sdk-core';
|
|
2
|
-
import { KameleoonError } from './KameleoonError';
|
|
3
2
|
export interface IAddDataHookResult {
|
|
4
3
|
/**
|
|
5
4
|
* Adds targeting data to the storage so that other methods could decide whether the current visitor is targeted or not. Note: userAgent data will not be stored in storage like other data, and it will be sent with every tracking request for bot filtration.
|
|
6
5
|
*
|
|
7
6
|
* @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
|
|
8
|
-
* @param {
|
|
7
|
+
* @param {KameleoonDataType[]} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.
|
|
8
|
+
* @throws `KameleoonError` with one of the following `type` s:
|
|
9
|
+
*
|
|
10
|
+
* - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.
|
|
11
|
+
* - `KameleoonException.StorageWrite` Couldn't update storage data.
|
|
12
|
+
* - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
|
|
9
13
|
*/
|
|
10
14
|
addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;
|
|
11
|
-
/** An optional error object that may be returned if an error occurs while calling the `addData` function. */
|
|
12
|
-
error: KameleoonError | null;
|
|
13
15
|
}
|
|
14
16
|
/**
|
|
15
17
|
* A React Hook that returns `addData` function for adding targeting data to the Kameleoon storage.
|
|
16
18
|
*
|
|
17
|
-
* @returns {IAddDataHookResult} an object containing the `addData` function
|
|
19
|
+
* @returns {IAddDataHookResult} an object containing the `addData` function.
|
|
18
20
|
*/
|
|
19
21
|
export declare function useAddData(): IAddDataHookResult;
|
package/dist/useAddData.js
CHANGED
|
@@ -6,30 +6,20 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports.useAddData = useAddData;
|
|
7
7
|
var _react = require("react");
|
|
8
8
|
var _useKameleoon = require("./useKameleoon");
|
|
9
|
-
var _useError = require("./useError");
|
|
10
9
|
/**
|
|
11
10
|
* A React Hook that returns `addData` function for adding targeting data to the Kameleoon storage.
|
|
12
11
|
*
|
|
13
|
-
* @returns {IAddDataHookResult} an object containing the `addData` function
|
|
12
|
+
* @returns {IAddDataHookResult} an object containing the `addData` function.
|
|
14
13
|
*/
|
|
15
14
|
function useAddData() {
|
|
16
15
|
const {
|
|
17
16
|
client
|
|
18
17
|
} = (0, _useKameleoon.useKameleoon)();
|
|
19
|
-
const {
|
|
20
|
-
error,
|
|
21
|
-
setError
|
|
22
|
-
} = (0, _useError.useError)();
|
|
23
18
|
const addData = (0, _react.useCallback)((visitorCode, ...data) => {
|
|
24
|
-
|
|
25
|
-
client.addData(visitorCode, ...data);
|
|
26
|
-
} catch (unknownError) {
|
|
27
|
-
setError(unknownError);
|
|
28
|
-
}
|
|
19
|
+
client.addData(visitorCode, ...data);
|
|
29
20
|
}, [client]);
|
|
30
21
|
return {
|
|
31
|
-
addData
|
|
32
|
-
error
|
|
22
|
+
addData
|
|
33
23
|
};
|
|
34
24
|
}
|
|
35
25
|
//# sourceMappingURL=useAddData.js.map
|
package/dist/useAddData.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAddData.js","names":["_react","require","_useKameleoon","
|
|
1
|
+
{"version":3,"file":"useAddData.js","names":["_react","require","_useKameleoon","useAddData","client","useKameleoon","addData","useCallback","visitorCode","data"],"sources":["../src/useAddData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { KameleoonDataType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IAddDataHookResult {\n /**\n * Adds targeting data to the storage so that other methods could decide whether the current visitor is targeted or not. Note: userAgent data will not be stored in storage like other data, and it will be sent with every tracking request for bot filtration.\n *\n * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n * @param {KameleoonDataType[]} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.\n * @throws `KameleoonError` with one of the following `type` s:\n * \n * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n * - `KameleoonException.StorageWrite` Couldn't update storage data.\n * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n */\n addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;\n}\n\n/**\n * A React Hook that returns `addData` function for adding targeting data to the Kameleoon storage.\n *\n * @returns {IAddDataHookResult} an object containing the `addData` function.\n */\nexport function useAddData(): IAddDataHookResult {\n const { client } = useKameleoon();\n\n const addData = useCallback(\n (visitorCode: string, ...data: KameleoonDataType[]): void => {\n client.addData(visitorCode, ...data);\n },\n [client],\n );\n\n return {\n addData,\n };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAiBA;AACA;AACA;AACA;AACA;AACO,SAASE,UAAUA,CAAA,EAAuB;EAC/C,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,OAAO,GAAG,IAAAC,kBAAW,EACzB,CAACC,WAAmB,EAAE,GAAGC,IAAyB,KAAW;IAC3DL,MAAM,CAACE,OAAO,CAACE,WAAW,EAAE,GAAGC,IAAI,CAAC;EACtC,CAAC,EACD,CAACL,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
interface IBrowserVisitorCodeHookResult {
|
|
1
|
+
export interface IBrowserVisitorCodeHookResult {
|
|
2
2
|
/**
|
|
3
3
|
* Obtains visitor code from browser cookie, if no cookie exists returns new random visitor code (or the specified default value).
|
|
4
4
|
*
|
|
5
|
-
* @param domain - domain to be set to browser cookie along with visitor code.
|
|
6
|
-
* @param defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in browser cookie.
|
|
5
|
+
* @param {string} domain - domain to be set to browser cookie along with visitor code.
|
|
6
|
+
* @param {string | undefined} defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in browser cookie.
|
|
7
7
|
* @returns {string} result visitor code.
|
|
8
8
|
*/
|
|
9
9
|
getBrowserVisitorCode: (domain: string, defaultVisitorCode?: string) => string;
|
|
@@ -11,7 +11,6 @@ interface IBrowserVisitorCodeHookResult {
|
|
|
11
11
|
/**
|
|
12
12
|
* A React Hook that returns `getBrowserVisitorCode` function which obtains the Kameleoon visitorCode.
|
|
13
13
|
*
|
|
14
|
-
* @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function
|
|
14
|
+
* @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function.
|
|
15
15
|
*/
|
|
16
16
|
export declare function useBrowserVisitorCode(): IBrowserVisitorCodeHookResult;
|
|
17
|
-
export {};
|
|
@@ -9,7 +9,7 @@ var _browserUtils = require("./kameleoonUtils/browserUtils");
|
|
|
9
9
|
/**
|
|
10
10
|
* A React Hook that returns `getBrowserVisitorCode` function which obtains the Kameleoon visitorCode.
|
|
11
11
|
*
|
|
12
|
-
* @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function
|
|
12
|
+
* @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function.
|
|
13
13
|
*/
|
|
14
14
|
function useBrowserVisitorCode() {
|
|
15
15
|
const getBrowserVisitorCode = (0, _react.useCallback)((domain, defaultVisitorCode) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useBrowserVisitorCode.js","names":["_react","require","_browserUtils","useBrowserVisitorCode","getBrowserVisitorCode","useCallback","domain","defaultVisitorCode","BrowserUtils","getVisitorCode"],"sources":["../src/useBrowserVisitorCode.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { BrowserUtils } from './kameleoonUtils/browserUtils';\n\
|
|
1
|
+
{"version":3,"file":"useBrowserVisitorCode.js","names":["_react","require","_browserUtils","useBrowserVisitorCode","getBrowserVisitorCode","useCallback","domain","defaultVisitorCode","BrowserUtils","getVisitorCode"],"sources":["../src/useBrowserVisitorCode.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { BrowserUtils } from './kameleoonUtils/browserUtils';\n\nexport interface IBrowserVisitorCodeHookResult {\n /**\n * Obtains visitor code from browser cookie, if no cookie exists returns new random visitor code (or the specified default value).\n *\n * @param {string} domain - domain to be set to browser cookie along with visitor code.\n * @param {string | undefined} defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in browser cookie.\n * @returns {string} result visitor code.\n */\n getBrowserVisitorCode: (\n domain: string,\n defaultVisitorCode?: string,\n ) => string;\n}\n\n/**\n * A React Hook that returns `getBrowserVisitorCode` function which obtains the Kameleoon visitorCode.\n *\n * @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function.\n */\nexport function useBrowserVisitorCode(): IBrowserVisitorCodeHookResult {\n const getBrowserVisitorCode = useCallback(\n (domain: string, defaultVisitorCode?: string): string => {\n return BrowserUtils.getVisitorCode(domain, defaultVisitorCode);\n },\n [],\n );\n\n return {\n getBrowserVisitorCode,\n };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAgBA;AACA;AACA;AACA;AACA;AACO,SAASE,qBAAqBA,CAAA,EAAkC;EACrE,MAAMC,qBAAqB,GAAG,IAAAC,kBAAW,EACvC,CAACC,MAAc,EAAEC,kBAA2B,KAAa;IACvD,OAAOC,0BAAY,CAACC,cAAc,CAACH,MAAM,EAAEC,kBAAkB,CAAC;EAChE,CAAC,EACD,EAAE,CACH;EAED,OAAO;IACLH;EACF,CAAC;AACH"}
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
import { KameleoonError } from './KameleoonError';
|
|
2
1
|
export interface IConfigurationUpdateHookResult {
|
|
3
2
|
/**
|
|
4
3
|
* Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.
|
|
5
4
|
*
|
|
6
5
|
* @param {() => void} callback - callback function with no parameters that will be called upon configuration update.
|
|
6
|
+
* @throws `KameleoonError` with one of the following `type` s:
|
|
7
|
+
*
|
|
8
|
+
* - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
|
|
7
9
|
*/
|
|
8
10
|
onConfigurationUpdate: (callback: () => void) => void;
|
|
9
|
-
/** An optional error object that may be returned if an error occurs while calling the `onConfigurationUpdate` function. */
|
|
10
|
-
error: KameleoonError | null;
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* A React Hook that returns `onConfigurationUpdate` function which fires a callback on client configuration update.
|
|
14
14
|
*
|
|
15
|
-
* @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function
|
|
15
|
+
* @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function.
|
|
16
16
|
*/
|
|
17
17
|
export declare function useConfigurationUpdate(): IConfigurationUpdateHookResult;
|
|
@@ -6,30 +6,20 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports.useConfigurationUpdate = useConfigurationUpdate;
|
|
7
7
|
var _react = require("react");
|
|
8
8
|
var _useKameleoon = require("./useKameleoon");
|
|
9
|
-
var _useError = require("./useError");
|
|
10
9
|
/**
|
|
11
10
|
* A React Hook that returns `onConfigurationUpdate` function which fires a callback on client configuration update.
|
|
12
11
|
*
|
|
13
|
-
* @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function
|
|
12
|
+
* @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function.
|
|
14
13
|
*/
|
|
15
14
|
function useConfigurationUpdate() {
|
|
16
15
|
const {
|
|
17
16
|
client
|
|
18
17
|
} = (0, _useKameleoon.useKameleoon)();
|
|
19
|
-
const {
|
|
20
|
-
error,
|
|
21
|
-
setError
|
|
22
|
-
} = (0, _useError.useError)();
|
|
23
18
|
const onConfigurationUpdate = (0, _react.useCallback)(callback => {
|
|
24
|
-
|
|
25
|
-
client.onConfigurationUpdate(callback);
|
|
26
|
-
} catch (unknownError) {
|
|
27
|
-
setError(unknownError);
|
|
28
|
-
}
|
|
19
|
+
client.onConfigurationUpdate(callback);
|
|
29
20
|
}, [client]);
|
|
30
21
|
return {
|
|
31
|
-
onConfigurationUpdate
|
|
32
|
-
error
|
|
22
|
+
onConfigurationUpdate
|
|
33
23
|
};
|
|
34
24
|
}
|
|
35
25
|
//# sourceMappingURL=useConfigurationUpdate.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useConfigurationUpdate.js","names":["_react","require","_useKameleoon","
|
|
1
|
+
{"version":3,"file":"useConfigurationUpdate.js","names":["_react","require","_useKameleoon","useConfigurationUpdate","client","useKameleoon","onConfigurationUpdate","useCallback","callback"],"sources":["../src/useConfigurationUpdate.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IConfigurationUpdateHookResult {\n /**\n * Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.\n *\n * @param {() => void} callback - callback function with no parameters that will be called upon configuration update.\n * @throws `KameleoonError` with one of the following `type` s:\n * \n * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n */\n onConfigurationUpdate: (callback: () => void) => void;\n}\n\n/**\n * A React Hook that returns `onConfigurationUpdate` function which fires a callback on client configuration update.\n *\n * @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function.\n */\nexport function useConfigurationUpdate(): IConfigurationUpdateHookResult {\n const { client } = useKameleoon();\n\n const onConfigurationUpdate = useCallback(\n (callback: () => void): void => {\n client.onConfigurationUpdate(callback);\n },\n [client],\n );\n\n return {\n onConfigurationUpdate,\n };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASE,sBAAsBA,CAAA,EAAmC;EACvE,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,qBAAqB,GAAG,IAAAC,kBAAW,EACtCC,QAAoB,IAAW;IAC9BJ,MAAM,CAACE,qBAAqB,CAACE,QAAQ,CAAC;EACxC,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.useEngineTrackingCode = useEngineTrackingCode;
|
|
7
|
+
var _react = require("react");
|
|
8
|
+
var _useKameleoon = require("./useKameleoon");
|
|
9
|
+
function useEngineTrackingCode() {
|
|
10
|
+
const {
|
|
11
|
+
client
|
|
12
|
+
} = (0, _useKameleoon.useKameleoon)();
|
|
13
|
+
const getEngineTrackingCode = (0, _react.useCallback)(visitorCode => {
|
|
14
|
+
return client.getEngineTrackingCode(visitorCode);
|
|
15
|
+
}, [client]);
|
|
16
|
+
return {
|
|
17
|
+
getEngineTrackingCode
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=useEngineTrackingCode.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useEngineTrackingCode.js","names":["_react","require","_useKameleoon","useEngineTrackingCode","client","useKameleoon","getEngineTrackingCode","useCallback","visitorCode"],"sources":["../src/useEngineTrackingCode.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IEngineTrackingCodeHookResult {\n /**\n * Returns Kameleoon tracking code for the current visitor. Tracking code is built of the experiments that were triggered and feature flag variations that were assigned during the last 5 seconds.\n * See [Kameleoon Automation API](https://developers.kameleoon.com/apis/activation-api-js/api-reference#trigger-1) for the details\n *\n * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length\n * @returns {string} Kameleoon tracking code\n */\n}\n\nexport function useEngineTrackingCode() {\n const { client } = useKameleoon();\n\n const getEngineTrackingCode = useCallback(\n (visitorCode: string): string => {\n return client.getEngineTrackingCode(visitorCode);\n },\n [client],\n );\n\n return {\n getEngineTrackingCode,\n };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAYO,SAASE,qBAAqBA,CAAA,EAAG;EACtC,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,qBAAqB,GAAG,IAAAC,kBAAW,EACtCC,WAAmB,IAAa;IAC/B,OAAOJ,MAAM,CAACE,qBAAqB,CAACE,WAAW,CAAC;EAClD,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { JSONType } from '@kameleoon/javascript-sdk-core';
|
|
2
|
+
export interface IExperimentVariationDataHookResult {
|
|
3
|
+
/**
|
|
4
|
+
* Returns variation data in JSON format for the variation with `variationId`.
|
|
5
|
+
*
|
|
6
|
+
* @param {number} variationId - id of variation
|
|
7
|
+
* @returns {JSONType} variation data in JSON format
|
|
8
|
+
* @throws `KameleoonError` with one of the following `type` s:
|
|
9
|
+
*
|
|
10
|
+
* - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
|
|
11
|
+
* - `KameleoonException.JSONParse` - Couldn't pass JSON value.
|
|
12
|
+
* - `KameleoonException.VariationNotFound` - No variation found for provided `variationId`
|
|
13
|
+
*/
|
|
14
|
+
getExperimentVariationData: (variationId: number) => JSONType;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* A React Hook that returns `getExperimentVariationData` function which returns variation data in JSON format for the variation with `variationId`.
|
|
18
|
+
*
|
|
19
|
+
* @returns {IExperimentVariationDataHookResult} an object containing the `getExperimentVariationData` function.
|
|
20
|
+
*/
|
|
21
|
+
export declare function useExperimentVariationData(): IExperimentVariationDataHookResult;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.useExperimentVariationData = useExperimentVariationData;
|
|
7
|
+
var _react = require("react");
|
|
8
|
+
var _useKameleoon = require("./useKameleoon");
|
|
9
|
+
/**
|
|
10
|
+
* A React Hook that returns `getExperimentVariationData` function which returns variation data in JSON format for the variation with `variationId`.
|
|
11
|
+
*
|
|
12
|
+
* @returns {IExperimentVariationDataHookResult} an object containing the `getExperimentVariationData` function.
|
|
13
|
+
*/
|
|
14
|
+
function useExperimentVariationData() {
|
|
15
|
+
const {
|
|
16
|
+
client
|
|
17
|
+
} = (0, _useKameleoon.useKameleoon)();
|
|
18
|
+
const getExperimentVariationData = (0, _react.useCallback)(variationId => {
|
|
19
|
+
return client.getExperimentVariationData(variationId);
|
|
20
|
+
}, [client]);
|
|
21
|
+
return {
|
|
22
|
+
getExperimentVariationData
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=useExperimentVariationData.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useExperimentVariationData.js","names":["_react","require","_useKameleoon","useExperimentVariationData","client","useKameleoon","getExperimentVariationData","useCallback","variationId"],"sources":["../src/useExperimentVariationData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { JSONType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IExperimentVariationDataHookResult {\n /**\n * Returns variation data in JSON format for the variation with `variationId`.\n *\n * @param {number} variationId - id of variation\n * @returns {JSONType} variation data in JSON format\n * @throws `KameleoonError` with one of the following `type` s:\n *\n * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n * - `KameleoonException.JSONParse` - Couldn't pass JSON value.\n * - `KameleoonException.VariationNotFound` - No variation found for provided `variationId`\n */\n getExperimentVariationData: (variationId: number) => JSONType;\n}\n\n/**\n * A React Hook that returns `getExperimentVariationData` function which returns variation data in JSON format for the variation with `variationId`.\n *\n * @returns {IExperimentVariationDataHookResult} an object containing the `getExperimentVariationData` function.\n */\nexport function useExperimentVariationData(): IExperimentVariationDataHookResult {\n const { client } = useKameleoon();\n\n const getExperimentVariationData = useCallback(\n (variationId: number): JSONType => {\n return client.getExperimentVariationData(variationId);\n },\n [client],\n );\n\n return {\n getExperimentVariationData,\n };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAiBA;AACA;AACA;AACA;AACA;AACO,SAASE,0BAA0BA,CAAA,EAAuC;EAC/E,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,0BAA0B,GAAG,IAAAC,kBAAW,EAC3CC,WAAmB,IAAe;IACjC,OAAOJ,MAAM,CAACE,0BAA0B,CAACE,WAAW,CAAC;EACvD,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}
|